Office365groupsmailClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewEmailInGroup': {'operation_id': 'OnNewEmailInGroup', 'path': '/{connectionId}/trigger/v1.0/groups/{groupId}/conversations', 'method': 'get', 'required_parameters': ['groupId'], 'callback_payload_type': 'OnNewEmailInGroupResponse'}}

Classes

ListConversationsResponse dataclass

ListConversationsResponse(*, next_link: Optional[str] = None, value: Optional[List[Conversation | Mapping[str, Any]]] = None)

Response for List the conversations of a group

Attributes

next_link class-attribute instance-attribute

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

Link to get next page of results

CreateConversationResponse dataclass

CreateConversationResponse(*, context: Optional[str] = None, id: Optional[str] = None, threads_odata_context: Optional[str] = None, threads: Optional[List[Dict[str, Any]]] = None)

Response for Create a new conversation in a group

Attributes

context class-attribute instance-attribute

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

The @odata.context link.

id class-attribute instance-attribute

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

New Conversation ID.

threads_odata_context class-attribute instance-attribute

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

The threads@odata.context link.

threads class-attribute instance-attribute

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

Created conversation thread.

Conversation dataclass

Conversation(*, id: Optional[str] = None, topic: Optional[str] = None, has_attachments: Optional[bool] = None, last_delivered_date_time: Optional[str] = None, unique_senders: Optional[List[str]] = None, preview: Optional[str] = None, threads: Optional[List[ConversationThread | Mapping[str, Any]]] = None)

Response for Get a group conversation

Attributes

id class-attribute instance-attribute

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

The conversations's unique identifier.

topic class-attribute instance-attribute

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

The topic of the conversation.

has_attachments class-attribute instance-attribute

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

Indicates whether any of the posts within this Conversation has at least one attachment.

last_delivered_date_time class-attribute instance-attribute

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

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

unique_senders class-attribute instance-attribute

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

All the users that sent a message to this Conversation.

preview class-attribute instance-attribute

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

A short summary from the body of the latest post in this Conversation.

ListConversationThreadsResponse dataclass

ListConversationThreadsResponse(*, next_link: Optional[str] = None, context: Optional[str] = None, value: Optional[List[ConversationThread | Mapping[str, Any]]] = None)

Response for List the conversation threads of a conversation

Attributes

next_link class-attribute instance-attribute

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

Link to get next page of results

context class-attribute instance-attribute

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

The Odata.context link.

NewConversationThreadResponse dataclass

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

Response for Create a conversation thread

Attributes

context class-attribute instance-attribute

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

The @odata.context link.

id class-attribute instance-attribute

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

New conversation thread ID.

ListGroupThreadsResponse dataclass

ListGroupThreadsResponse(*, next_link: Optional[str] = None, value: Optional[List[ConversationThread | Mapping[str, Any]]] = None)

Response for List the threads of a group

Attributes

next_link class-attribute instance-attribute

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

Link to get next page of results

ConversationThread dataclass

ConversationThread(*, id: Optional[str] = None, topic: Optional[str] = None, has_attachments: Optional[bool] = None, last_delivered_date_time: Optional[str] = None, unique_senders: Optional[List[str]] = None, preview: Optional[str] = None, is_locked: Optional[bool] = None, to_recipients: Optional[List[EmailAddress | Mapping[str, Any]]] = None, cc_recipients: Optional[List[EmailAddress | Mapping[str, Any]]] = None, posts: Optional[List[Post | Mapping[str, Any]]] = None)

Response for Get a conversation thread

Attributes

id class-attribute instance-attribute

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

The conversation thread's unique identifier.

topic class-attribute instance-attribute

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

The topic of the conversation.

has_attachments class-attribute instance-attribute

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

Indicates whether any of the posts within this Conversation has at least one attachment.

last_delivered_date_time class-attribute instance-attribute

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

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

unique_senders class-attribute instance-attribute

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

All the users that sent a message to this Conversation.

preview class-attribute instance-attribute

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

A short summary from the body of the latest post in this Conversation.

is_locked class-attribute instance-attribute

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

Indicates if the thread is locked.

to_recipients class-attribute instance-attribute

