wxc_sdk.events package

class wxc_sdk.events.EventData(*, id: str | None = None, title: str | None = None, roomId: str | None = None, type: str | None = None, roomType: str | None = None, isRoomHidden: bool | None = None, orgId: str | None = None, text: str | None = None, files: list[str] | None = None, personId: str | None = None, personEmail: str | None = None, personOrgId: str | None = None, personDisplayName: str | None = None, isModerator: bool | None = None, isMonitor: bool | None = None, meetingId: str | None = None, creatorId: str | None = None, host: object | None = None, attendees: list[Any] | None = None, transcriptionEnabled: str | None = None, recordingEnabled: str | None = None, hasPostMeetingsChat: str | None = None, created: datetime | None = None, updated: datetime | None = None, markdown: str | None = None, html: str | None = None, mentionedPeople: list[str] | None = None, fileContentUrl: str | None = None, fileId: str | None = None, pageNumber: int | None = None, isLocked: bool | None = None, isPublic: bool | None = None, madePublic: datetime | None = None, isAnnouncementOnly: bool | None = None)[source]

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

id: str | None
title: str | None
room_id: str | None
type: str | None
room_type: str | None
is_room_hidden: bool | None
org_id: str | None
text: str | None
files: list[str] | None
person_id: str | None
person_email: str | None
person_org_id: str | None
person_display_name: str | None
is_moderator: bool | None
is_monitor: bool | None
meeting_id: str | None
creator_id: str | None
host: object | None

The meeting’s host data

attendees: list[Any] | None

Common Identity (CI) authenticated meeting attendees

transcription_enabled: str | None

indicates whether or not the Voice Assistant was enabled during the meeting. If true a transcript should be available a couple minutes after the meeting ended at the meetingTranscripts resource

recording_enabled: str | None

indicates if recording was enabled for all or parts of the meeting. If true a recording should be available shortly after the meeting ended at the recordings resource

has_post_meetings_chat: str | None

indicates i chat messages were exchanged during the meeting in the meetings client (not the unified client). If true these messages can be accessed by a compliance officer at the postMeetingsChat resource. Meetings chat collection must be custom enabled.

created: datetime | None
updated: datetime | None
markdown: str | None
html: str | None
mentioned_people: list[str] | None
file_content_url: str | None
file_id: str | None
page_number: int | None
is_locked: bool | None
is_public: bool | None
made_public: datetime | None
is_announcement_only: bool | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'attendees': FieldInfo(annotation=Union[list[Any], NoneType], required=False, alias='attendees', alias_priority=1), 'created': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='created', alias_priority=1), 'creator_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='creatorId', alias_priority=1), 'file_content_url': FieldInfo(annotation=Union[str, NoneType], required=False, alias='fileContentUrl', alias_priority=1), 'file_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='fileId', alias_priority=1), 'files': FieldInfo(annotation=Union[list[str], NoneType], required=False, alias='files', alias_priority=1), 'has_post_meetings_chat': FieldInfo(annotation=Union[str, NoneType], required=False, alias='hasPostMeetingsChat', alias_priority=1), 'host': FieldInfo(annotation=Union[object, NoneType], required=False, alias='host', alias_priority=1), 'html': FieldInfo(annotation=Union[str, NoneType], required=False, alias='html', alias_priority=1), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=1), 'is_announcement_only': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='isAnnouncementOnly', alias_priority=1), 'is_locked': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='isLocked', alias_priority=1), 'is_moderator': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='isModerator', alias_priority=1), 'is_monitor': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='isMonitor', alias_priority=1), 'is_public': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='isPublic', alias_priority=1), 'is_room_hidden': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='isRoomHidden', alias_priority=1), 'made_public': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='madePublic', alias_priority=1), 'markdown': FieldInfo(annotation=Union[str, NoneType], required=False, alias='markdown', alias_priority=1), 'meeting_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='meetingId', alias_priority=1), 'mentioned_people': FieldInfo(annotation=Union[list[str], NoneType], required=False, alias='mentionedPeople', alias_priority=1), 'org_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='orgId', alias_priority=1), 'page_number': FieldInfo(annotation=Union[int, NoneType], required=False, alias='pageNumber', alias_priority=1), 'person_display_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='personDisplayName', alias_priority=1), 'person_email': FieldInfo(annotation=Union[str, NoneType], required=False, alias='personEmail', alias_priority=1), 'person_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='personId', alias_priority=1), 'person_org_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='personOrgId', alias_priority=1), 'recording_enabled': FieldInfo(annotation=Union[str, NoneType], required=False, alias='recordingEnabled', alias_priority=1), 'room_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='roomId', alias_priority=1), 'room_type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='roomType', alias_priority=1), 'text': FieldInfo(annotation=Union[str, NoneType], required=False, alias='text', alias_priority=1), 'title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='title', alias_priority=1), 'transcription_enabled': FieldInfo(annotation=Union[str, NoneType], required=False, alias='transcriptionEnabled', alias_priority=1), 'type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='type', alias_priority=1), 'updated': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='updated', alias_priority=1)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class wxc_sdk.events.ComplianceEvent(*, id: str | None = None, resource: EventResource | None = None, type: EventType | None = None, appId: str | None = None, actorId: str | None = None, orgId: str | None = None, created: datetime | None = None, data: EventData | None = None)[source]

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

