TeamsClient

Attributes

ChatMessageList module-attribute

ChatMessageList = List['ChatMessage | Mapping[str, Any]']

OnGroupMemberChangeResponse module-attribute

OnGroupMemberChangeResponse = List[Dict[str, Any]]

GetFlowContinuationSubscriptionWithPosterOutputMetadataInput module-attribute

GetFlowContinuationSubscriptionWithPosterOutputMetadataInput = str

ThemeEditor module-attribute

ThemeEditor = Literal['white', 'blue', 'green', 'purple', 'pink', 'yellow', 'gray', 'darkblue', 'darkgreen', 'darkpurple', 'darkpink', 'darkyellow']

Activities module-attribute

Activities = List[Dict[str, Any]]

ChannelIdForTeam module-attribute

ChannelIdForTeam = str

ChatId module-attribute

ChatId = str

BotIdForChat module-attribute

BotIdForChat = str

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewChannelMessage': {'operation_id': 'OnNewChannelMessage', 'path': '/{connectionId}/trigger/beta/teams/{groupId}/channels/{channelId}/messages', 'method': 'get', 'required_parameters': ['groupId', 'channelId'], 'callback_payload_type': 'ChatMessageList'}, 'OnNewChannelMessageMentioningMe': {'operation_id': 'OnNewChannelMessageMentioningMe', 'path': '/{connectionId}/trigger/beta/teams/{groupId}/channels/{channelId}/messages_mentioningme', 'method': 'get', 'required_parameters': ['groupId', 'channelId'], 'callback_payload_type': 'ChatMessageList'}, 'WebhookAtMentionTrigger': {'operation_id': 'WebhookAtMentionTrigger', 'path': '/{connectionId}/beta/subscriptions/atmentiontrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['threadType'], 'callback_payload_type': None}, 'WebhookMessageReactionTrigger': {'operation_id': 'WebhookMessageReactionTrigger', 'path': '/{connectionId}/beta/subscriptions/messagereactiontrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['reactionKey', 'frequency', 'runningPolicy', 'threadType'], 'callback_payload_type': None}, 'TranscriptTrigger': {'operation_id': 'TranscriptTrigger', 'path': '/{connectionId}/beta/subscriptions/transcripttrigger', 'method': 'post', 'required_parameters': ['scopeType', 'body'], 'callback_payload_type': None}, 'RecordingTrigger': {'operation_id': 'RecordingTrigger', 'path': '/{connectionId}/beta/subscriptions/recordingtrigger', 'method': 'post', 'required_parameters': ['scopeType', 'body'], 'callback_payload_type': None}, 'WebhookChatMessageTrigger': {'operation_id': 'WebhookChatMessageTrigger', 'path': '/{connectionId}/beta/subscriptions/chatmessagetrigger', 'method': 'post', 'required_parameters': ['ChatMessageSubscriptionRequest'], 'callback_payload_type': None}, 'WebhookKeywordTrigger': {'operation_id': 'WebhookKeywordTrigger', 'path': '/{connectionId}/beta/subscriptions/keywordtrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['threadType', '$search'], 'callback_payload_type': None}, 'WebhookNewMessageTrigger': {'operation_id': 'WebhookNewMessageTrigger', 'path': '/{connectionId}/beta/subscriptions/newmessagetrigger/threadType/{threadType}', 'method': 'post', 'required_parameters': ['threadType'], 'callback_payload_type': None}, 'OnGroupMembershipRemoval': {'operation_id': 'OnGroupMembershipRemoval', 'path': '/{connectionId}/trigger/v1.0/groups/removal', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnGroupMemberChangeResponse'}, 'OnGroupMembershipAdd': {'operation_id': 'OnGroupMembershipAdd', 'path': '/{connectionId}/trigger/v1.0/groups/delta', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnGroupMemberChangeResponse'}}

Classes

NewMeetingResponse dataclass

NewMeetingResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, categories: Optional[List[Any]] = None, time_zone: Optional[str] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, has_attachments: Optional[bool] = None, subject: Optional[str] = None, body_preview: Optional[str] = None, importance: Optional[str] = None, sensitivity: Optional[str] = None, is_all_day: Optional[bool] = None, is_cancelled: Optional[bool] = None, is_organizer: Optional[bool] = None, response_requested: Optional[bool] = None, show_as: Optional[str] = None, type_: Optional[str] = None, web_link: Optional[str] = None, online_meeting_url: Optional[str] = None, allow_new_time_proposals: Optional[bool] = None, recurrence: Optional[Dict[str, Any]] = None, response_status: Optional[Dict[str, Any]] = None, body: Optional[Dict[str, Any]] = None, start: Optional[Dict[str, Any]] = None, end: Optional[Dict[str, Any]] = None, location: Optional[Dict[str, Any]] = None, attendees: Optional[List[Dict[str, Any]]] = None, organizer: Optional[Dict[str, Any]] = None, online_meeting: Optional[Dict[str, Any]] = None)

Response for Create a Teams meeting

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique identifier for the event

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

Timestamp the event was created

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

Timestamp the event was last modified

categories class-attribute instance-attribute

categories: Optional[List[Any]] = dataclass_field(default=None, kw_only=True)

The categories associated with the event

time_zone class-attribute instance-attribute

time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeZone'})

Time zone of the event

reminder_minutes_before_start class-attribute instance-attribute

reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})

The number of minutes before the event start time that the reminder alert occurs

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

Set to true if an alert is set to remind the user of the event

has_attachments class-attribute instance-attribute

has_attachments: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasAttachments'})

Set to true if the event has attachments

subject class-attribute instance-attribute

subject: Optional[str] = dataclass_field(default=None, kw_only=True)

The text of the event's subject line

body_preview class-attribute instance-attribute

body_preview: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bodyPreview'})

The preview of the message associated with the event

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True)

The importance of the event. The possible values are: low, normal, high

sensitivity class-attribute instance-attribute

sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True)

Sensitivity of the event

is_all_day class-attribute instance-attribute

is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day

is_cancelled class-attribute instance-attribute

is_cancelled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isCancelled'})

Set to true if the event has been canceled

is_organizer class-attribute instance-attribute

is_organizer: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOrganizer'})

Set to true if the calendar owner is the organizer of the event

response_requested class-attribute instance-attribute

response_requested: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseRequested'})

The organizer would like an invitee to send a response to the event

show_as class-attribute instance-attribute

show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})

The status to show. Possible values are: free, tentative, busy, oof, workingElsewhere, unknown.

type_ class-attribute instance-attribute

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

The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster

web_link class-attribute instance-attribute

web_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webLink'})

The URL to open the event in Outlook on the web.

online_meeting_url class-attribute instance-attribute

online_meeting_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onlineMeetingUrl'})

A URL for an online meeting

allow_new_time_proposals class-attribute instance-attribute

allow_new_time_proposals: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowNewTimeProposals'})

True if the meeting organizer allows invitees to propose a new time when responding

recurrence class-attribute instance-attribute

recurrence: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The recurrence pattern for the event

response_status class-attribute instance-attribute

response_status: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseStatus'})

Indicates the type of response sent in response to an event message

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The body of the message associated with the event

start class-attribute instance-attribute

start: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The start date, time, and time zone of the event

end class-attribute instance-attribute

end: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The date, time, and time zone that the event ends

location class-attribute instance-attribute

location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The location of the event

attendees class-attribute instance-attribute

attendees: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

The collection of attendees for the event

organizer class-attribute instance-attribute

organizer: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Organizer

online_meeting class-attribute instance-attribute

online_meeting: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'onlineMeeting'})

Details for an attendee to join the meeting online.

GetAllTeamsResponse dataclass

GetAllTeamsResponse(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List joined teams

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of the teams you are a member of

GetAllAssociatedTeamsResponse dataclass

GetAllAssociatedTeamsResponse(*, context: Optional[str] = None, value: Optional[List[AssociatedTeamInfo | Mapping[str, Any]]] = None)

Response for List associated teams

Attributes

value class-attribute instance-attribute

value: Optional[List[AssociatedTeamInfo | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of the teams you are associated with

GetChannelsForGroupResponse dataclass

GetChannelsForGroupResponse(*, context: Optional[str] = None, value: Optional[List[GetChannelResponse | Mapping[str, Any]]] = None)

Response for List channels

Attributes

value class-attribute instance-attribute

value: Optional[List[GetChannelResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of one or more channels for a specific team

CreateChannelInput dataclass

CreateChannelInput(display_name: str, *, description: Optional[str] = None, membership_type: Optional[str] = None)

Create a channel

Attributes

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Optional textual description for the channel

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

Channel name as it appears in Microsoft Teams

membership_type class-attribute instance-attribute

membership_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'membershipType'})

The type of channel. Private channels are accessible only to specific members. Shared channels can be shared with users outside the team. Defaults to standard.

CreateChannelResponse dataclass

CreateChannelResponse(*, description: Optional[str] = None, display_name: Optional[str] = None, id: Optional[str] = None, membership_type: Optional[str] = None)

Response for Create a channel

Attributes

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Optional textual description for the channel

display_name class-attribute instance-attribute

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

Channel name as it appears in Microsoft Teams

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The channel's unique identifier

membership_type class-attribute instance-attribute

membership_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'membershipType'})

The type of channel membership

GetChannelResponse dataclass

GetChannelResponse(*, id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, email: Optional[str] = None, tenant_id: Optional[str] = None, web_url: Optional[str] = None, files_folder_web_url: Optional[str] = None, created_date_time: Optional[str] = None, membership_type: Optional[str] = None)

Response for Get details for a specific channel in a team

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the channel

display_name class-attribute instance-attribute

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

The name of the channel

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the channel, optional

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

The email address for sending messages to the channel

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})

The ID of the Microsoft Entra tenant.

web_url class-attribute instance-attribute

web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webUrl'})

A hyperlink for the channel in Microsoft Teams

files_folder_web_url class-attribute instance-attribute

files_folder_web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'filesFolderWebUrl'})

The SharePoint folder URL of the channel

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

Timestamp at which the channel was created. Read only

membership_type class-attribute instance-attribute

membership_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'membershipType'})

The channel membership type

UpdateChannelPropertiesInput dataclass

UpdateChannelPropertiesInput(*, display_name: Optional[str] = None, description: Optional[str] = None)

Update channel

Attributes

display_name class-attribute instance-attribute

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

The new display name for the channel.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The new description for the channel.

ArchiveChannelInput dataclass

ArchiveChannelInput(*, should_set_spo_site_read_only_for_members: Optional[bool] = None)

Archive a channel

Attributes

should_set_spo_site_read_only_for_members class-attribute instance-attribute

should_set_spo_site_read_only_for_members: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'shouldSetSpoSiteReadOnlyForMembers'})

If true, sets permissions for channel members to read-only on the SharePoint Online site associated with the team.

AsyncOperationResponse dataclass

AsyncOperationResponse(*, status: Optional[str] = None)

Response for Archive a channel

Attributes

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status of the asynchronous operation

GetAllChannelsForTeamResponse dataclass

GetAllChannelsForTeamResponse(*, context: Optional[str] = None, value: Optional[List[ChannelWithOwnerTeamId | Mapping[str, Any]]] = None)

Response for List all channels

Attributes

value class-attribute instance-attribute

