WebexClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'MembershipsUpdated': {'operation_id': 'MembershipsUpdated', 'path': '/{connectionId}/v1/webhooks/1', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MembershipsUpdatedResponse'}, 'MembershipsDeleted': {'operation_id': 'MembershipsDeleted', 'path': '/{connectionId}/v1/webhooks/2', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MembershipsDeletedResponse'}, 'MembershipsCreated': {'operation_id': 'MembershipsCreated', 'path': '/{connectionId}/v1/webhooks/3', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MembershipsCreatedResponse'}, 'MessagesCreated': {'operation_id': 'MessagesCreated', 'path': '/{connectionId}/v1/webhooks/4', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MessagesCreatedResponse'}, 'MessagesDeleted': {'operation_id': 'MessagesDeleted', 'path': '/{connectionId}/v1/webhooks/5', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'MessagesDeletedResponse'}, 'SpaceCreated': {'operation_id': 'SpaceCreated', 'path': '/{connectionId}/v1/webhooks/6', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'SpaceCreatedResponse'}, 'SpaceUpdated': {'operation_id': 'SpaceUpdated', 'path': '/{connectionId}/v1/webhooks/7', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'SpaceUpdatedResponse'}}

Classes

CreateSpaceMemberInput dataclass

CreateSpaceMemberInput(is_moderator: Optional[bool] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, room_id: Optional[str] = None)

Add Member to Space

Attributes

is_moderator class-attribute instance-attribute

is_moderator: Optional[bool] = field(default=None, metadata={'wire_name': 'isModerator'})

Is moderator?

person_email class-attribute instance-attribute

person_email: Optional[str] = field(default=None, metadata={'wire_name': 'personEmail'})

Email address

person_id class-attribute instance-attribute

person_id: Optional[str] = field(default=None, metadata={'wire_name': 'personId'})

Person ID of the new member

room_id class-attribute instance-attribute

room_id: Optional[str] = field(default=None, metadata={'wire_name': 'roomId'})

Select a space

CreateSpaceMemberResponse dataclass

CreateSpaceMemberResponse(created: Optional[str] = None, id: Optional[str] = None, is_moderator: Optional[bool] = None, is_monitor: Optional[bool] = None, person_display_name: Optional[str] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, person_org_id: Optional[str] = None, room_id: Optional[str] = None)

Response for Add Member to Space

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

is_moderator class-attribute instance-attribute

is_moderator: Optional[bool] = field(default=None, metadata={'wire_name': 'isModerator'})

isModerator

is_monitor class-attribute instance-attribute

is_monitor: Optional[bool] = field(default=None, metadata={'wire_name': 'isMonitor'})

isMonitor

person_display_name class-attribute instance-attribute

person_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'personDisplayName'})

personDisplayName

person_email class-attribute instance-attribute

