Skip to content

Latest commit

 

History

History
437 lines (240 loc) · 6.29 KB

api.rst

File metadata and controls

437 lines (240 loc) · 6.29 KB
.. currentmodule:: webexteamssdk

User API Doc

WebexTeamsAPI

The :class:`WebexTeamsAPI` class creates "connection objects" for working with the Webex Teams APIs and hierarchically organizes the Webex Teams APIs and their endpoints underneath these connection objects.

.. autoclass:: WebexTeamsAPI()
    :members:
    :exclude-members: access_token, base_url

    .. automethod:: WebexTeamsAPI.__init__

access_tokens

.. autoclass:: webexteamssdk.api.access_tokens.AccessTokensAPI()

admin_audit_events

.. autoclass:: webexteamssdk.api.admin_audit_events.AdminAuditEventsAPI()

attachment_actions

.. autoclass:: webexteamssdk.api.attachment_actions.AttachmentActionsAPI()

events

.. autoclass:: webexteamssdk.api.events.EventsAPI()

guest_issuer

.. autoclass:: webexteamssdk.api.guest_issuer.GuestIssuerAPI()

licenses

.. autoclass:: webexteamssdk.api.licenses.LicensesAPI()

memberships

.. autoclass:: webexteamssdk.api.memberships.MembershipsAPI()

messages

.. autoclass:: webexteamssdk.api.messages.MessagesAPI()

organizations

.. autoclass:: webexteamssdk.api.organizations.OrganizationsAPI()

people

.. autoclass:: webexteamssdk.api.people.PeopleAPI()

roles

.. autoclass:: webexteamssdk.api.roles.RolesAPI()

rooms

.. autoclass:: webexteamssdk.api.rooms.RoomsAPI()

teams

.. autoclass:: webexteamssdk.api.teams.TeamsAPI()

team_memberships

.. autoclass:: webexteamssdk.api.team_memberships.TeamMembershipsAPI()

webhooks

.. autoclass:: webexteamssdk.api.webhooks.WebhooksAPI()

Webex Teams Data Objects

Access Token

.. autoclass:: AccessToken()
    :inherited-members:

Admin Audit Event

.. autoclass:: AdminAuditEvent()
    :inherited-members:

Attachment Action

.. autoclass:: AttachmentAction()
    :inherited-members:

Event

.. autoclass:: Event()
    :inherited-members:

Guest Issuer Token

.. autoclass:: GuestIssuerToken()
    :inherited-members:

License

.. autoclass:: License()
    :inherited-members:

Membership

.. autoclass:: Membership()
    :inherited-members:

Message

.. autoclass:: Message()
    :inherited-members:

Organization

.. autoclass:: Organization()
    :inherited-members:

Person

.. autoclass:: Person()
    :inherited-members:

Role

.. autoclass:: Role()
    :inherited-members:

Room

.. autoclass:: Room()
    :inherited-members:

Room Meeting Info

.. autoclass:: RoomMeetingInfo()
    :inherited-members:

Team

.. autoclass:: Team()
    :inherited-members:

Team Membership

.. autoclass:: TeamMembership()
    :inherited-members:

Webhook

.. autoclass:: Webhook()
    :inherited-members:

Webhook Event

.. autoclass:: WebhookEvent()
    :inherited-members:

Exceptions

.. autoexception:: webexteamssdkException()
    :show-inheritance:
    :members:


.. autoexception:: AccessTokenError()
    :show-inheritance:
    :members:


.. autoexception:: ApiError()
    :show-inheritance:
    :members:


.. autoexception:: MalformedResponse()
    :show-inheritance:
    :members:


.. autoexception:: RateLimitError()
    :show-inheritance:
    :members:

Warnings

.. autoexception:: webexteamssdkWarning()
    :show-inheritance:
    :members:


.. autoexception:: ApiWarning()
    :show-inheritance:
    :members:


.. autoexception:: RateLimitWarning()
    :show-inheritance:
    :members:

Cards and Buttons

.. autoclass:: webexteamssdk.cards.card.AdaptiveCard()

Components

.. autoclass:: webexteamssdk.cards.components.Image()
   :members:

   .. automethod:: __init__


.. autoclass:: webexteamssdk.cards.components.TextBlock()
   :members:

   .. automethod:: __init__


.. autoclass:: webexteamssdk.cards.components.Column()


.. autoclass:: webexteamssdk.cards.components.Fact()


.. autoclass:: webexteamssdk.cards.components.Choice()

Options

.. autoclass:: webexteamssdk.cards.options.VerticalContentAlignment()


.. autoclass:: webexteamssdk.cards.options.Colors()


.. autoclass:: webexteamssdk.cards.options.HorizontalAlignment()


.. autoclass:: webexteamssdk.cards.options.FontSize()


.. autoclass:: webexteamssdk.cards.options.FontWeight()


.. autoclass:: webexteamssdk.cards.options.BlockElementHeight()


.. autoclass:: webexteamssdk.cards.options.Spacing()


.. autoclass:: webexteamssdk.cards.options.ImageSize()


.. autoclass:: webexteamssdk.cards.options.ImageStyle()


.. autoclass:: webexteamssdk.cards.options.ContainerStyle()


.. autoclass:: webexteamssdk.cards.options.TextInputStyle()


.. autoclass:: webexteamssdk.cards.options.ChoiceInputStyle()

Container

.. autoclass:: webexteamssdk.cards.container.Container()


.. autoclass:: webexteamssdk.cards.container.ColumnSet()


.. autoclass:: webexteamssdk.cards.container.FactSet()


.. autoclass:: webexteamssdk.cards.container.ImageSet()

Inputs

.. autoclass:: webexteamssdk.cards.inputs.Text()


.. autoclass:: webexteamssdk.cards.inputs.Number()


.. autoclass:: webexteamssdk.cards.inputs.Date()


.. autoclass:: webexteamssdk.cards.inputs.Time()


.. autoclass:: webexteamssdk.cards.inputs.Toggle()


.. autoclass:: webexteamssdk.cards.inputs.Choices()

Actions

.. autoclass:: webexteamssdk.cards.actions.OpenUrl


.. autoclass:: webexteamssdk.cards.actions.Submit


.. autoclass:: webexteamssdk.cards.actions.ShowCard

Copyright (c) 2016-2019 Cisco and/or its affiliates.