value: Optional[List[ChannelWithOwnerTeamId | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of one or more channels for a specific team

GetChatsResponse dataclass

GetChatsResponse(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List chats

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of one or more chats you are a part of

AtMentionTagResponse dataclass

AtMentionTagResponse(*, at_mention: Optional[str] = None)

Response for Get an @mention token for a team tag

Attributes

at_mention class-attribute instance-attribute

at_mention: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'atMention'})

A token for the tag to @mention. It can be inserted into messages and adaptive cards sent from a person

GetMessagesFromConversationResponse dataclass

GetMessagesFromConversationResponse(*, context: Optional[str] = None, count: Optional[int] = None, next_link: Optional[str] = None, value: Optional[ChatMessageList] = None)

Response for Get messages in a channel

Attributes

context class-attribute instance-attribute

context: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.context'})

@odata.context

count class-attribute instance-attribute

count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.count'})

@odata.count

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

@odata.nextLink

DynamicGetMessageDetailsResponseSchema dataclass

DynamicGetMessageDetailsResponseSchema(*, additional_properties: Dict[str, Any] = dict())

Response for Get message details

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListRepliesResponseSchema dataclass

ListRepliesResponseSchema(*, value: Optional[List[Dict[str, Any]]] = None)

Response for List replies of a channel message

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List replies response

ListMembersResponseSchema dataclass

ListMembersResponseSchema(*, value: Optional[List[Dict[str, Any]]] = None)

Response for List chat or channel members

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List members response

WebhookChatMessageTriggerInput dataclass

WebhookChatMessageTriggerInput(*, notification_url: Optional[str] = None)

When a new chat message is added

GetTeamResponse dataclass

GetTeamResponse(*, id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, internal_id: Optional[str] = None, web_url: Optional[str] = None, is_archived: Optional[bool] = None, member_settings: Optional[MemberSettings | Mapping[str, Any]] = None, guest_settings: Optional[GuestSettings | Mapping[str, Any]] = None, messaging_settings: Optional[MessagingSettings | Mapping[str, Any]] = None, fun_settings: Optional[FunSettings | Mapping[str, Any]] = None, discovery_settings: Optional[DiscoverySettings | Mapping[str, Any]] = None)

Response for Get a team

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the team

display_name class-attribute instance-attribute

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

The name of the team

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the team, optional

internal_id class-attribute instance-attribute

internal_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'internalId'})

The internal ID of the team

web_url class-attribute instance-attribute

web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webUrl'})

A hyperlink that will go to the team in the Microsoft Teams client

is_archived class-attribute instance-attribute

is_archived: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isArchived'})

Whether this team is in read-only mode

AtMentionUser dataclass

AtMentionUser(*, at_mention: Optional[str] = None)

Response for Get an @mention token for a user

Attributes

at_mention class-attribute instance-attribute

at_mention: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'atMention'})

An @mention token for the user. This property can be inserted into messages

NewChatResponse dataclass

NewChatResponse(*, id: Optional[str] = None)

Response for Create a chat

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The chat's unique identifier

ChatMessage dataclass

ChatMessage(*, attachments: Optional[List[Dict[str, Any]]] = None, body: Optional[Dict[str, Any]] = None, created_date_time: Optional[str] = None, deleted: Optional[bool] = None, etag: Optional[str] = None, from_: Optional[Dict[str, Any]] = None, id: Optional[str] = None, importance: Optional[str] = None, last_modified_date_time: Optional[str] = None, locale: Optional[str] = None, mentions: Optional[List[Dict[str, Any]]] = None, message_type: Optional[str] = None, reactions: Optional[List[Dict[str, Any]]] = None, reply_to_id: Optional[str] = None, subject: Optional[str] = None, summary: Optional[str] = None)

Response for Post a message to myself

Attributes

attachments class-attribute instance-attribute

attachments: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

attachments

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Plaintext representation of the content of the message

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

Timestamp of when the chat message was created

deleted class-attribute instance-attribute

deleted: Optional[bool] = dataclass_field(default=None, kw_only=True)

deleted

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True)

Version number of the chat message.

from_ class-attribute instance-attribute

from_: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'from'})

The message sender

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique ID of the message

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True)

The importance of the message. The possible values are: normal, high, urgent.

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed

locale class-attribute instance-attribute

locale: Optional[str] = dataclass_field(default=None, kw_only=True)

Locale of the chat message set by the client.

mentions class-attribute instance-attribute

mentions: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.

message_type class-attribute instance-attribute

message_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'messageType'})

The type of chat message

reactions class-attribute instance-attribute

reactions: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

Reactions for this chat message (for example, Like)

reply_to_id class-attribute instance-attribute

reply_to_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replyToId'})

ID of the parent message of the thread

subject class-attribute instance-attribute

subject: Optional[str] = dataclass_field(default=None, kw_only=True)

The subject of the chat message, optional

summary class-attribute instance-attribute

summary: Optional[str] = dataclass_field(default=None, kw_only=True)

Summary text of the message that could be used for push notifications and summary views or fall back views

CreateATeamInput dataclass

CreateATeamInput(display_name: str, description: str, *, visibility: Optional[str] = None)

Create a team

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

The name of the team

description instance-attribute

description: str

An optional description for the team

visibility class-attribute instance-attribute

visibility: Optional[str] = dataclass_field(default=None, kw_only=True)

The visibility of the the team

CreateATeamResponse dataclass

CreateATeamResponse(*, new_team_id: Optional[str] = None)

Response for Create a team

Attributes

new_team_id class-attribute instance-attribute

new_team_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newTeamId'})

Team ID of the team that was just created

AddMemberToTeamInput dataclass

AddMemberToTeamInput(user_id: str, *, owner: Optional[bool] = None)

Add a member to a team

Attributes

user_id class-attribute instance-attribute

user_id: str = dataclass_field(metadata={'wire_name': 'userId'})

User principal name or Microsoft Entra ID to add

owner class-attribute instance-attribute

owner: Optional[bool] = dataclass_field(default=None, kw_only=True)

True, if the user should be a team owner

AddMemberToChannelInput dataclass

AddMemberToChannelInput(user_id: str, *, owner: Optional[bool] = None)

Add a member to a channel

Attributes

user_id class-attribute instance-attribute

user_id: str = dataclass_field(metadata={'wire_name': 'userId'})

User principal name or Microsoft Entra ID to add

owner class-attribute instance-attribute

owner: Optional[bool] = dataclass_field(default=None, kw_only=True)

True, if the user should be a channel owner

PostToConversationResponse dataclass

PostToConversationResponse(*, id: Optional[str] = None, message_link: Optional[str] = None, conversation_id: Optional[str] = None)

Response for Post message in a chat or channel

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique message ID

message_link class-attribute instance-attribute

message_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'messageLink'})

Link to the message in Microsoft Teams

conversation_id class-attribute instance-attribute

conversation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'conversationId'})

The chat's unique identifier

PostCardAndWaitForResponseInput dataclass

PostCardAndWaitForResponseInput(notification_url: str, body: Dict[str, Any])

Post adaptive card and wait for a response

DynamicPostGatherInputToConversationResponse dataclass

DynamicPostGatherInputToConversationResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Post adaptive card and wait for a response

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ObjectWithoutType dataclass

ObjectWithoutType(*, additional_properties: Dict[str, Any] = dict())

Response for Send a Microsoft Graph HTTP request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

AddMemberToChatInput dataclass

AddMemberToChatInput(user_id: str, *, owner: Optional[bool] = None, visible_history_start_date_time: Optional[str] = None)

Add a user to a chat

Attributes

user_id class-attribute instance-attribute

user_id: str = dataclass_field(metadata={'wire_name': 'userId'})

User principal name or Microsoft Entra ID to add

owner class-attribute instance-attribute

owner: Optional[bool] = dataclass_field(default=None, kw_only=True)

True, if the user should be a chat owner

visible_history_start_date_time class-attribute instance-attribute

visible_history_start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'visibleHistoryStartDateTime'})

Timestamp that represents how far back in the chat history the new member can see. If not specified, no history is shared.

GetOnlineMeetingResponse dataclass

GetOnlineMeetingResponse(*, id: Optional[str] = None, subject: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, creation_date_time: Optional[str] = None, join_web_url: Optional[str] = None, join_meeting_id_settings: Optional[Dict[str, Any]] = None, participants: Optional[Dict[str, Any]] = None, audio_conferencing: Optional[Dict[str, Any]] = None, is_entry_exit_announced: Optional[bool] = None, allowed_presenters: Optional[str] = None, lobby_bypass_settings: Optional[Dict[str, Any]] = None, record_automatically: Optional[bool] = None, allow_meeting_chat: Optional[str] = None, meeting_options_web_url: Optional[str] = None)

Response for Get an online meeting

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the online meeting

subject class-attribute instance-attribute

subject: Optional[str] = dataclass_field(default=None, kw_only=True)

The subject of the online meeting

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})

The start time of the meeting in UTC

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

The end time of the meeting in UTC

creation_date_time class-attribute instance-attribute

creation_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'creationDateTime'})

The creation time of the meeting in UTC

join_web_url class-attribute instance-attribute

join_web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'joinWebUrl'})

The URL used to join the meeting online

join_meeting_id_settings class-attribute instance-attribute

join_meeting_id_settings: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'joinMeetingIdSettings'})

Settings related to the join meeting ID

participants class-attribute instance-attribute

participants: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The participants of the meeting

audio_conferencing class-attribute instance-attribute

audio_conferencing: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'audioConferencing'})

Phone call-in information for the meeting

is_entry_exit_announced class-attribute instance-attribute

is_entry_exit_announced: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEntryExitAnnounced'})

Whether announce notifications are enabled for callers joining or leaving the meeting

allowed_presenters class-attribute instance-attribute

allowed_presenters: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowedPresenters'})

Specifies who can be a presenter in the meeting

lobby_bypass_settings class-attribute instance-attribute

lobby_bypass_settings: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lobbyBypassSettings'})

Specifies which participants can bypass the meeting lobby

record_automatically class-attribute instance-attribute

record_automatically: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recordAutomatically'})

Indicates whether to record the meeting automatically

allow_meeting_chat class-attribute instance-attribute

allow_meeting_chat: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowMeetingChat'})

Specifies the mode of meeting chat

meeting_options_web_url class-attribute instance-attribute

meeting_options_web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingOptionsWebUrl'})

A URL for the organizer to change settings for the meeting

CallTranscriptCollectionResponse dataclass

CallTranscriptCollectionResponse(*, context: Optional[str] = None, value: Optional[List[CallTranscriptResponse | Mapping[str, Any]]] = None)

Response for List meeting transcripts

Attributes

value class-attribute instance-attribute

value: Optional[List[CallTranscriptResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of transcripts

CallTranscriptResponse dataclass

CallTranscriptResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, transcript_content_url: Optional[str] = None, meeting_id: Optional[str] = None, meeting_organizer_id: Optional[str] = None, call_id: Optional[str] = None)

Response for Get meeting transcript

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The transcript ID

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

The date and time when the transcript was created

transcript_content_url class-attribute instance-attribute

transcript_content_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'transcriptContentUrl'})

The URL to access the transcript content

meeting_id class-attribute instance-attribute

meeting_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingId'})

The meeting ID

meeting_organizer_id class-attribute instance-attribute

meeting_organizer_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingOrganizerId'})

The meeting organizer's user ID

call_id class-attribute instance-attribute

call_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callId'})

The call ID

CallRecordingCollectionResponse dataclass

CallRecordingCollectionResponse(*, context: Optional[str] = None, value: Optional[List[CallRecordingResponse | Mapping[str, Any]]] = None)

Response for List meeting recordings

Attributes

value class-attribute instance-attribute