person_email: Optional[str] = field(default=None, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute

person_id: Optional[str] = field(default=None, metadata={'wire_name': 'personId'})

personId

person_org_id class-attribute instance-attribute

person_org_id: Optional[str] = field(default=None, metadata={'wire_name': 'personOrgId'})

personOrgId

room_id class-attribute instance-attribute

room_id: Optional[str] = field(default=None, metadata={'wire_name': 'roomId'})

roomId

GetMessagesResponse dataclass

GetMessagesResponse(items: Optional[List[Dict[str, Any]]] = None)

Response for Get Messages

Attributes

items class-attribute instance-attribute

items: Optional[List[Dict[str, Any]]] = None

items

SendMessageInput dataclass

SendMessageInput(files: Optional[List[str]] = None, markdown: Optional[str] = None, room_id: Optional[str] = None, text: Optional[str] = None, to_person_email: Optional[str] = None, to_person_id: Optional[str] = None)

Send a Message

Attributes

files class-attribute instance-attribute

files: Optional[List[str]] = None

files

markdown class-attribute instance-attribute

markdown: Optional[str] = None

Message, in markdown format

room_id class-attribute instance-attribute

room_id: Optional[str] = field(default=None, metadata={'wire_name': 'roomId'})

Select a recipient space

text class-attribute instance-attribute

text: Optional[str] = None

Message Text, in plain text, used for clients that do not support markdown

to_person_email class-attribute instance-attribute

to_person_email: Optional[str] = field(default=None, metadata={'wire_name': 'toPersonEmail'})

The email address of the recipient when sending a private 1:1 message

to_person_id class-attribute instance-attribute

to_person_id: Optional[str] = field(default=None, metadata={'wire_name': 'toPersonId'})

The ID of the recipient when sending a 1:1 message

SendMessageResponse dataclass

SendMessageResponse(created: Optional[str] = None, id: Optional[str] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, room_id: Optional[str] = None, room_type: Optional[str] = None, text: Optional[str] = None, to_person_email: Optional[str] = None)

Response for Send a Message

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

person_email class-attribute instance-attribute

person_email: Optional[str] = field(default=None, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute

person_id: Optional[str] = field(default=None, metadata={'wire_name': 'personId'})

personId

room_id class-attribute instance-attribute

room_id: Optional[str] = field(default=None, metadata={'wire_name': 'roomId'})

roomId

room_type class-attribute instance-attribute

room_type: Optional[str] = field(default=None, metadata={'wire_name': 'roomType'})

roomType

text class-attribute instance-attribute

text: Optional[str] = None

text

to_person_email class-attribute instance-attribute

to_person_email: Optional[str] = field(default=None, metadata={'wire_name': 'toPersonEmail'})

toPersonEmail

GetMessageDetailsResponse dataclass

GetMessageDetailsResponse(created: Optional[str] = None, files: Optional[List[str]] = None, id: Optional[str] = None, markdown: Optional[str] = None, mentioned_groups: Optional[List[str]] = None, mentioned_people: Optional[List[str]] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, room_id: Optional[str] = None, room_type: Optional[str] = None, text: Optional[str] = None, to_person_email: Optional[str] = None, to_person_id: Optional[str] = None)

Response for Get Message Details

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

files class-attribute instance-attribute

files: Optional[List[str]] = None

files

id class-attribute instance-attribute

id: Optional[str] = None

id

markdown class-attribute instance-attribute

markdown: Optional[str] = None

markdown

mentioned_groups class-attribute instance-attribute

mentioned_groups: Optional[List[str]] = field(default=None, metadata={'wire_name': 'mentionedGroups'})

mentionedGroups

mentioned_people class-attribute instance-attribute

mentioned_people: Optional[List[str]] = field(default=None, metadata={'wire_name': 'mentionedPeople'})

mentionedPeople

person_email class-attribute instance-attribute

person_email: Optional[str] = field(default=None, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute

person_id: Optional[str] = field(default=None, metadata={'wire_name': 'personId'})

personId

room_id class-attribute instance-attribute

room_id: Optional[str] = field(default=None, metadata={'wire_name': 'roomId'})

roomId

room_type class-attribute instance-attribute

room_type: Optional[str] = field(default=None, metadata={'wire_name': 'roomType'})

roomType

text class-attribute instance-attribute

text: Optional[str] = None

text

to_person_email class-attribute instance-attribute

to_person_email: Optional[str] = field(default=None, metadata={'wire_name': 'toPersonEmail'})

toPersonEmail

to_person_id class-attribute instance-attribute

to_person_id: Optional[str] = field(default=None, metadata={'wire_name': 'toPersonId'})

toPersonId

GetPeopleResponse dataclass

GetPeopleResponse(items: Optional[List[Dict[str, Any]]] = None, not_found_ids: Optional[List[str]] = None)

Response for Get People

Attributes

items class-attribute instance-attribute

items: Optional[List[Dict[str, Any]]] = None

items

not_found_ids class-attribute instance-attribute

not_found_ids: Optional[List[str]] = field(default=None, metadata={'wire_name': 'notFoundIds'})

notFoundIds

GetMyOwnDetailsResponse dataclass

GetMyOwnDetailsResponse(avatar: Optional[str] = None, created: Optional[str] = None, display_name: Optional[str] = None, emails: Optional[List[str]] = None, first_name: Optional[str] = None, id: Optional[str] = None, last_activity: Optional[str] = None, last_name: Optional[str] = None, nick_name: Optional[str] = None, org_id: Optional[str] = None, phone_numbers: Optional[List[Dict[str, Any]]] = None, status: Optional[str] = None, type_: Optional[str] = None)

Response for Get My Own Details

Attributes

avatar class-attribute instance-attribute

avatar: Optional[str] = None

avatar

created class-attribute instance-attribute

created: Optional[str] = None

created

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

displayName

emails class-attribute instance-attribute

emails: Optional[List[str]] = None

emails

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

firstName

id class-attribute instance-attribute

id: Optional[str] = None

id

last_activity class-attribute instance-attribute

last_activity: Optional[str] = field(default=None, metadata={'wire_name': 'lastActivity'})

lastActivity

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

lastName

nick_name class-attribute instance-attribute

nick_name: Optional[str] = field(default=None, metadata={'wire_name': 'nickName'})

nickName

org_id class-attribute instance-attribute

org_id: Optional[str] = field(default=None, metadata={'wire_name': 'orgId'})

orgId

phone_numbers class-attribute instance-attribute

phone_numbers: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'phoneNumbers'})

phoneNumbers

status class-attribute instance-attribute

status: Optional[str] = None

status

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

type

GetSpacesResponse dataclass

GetSpacesResponse(items: Optional[List[Dict[str, Any]]] = None)

Response for Get Spaces List

Attributes

items class-attribute instance-attribute

items: Optional[List[Dict[str, Any]]] = None

items

CreateSpaceInput dataclass

CreateSpaceInput(team_id: Optional[str] = None, title: Optional[str] = None)

Create Space

Attributes

team_id class-attribute instance-attribute

team_id: Optional[str] = field(default=None, metadata={'wire_name': 'teamId'})

Optionally select a team

title class-attribute instance-attribute

title: Optional[str] = None

Space Title

CreateSpaceResponse dataclass

CreateSpaceResponse(created: Optional[str] = None, creator_id: Optional[str] = None, id: Optional[str] = None, is_locked: Optional[bool] = None, last_activity: Optional[str] = None, title: Optional[str] = None, type_: Optional[str] = None)

Response for Create Space

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

creator_id class-attribute instance-attribute

creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

creatorId

id class-attribute instance-attribute

id: Optional[str] = None

id

is_locked class-attribute instance-attribute

is_locked: Optional[bool] = field(default=None, metadata={'wire_name': 'isLocked'})

isLocked

last_activity class-attribute instance-attribute

last_activity: Optional[str] = field(default=None, metadata={'wire_name': 'lastActivity'})

lastActivity

title class-attribute instance-attribute

title: Optional[str] = None

title

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

type

GetSpaceDetailResponse dataclass

GetSpaceDetailResponse(created: Optional[str] = None, creator_id: Optional[str] = None, id: Optional[str] = None, is_locked: Optional[bool] = None, last_activity: Optional[str] = None, title: Optional[str] = None, type_: Optional[str] = None)

Response for Get Space Details

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

creator_id class-attribute instance-attribute

creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

creatorId

id class-attribute instance-attribute

id: Optional[str] = None

id

is_locked class-attribute instance-attribute

is_locked: Optional[bool] = field(default=None, metadata={'wire_name': 'isLocked'})

isLocked

last_activity class-attribute instance-attribute

last_activity: Optional[str] = field(default=None, metadata={'wire_name': 'lastActivity'})

lastActivity

title class-attribute instance-attribute

title: Optional[str] = None

title

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

type

CreateTeamMemberInput dataclass

CreateTeamMemberInput(is_moderator: Optional[bool] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, team_id: Optional[str] = None)

Add Member to Team

Attributes

is_moderator class-attribute instance-attribute

is_moderator: Optional[bool] = field(default=None, metadata={'wire_name': 'isModerator'})

Is Moderator?

person_email class-attribute instance-attribute

person_email: Optional[str] = field(default=None, metadata={'wire_name': 'personEmail'})

Email address

person_id class-attribute instance-attribute

person_id: Optional[str] = field(default=None, metadata={'wire_name': 'personId'})

Person ID of the new member

team_id class-attribute instance-attribute

team_id: Optional[str] = field(default=None, metadata={'wire_name': 'teamId'})

Select a team

CreateTeamMemberResponse dataclass

CreateTeamMemberResponse(created: Optional[str] = None, id: Optional[str] = None, is_moderator: Optional[bool] = None, person_display_name: Optional[str] = None, person_email: Optional[str] = None, person_id: Optional[str] = None, person_org_id: Optional[str] = None, team_id: Optional[str] = None)

Response for Add Member to Team

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

is_moderator class-attribute instance-attribute

is_moderator: Optional[bool] = field(default=None, metadata={'wire_name': 'isModerator'})

isModerator

person_display_name class-attribute instance-attribute

person_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'personDisplayName'})