to_recipients: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'toRecipients'})

The To: recipients for the thread.

cc_recipients class-attribute instance-attribute

cc_recipients: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ccRecipients'})

The Cc: recipients for the thread.

ListThreadPostsResponse dataclass

ListThreadPostsResponse(*, next_link: Optional[str] = None, context: Optional[str] = None, value: Optional[List[Post | Mapping[str, Any]]] = None)

Response for List the posts of a conversation thread

Attributes

next_link class-attribute instance-attribute

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

Link to get next page of results

context class-attribute instance-attribute

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

The @odata.context link.

value class-attribute instance-attribute

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

Array containing the posts in the specified thread.

Post dataclass

Post(*, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, change_key: Optional[str] = None, conversation_id: Optional[str] = None, conversation_thread_id: Optional[str] = None, categories: Optional[List[str]] = None, received_date_time: Optional[str] = None, has_attachments: Optional[bool] = None, new_participants: Optional[List[EmailAddress | Mapping[str, Any]]] = None, body: Optional[ItemBody | Mapping[str, Any]] = None, from_: Optional[EmailAddress | Mapping[str, Any]] = None, sender: Optional[EmailAddress | Mapping[str, Any]] = None, attachments: Optional[List[Attachment | Mapping[str, Any]]] = None)

Response for Get a thread post

Attributes

id class-attribute instance-attribute

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

The post's unique identifier.

change_key class-attribute instance-attribute

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

Identifies the version of the post.

conversation_id class-attribute instance-attribute

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

Unique ID of the conversation the post belongs to.

conversation_thread_id class-attribute instance-attribute

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

Unique ID of the conversation thread the post belongs to.

categories class-attribute instance-attribute

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

The categories associated with the post.

received_date_time class-attribute instance-attribute

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

Post received timestamp.

has_attachments class-attribute instance-attribute

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

Indicates whether the post has at least one attachment.

new_participants class-attribute instance-attribute

new_participants: Optional[List[EmailAddress | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newParticipants'})

Conversation participants that were added to the thread as part of this post.

GetAttachmentsResponse dataclass

GetAttachmentsResponse(*, next_link: Optional[str] = None, context: Optional[str] = None, value: Optional[List[Attachment | Mapping[str, Any]]] = None)

Response for List the attachments of a post

Attributes

next_link class-attribute instance-attribute

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

Link to get next page of results

context class-attribute instance-attribute

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

The @odata.context link.

value class-attribute instance-attribute

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

Array containing the attachments of the post.

OnNewEmailInGroupResponse dataclass

OnNewEmailInGroupResponse(*, value: Optional[List[ConversationTriggerResponse | Mapping[str, Any]]] = None)

Response for When a new email arrives to a group

Attributes

value class-attribute instance-attribute

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

Response of the trigger.

ObjectWithoutType dataclass

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

Response for Send an 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])

ListGroupsResponse dataclass

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

Response for List user groups

Attributes

value class-attribute instance-attribute

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

Array with the groups the user is part of.

Attachment dataclass

Attachment(*, id: Optional[str] = None, name: Optional[str] = None, content_type: Optional[str] = None, size: Optional[int] = None, content_bytes: Optional[str] = None)

Definition: Attachment

Attributes

id class-attribute instance-attribute

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

Id of the attachment.

name class-attribute instance-attribute

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

Name of attachment.

content_type class-attribute instance-attribute

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

Content type of attachment.

size class-attribute instance-attribute

size: Optional[int] = dataclass_field(default=None, kw_only=True)

Size of attachment.

content_bytes class-attribute instance-attribute

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

Content of attachment.

EmailAddress dataclass

EmailAddress(*, email_address: Optional[Dict[str, Any]] = None)

Definition: EmailAddress

Attributes

email_address class-attribute instance-attribute

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

Represents information about a user in the sending or receiving end of an event, message or group post.

ItemBody dataclass

ItemBody(*, content_type: Optional[str] = None, content: Optional[str] = None)

Definition: ItemBody

Attributes

content_type class-attribute instance-attribute

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

Content type of the body.

content class-attribute instance-attribute

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

Content of the body.

ReplyConversationThreadBody dataclass