value: Optional[List[CallRecordingResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of recordings

CallRecordingResponse dataclass

CallRecordingResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, recording_content_url: Optional[str] = None, meeting_id: Optional[str] = None, meeting_organizer_id: Optional[str] = None, call_id: Optional[str] = None)

Response for Get meeting recording

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The recording ID

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

The date and time when the recording was created

recording_content_url class-attribute instance-attribute

recording_content_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recordingContentUrl'})

The URL to access the recording content

meeting_id class-attribute instance-attribute

meeting_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingId'})

The meeting ID

meeting_organizer_id class-attribute instance-attribute

meeting_organizer_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingOrganizerId'})

The meeting organizer's user ID

call_id class-attribute instance-attribute

call_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callId'})

The call ID

ListSectionsResponse dataclass

ListSectionsResponse(*, context: Optional[str] = None, microsoft_graph_sections_version: Optional[str] = None, value: Optional[List[SectionResponse | Mapping[str, Any]]] = None)

Response for List sections

Attributes

microsoft_graph_sections_version class-attribute instance-attribute

microsoft_graph_sections_version: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@microsoft.graph.sectionsVersion'})

Version identifier for the sections hierarchy. Pass as If-Match on Create, Update, Delete, Add Item, Remove Item, and Move Item operations.

value class-attribute instance-attribute

value: Optional[List[SectionResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of sections

CreateSectionInput dataclass

CreateSectionInput(display_name: str, *, display_icon: Optional[Dict[str, Any]] = None, is_expanded: Optional[bool] = None, sort_type: Optional[str] = None)

Create a section

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

The display name of the section

display_icon class-attribute instance-attribute

display_icon: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayIcon'})

The display icon for the section. Only iconType is writable; other fields are populated by the service.

is_expanded class-attribute instance-attribute

is_expanded: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isExpanded'})

Whether the section is expanded

sort_type class-attribute instance-attribute

sort_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sortType'})

The sort type for the section

SectionResponse dataclass

SectionResponse(*, etag: Optional[str] = None, id: Optional[str] = None, display_name: Optional[str] = None, display_icon: Optional[Dict[str, Any]] = None, is_expanded: Optional[bool] = None, sort_type: Optional[str] = None, section_type: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None)

Response for Create a section

Attributes

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.etag'})

ETag for the sections collection. Pass as If-Match on Create, Update, and Delete.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The section ID

display_name class-attribute instance-attribute

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

The display name of the section

display_icon class-attribute instance-attribute

display_icon: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayIcon'})

The display icon for the section

is_expanded class-attribute instance-attribute

is_expanded: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isExpanded'})

Whether the section is expanded

sort_type class-attribute instance-attribute

sort_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sortType'})

The sort type for the section

section_type class-attribute instance-attribute

section_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sectionType'})

The type of section

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

The date and time when the section was created

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

The date and time when the section was last modified

UpdateSectionInput dataclass

UpdateSectionInput(*, display_name: Optional[str] = None, display_icon: Optional[Dict[str, Any]] = None, is_expanded: Optional[bool] = None, sort_type: Optional[str] = None)

Update a section

Attributes

display_name class-attribute instance-attribute

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

The display name of the section

display_icon class-attribute instance-attribute

display_icon: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayIcon'})

The display icon for the section. Only iconType is writable; other fields are populated by the service.

is_expanded class-attribute instance-attribute

is_expanded: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isExpanded'})

Whether the section is expanded

sort_type class-attribute instance-attribute

sort_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sortType'})

The sort type for the section

ListSectionItemsResponse dataclass

ListSectionItemsResponse(*, context: Optional[str] = None, value: Optional[List[SectionItemResponse | Mapping[str, Any]]] = None)

Response for List section items

Attributes

value class-attribute instance-attribute

value: Optional[List[SectionItemResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of section items

AddSectionItemInput dataclass

AddSectionItemInput(id: str)

Add an item to a section

Attributes

id instance-attribute

id: str

The conversation ID of the chat, channel, meeting, or community to add to the section. For community items, the service automatically normalizes the ID to the 19:{id}@EngageCommunity format.

SectionItemResponse dataclass

SectionItemResponse(*, etag: Optional[str] = None, id: Optional[str] = None, item_type: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None)

Response for Add an item to a section

Attributes

etag class-attribute instance-attribute

etag: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.etag'})

ETag for the section items collection. Pass as If-Match on Add, Remove, and Move.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the item. Corresponds to the conversation ID of the underlying chat, channel, meeting, or community.

item_type class-attribute instance-attribute

item_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'itemType'})

The type of the item

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

The date and time when the item was added to the section

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

The date and time when the item was last modified

MoveSectionItemInput dataclass

MoveSectionItemInput(target_section_id: str)

Move a section item

Attributes

target_section_id class-attribute instance-attribute

target_section_id: str = dataclass_field(metadata={'wire_name': 'targetSectionId'})

The ID of the section to move the item to

GetTagsResponseSchema dataclass

GetTagsResponseSchema(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List all tags for a team

CreateTagInput dataclass

CreateTagInput(display_name: str, members: str)

Create a tag for a team

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

The name of the tag as it appears to the user in Microsoft Teams.

members instance-attribute

members: str

List of users' IDs separated by semi-colons, identifier must be in a format like '550e8400-e29b-41d4-a716-446655440000'.

CreateTagResponseSchema dataclass

CreateTagResponseSchema(*, type_: Optional[str] = None, id: Optional[str] = None, team_id: Optional[str] = None, display_name: Optional[str] = None, member_count: Optional[int] = None)

Response for Create a tag for a team

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique identifier of the tag

team_id class-attribute instance-attribute

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

ID of the team in which the tag is defined

display_name class-attribute instance-attribute

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

The name of the tag as it appears to the user in Microsoft Teams.

member_count class-attribute instance-attribute

member_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'memberCount'})

The number of users assigned to the tag

UpdateTagInput dataclass

UpdateTagInput(display_name: str)

Update a team tag

Attributes

display_name class-attribute instance-attribute

display_name: str = dataclass_field(metadata={'wire_name': 'displayName'})

The new name of the tag as it appears to the user in Microsoft Teams.

AddMemberToTagInput dataclass

AddMemberToTagInput(user_id: str)

Add a member to a team tag

Attributes

user_id class-attribute instance-attribute

user_id: str = dataclass_field(metadata={'wire_name': 'userId'})

The user's ID of the member to add to the tag, must be in a format like '550e8400-e29b-41d4-a716-446655440000'.

AddMemberToTagResponseSchema dataclass

AddMemberToTagResponseSchema(*, user_id: Optional[str] = None)

Response for Add a member to a team tag

Attributes

user_id class-attribute instance-attribute

user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userId'})

User ID of the member added to the tag

GetTagMembersResponseSchema dataclass

GetTagMembersResponseSchema(*, value: Optional[List[Dict[str, Any]]] = None)

Response for List the members of a team tag

AiInsightCollectionResponse dataclass

AiInsightCollectionResponse(*, context: Optional[str] = None, value: Optional[List[AiInsightResponse | Mapping[str, Any]]] = None)

Response for List AI insights

Attributes

value class-attribute instance-attribute

value: Optional[List[AiInsightResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of AI insights

AiInsightDetailResponse dataclass

AiInsightDetailResponse(*, context: Optional[str] = None, id: Optional[str] = None, call_id: Optional[str] = None, content_correlation_id: Optional[str] = None, created_date_time: Optional[str] = None, end_date_time: Optional[str] = None, recap_url: Optional[str] = None, meeting_notes: Optional[List[AiInsightMeetingNote | Mapping[str, Any]]] = None, action_items: Optional[List[AiInsightActionItem | Mapping[str, Any]]] = None, viewpoint: Optional[AiInsightViewpoint | Mapping[str, Any]] = None)

Response for Get AI insight

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The AI insight ID

call_id class-attribute instance-attribute

call_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callId'})

The call ID

content_correlation_id class-attribute instance-attribute

content_correlation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentCorrelationId'})

The content correlation ID

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

The date and time when the AI insight was created

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

The date and time when the AI insight ended

recap_url class-attribute instance-attribute

recap_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recapUrl'})

Deep link that opens the meeting recap for this AI insight, surfaced from the underlying callAiInsight resource returned by the fetch. Present when the underlying resource provides it; otherwise absent.

meeting_notes class-attribute instance-attribute

meeting_notes: Optional[List[AiInsightMeetingNote | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingNotes'})

Detailed notes of the meeting discussion generated by Microsoft Teams Copilot.

action_items class-attribute instance-attribute

action_items: Optional[List[AiInsightActionItem | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'actionItems'})

Action items generated from the meeting conversation.

GetMessageLocationsResponse dataclass

GetMessageLocationsResponse(*, locations: Optional[List[Dict[str, Any]]] = None)

Response for Conversation location for where to post

Attributes

locations class-attribute instance-attribute

locations: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

valid locations to post a message or reply, make verbose

GetMessageDetailsSchema dataclass

GetMessageDetailsSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get message details response schema

ListMembersSchema dataclass

ListMembersSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for List members input schema

PostFeedSchema dataclass

PostFeedSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get feed notification input metadata

UnifiedActionSchema dataclass

UnifiedActionSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get unified action input metadata

ConnectorMetadata dataclass

ConnectorMetadata(*, metadatatype: Optional[str] = None, activitytype: Optional[str] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get message with options subscription input metadata

WebhookTriggerSchema dataclass

WebhookTriggerSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Input schema for webhook trigger

DynamicResponseSchema dataclass

DynamicResponseSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Response for Get response schema

ObjectEntity dataclass

ObjectEntity(*, additional_properties: Dict[str, Any] = dict())

Response for Get subscription scope input schema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

PostMessageSchema dataclass

PostMessageSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: PostMessageSchema

PostCardSchema dataclass

PostCardSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: PostCardSchema

PostCardAndWaitSchema dataclass

PostCardAndWaitSchema(*, schema: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: PostCardAndWaitSchema

DynamicGetMessageDetailsSchema dataclass

DynamicGetMessageDetailsSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicGetMessageDetailsSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicListMembersSchema dataclass

DynamicListMembersSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicListMembersSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicUserNotificationRequest dataclass

DynamicUserNotificationRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicUserNotificationRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicPostConversationNotificationRequest dataclass

DynamicPostConversationNotificationRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicPostConversationNotificationRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicChannelNotificationRequest dataclass

DynamicChannelNotificationRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicChannelNotificationRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicPostFeedNotificationRequest dataclass

DynamicPostFeedNotificationRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicPostFeedNotificationRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicPostMessageRequest dataclass

DynamicPostMessageRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicPostMessageRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicReplyMessageRequest dataclass

DynamicReplyMessageRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicReplyMessageRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicPostCardRequest dataclass

DynamicPostCardRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicPostCardRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicPostCardAndWaitRequest dataclass

DynamicPostCardAndWaitRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicPostCardAndWaitRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicReplyCardRequest dataclass

DynamicReplyCardRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicReplyCardRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicUpdateCardRequest dataclass

DynamicUpdateCardRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicUpdateCardRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicUserAdaptiveCardRequest dataclass

DynamicUserAdaptiveCardRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicUserAdaptiveCardRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicChannelAdaptiveCardRequest dataclass

DynamicChannelAdaptiveCardRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicChannelAdaptiveCardRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicUserMessageWithOptionsSubscriptionRequest dataclass

DynamicUserMessageWithOptionsSubscriptionRequest(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicUserMessageWithOptionsSubscriptionRequest

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicUserMessageWithOptionsSubscriptionResult dataclass

DynamicUserMessageWithOptionsSubscriptionResult(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicUserMessageWithOptionsSubscriptionResult

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicSelectedMessageTriggerResult dataclass

DynamicSelectedMessageTriggerResult(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicSelectedMessageTriggerResult

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicComposeMessageTriggerResult dataclass

DynamicComposeMessageTriggerResult(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicComposeMessageTriggerResult

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicCardResponseTriggerResult dataclass

DynamicCardResponseTriggerResult(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicCardResponseTriggerResult

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MessageReactionWebhookResponseSchema dataclass

MessageReactionWebhookResponseSchema(*, thread_type: Optional[str] = None, chat_id: Optional[str] = None, team_id: Optional[str] = None, channel_id: Optional[str] = None, message_id: Optional[str] = None, reply_to_id: Optional[str] = None, message_link: Optional[str] = None, user_id: Optional[str] = None, message_reaction: Optional[str] = None)

Definition: MessageReactionWebhookResponseSchema

Attributes

chat_id class-attribute instance-attribute

chat_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'chatId'})

The chat's unique identifier

team_id class-attribute instance-attribute

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

The team's unique identifier

channel_id class-attribute instance-attribute

channel_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'channelId'})

The channel's unique identifier

message_id class-attribute instance-attribute

message_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'messageId'})

Id of the message which was reacted

reply_to_id class-attribute instance-attribute

reply_to_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replyToId'})

ID of the parent message of the thread

message_link class-attribute instance-attribute

message_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'messageLink'})

Link to the message which was reacted

user_id class-attribute instance-attribute

user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userId'})

Reacting user's Id

message_reaction class-attribute instance-attribute

message_reaction: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'messageReaction'})

Message reaction used

TeamsIdentitySet dataclass

TeamsIdentitySet(*, application: Optional[Dict[str, Any]] = None, device: Optional[Dict[str, Any]] = None, user: Optional[Dict[str, Any]] = None)

Definition: TeamsIdentitySet

Attributes

application class-attribute instance-attribute

application: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Application identity (bot or service)

device class-attribute instance-attribute

device: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Device identity

user class-attribute instance-attribute

user: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

User identity

CallEventWebhookResponseSchema dataclass

CallEventWebhookResponseSchema(*, id: Optional[str] = None, id_2: Optional[str] = None, type_: Optional[str] = None, call_event_type: Optional[str] = None, event_date_time: Optional[str] = None, call_conversation_id: Optional[str] = None, join_web_url: Optional[str] = None, chat_info: Optional[Dict[str, Any]] = None, organizer_meeting_info: Optional[Dict[str, Any]] = None, transcription_state: Optional[Dict[str, Any]] = None, recording_state: Optional[Dict[str, Any]] = None, participants: Optional[List[Dict[str, Any]]] = None)

Definition: CallEventWebhookResponseSchema

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Event identifier

id_2 class-attribute instance-attribute

id_2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.id'})

OData identifier

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.type'})

OData type discriminator (always #microsoft.graph.callEvent; meeting-specific fields are flattened onto the base type by notification delivery).

call_event_type class-attribute instance-attribute

call_event_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callEventType'})

Type of call event

event_date_time class-attribute instance-attribute

event_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'eventDateTime'})

When the event occurred

call_conversation_id class-attribute instance-attribute

call_conversation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callConversationId'})

Call conversation identifier

join_web_url class-attribute instance-attribute

join_web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'joinWebUrl'})