personDisplayName

person_email class-attribute instance-attribute

person_email: Optional[str] = field(default=None, metadata={'wire_name': 'personEmail'})

personEmail

person_id class-attribute instance-attribute

person_id: Optional[str] = field(default=None, metadata={'wire_name': 'personId'})

personId

person_org_id class-attribute instance-attribute

person_org_id: Optional[str] = field(default=None, metadata={'wire_name': 'personOrgId'})

personOrgId

team_id class-attribute instance-attribute

team_id: Optional[str] = field(default=None, metadata={'wire_name': 'teamId'})

teamId

MembershipsUpdatedInput dataclass

MembershipsUpdatedInput(event: Optional[str] = None, name: Optional[str] = None, resource: Optional[str] = None, target_url: Optional[str] = None)

When a membership is updated

Attributes

event class-attribute instance-attribute

event: Optional[str] = None

event

name class-attribute instance-attribute

name: Optional[str] = None

name

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

MembershipsUpdatedResponse dataclass

MembershipsUpdatedResponse(created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a membership is updated

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

name class-attribute instance-attribute

name: Optional[str] = None

name

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

event class-attribute instance-attribute

event: Optional[str] = None

event

filter class-attribute instance-attribute

filter: Optional[str] = None

filter

secret class-attribute instance-attribute

secret: Optional[str] = None

secret

status class-attribute instance-attribute

status: Optional[str] = None

status

MembershipsDeletedInput dataclass

MembershipsDeletedInput(event: Optional[str] = None, name: Optional[str] = None, resource: Optional[str] = None, target_url: Optional[str] = None)

When a membership is deleted

Attributes

event class-attribute instance-attribute

event: Optional[str] = None

event

name class-attribute instance-attribute

name: Optional[str] = None

name

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

MembershipsDeletedResponse dataclass

MembershipsDeletedResponse(created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a membership is deleted

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

name class-attribute instance-attribute

name: Optional[str] = None

name

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

event class-attribute instance-attribute

event: Optional[str] = None

event

filter class-attribute instance-attribute

filter: Optional[str] = None

filter

secret class-attribute instance-attribute

secret: Optional[str] = None

secret

status class-attribute instance-attribute

status: Optional[str] = None

status

MembershipsCreatedInput dataclass

MembershipsCreatedInput(event: Optional[str] = None, name: Optional[str] = None, resource: Optional[str] = None, target_url: Optional[str] = None)

When a membership is created

Attributes

event class-attribute instance-attribute

event: Optional[str] = None

event

name class-attribute instance-attribute

name: Optional[str] = None

name

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

MembershipsCreatedResponse dataclass

MembershipsCreatedResponse(created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a membership is created

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

name class-attribute instance-attribute

name: Optional[str] = None

name

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

event class-attribute instance-attribute

event: Optional[str] = None

event

filter class-attribute instance-attribute

filter: Optional[str] = None

filter

secret class-attribute instance-attribute

secret: Optional[str] = None

secret

status class-attribute instance-attribute

status: Optional[str] = None

status

MessagesCreatedInput dataclass

MessagesCreatedInput(event: Optional[str] = None, name: Optional[str] = None, resource: Optional[str] = None, target_url: Optional[str] = None)

When a message is created

Attributes

event class-attribute instance-attribute

event: Optional[str] = None

event

name class-attribute instance-attribute

name: Optional[str] = None

name

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

MessagesCreatedResponse dataclass

MessagesCreatedResponse(created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a message is created

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

name class-attribute instance-attribute

name: Optional[str] = None

name

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

event class-attribute instance-attribute

event: Optional[str] = None

event

filter class-attribute instance-attribute

filter: Optional[str] = None

filter

secret class-attribute instance-attribute

secret: Optional[str] = None

secret

status class-attribute instance-attribute

status: Optional[str] = None

status

MessagesDeletedInput dataclass

MessagesDeletedInput(event: Optional[str] = None, name: Optional[str] = None, resource: Optional[str] = None, target_url: Optional[str] = None)

When a message is deleted

Attributes

event class-attribute instance-attribute

event: Optional[str] = None

event

name class-attribute instance-attribute

name: Optional[str] = None

name

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

MessagesDeletedResponse dataclass

MessagesDeletedResponse(created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a message is deleted

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

name class-attribute instance-attribute

name: Optional[str] = None

name

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

event class-attribute instance-attribute

event: Optional[str] = None

event

filter class-attribute instance-attribute

filter: Optional[str] = None

filter

secret class-attribute instance-attribute

secret: Optional[str] = None

secret

status class-attribute instance-attribute

status: Optional[str] = None

status

SpaceCreatedInput dataclass

SpaceCreatedInput(event: Optional[str] = None, name: Optional[str] = None, resource: Optional[str] = None, target_url: Optional[str] = None)

When a space is created

Attributes

event class-attribute instance-attribute

event: Optional[str] = None

event

name class-attribute instance-attribute

name: Optional[str] = None

name

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

SpaceCreatedResponse dataclass

SpaceCreatedResponse(created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a space is created

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

name class-attribute instance-attribute

name: Optional[str] = None

name

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

event class-attribute instance-attribute

event: Optional[str] = None

event

filter class-attribute instance-attribute

filter: Optional[str] = None

filter

secret class-attribute instance-attribute

secret: Optional[str] = None

secret

status class-attribute instance-attribute

status: Optional[str] = None

status

SpaceUpdatedInput dataclass

SpaceUpdatedInput(event: Optional[str] = None, name: Optional[str] = None, resource: Optional[str] = None, target_url: Optional[str] = None)

When a space is updated

Attributes

event class-attribute instance-attribute

event: Optional[str] = None

event

name class-attribute instance-attribute

name: Optional[str] = None

name

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

SpaceUpdatedResponse dataclass

SpaceUpdatedResponse(created: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, target_url: Optional[str] = None, resource: Optional[str] = None, event: Optional[str] = None, filter: Optional[str] = None, secret: Optional[str] = None, status: Optional[str] = None)

Response for When a space is updated

Attributes

created class-attribute instance-attribute

created: Optional[str] = None

created

id class-attribute instance-attribute

id: Optional[str] = None

id

name class-attribute instance-attribute

name: Optional[str] = None

name

target_url class-attribute instance-attribute

target_url: Optional[str] = field(default=None, metadata={'wire_name': 'targetUrl'})

targetUrl

resource class-attribute instance-attribute

resource: Optional[str] = None

resource

event class-attribute instance-attribute

event: Optional[str] = None

event

filter class-attribute instance-attribute

filter: Optional[str] = None

filter

secret class-attribute instance-attribute

secret: Optional[str] = None

secret

status class-attribute instance-attribute

status: Optional[str] = None

status

WebexClient

WebexClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for webex connector.

Initialize a WebexClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

create_space_member_async async

create_space_member_async(input: CreateSpaceMemberInput) -> dict[str, Any] | None

Add Member to Space

Add a member to an existing space

get_messages_async async

get_messages_async(room_id: str, mentioned_people: Optional[str] = None, before_message: Optional[str] = None, before: Optional[str] = None, max: Optional[int] = None) -> dict[str, Any] | None

Get Messages

Get a list of recent messages for a space

send_message_async async

send_message_async(input: SendMessageInput) -> dict[str, Any] | None

Send a Message

Send a message to webex

get_message_details_async async

get_message_details_async(message_id: str) -> dict[str, Any] | None

Get Message Details

Shows details for a message, by message ID.

get_people_async async

get_people_async(id: Optional[str] = None, email: Optional[str] = None) -> dict[str, Any] | None

Get People

Lookup details and presence information for people in your organization

get_my_own_details_async async

get_my_own_details_async() -> dict[str, Any] | None

Get My Own Details

Lookup your own details

get_spaces_async async

get_spaces_async(max: Optional[int] = None, type_: Optional[str] = None, sort_by: Optional[str] = None) -> dict[str, Any] | None

Get Spaces List

This action retrieves a list of spaces

create_space_async async

create_space_async(input: CreateSpaceInput) -> dict[str, Any] | None

Create Space

Create space or team space

get_space_detail_async async

get_space_detail_async(room_id: str) -> dict[str, Any] | None

Get Space Details

Return details of a given space

create_team_member_async async

create_team_member_async(input: CreateTeamMemberInput) -> dict[str, Any] | None

Add Member to Team

Add a member to a team