id: str | None

The unique identifier for the event.

resource: EventResource | None

The type of resource in the event.

type: EventType | None

The action which took place in the event.

app_id: str | None

The ID of the application for the event.

actor_id: str | None

The ID of the person who performed the action.

org_id: str | None

The ID of the organization for the event.

created: datetime | None

The date and time of the event.

data: EventData | None

The event’s data representation. This object will contain the event’s resource, such as memberships, messages, meetings, tabs, rooms or attachmentActions at the time the event took place.

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'actor_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='actorId', alias_priority=1), 'app_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appId', alias_priority=1), 'created': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='created', alias_priority=1), 'data': FieldInfo(annotation=Union[EventData, NoneType], required=False, alias='data', alias_priority=1), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='id', alias_priority=1), 'org_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='orgId', alias_priority=1), 'resource': FieldInfo(annotation=Union[EventResource, NoneType], required=False, alias='resource', alias_priority=1), 'type': FieldInfo(annotation=Union[EventType, NoneType], required=False, alias='type', alias_priority=1)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class wxc_sdk.events.EventResource(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

messages = 'messages'

State changed on a messages resource

memberships = 'memberships'

State changed on a memberships resource

meetings = 'meetings'

State change on a meeting ( here combined with type = ‘ended’ )

meeting_transcripts = 'meetingTranscripts'

State change on a automatic transcript resource for Webex Assistant

meeting_messages = 'meetingMessages'

State changed on a meeting message, i.e. message exchanged as part of a meeting

tabs = 'tabs'

State changed on a room tabs in a space

rooms = 'rooms'

State changed on a space classification

attachment_actions = 'attachmentActions'

State changed on a card attachment

files = 'files'

State changed on a file download

file_transcodings = 'file_transcodings'

State change on a file preview

class wxc_sdk.events.EventType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

created = 'created'

The resource has been created

updated = 'updated'

A property on the resource has been updated

deleted = 'deleted'

The resource has been deleted

ended = 'ended'

The meeting has ended

read = 'read'
class wxc_sdk.events.EventsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Events are generated when actions take place within Webex, such as when someone creates or deletes a message. The Events API can only be used by a Compliance Officer with an API access token that contains the spark-compliance:events_read scope. See the Compliance Guide for more information.

list(resource: EventResource | None = None, type_: EventType | None = None, actor_id: str | None = None, from_: datetime | None = None, to_: datetime | None = None, **params) → Generator[ComplianceEvent, None, None][source]

List events in your organization. Several query parameters are available to filter the events returned in the response. Long result sets will be split into pages.

Parameters:

  • resource (EventResource) – List events with a specific resource type.

  • type (EventType) – List events with a specific event type.

  • actor_id (str) – List events performed by this person, by person ID.

  • from (str) – List events which occurred after a specific date and time.

  • to (str) – List events which occurred before a specific date and time. If unspecified, or set to a time in the future, lists events up to the present.

details(event_id: str) → ComplianceEvent[source]

Shows details for an event, by event ID. Specify the event ID in the eventId parameter in the URI.

Parameters:

event_id (str) – The unique identifier for the event.

base = 'events'
session: RestSession

REST session