Meeting join URL (populated when the call is associated with an online meeting)

chat_info class-attribute instance-attribute

chat_info: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'chatInfo'})

Chat information for the meeting (populated when the call is associated with an online meeting)

organizer_meeting_info class-attribute instance-attribute

organizer_meeting_info: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'organizerMeetingInfo'})

Organizer info (populated when the call is associated with an online meeting)

transcription_state class-attribute instance-attribute

transcription_state: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'transcriptionState'})

Transcription state (set on transcriptionStateUpdated events)

recording_state class-attribute instance-attribute

recording_state: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recordingState'})

Recording state (set on recordingStateUpdated events)

participants class-attribute instance-attribute

participants: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

Participants (set on rosterUpdated events)

TranscriptWebhookResponseSchema dataclass

TranscriptWebhookResponseSchema(*, id: Optional[str] = None, id_2: Optional[str] = None, meeting_id: Optional[str] = None, call_id: Optional[str] = None, content_correlation_id: Optional[str] = None, meeting_organizer: Optional[TeamsIdentitySet | Mapping[str, Any]] = None, transcript_content_url: Optional[str] = None, created_date_time: Optional[str] = None, end_date_time: Optional[str] = None)

Definition: TranscriptWebhookResponseSchema

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Transcript identifier

id_2 class-attribute instance-attribute

id_2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.id'})

OData identifier

meeting_id class-attribute instance-attribute

meeting_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingId'})

Online meeting identifier (empty for ad-hoc call transcripts)

call_id class-attribute instance-attribute

call_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callId'})

Call identifier (set for ad-hoc call transcripts)

content_correlation_id class-attribute instance-attribute

content_correlation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentCorrelationId'})

Content correlation identifier

transcript_content_url class-attribute instance-attribute

transcript_content_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'transcriptContentUrl'})

URL to download the transcript content

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

When the transcript was created (UTC)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

When the transcript ended (UTC)

AiInsightWebhookResponseSchema dataclass

AiInsightWebhookResponseSchema(*, id: Optional[str] = None, id_2: Optional[str] = None, meeting_id: Optional[str] = None, call_id: Optional[str] = None)

Definition: AiInsightWebhookResponseSchema

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

AI insight identifier

id_2 class-attribute instance-attribute

id_2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.id'})

OData identifier

meeting_id class-attribute instance-attribute

meeting_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingId'})

Online meeting identifier (empty for ad-hoc call AI insights)

call_id class-attribute instance-attribute

call_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callId'})

Call identifier (set for ad-hoc call AI insights)

RecordingWebhookResponseSchema dataclass

RecordingWebhookResponseSchema(*, id: Optional[str] = None, id_2: Optional[str] = None, meeting_id: Optional[str] = None, call_id: Optional[str] = None, content_correlation_id: Optional[str] = None, meeting_organizer: Optional[TeamsIdentitySet | Mapping[str, Any]] = None, recording_content_url: Optional[str] = None, created_date_time: Optional[str] = None, end_date_time: Optional[str] = None)

Definition: RecordingWebhookResponseSchema

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Recording identifier

id_2 class-attribute instance-attribute

id_2: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.id'})

OData identifier

meeting_id class-attribute instance-attribute

meeting_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'meetingId'})

Online meeting identifier (empty for ad-hoc call recordings)

call_id class-attribute instance-attribute

call_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callId'})

Call identifier (set for ad-hoc call recordings)

content_correlation_id class-attribute instance-attribute

content_correlation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentCorrelationId'})

Content correlation identifier

recording_content_url class-attribute instance-attribute

recording_content_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recordingContentUrl'})

URL to download the recording content

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

When the recording was created (UTC)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

When the recording ended (UTC)

ChatMessageWebhookResponseSchema dataclass

ChatMessageWebhookResponseSchema(*, value: Optional[List[Dict[str, Any]]] = None)

Definition: ChatMessageWebhookResponseSchema

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

Message details response

DynamicWebhookTriggerRequestSchema dataclass

DynamicWebhookTriggerRequestSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicWebhookTriggerRequestSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicKeywordWebhookTriggerResponseSchema dataclass

DynamicKeywordWebhookTriggerResponseSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicKeywordWebhookTriggerResponseSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicAtMentionWebhookTriggerResponseSchema dataclass

DynamicAtMentionWebhookTriggerResponseSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicAtMentionWebhookTriggerResponseSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicNewMessageWebhookTriggerResponseSchema dataclass

DynamicNewMessageWebhookTriggerResponseSchema(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicNewMessageWebhookTriggerResponseSchema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicPostToConversationResponse dataclass

DynamicPostToConversationResponse(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicPostToConversationResponse

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MessageId dataclass

MessageId(*, id: Optional[str] = None)

Definition: MessageId

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique message identifier

DynamicUserFlowContinuationSubscriptionResult dataclass

DynamicUserFlowContinuationSubscriptionResult(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicUserFlowContinuationSubscriptionResult

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicChannelFlowContinuationSubscriptionResult dataclass

DynamicChannelFlowContinuationSubscriptionResult(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicChannelFlowContinuationSubscriptionResult

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DynamicGatherInputSubscriptionResult dataclass

DynamicGatherInputSubscriptionResult(*, additional_properties: Dict[str, Any] = dict())

Definition: DynamicGatherInputSubscriptionResult

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

AssociatedTeamInfo dataclass

AssociatedTeamInfo(*, id: Optional[str] = None, display_name: Optional[str] = None, tenant_id: Optional[str] = None)

Definition: AssociatedTeamInfo

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the team

display_name class-attribute instance-attribute

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

The name of the team

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})

The ID of the Microsoft Entra tenant this team belongs to

ChannelWithOwnerTeamId dataclass

ChannelWithOwnerTeamId(*, id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, email: Optional[str] = None, tenant_id: Optional[str] = None, web_url: Optional[str] = None, files_folder_web_url: Optional[str] = None, created_date_time: Optional[str] = None, membership_type: Optional[str] = None, owner_team_id: Optional[str] = None)

Definition: ChannelWithOwnerTeamId

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique identifier of the channel

display_name class-attribute instance-attribute

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

The name of the channel

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

The description of the channel, optional

email class-attribute instance-attribute

email: Optional[str] = dataclass_field(default=None, kw_only=True)

The email address for sending messages to the channel

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})

The ID of the Microsoft Entra tenant.

web_url class-attribute instance-attribute

web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webUrl'})

A hyperlink for the channel in Microsoft Teams

files_folder_web_url class-attribute instance-attribute

files_folder_web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'filesFolderWebUrl'})

The SharePoint folder URL of the channel

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

Timestamp at which the channel was created. Read only

membership_type class-attribute instance-attribute

membership_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'membershipType'})

The channel membership type

owner_team_id class-attribute instance-attribute

owner_team_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ownerTeamId'})

The ID of the team that owns the channel

WebhookRequest dataclass

WebhookRequest(notification_url: str)

Definition: WebhookRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

Specify a well-formed URL of the endpoint that will receive notifications

GetTimeOffReasonsResponse dataclass

GetTimeOffReasonsResponse(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Definition: GetTimeOffReasonsResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of time off reasons.

TimeOffRequestResponse dataclass

TimeOffRequestResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, time_off_reason_id: Optional[str] = None)

Definition: TimeOffRequestResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the TimeOff request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})

Start of time requested off

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

End of time requested off

time_off_reason_id class-attribute instance-attribute

time_off_reason_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeOffReasonId'})

The ID of the TimeOff Reason

OfferShiftRequestResponse dataclass

OfferShiftRequestResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, sender_shift_id: Optional[str] = None, recipient_action_date_time: Optional[str] = None, recipient_action_message: Optional[str] = None, recipient_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None)

Definition: OfferShiftRequestResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the Offer Shift request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

sender_shift_id class-attribute instance-attribute

sender_shift_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderShiftId'})

The ID of the shift from the sender

recipient_action_date_time class-attribute instance-attribute

recipient_action_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientActionDateTime'})

Time when the recipient responded

recipient_action_message class-attribute instance-attribute

recipient_action_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientActionMessage'})

The message from the recipient

recipient_user_id class-attribute instance-attribute

recipient_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientUserId'})

The ID of the recipient of the request

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

SwapShiftsChangeRequestResponse dataclass

SwapShiftsChangeRequestResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, sender_shift_id: Optional[str] = None, recipient_action_date_time: Optional[str] = None, recipient_action_message: Optional[str] = None, recipient_user_id: Optional[str] = None, recipient_shift_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None)

Definition: SwapShiftsChangeRequestResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the Swap Shift request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

sender_shift_id class-attribute instance-attribute

sender_shift_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderShiftId'})

The ID of the shift from the sender

recipient_action_date_time class-attribute instance-attribute

recipient_action_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientActionDateTime'})

Time when the recipient responded

recipient_action_message class-attribute instance-attribute

recipient_action_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientActionMessage'})

The message from the recipient

recipient_user_id class-attribute instance-attribute

recipient_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientUserId'})

The ID of the recipient of the request

recipient_shift_id class-attribute instance-attribute

recipient_shift_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientShiftId'})

The ID of the shift from the recipient

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

OpenShiftChangeRequestResponse dataclass

OpenShiftChangeRequestResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None, open_shift_id: Optional[str] = None)

Definition: OpenShiftChangeRequestResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the Open Shift Change request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

open_shift_id class-attribute instance-attribute

open_shift_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'openShiftId'})

The ID of the open shift being requested