ReplyConversationThreadBody(*, post: Optional[NewPostBody | Mapping[str, Any]] = None)

Definition: ReplyConversationThreadBody

ForwardPostBody dataclass

ForwardPostBody(to_recipients: List[GetUsersGraphAction | Mapping[str, Any]], *, comment: Optional[str] = None)

Definition: ForwardPost_V2Body

Attributes

comment class-attribute instance-attribute

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

Comment to forward with the post.

to_recipients class-attribute instance-attribute

to_recipients: List[GetUsersGraphAction | Mapping[str, Any]] = dataclass_field(metadata={'wire_name': 'ToRecipients'})

The recipients to whom the threaded is forwarded to.

CreateConversationBody dataclass

CreateConversationBody(topic: str, *, post: Optional[NewPostBody | Mapping[str, Any]] = None)

Definition: CreateConversationBody

Attributes

topic instance-attribute

topic: str

Topic of the new conversation.

NewPostBody dataclass

NewPostBody(*, body: Optional[Dict[str, Any]] = None, categories: Optional[List[str]] = None, new_participants: Optional[List[GetUsersGraphAction | Mapping[str, Any]]] = None, attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = None)

Definition: NewPostBody

Attributes

body class-attribute instance-attribute

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

Body of the new post.

categories class-attribute instance-attribute

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

The categories associated with the post.

new_participants class-attribute instance-attribute

new_participants: Optional[List[GetUsersGraphAction | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'newParticipants'})

Add participants to the thread as part of this post.

attachments class-attribute instance-attribute

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

File attachments to include.

GetUsersGraphAction dataclass

GetUsersGraphAction(*, email_address: Optional[Dict[str, Any]] = None)

Definition: GetUsers__GraphAction

Attributes

email_address class-attribute instance-attribute

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

User email address.

ClientSendAttachment dataclass

ClientSendAttachment(type_: str, name: str, content_bytes: str)

Definition: ClientSendAttachment

Attributes

type_ class-attribute instance-attribute

type_: str = dataclass_field(metadata={'wire_name': '@odata.type'})

@odata.type for a file attachment.

name class-attribute instance-attribute

name: str = dataclass_field(metadata={'wire_name': 'Name'})

Name of the attachment.

content_bytes class-attribute instance-attribute

content_bytes: str = dataclass_field(metadata={'wire_name': 'ContentBytes'})

Content of the attachment.

ConversationTriggerResponse dataclass

ConversationTriggerResponse(*, id: Optional[str] = None, last_delivered_date_time: Optional[str] = None, threads: Optional[List[ConversationThreadTriggerResponse | Mapping[str, Any]]] = None)

Definition: ConversationTriggerResponse

Attributes

id class-attribute instance-attribute

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

The conversation unique identifier.

last_delivered_date_time class-attribute instance-attribute

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

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

ConversationThreadTriggerResponse dataclass

ConversationThreadTriggerResponse(*, id: Optional[str] = None, posts: Optional[List[PostTriggerResponse | Mapping[str, Any]]] = None)

Definition: ConversationThreadTriggerResponse

Attributes

id class-attribute instance-attribute

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

The conversation thread's unique identifier.

PostTriggerResponse dataclass

PostTriggerResponse(*, id: Optional[str] = None, last_modified_date_time: Optional[str] = None, change_key: Optional[str] = None)

Definition: PostTriggerResponse

Attributes

id class-attribute instance-attribute

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

The post's unique identifier.

change_key class-attribute instance-attribute

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

Identifies the version of the post.

Office365groupsmailClient

