wxc_sdk.events package

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

Bases: ApiModel

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

Raises ValidationError if the input data cannot be parsed to form a valid model.

id: Optional[str]

room_id: Optional[str]

type: Optional[str]

room_type: Optional[str]

is_room_hidden: Optional[bool]

org_id: Optional[str]

text: Optional[str]

files: Optional[list[str]]

person_id: Optional[str]

person_email: Optional[str]

person_org_id: Optional[str]

person_display_name: Optional[str]

is_moderator: Optional[bool]

is_monitor: Optional[bool]

meeting_id: Optional[str]

creator_id: Optional[str]

host: Optional[object]: The meeting’s host data

attendees: Optional[list[Any]]: Common Identity (CI) authenticated meeting attendees

transcription_enabled: Optional[str]: 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: Optional[str]: 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: Optional[str]: 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: Optional[datetime]

updated: Optional[datetime]

markdown: Optional[str]

html: Optional[str]

mentioned_people: Optional[list[str]]

file_content_url: Optional[str]

file_id: Optional[str]

page_number: Optional[int]

is_locked: Optional[bool]

is_announcement_only: Optional[bool]

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

Bases: ApiModel

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

Raises ValidationError if the input data cannot be parsed to form a valid model.

id: Optional[str]: The unique identifier for the event.

resource: Optional[EventResource]: The type of resource in the event.

type: Optional[EventType]: The action which took place in the event.

app_id: Optional[str]: The ID of the application for the event.

actor_id: Optional[str]: The ID of the person who performed the action.

org_id: Optional[str]: The ID of the organization for the event.

created: Optional[datetime]: The date and time of the event.

data: Optional[EventData]: 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.

class wxc_sdk.events.EventResource(value)[source]

Bases: str, Enum

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)[source]

Bases: str, Enum

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: Optional[str] = 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: Optional[EventResource] = None, type_: Optional[EventType] = None, actor_id: Optional[str] = None, from_: Optional[datetime] = None, to_: Optional[datetime] = 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