EditOpenShiftRequest dataclass

EditOpenShiftRequest(*, scheduling_group_id: Optional[str] = None, shared_open_shift: Optional[Dict[str, Any]] = None)

Definition: EditOpenShiftRequest

Attributes

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'schedulingGroupId'})

Scheduling Group ID

OpenShiftResponse dataclass

OpenShiftResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, scheduling_group_id: Optional[str] = None, last_modified_by: Optional[LastModifiedBy | Mapping[str, Any]] = None, shared_open_shift: Optional[SharedOpenShift | Mapping[str, Any]] = None, draft_open_shift: Optional[DraftOpenShift | Mapping[str, Any]] = None)

Definition: OpenShiftResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the open shift.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'schedulingGroupId'})

Scheduling Group ID

SharedOpenShift dataclass

SharedOpenShift(*, display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, open_slot_count: Optional[int] = None, activities: Optional[Activities] = None)

Definition: SharedOpenShift

Attributes

display_name class-attribute instance-attribute

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

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme class-attribute instance-attribute

theme: Optional[str] = dataclass_field(default=None, kw_only=True)

Theme

open_slot_count class-attribute instance-attribute

open_slot_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'openSlotCount'})

Open Slot Count

DraftOpenShift dataclass

DraftOpenShift(*, display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, open_slot_count: Optional[int] = None, activities: Optional[Activities] = None)

Definition: DraftOpenShift

Attributes

display_name class-attribute instance-attribute

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

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme class-attribute instance-attribute

theme: Optional[str] = dataclass_field(default=None, kw_only=True)

Theme

open_slot_count class-attribute instance-attribute

open_slot_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'openSlotCount'})

Open Slot Count

ShiftResponse dataclass

ShiftResponse(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, user_id: Optional[str] = None, scheduling_group_id: Optional[str] = None, last_modified_by: Optional[LastModifiedBy | Mapping[str, Any]] = None, shared_shift: Optional[SharedShift | Mapping[str, Any]] = None, draft_shift: Optional[DraftShift | Mapping[str, Any]] = None)

Definition: ShiftResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the shift.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

user_id class-attribute instance-attribute

user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userId'})

Assigned To User ID

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'schedulingGroupId'})

Scheduling Group ID

SharedShift dataclass

SharedShift(*, display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, activities: Optional[Activities] = None)

Definition: SharedShift

Attributes

display_name class-attribute instance-attribute

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

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme class-attribute instance-attribute

theme: Optional[str] = dataclass_field(default=None, kw_only=True)

Theme

DraftShift dataclass

DraftShift(*, display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[str] = None, activities: Optional[Activities] = None)

Definition: DraftShift

Attributes

display_name class-attribute instance-attribute

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

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

theme class-attribute instance-attribute

theme: Optional[str] = dataclass_field(default=None, kw_only=True)

Theme

ScheduleResponse dataclass

ScheduleResponse(*, id: Optional[str] = None, time_zone: Optional[str] = None, provision_status: Optional[str] = None, provision_status_code: Optional[str] = None)

Definition: ScheduleResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the schedule.

time_zone class-attribute instance-attribute

time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeZone'})

The Time Zone of the schedule.

provision_status class-attribute instance-attribute

provision_status: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisionStatus'})

The Provision Status of the schedule.

provision_status_code class-attribute instance-attribute

provision_status_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisionStatusCode'})

The Provision Status Code of the schedule.

PostMessageToSelfRequest dataclass

PostMessageToSelfRequest(body: Dict[str, Any])

Definition: PostMessageToSelfRequest

SchedulingGroupResponse dataclass

SchedulingGroupResponse(*, id: Optional[str] = None, display_name: Optional[str] = None, is_active: Optional[bool] = None, user_ids: Optional[List[str]] = None)

Definition: SchedulingGroupResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the scheduling group.

display_name class-attribute instance-attribute

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

The display name for the scheduling group.

is_active class-attribute instance-attribute

is_active: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isActive'})

Indicates whether the scheduling group can be used when creating new entities or updating existing ones.

user_ids class-attribute instance-attribute

user_ids: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userIds'})

List of IDs of users in the scheduling group.

BotMentionRequest dataclass

BotMentionRequest(bot_id: str, app_id: str, name: str)

Definition: BotMentionRequest

Attributes

bot_id class-attribute instance-attribute

bot_id: str = dataclass_field(metadata={'wire_name': 'botId'})

The bot's unique identifier (GUID)

app_id class-attribute instance-attribute

app_id: str = dataclass_field(metadata={'wire_name': 'appId'})

The bot's app identifier (GUID)

name instance-attribute

name: str

The bot's display name

AtMentionBotResponse dataclass

AtMentionBotResponse(*, at_mention: Optional[str] = None)

Definition: AtMentionBotResponse

Attributes

at_mention class-attribute instance-attribute

at_mention: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'atMention'})

An @mention token for the bot. This property can be inserted into messages and adaptive cards

ChannelIds dataclass

ChannelIds(channel: ChannelIdForTeam)

Definition: ChannelIds

NewChat dataclass

NewChat(members: str, *, topic: Optional[str] = None)

Definition: NewChat

Attributes

topic class-attribute instance-attribute

topic: Optional[str] = dataclass_field(default=None, kw_only=True)

Title, displayed only in group chats

members instance-attribute

members: str

User's IDs, separated by semicolons

NewMeeting dataclass

NewMeeting(subject: str, body: Dict[str, Any], time_zone: str, start: Dict[str, Any], end: Dict[str, Any], is_online_meeting: bool, online_meeting_provider: str, *, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, location: Optional[Dict[str, Any]] = None, importance: Optional[str] = None, recurrence: Optional[Dict[str, Any]] = None, is_all_day: Optional[bool] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: NewMeeting

Attributes

subject instance-attribute

subject: str

The text of the event's subject line

body instance-attribute

body: Dict[str, Any]

The body of the message associated with the event

time_zone class-attribute instance-attribute

time_zone: str = dataclass_field(metadata={'wire_name': 'timeZone'})

Time zone of the event

required_attendees class-attribute instance-attribute

required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute

optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'optionalAttendees'})

Optional attendees for the event separated by semicolons

location class-attribute instance-attribute

location: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The location of the event

importance class-attribute instance-attribute

importance: Optional[str] = dataclass_field(default=None, kw_only=True)

The importance of the event: low, normal or high

recurrence class-attribute instance-attribute

recurrence: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The recurrence pattern for the meeting

is_all_day class-attribute instance-attribute

is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day

reminder_minutes_before_start class-attribute instance-attribute

reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})

The number of minutes before the event start time that the reminder alert occurs

is_reminder_on class-attribute instance-attribute

is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})

Set to true if an alert is set to remind the user of the event

show_as class-attribute instance-attribute

show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})

Status to show during the event

response_requested class-attribute instance-attribute

response_requested: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted

is_online_meeting class-attribute instance-attribute

is_online_meeting: bool = dataclass_field(metadata={'wire_name': 'isOnlineMeeting'})

Set to true, if the meeting should have an online meeting provider

online_meeting_provider class-attribute instance-attribute

online_meeting_provider: str = dataclass_field(metadata={'wire_name': 'onlineMeetingProvider'})

Represents the online meeting service provider

LastModifiedBy dataclass

LastModifiedBy(*, application: Optional[str] = None, device: Optional[str] = None, conversation: Optional[str] = None, user: Optional[Dict[str, Any]] = None)

Definition: LastModifiedBy

Attributes

application class-attribute instance-attribute

application: Optional[str] = dataclass_field(default=None, kw_only=True)

Application

device class-attribute instance-attribute

device: Optional[str] = dataclass_field(default=None, kw_only=True)

Device

conversation class-attribute instance-attribute

conversation: Optional[str] = dataclass_field(default=None, kw_only=True)

Conversation

user class-attribute instance-attribute

user: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

User

MemberSettings dataclass

MemberSettings(*, allow_create_update_channels: Optional[bool] = None, allow_delete_channels: Optional[bool] = None, allow_add_remove_apps: Optional[bool] = None, allow_create_update_remove_tabs: Optional[bool] = None, allow_create_update_remove_connectors: Optional[bool] = None)

Definition: MemberSettings

Attributes

allow_create_update_channels class-attribute instance-attribute

allow_create_update_channels: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowCreateUpdateChannels'})

If set to true, members can add and update channels

allow_delete_channels class-attribute instance-attribute

allow_delete_channels: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowDeleteChannels'})

If set to true, members can delete channels

allow_add_remove_apps class-attribute instance-attribute

allow_add_remove_apps: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowAddRemoveApps'})

If set to true, members can add and remove apps

allow_create_update_remove_tabs class-attribute instance-attribute

allow_create_update_remove_tabs: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowCreateUpdateRemoveTabs'})

If set to true, members can add, update, and remove tabs

allow_create_update_remove_connectors class-attribute instance-attribute

allow_create_update_remove_connectors: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowCreateUpdateRemoveConnectors'})

If set to true, members can add, update, and remove connectors

GuestSettings dataclass

GuestSettings(*, allow_create_update_channels: Optional[bool] = None, allow_delete_channels: Optional[bool] = None)

Definition: GuestSettings

Attributes

allow_create_update_channels class-attribute instance-attribute

allow_create_update_channels: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowCreateUpdateChannels'})

If set to true, guests can add and update channels

allow_delete_channels class-attribute instance-attribute

allow_delete_channels: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowDeleteChannels'})

If set to true, guests can delete channels

MessagingSettings dataclass

MessagingSettings(*, allow_user_edit_messages: Optional[bool] = None, allow_user_delete_messages: Optional[bool] = None, allow_owner_delete_messages: Optional[bool] = None, allow_team_mentions: Optional[bool] = None, allow_channel_mentions: Optional[bool] = None)

Definition: MessagingSettings

Attributes

allow_user_edit_messages class-attribute instance-attribute

allow_user_edit_messages: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowUserEditMessages'})

If set to true, users can edit their messages

allow_user_delete_messages class-attribute instance-attribute

allow_user_delete_messages: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowUserDeleteMessages'})

If set to true, users can delete their messages

allow_owner_delete_messages class-attribute instance-attribute

allow_owner_delete_messages: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowOwnerDeleteMessages'})

If set to true, owners can delete any message

allow_team_mentions class-attribute instance-attribute

allow_team_mentions: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowTeamMentions'})

If set to true, @team mentions are allowed

allow_channel_mentions class-attribute instance-attribute

allow_channel_mentions: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowChannelMentions'})

If set to true, @channel mentions are allowed

FunSettings dataclass

FunSettings(*, allow_giphy: Optional[bool] = None, giphy_content_rating: Optional[str] = None, allow_stickers_and_memes: Optional[bool] = None, allow_custom_memes: Optional[bool] = None)

Definition: FunSettings

Attributes

allow_giphy class-attribute instance-attribute

allow_giphy: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowGiphy'})

If set to true, enables Giphy use

giphy_content_rating class-attribute instance-attribute

giphy_content_rating: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'giphyContentRating'})

Giphy content rating. Possible values are: moderate, strict

allow_stickers_and_memes class-attribute instance-attribute

allow_stickers_and_memes: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowStickersAndMemes'})

If set to true, enables users to include stickers and memes

allow_custom_memes class-attribute instance-attribute

allow_custom_memes: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowCustomMemes'})

If set to true, enables users to include custom memes

DiscoverySettings dataclass

DiscoverySettings(*, show_in_teams_search_and_suggestions: Optional[bool] = None)

Definition: DiscoverySettings

Attributes

show_in_teams_search_and_suggestions class-attribute instance-attribute

show_in_teams_search_and_suggestions: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showInTeamsSearchAndSuggestions'})

If set to true, the team is visible via search and suggestions from the Teams client

SelectedMessageTriggerMetadata dataclass