Office365groupsmailClient(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 office365groupsmail connector.

Initialize a Office365groupsmailClient.

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:

list_conversations

list_conversations(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 the conversations of a group

Get all the conversations in this group.

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

Swagger operation ID: ListConversations.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group 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.

create_conversation async

create_conversation(input: CreateConversationBody | 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 new conversation in a group

Create a new conversation in this group.

Swagger operation ID: CreateConversation.

Parameters:

Name	Type	Description	Default
input	CreateConversationBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Pick a group from the drop down or enter group 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_group_conversation async

get_group_conversation(group_id: str, conversation_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 group conversation

Retrieves the properties of a particular conversation.

Swagger operation ID: GetGroupConversation.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group id.	required
conversation_id	str	Enter the conversation 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_conversation_threads

list_conversation_threads(group_id: str, conversation_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 conversation threads of a conversation

Get all the threads in a group conversation.

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

Swagger operation ID: ListConversationThreads.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group id.	required
conversation_id	str	Enter the conversation 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.

create_conversation_thread async

create_conversation_thread(input: CreateConversationBody | Mapping[str, Any], group_id: str, conversation_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 conversation thread

Create a new thread in the specified conversation.

Swagger operation ID: CreateConversationThread.

Parameters:

Name	Type	Description	Default
input	CreateConversationBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Pick a group from the drop down or enter group id.	required
conversation_id	str	Enter the conversation 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_group_threads

list_group_threads(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 the threads of a group

Get all the threads of a group.

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

Swagger operation ID: ListGroupThreads.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group 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.

create_group_thread async

create_group_thread(input: CreateConversationBody | 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

Start a new group conversation by creating a thread

Start a new group conversation by first creating a thread.

Swagger operation ID: CreateGroupThread.

Parameters:

Name	Type	Description	Default
input	CreateConversationBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Pick a group from the drop down or enter group 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_conversation_thread async

get_conversation_thread(group_id: str, thread_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 conversation thread

Get a specific thread that belongs to a group.

Swagger operation ID: GetConversationThread.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group id.	required
thread_id	str	Enter the conversation thread 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.

delete_conversation_thread async

delete_conversation_thread(group_id: str, thread_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 conversation thread

Deletes the specified conversation thread.

Swagger operation ID: DeleteConversationThread.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group id.	required
thread_id	str	Enter the conversation thread 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.

list_thread_posts

list_thread_posts(group_id: str, thread_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 posts of a conversation thread

Get all the posts of the specified conversation thread.

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

Swagger operation ID: ListThreadPosts.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group id.	required
thread_id	str	Enter the conversation thread 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_thread async

get_thread(group_id: str, thread_id: str, post_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 thread post

Retrieves a post in a specified thread.

Swagger operation ID: GetThreadPost.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group id.	required
thread_id	str	Enter the conversation thread ID.	required
post_id	str	Enter the post 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_attachments

list_attachments(group_id: str, thread_id: str, post_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 attachments of a post

Retrieve a list of attachments that belong to a post.

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

Swagger operation ID: GetAttachments.

Parameters:

Name	Type	Description	Default
group_id	str	Pick a group from the drop down or enter group id.	required
thread_id	str	Enter the conversation thread ID.	required
post_id	str	Enter the post 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.

reply_to_a_thread async

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

Reply to a conversation thread

Reply to a thread in a group conversation and add a new post to it.

Swagger operation ID: ReplyToAThread.

Parameters:

Name	Type	Description	Default
input	ReplyConversationThreadBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Pick a group from the drop down or enter group id.	required
thread_id	str	Enter the conversation thread 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.

reply async

reply(input: ReplyConversationThreadBody | Mapping[str, Any], group_id: str, thread_id: str, post_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Reply to a post

Reply to a post and add a new post to the specified thread in a group conversation.

Swagger operation ID: ReplyPost.

Parameters:

Name	Type	Description	Default
input	ReplyConversationThreadBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_id	str	Pick a group from the drop down or enter group id.	required
thread_id	str	Enter the conversation thread ID.	required
post_id	str	Enter the post 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.

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 an HTTP request

Construct a Microsoft Graph REST API request to invoke. 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.

forward async

forward(input: ForwardPostBody | Mapping[str, Any], group_mail: str, conversation_id: str, thread_id: str, post_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Forward a post

Forward a post to a recipient.

Swagger operation ID: ForwardPost_V2.

Parameters:

Name	Type	Description	Default
input	ForwardPostBody | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
group_mail	str	Pick a group from the drop down or enter the group mail address.	required
conversation_id	str	Enter the conversation ID.	required
thread_id	str	Enter the conversation thread ID.	required
post_id	str	Enter the post 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.

list_groups

list_groups(*, 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 user groups

Retrieves all Office 365 Groups the user is part of.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListGroups.

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.