SelectedMessageTriggerMetadata(*, teams_flow_run_context: Optional[ObjectEntity | Mapping[str, Any]] = None, card_outputs: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: SelectedMessageTriggerMetadata

ComposeMessageTriggerMetadata dataclass

ComposeMessageTriggerMetadata(*, teams_flow_run_context: Optional[ObjectEntity | Mapping[str, Any]] = None, card_outputs: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: ComposeMessageTriggerMetadata

CardResponseTriggerMetadata dataclass

CardResponseTriggerMetadata(*, teams_flow_run_context: Optional[ObjectEntity | Mapping[str, Any]] = None, card_outputs: Optional[ObjectEntity | Mapping[str, Any]] = None)

Definition: CardResponseTriggerMetadata

VirtualAgentBots dataclass

VirtualAgentBots(*, context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Definition: VirtualAgentBots

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of the Microsoft Copilot Studio agents

SectionItemConflictError dataclass

SectionItemConflictError(*, error: Optional[Dict[str, Any]] = None)

Definition: SectionItemConflictError

DynamicCallEventTriggerRequest dataclass

DynamicCallEventTriggerRequest(notification_url: str, scope: Dict[str, Any])

Definition: DynamicCallEventTriggerRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

Webhook callback URL

DynamicTranscriptTriggerRequest dataclass

DynamicTranscriptTriggerRequest(notification_url: str, scope: Dict[str, Any])

Definition: DynamicTranscriptTriggerRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

Webhook callback URL

DynamicAiInsightTriggerRequest dataclass

DynamicAiInsightTriggerRequest(notification_url: str, scope: Dict[str, Any])

Definition: DynamicAiInsightTriggerRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

Webhook callback URL

DynamicRecordingTriggerRequest dataclass

DynamicRecordingTriggerRequest(notification_url: str, scope: Dict[str, Any])

Definition: DynamicRecordingTriggerRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

Webhook callback URL

SingleTagTriggerRequest dataclass

SingleTagTriggerRequest(notification_url: str, group_id: str, tag_id: str)

Definition: SingleTagTriggerRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

Webhook callback URL

group_id class-attribute instance-attribute

group_id: str = dataclass_field(metadata={'wire_name': 'groupId'})

The team that owns the tag to monitor

tag_id class-attribute instance-attribute

tag_id: str = dataclass_field(metadata={'wire_name': 'tagId'})

The specific tag to monitor

SingleTagMemberTriggerRequest dataclass

SingleTagMemberTriggerRequest(notification_url: str, group_id: str, tag_id: str)

Definition: SingleTagMemberTriggerRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

Webhook callback URL

group_id class-attribute instance-attribute

group_id: str = dataclass_field(metadata={'wire_name': 'groupId'})

The team that owns the tag whose membership to monitor

tag_id class-attribute instance-attribute

tag_id: str = dataclass_field(metadata={'wire_name': 'tagId'})

The specific tag whose membership to monitor

TagWebhookResponseSchema dataclass

TagWebhookResponseSchema(*, change_type: Optional[str] = None, id: Optional[str] = None, team_id: Optional[str] = None, tag_id: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, member_count: Optional[int] = None, tag_type: Optional[str] = None, event_id: Optional[str] = None)

Definition: TagWebhookResponseSchema

Attributes

change_type class-attribute instance-attribute

change_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeType'})

The tag lifecycle change: 'created', 'updated', or 'deleted'.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The tag identifier.

team_id class-attribute instance-attribute

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

The team (group) ID that owns the tag.

tag_id class-attribute instance-attribute

tag_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tagId'})

The tag ID.

display_name class-attribute instance-attribute

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

Display name of the tag.

description class-attribute instance-attribute

description: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of the tag.

member_count class-attribute instance-attribute

member_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'memberCount'})

Number of members in the tag.

tag_type class-attribute instance-attribute

tag_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tagType'})

Tag type.

event_id class-attribute instance-attribute

event_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'eventId'})

Per-event identifier from the source tag event, unique per event and stable across retries. Used for delivery idempotency and correlation.

TagMemberWebhookResponseSchema dataclass

TagMemberWebhookResponseSchema(*, change_type: Optional[str] = None, id: Optional[str] = None, team_id: Optional[str] = None, tag_id: Optional[str] = None, tenant_id: Optional[str] = None, user_id: Optional[str] = None, event_id: Optional[str] = None)

Definition: TagMemberWebhookResponseSchema

Attributes

change_type class-attribute instance-attribute

change_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeType'})

The membership change: 'created' (member added) or 'deleted' (member removed).

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The tag member identifier.

team_id class-attribute instance-attribute

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

The team (group) ID that owns the tag.

tag_id class-attribute instance-attribute

tag_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tagId'})

The tag ID whose membership changed.

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})

Tenant ID of the tag member.

user_id class-attribute instance-attribute

user_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userId'})

User ID of the tag member.

event_id class-attribute instance-attribute

event_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'eventId'})

Per-event identifier from the source tag event, unique per event and stable across retries. Used for delivery idempotency and correlation.

AiInsightResponse dataclass

AiInsightResponse(*, id: Optional[str] = None, call_id: Optional[str] = None, content_correlation_id: Optional[str] = None, created_date_time: Optional[str] = None, end_date_time: Optional[str] = None)

Definition: AiInsightResponse

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The AI insight ID

call_id class-attribute instance-attribute

call_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'callId'})

The call ID

content_correlation_id class-attribute instance-attribute

content_correlation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentCorrelationId'})

The content correlation ID

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})

The date and time when the AI insight was created

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endDateTime'})

The date and time when the AI insight ended

AiInsightMeetingNote dataclass

AiInsightMeetingNote(*, title: Optional[str] = None, text: Optional[str] = None, subpoints: Optional[List[AiInsightMeetingNoteSubpoint | Mapping[str, Any]]] = None)

Definition: AiInsightMeetingNote

Attributes

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of the meeting note.

text class-attribute instance-attribute

text: Optional[str] = dataclass_field(default=None, kw_only=True)

Summary text of the meeting note.

subpoints class-attribute instance-attribute

subpoints: Optional[List[AiInsightMeetingNoteSubpoint | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

Detailed subpoints of the discussion.

AiInsightMeetingNoteSubpoint dataclass

AiInsightMeetingNoteSubpoint(*, title: Optional[str] = None, text: Optional[str] = None)

Definition: AiInsightMeetingNoteSubpoint

Attributes

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of the subpoint.

text class-attribute instance-attribute

text: Optional[str] = dataclass_field(default=None, kw_only=True)

Text of the subpoint.

AiInsightActionItem dataclass

AiInsightActionItem(*, title: Optional[str] = None, text: Optional[str] = None, owner_display_name: Optional[str] = None)

Definition: AiInsightActionItem

Attributes

title class-attribute instance-attribute

title: Optional[str] = dataclass_field(default=None, kw_only=True)

Title of the action item.

text class-attribute instance-attribute

text: Optional[str] = dataclass_field(default=None, kw_only=True)

Description of the action item.

owner_display_name class-attribute instance-attribute

owner_display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ownerDisplayName'})

Display name of the person assigned the action item.

AiInsightViewpoint dataclass

AiInsightViewpoint(*, mention_events: Optional[List[AiInsightMentionEvent | Mapping[str, Any]]] = None)

Definition: AiInsightViewpoint

Attributes

mention_events class-attribute instance-attribute

mention_events: Optional[List[AiInsightMentionEvent | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mentionEvents'})

Utterances where participants are directly mentioned, with timestamps and speaker details.

AiInsightMentionEvent dataclass

AiInsightMentionEvent(*, event_date_time: Optional[str] = None, transcript_utterance: Optional[str] = None, speaker: Optional[Dict[str, Any]] = None)

Definition: AiInsightMentionEvent

Attributes

event_date_time class-attribute instance-attribute

event_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'eventDateTime'})

The time during the meeting when the mention occurred (UTC).

transcript_utterance class-attribute instance-attribute

transcript_utterance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'transcriptUtterance'})

The transcript utterance containing the mention.

speaker class-attribute instance-attribute

speaker: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The speaker who made the utterance.

TeamsClient

TeamsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for teams connector.

Initialize a TeamsClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

create_teams_meeting async

create_teams_meeting(input: NewMeeting | Mapping[str, Any], calendarid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a Teams meeting

Create a meeting with a link at the bottom of the invite to join the meeting online on Microsoft Teams.

Swagger operation ID: CreateTeamsMeeting.

Parameters:

Name	Type	Description	Default
input	NewMeeting | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
calendarid	str	Select a value.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_teams

list_all_teams(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List joined teams

Lists all the teams in Microsoft Teams that you are a member of

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllTeams.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_associated_teams

list_all_associated_teams(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List associated teams

Lists all the teams you are a direct member of, or are a member of a shared channel that is hosted inside the team.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllAssociatedTeams.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_channels_for_group

list_channels_for_group(group_id: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List channels

Lists all the channels for a specific team

Returns a single-page Azure Core async collection.

Swagger operation ID: GetChannelsForGroup.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
filter	Optional[str]	An OData filter query to restrict the entries returned (e.g. membershipType eq 'standard').	None
orderby	Optional[str]	An OData orderBy query option for specifying the order of entries (e.g., displayName asc).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_channel async

create_channel(input: CreateChannelInput | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a channel

Create a new channel within a specified team

Swagger operation ID: CreateChannel.

Parameters:

Name	Type	Description	Default
input	CreateChannelInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Select team.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_channel async

get_channel(group_id: str, channel_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get details for a specific channel in a team

Get the channel details

Swagger operation ID: GetChannel.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
channel_id	str	Channel ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_channel_properties async

update_channel_properties(input: UpdateChannelPropertiesInput | Mapping[str, Any], group_id: str, channel_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Update channel

Updates the properties of a channel in a specific team. Only the properties you provide are changed; omitted properties are left unchanged. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel.

Swagger operation ID: UpdateChannelProperties.

Parameters:

Name	Type	Description	Default
input	UpdateChannelPropertiesInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Select team.	required
channel_id	str	Channel ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

archive_channel async

archive_channel(input: ArchiveChannelInput | Mapping[str, Any], group_id: str, channel_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Archive a channel

Archive a channel in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel. Archiving is an asynchronous operation.

Swagger operation ID: ArchiveChannel.

Parameters:

Name	Type	Description	Default
input	ArchiveChannelInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Select team.	required
channel_id	str	Channel ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_channels_for_team

list_all_channels_for_team(group_id: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all channels

Lists all the channels for a specific team, including channels that are shared with the team

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllChannelsForTeam.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
filter	Optional[str]	An OData filter query to restrict the entries returned (e.g. membershipType eq 'standard').	None
orderby	Optional[str]	An OData orderBy query option for specifying the order of entries (e.g., displayName asc).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_chats

list_chats(chat_type: str, topic: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List chats

Lists recent chats you are a part of

Returns a single-page Azure Core async collection.

Swagger operation ID: GetChats.

Parameters:

Name	Type	Description	Default
chat_type	str	Filter by type.	required
topic	str	Filter by whether or not the topic name is defined.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_feed_notification async

post_feed_notification(input: DynamicPostFeedNotificationRequest | Mapping[str, Any], poster: str, notification_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Post a feed notification

Posts a notification to a user's activity feed linking to a chat or team.

Swagger operation ID: PostFeedNotification.

Parameters:

Name	Type	Description	Default
input	DynamicPostFeedNotificationRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
poster	str	Select an option.	required
notification_type	str	Choose notification type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

at_mention_tag async

at_mention_tag(group_id: str, tag_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an @mention token for a team tag

Creates a token that can be inserted into a message or adaptive card sent as a user in a channel to @mention a team tag.

Swagger operation ID: AtMentionTag.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
tag_id	str	Select tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_messages_from_channel

list_messages_from_channel(group_id: str, channel_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get messages in a channel

Gets messages from a channel in a specific team. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetMessagesFromChannel.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
channel_id	str	Channel ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_message_details async

get_message_details(input: DynamicGetMessageDetailsSchema | Mapping[str, Any], message_id: str, thread_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get message details

Gets the details of a message in a chat or a channel.

Swagger operation ID: GetMessageDetails.

Parameters:

Name	Type	Description	Default
input	DynamicGetMessageDetailsSchema | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
message_id	str	Message ID.	required
thread_type	str	Choose message type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_replies_to_message

list_replies_to_message(group_id: str, channel_id: str, message_id: str, *, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List replies of a channel message

List replies to a message in a channel in a specific team. For shared channels, the team ID must refer to the host team, which is the team that owns the shared channel.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListRepliesToMessage.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
channel_id	str	Channel ID.	required
message_id	str	Message ID.	required
top	Optional[int]	The number of latest replies to return. The default value is 20. The supported value is between 1 and 50.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_members

list_members(input: DynamicListMembersSchema | Mapping[str, Any], thread_type: str, *, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List chat or channel members

List direct members of a group chat or a channel

Returns a single-page Azure Core async collection.

Swagger operation ID: ListMembers.

Parameters:

Name	Type	Description	Default
input	DynamicListMembersSchema | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
thread_type	str	Choose message type.	required
filter	Optional[str]	An OData filter query to restrict the entries returned (e.g. membershipType eq 'standard').	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

subscribe_user_message_with_options async

subscribe_user_message_with_options(input: DynamicUserMessageWithOptionsSubscriptionRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Post a choice of options as the Flow bot to a user

Send a set of options to a Microsoft Teams user, that they must respond to before the flow will continue. This action will pause the flow until the user response to the options

Swagger operation ID: SubscribeUserMessageWithOptions.

Parameters:

Name	Type	Description	Default
input	DynamicUserMessageWithOptionsSubscriptionRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_team async

get_team(team_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a team

Gets the details for a team in Microsoft Teams.

Swagger operation ID: GetTeam.

Parameters:

Name	Type	Description	Default
team_id	str	Select team.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

at_mention_user async

at_mention_user(user_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an @mention token for a user

Creates a token that can be inserted into a message or adaptive card to @mention a user.

Swagger operation ID: AtMentionUser.

Parameters:

Name	Type	Description	Default
user_id	str	Specify a user principal or user ID to @mention.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_chat async

create_chat(input: NewChat | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a chat

Creates a one on one or group chat

Swagger operation ID: CreateChat.

Parameters:

Name	Type	Description	Default
input	NewChat | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_messages_from_chat

list_messages_from_chat(chat_id: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get messages in a chat

Retrieves messages from a one on one or group chat

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: GetMessagesFromChat.

Parameters:

Name	Type	Description	Default
chat_id	str	The chat's unique identifier.	required
filter	Optional[str]	An OData filter query to restrict the entries returned (e.g. membershipType eq 'standard').	None
orderby	Optional[str]	An OData orderBy query option for specifying the order of entries (e.g., displayName asc).	None
top	Optional[str]	An OData top query option for specifying the maximum number of entries returned.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_message_to_self async

post_message_to_self(input: PostMessageToSelfRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Post a message to myself

Sends a message to the signed-in user's own Notes chat in Microsoft Teams.

Swagger operation ID: PostMessageToSelf.

Parameters:

Name	Type	Description	Default
input	PostMessageToSelfRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_a_team async

create_a_team(input: CreateATeamInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a team

Creates a new team in Microsoft Teams

Swagger operation ID: CreateATeam.

Parameters:

Name	Type	Description	Default
input	CreateATeamInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_team_members

list_team_members(team_id: str, *, filter: Optional[str] = None, top: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List team members

Lists the members of a team in Microsoft Teams

Returns a single-page Azure Core async collection.

Swagger operation ID: ListTeamMembers.

Parameters:

Name	Type	Description	Default
team_id	str	Select team.	required
filter	Optional[str]	An OData filter query to restrict the entries returned (e.g. membershipType eq 'standard').	None
top	Optional[str]	An OData top query option for specifying the maximum number of entries returned.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_member_to_team async

add_member_to_team(input: AddMemberToTeamInput | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Add a member to a team

Adds a member to a team in Microsoft Teams

Swagger operation ID: AddMemberToTeam.

Parameters:

Name	Type	Description	Default
input	AddMemberToTeamInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Select team.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

remove_member_from_team async

remove_member_from_team(team_id: str, membership_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Remove a member from a team

Removes a member from a team in Microsoft Teams

Swagger operation ID: RemoveMemberFromTeam.

Parameters:

Name	Type	Description	Default
team_id	str	Select team.	required
membership_id	str	The membership ID of the member to remove from the team. Use the 'List team members' action to look up the membership ID for a user.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_member_to_channel async

add_member_to_channel(input: AddMemberToChannelInput | Mapping[str, Any], group_id: str, channel_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Add a member to a channel

Adds a member to a channel in Microsoft Teams. The channel must be a private or shared channel.

Swagger operation ID: AddMemberToChannel.

Parameters:

Name	Type	Description	Default
input	AddMemberToChannelInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Select team.	required
channel_id	str	Channel ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

remove_member_from_channel async

remove_member_from_channel(group_id: str, channel_id: str, membership_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Remove a direct member from a channel

Removes a direct member from a channel in Microsoft Teams. The channel must be a private or shared channel.

Swagger operation ID: RemoveMemberFromChannel.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
channel_id	str	Channel ID.	required
membership_id	str	The membership ID of the direct member to remove from the channel. Use the 'List chat or channel members' action with thread type 'Channel' to look up the membership ID for a user.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_message_to_conversation async

post_message_to_conversation(input: DynamicPostMessageRequest | Mapping[str, Any], poster: str, location: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Post message in a chat or channel

Posts a message to a chat or a channel

Swagger operation ID: PostMessageToConversation.

Parameters:

Name	Type	Description	Default
input	DynamicPostMessageRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
poster	str	Select an option.	required
location	str	Select an option.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

reply_with_message_to_conversation async

reply_with_message_to_conversation(input: DynamicReplyMessageRequest | Mapping[str, Any], poster: str, location: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Reply with a message in a channel

Replies with a message to a channel's message

Swagger operation ID: ReplyWithMessageToConversation.

Parameters:

Name	Type	Description	Default
input	DynamicReplyMessageRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
poster	str	Select an option.	required
location	str	Select an option.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_card_to_conversation async

post_card_to_conversation(input: DynamicPostCardRequest | Mapping[str, Any], poster: str, location: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Post card in a chat or channel

Posts a card to a chat or a channel

Swagger operation ID: PostCardToConversation.

Parameters:

Name	Type	Description	Default
input	DynamicPostCardRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
poster	str	Select an option.	required
location	str	Select an option.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

post_card_and_wait_for_response async

post_card_and_wait_for_response(input: PostCardAndWaitForResponseInput | Mapping[str, Any], poster: str, location: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Post adaptive card and wait for a response

Posts an adaptive card to a chat or a channel and waits for a response from any user. This will pause the flow until any user responds.

Swagger operation ID: PostCardAndWaitForResponse.

Parameters:

Name	Type	Description	Default
input	PostCardAndWaitForResponseInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
poster	str	Select an option.	required
location	str	Select an option.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

reply_with_card_to_conversation async

reply_with_card_to_conversation(input: DynamicReplyCardRequest | Mapping[str, Any], poster: str, location: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Reply with an adaptive card in a channel

Replies with an adaptive card to a channel's message

Swagger operation ID: ReplyWithCardToConversation.

Parameters:

Name	Type	Description	Default
input	DynamicReplyCardRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
poster	str	Select an option.	required
location	str	Select an option.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_card_in_conversation async

update_card_in_conversation(input: DynamicUpdateCardRequest | Mapping[str, Any], poster: str, location: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update an adaptive card in a chat or channel

Updates an existing adaptive card

Swagger operation ID: UpdateCardInConversation.

Parameters:

Name	Type	Description	Default
input	DynamicUpdateCardRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
poster	str	Select an option.	required
location	str	Select an option.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

http_request async

http_request(input: bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send a Microsoft Graph HTTP request

Construct a Microsoft Graph REST API request to invoke against the Microsoft Teams endpoints. These segments are supported: 1st segment: /teams, /me, /users 2nd segment: channels, chats, installedApps, messages, pinnedMessages, onlineMeetings. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api

Swagger operation ID: HttpRequest.

Parameters:

Name	Type	Description	Default
input	bytes	The binary request body.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_member_to_chat async

add_member_to_chat(input: AddMemberToChatInput | Mapping[str, Any], chat_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Add a user to a chat

Adds a user to a chat in Microsoft Teams.

Swagger operation ID: AddMemberToChat.

Parameters:

Name	Type	Description	Default
input	AddMemberToChatInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
chat_id	str	The chat's unique identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

remove_member_from_chat async

remove_member_from_chat(chat_id: str, membership_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Remove a member from a chat

Removes a member from a chat in Microsoft Teams. Only group chats support member removal.

Swagger operation ID: RemoveMemberFromChat.

Parameters:

Name	Type	Description	Default
chat_id	str	The chat's unique identifier.	required
membership_id	str	The membership ID of the member to remove from the chat. Use the 'List chat or channel members' action with thread type 'Group chat' to look up the membership ID for a user.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_online_meeting async

get_online_meeting(lookup_type: str, lookup_value: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an online meeting

Retrieves the properties and relationships of an online meeting. You can look up a meeting by meeting ID, join web URL, or join meeting ID.

Swagger operation ID: GetOnlineMeeting.

Parameters:

Name	Type	Description	Default
lookup_type	str	Select how to identify the meeting.	required
lookup_value	str	The value corresponding to the selected lookup type (meeting ID, join web URL, or join meeting ID).	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_meeting_transcripts

list_meeting_transcripts(meeting_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List meeting transcripts

Lists all transcripts for an online meeting

Returns a single-page Azure Core async collection.

Swagger operation ID: ListMeetingTranscripts.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_meeting_transcript async

get_meeting_transcript(meeting_id: str, transcript_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get meeting transcript

Gets a specific transcript for an online meeting

Swagger operation ID: GetMeetingTranscript.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
transcript_id	str	The transcript ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_meeting_transcript_content async

get_meeting_transcript_content(meeting_id: str, transcript_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get meeting transcript content

Gets the content of a meeting transcript

Swagger operation ID: GetMeetingTranscriptContent.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
transcript_id	str	The transcript ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_meeting_recordings

list_meeting_recordings(meeting_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List meeting recordings

Lists all recordings for an online meeting

Returns a single-page Azure Core async collection.

Swagger operation ID: ListMeetingRecordings.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_meeting_recording async

get_meeting_recording(meeting_id: str, recording_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get meeting recording

Gets a specific recording for an online meeting

Swagger operation ID: GetMeetingRecording.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
recording_id	str	The recording ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_meeting_recording_content async

get_meeting_recording_content(meeting_id: str, recording_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get meeting recording content

Gets the content stream of a meeting recording

Swagger operation ID: GetMeetingRecordingContent.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
recording_id	str	The recording ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_sections

list_sections(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List sections

Lists the current user's teamwork sections

Returns a single-page Azure Core async collection.

Swagger operation ID: ListSections.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_section async

create_section(input: CreateSectionInput | Mapping[str, Any], *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a section

Creates a new teamwork section for the current user

Swagger operation ID: CreateSection.

Parameters:

Name	Type	Description	Default
input	CreateSectionInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_section async

get_section(section_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a section

Gets a specific teamwork section by ID

Swagger operation ID: GetSection.

Parameters:

Name	Type	Description	Default
section_id	str	The section ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_section async

update_section(input: UpdateSectionInput | Mapping[str, Any], section_id: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a section

Updates a teamwork section for the current user

Swagger operation ID: UpdateSection.

Parameters:

Name	Type	Description	Default
input	UpdateSectionInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
section_id	str	The section ID.	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_section async

delete_section(section_id: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a section

Deletes a teamwork section for the current user

Swagger operation ID: DeleteSection.

Parameters:

Name	Type	Description	Default
section_id	str	The section ID.	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_section_items

list_section_items(section_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List section items

Lists the items (chats, channels, meetings, communities) in a teamwork section. Each item belongs to exactly one section at a time.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListSectionItems.

Parameters:

Name	Type	Description	Default
section_id	str	The section ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_section_item async

add_section_item(input: AddSectionItemInput | Mapping[str, Any], section_id: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add an item to a section

Adds an item (chat, channel, meeting, or community) currently in a system-defined section to a user-defined teamwork section. Use Move Section Item to relocate items already in another user-defined section.

Swagger operation ID: AddSectionItem.

Parameters:

Name	Type	Description	Default
input	AddSectionItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
section_id	str	The section ID.	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

remove_section_item async

remove_section_item(section_id: str, section_item_id: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Remove an item from a section

Removes an item from a user-defined teamwork section. The underlying chat, channel, meeting, or community is not deleted; the item returns to its default system-defined section.

Swagger operation ID: RemoveSectionItem.

Parameters:

Name	Type	Description	Default
section_id	str	The section ID.	required
section_item_id	str	The section item ID (the conversation ID of the underlying chat, channel, meeting, or community).	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

move_section_item async

move_section_item(input: MoveSectionItemInput | Mapping[str, Any], section_id: str, section_item_id: str, *, etag: Optional[str] = None, match_condition: Optional[MatchConditions] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Move a section item

Atomically moves an item from one user-defined teamwork section to another user-defined section. Each item can belong to only one section at a time. This action removes the item from its current section and adds it to the target section.

Swagger operation ID: MoveSectionItem.

Parameters:

Name	Type	Description	Default
input	MoveSectionItemInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
section_id	str	The section ID.	required
section_item_id	str	The section item ID (the conversation ID of the underlying chat, channel, meeting, or community).	required
etag	Optional[str]	The entity tag for the conditional request.	None
match_condition	Optional[MatchConditions]	The Azure Core match condition.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tags

list_tags(group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all tags for a team

Lists the team's tags

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTags.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_tag async

create_tag(input: CreateTagInput | Mapping[str, Any], group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a tag for a team

Creates a tag in a team

Swagger operation ID: CreateTag.

Parameters:

Name	Type	Description	Default
input	CreateTagInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Select team.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_tag async

get_tag(group_id: str, tag_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a team tag

Gets a specific tag by ID from a team

Swagger operation ID: GetTag.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
tag_id	str	Select tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_tag async

update_tag(input: UpdateTagInput | Mapping[str, Any], group_id: str, tag_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update a team tag

Updates the display name of a tag in a team

Swagger operation ID: UpdateTag.

Parameters:

Name	Type	Description	Default
input	UpdateTagInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Select team.	required
tag_id	str	Select tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_tag async

delete_tag(group_id: str, tag_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a team tag

Deletes a tag from a team

Swagger operation ID: DeleteTag.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
tag_id	str	Select tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

add_member_to_tag async

add_member_to_tag(input: AddMemberToTagInput | Mapping[str, Any], group_id: str, tag_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Add a member to a team tag

Adds a user to a team tag

Swagger operation ID: AddMemberToTag.

Parameters:

Name	Type	Description	Default
input	AddMemberToTagInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Select team.	required
tag_id	str	Select tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tag_members

list_tag_members(group_id: str, tag_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List the members of a team tag

Lists the members of a team tag

Returns a single-page Azure Core async collection.

Swagger operation ID: GetTagMembers.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
tag_id	str	Select tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_tag_member async

delete_tag_member(group_id: str, tag_id: str, tag_member_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a member from a team tag

Deletes a member from a team tag

Swagger operation ID: DeleteTagMember.

Parameters:

Name	Type	Description	Default
group_id	str	Select team.	required
tag_id	str	Select tag.	required
tag_member_id	str	ID of the member to remove from the tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_call_recordings

list_call_recordings(call_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List call recordings

Lists all recordings for an ad-hoc call

Returns a single-page Azure Core async collection.

Swagger operation ID: ListCallRecordings.

Parameters:

Name	Type	Description	Default
call_id	str	The call ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_call_recording async

get_call_recording(call_id: str, recording_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get call recording

Gets a specific recording for an ad-hoc call

Swagger operation ID: GetCallRecording.

Parameters:

Name	Type	Description	Default
call_id	str	The call ID.	required
recording_id	str	The recording ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_call_recording_content async

get_call_recording_content(call_id: str, recording_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Get call recording content

Gets the content of a call recording

Swagger operation ID: GetCallRecordingContent.

Parameters:

Name	Type	Description	Default
call_id	str	The call ID.	required
recording_id	str	The recording ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_call_transcripts

list_call_transcripts(call_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List call transcripts

Lists all transcripts for an ad-hoc call

Returns a single-page Azure Core async collection.

Swagger operation ID: ListCallTranscripts.

Parameters:

Name	Type	Description	Default
call_id	str	The call ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_call_transcript async

get_call_transcript(call_id: str, transcript_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get call transcript

Gets a specific transcript for an ad-hoc call

Swagger operation ID: GetCallTranscript.

Parameters:

Name	Type	Description	Default
call_id	str	The call ID.	required
transcript_id	str	The transcript ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_call_transcript_content async

get_call_transcript_content(call_id: str, transcript_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get call transcript content

Gets the content of a call transcript

Swagger operation ID: GetCallTranscriptContent.

Parameters:

Name	Type	Description	Default
call_id	str	The call ID.	required
transcript_id	str	The transcript ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_adhoc_call_recordings

list_all_adhoc_call_recordings(*, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, deltatoken: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get all ad-hoc call recordings

Gets all recordings from ad-hoc calls for the signed-in user

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllAdhocCallRecordings.

Parameters:

Name	Type	Description	Default
start_date_time	Optional[str]	The start date and time to filter recordings.	None
end_date_time	Optional[str]	The end date and time to filter recordings.	None
top	Optional[int]	The number of recordings to return.	None
skiptoken	Optional[str]	The skip token for pagination.	None
deltatoken	Optional[str]	The delta token for tracking changes.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_adhoc_call_transcripts

list_all_adhoc_call_transcripts(*, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, deltatoken: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get all ad-hoc call transcripts

Gets all transcripts from ad-hoc calls for the signed-in user

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllAdhocCallTranscripts.

Parameters:

Name	Type	Description	Default
start_date_time	Optional[str]	The start date and time to filter transcripts.	None
end_date_time	Optional[str]	The end date and time to filter transcripts.	None
top	Optional[int]	The number of transcripts to return.	None
skiptoken	Optional[str]	The skip token for pagination.	None
deltatoken	Optional[str]	The delta token for tracking changes.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_ai_insights

list_ai_insights(meeting_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List AI insights

Lists AI-generated insights for an online meeting. Requires Microsoft 365 Copilot license.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListAiInsights.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_ai_insight async

get_ai_insight(meeting_id: str, ai_insight_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get AI insight

Gets a specific AI-generated insight for an online meeting. Requires Microsoft 365 Copilot license.

Swagger operation ID: GetAiInsight.

Parameters:

Name	Type	Description	Default
meeting_id	str	The online meeting ID.	required
ai_insight_id	str	The AI insight ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_message_locations

list_message_locations(message_type: str, poster: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Conversation location for where to post

Returns a list of locations to post a message or reply based on who the user is posting as

Returns a single-page Azure Core async collection.

Swagger operation ID: GetMessageLocations.

Parameters:

Name	Type	Description	Default
message_type	str	Message Type.	required
poster	str	Select an option.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_message_details_input_schema async

get_message_details_input_schema(thread_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get message details response schema

Get the schema information for get message details response

Swagger operation ID: GetMessageDetailsInputSchema.

Parameters:

Name	Type	Description	Default
thread_type	str	Choose message type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_message_details_response_schema async

get_message_details_response_schema(thread_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get message details input metadata

Get the schema information for message inputs

Swagger operation ID: GetMessageDetailsResponseSchema.

Parameters:

Name	Type	Description	Default
thread_type	str	Choose message type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_members_input_schema async

list_members_input_schema(thread_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

List members input schema

Get the schema information for list members input based on thread type

Swagger operation ID: ListMembersInputSchema.

Parameters:

Name	Type	Description	Default
thread_type	str	Choose message type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_feed_notification_input_schema async

get_feed_notification_input_schema(poster: str, notification_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get feed notification input metadata

Get the schema information for feed notification

Swagger operation ID: GetFeedNotificationInputSchema.

Parameters:

Name	Type	Description	Default
poster	str	Select an option.	required
notification_type	str	Choose notification type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_unified_action_schema async

get_unified_action_schema(action_type: str, poster: str, recipient_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get unified action input metadata

Get the schema information for unified actions

Swagger operation ID: GetUnifiedActionSchema.

Parameters:

Name	Type	Description	Default
action_type	str	Unified Action.	required
poster	str	Select an option.	required
recipient_type	str	Type of the recipient of the action.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_message_with_options_subscription_input_metadata async

get_message_with_options_subscription_input_metadata(recipient_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get message with options subscription input metadata

Get the schema information for the message with options subscription inputs

Swagger operation ID: GetMessageWithOptionsSubscriptionInputMetadata.

Parameters:

Name	Type	Description	Default
recipient_type	str	Type of the recipient of the action.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_message_with_options_subscription_output_metadata async

get_message_with_options_subscription_output_metadata(recipient_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get message with options subscription output metadata

Get the schema information for the message with options subscription outputs

Swagger operation ID: GetMessageWithOptionsSubscriptionOutputMetadata.

Parameters:

Name	Type	Description	Default
recipient_type	str	Type of the recipient of the action.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_webhook_trigger_request_schema async

get_webhook_trigger_request_schema(thread_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Input schema for webhook trigger

Gets the input schema for webhook trigger

Swagger operation ID: GetWebhookTriggerRequestSchema.

Parameters:

Name	Type	Description	Default
thread_type	str	Choose message type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_webhook_trigger_response_schema async

get_webhook_trigger_response_schema(trigger_type: str, thread_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Response schema for webhook trigger

Gets the response schema for webhook trigger

Swagger operation ID: GetWebhookTriggerResponseSchema.

Parameters:

Name	Type	Description	Default
trigger_type	str	Trigger type.	required
thread_type	str	Choose message type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_post_to_conversation_response_schema async

get_post_to_conversation_response_schema(action_type: str, poster: str, recipient_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get response schema

Get the schema information for unified action responses

Swagger operation ID: GetPostToConversationResponseSchema.

Parameters:

Name	Type	Description	Default
action_type	str	Unified Action.	required
poster	str	Select an option.	required
recipient_type	str	Type of the recipient of the action.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_flow_continuation_subscription_with_poster_output_metadata async

get_flow_continuation_subscription_with_poster_output_metadata(input: GetFlowContinuationSubscriptionWithPosterOutputMetadataInput, poster: str, recipient_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get flow continuation subscription output metadata

Get the schema information for the flow continuation subscription outputs

Swagger operation ID: GetFlowContinuationSubscriptionWithPosterOutputMetadata.

Parameters:

Name	Type	Description	Default
input	GetFlowContinuationSubscriptionWithPosterOutputMetadataInput	The request body.	required
poster	str	Select an option.	required
recipient_type	str	Type of the recipient of the action.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_subscription_scope_schema async

get_subscription_scope_schema(scope_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get subscription scope input schema

Returns the input schema for a subscription trigger based on the selected scope type.

Swagger operation ID: GetSubscriptionScopeSchema.

Parameters:

Name	Type	Description	Default
scope_type	str	The selected scope type.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.