microsoft-agents-activity 0.7.0.dev0__py3-none-any.whl

microsoft_agents/activity/teams/config_task_response.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+
+from .config_response import ConfigResponse
+from .task_module_response_base import TaskModuleResponseBase
+
+
+class ConfigTaskResponse(ConfigResponse):
+    """Envelope for Config Task Response.
+
+    This class uses TaskModuleResponseBase as the type for the config parameter.
+    """
+
+    config: TaskModuleResponseBase = Field(
+        default_factory=lambda: TaskModuleResponseBase()
+    )

microsoft_agents/activity/teams/conversation_list.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List
+
+from .channel_info import ChannelInfo
+
+
+class ConversationList(AgentsModel):
+    """List of channels under a team.
+
+    :param conversations: List of ChannelInfo objects.
+    :type conversations: List[ChannelInfo]
+    """
+
+    conversations: List[ChannelInfo]

microsoft_agents/activity/teams/file_consent_card.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Any, Optional
+
+
+class FileConsentCard(AgentsModel):
+    """File consent card attachment.
+
+    :param description: File description.
+    :type description: str
+    :param size_in_bytes: Size of the file to be uploaded in Bytes.
+    :type size_in_bytes: Optional[int]
+    :param accept_context: Context sent back to the Bot if user consented to upload.
+    :type accept_context: Any
+    :param decline_context: Context sent back to the Bot if user declined.
+    :type decline_context: Any
+    """
+
+    description: str
+    size_in_bytes: Optional[int]
+    accept_context: Any
+    decline_context: Any

microsoft_agents/activity/teams/file_consent_card_response.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Any, Optional
+
+
+class FileConsentCardResponse(AgentsModel):
+    """Represents the value of the invoke activity sent when the user acts on a file consent card.
+
+    :param action: The action the user took. Possible values include: 'accept', 'decline'
+    :type action: Optional[str]
+    :param context: The context associated with the action.
+    :type context: Optional[Any]
+    :param upload_info: If the user accepted the file, contains information about the file to be uploaded.
+    :type upload_info: Optional[Any]
+    """
+
+    action: Optional[str]
+    context: Optional[Any]
+    upload_info: Optional[Any]

microsoft_agents/activity/teams/file_download_info.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class FileDownloadInfo(AgentsModel):
+    """File download info attachment.
+
+    :param download_url: File download url.
+    :type download_url: str
+    :param unique_id: Unique Id for the file.
+    :type unique_id: str
+    :param file_type: Type of file.
+    :type file_type: str
+    :param etag: ETag for the file.
+    :type etag: Optional[str]
+    """
+
+    download_url: str
+    unique_id: str
+    file_type: str
+    etag: Optional[str]

microsoft_agents/activity/teams/file_info_card.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class FileInfoCard(AgentsModel):
+    """File info card.
+
+    :param unique_id: Unique Id for the file.
+    :type unique_id: str
+    :param file_type: Type of file.
+    :type file_type: str
+    :param etag: ETag for the file.
+    :type etag: Optional[str]
+    """
+
+    unique_id: str
+    file_type: str
+    etag: Optional[str]

microsoft_agents/activity/teams/file_upload_info.py

@@ -0,0 +1,26 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class FileUploadInfo(AgentsModel):
+    """Information about the file to be uploaded.
+
+    :param name: Name of the file.
+    :type name: str
+    :param upload_url: URL to an upload session that the bot can use to set the file contents.
+    :type upload_url: str
+    :param content_url: URL to file.
+    :type content_url: str
+    :param unique_id: ID that uniquely identifies the file.
+    :type unique_id: str
+    :param file_type: Type of the file.
+    :type file_type: str
+    """
+
+    name: str
+    upload_url: str
+    content_url: str
+    unique_id: str
+    file_type: str

microsoft_agents/activity/teams/meeting_details.py

@@ -0,0 +1,23 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class MeetingDetails(AgentsModel):
+    """Specific details of a Teams meeting.
+
+    :param ms_graph_resource_id: The MsGraphResourceId, used specifically for MS Graph API calls.
+    :type ms_graph_resource_id: str
+    :param scheduled_start_time: The meeting's scheduled start time, in UTC.
+    :type scheduled_start_time: str
+    :param scheduled_end_time: The meeting's scheduled end time, in UTC.
+    :type scheduled_end_time: str
+    :param type: The meeting's type.
+    :type type: str
+    """
+
+    ms_graph_resource_id: str = None
+    scheduled_start_time: str = None
+    scheduled_end_time: str = None
+    type: str = None

microsoft_agents/activity/teams/meeting_details_base.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+
+
+class MeetingDetailsBase(AgentsModel):
+    """Specific details of a Teams meeting.
+
+    :param id: The meeting's Id, encoded as a BASE64 string.
+    :type id: str
+    :param join_url: The URL used to join the meeting.
+    :type join_url: str
+    :param title: The title of the meeting.
+    :type title: str
+    """
+
+    id: str = Field(None, alias="uniqueId")
+    join_url: str = None
+    title: str = None

microsoft_agents/activity/teams/meeting_end_event_details.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class MeetingEndEventDetails(AgentsModel):
+    """Specific details of a Teams meeting end event.
+
+    :param end_time: Timestamp for meeting end, in UTC.
+    :type end_time: str
+    """
+
+    end_time: str = None

microsoft_agents/activity/teams/meeting_event_details.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class MeetingEventDetails(AgentsModel):
+    """Base class for Teams meeting start and end events.
+
+    :param meeting_type: The meeting's type.
+    :type meeting_type: str
+    """
+
+    meeting_type: str = None

microsoft_agents/activity/teams/meeting_info.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+from .meeting_details import MeetingDetails
+from .teams_channel_account import TeamsChannelAccount
+from ..conversation_account import ConversationAccount
+
+
+class MeetingInfo(AgentsModel):
+    """General information about a Teams meeting.
+
+    :param details: The specific details of a Teams meeting.
+    :type details: MeetingDetails
+    :param conversation: The Conversation Account for the meeting.
+    :type conversation: ConversationAccount
+    :param organizer: The meeting's organizer details.
+    :type organizer: TeamsChannelAccount
+    """
+
+    details: MeetingDetails = None
+    conversation: ConversationAccount = None
+    organizer: TeamsChannelAccount = None

microsoft_agents/activity/teams/meeting_notification.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .meeting_notification_base import MeetingNotificationBase
+from .targeted_meeting_notification_value import TargetedMeetingNotificationValue
+
+
+class MeetingNotification(MeetingNotificationBase):
+    """Specifies Bot meeting notification including meeting notification value.
+
+    :param value: Teams Bot meeting notification value.
+    :type value: TargetedMeetingNotificationValue
+    """
+
+    value: TargetedMeetingNotificationValue = None

microsoft_agents/activity/teams/meeting_notification_base.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class MeetingNotificationBase(AgentsModel):
+    """Specifies Bot meeting notification base including channel data and type.
+
+    :param type: Type of Bot meeting notification.
+    :type type: str
+    """
+
+    type: str = None

microsoft_agents/activity/teams/meeting_notification_channel_data.py

@@ -0,0 +1,16 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List
+from .on_behalf_of import OnBehalfOf
+
+
+class MeetingNotificationChannelData(AgentsModel):
+    """Specify Teams Bot meeting notification channel data.
+
+    :param on_behalf_of_list: The Teams Bot meeting notification's OnBehalfOf list.
+    :type on_behalf_of_list: list[OnBehalfOf]
+    """
+
+    on_behalf_of_list: List[OnBehalfOf] = None

microsoft_agents/activity/teams/meeting_notification_recipient_failure_info.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class MeetingNotificationRecipientFailureInfo(AgentsModel):
+    """Information regarding failure to notify a recipient of a meeting notification.
+
+    :param recipient_mri: The MRI for a recipient meeting notification failure.
+    :type recipient_mri: str
+    :param error_code: The error code for a meeting notification.
+    :type error_code: str
+    :param failure_reason: The reason why a participant meeting notification failed.
+    :type failure_reason: str
+    """
+
+    recipient_mri: str = None
+    error_code: str = None
+    failure_reason: str = None

microsoft_agents/activity/teams/meeting_notification_response.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List
+from .meeting_notification_recipient_failure_info import (
+    MeetingNotificationRecipientFailureInfo,
+)
+
+
+class MeetingNotificationResponse(AgentsModel):
+    """Specifies Bot meeting notification response.
+
+    Contains list of MeetingNotificationRecipientFailureInfo.
+
+    :param recipients_failure_info: The list of MeetingNotificationRecipientFailureInfo.
+    :type recipients_failure_info: list[MeetingNotificationRecipientFailureInfo]
+    """
+
+    recipients_failure_info: List[MeetingNotificationRecipientFailureInfo] = None

microsoft_agents/activity/teams/meeting_participant_info.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class MeetingParticipantInfo(AgentsModel):
+    """Information about a meeting participant.
+
+    :param role: The role of the participant in the meeting.
+    :type role: str
+    :param in_meeting: Indicates whether the participant is currently in the meeting.
+    :type in_meeting: bool
+    """
+
+    role: str = None
+    in_meeting: bool = None

microsoft_agents/activity/teams/meeting_participants_event_details.py

@@ -0,0 +1,16 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List
+from .teams_meeting_member import TeamsMeetingMember
+
+
+class MeetingParticipantsEventDetails(AgentsModel):
+    """Data about the meeting participants.
+
+    :param members: The members involved in the meeting event.
+    :type members: list[TeamsMeetingMember]
+    """
+
+    members: List[TeamsMeetingMember] = None

microsoft_agents/activity/teams/meeting_stage_surface.py

@@ -0,0 +1,25 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+from .surface import Surface, SurfaceType
+
+
+class ContentType(int, Enum):
+    UNKNOWN = 0
+    TASK = 1
+
+
+class MeetingStageSurface(Surface):
+    """Specifies meeting stage surface.
+
+    :param content_type: The content type of this MeetingStageSurface.
+    :type content_type: ContentType
+    :param content: The content of this MeetingStageSurface.
+    :type content: Any
+    """
+
+    type: SurfaceType = SurfaceType.MEETING_STAGE
+    content_type: ContentType = ContentType.TASK
+    content: object = None

microsoft_agents/activity/teams/meeting_start_event_details.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class MeetingStartEventDetails(AgentsModel):
+    """Specific details of a Teams meeting start event.
+
+    :param start_time: Timestamp for meeting start, in UTC.
+    :type start_time: str
+    """
+
+    start_time: str = None

microsoft_agents/activity/teams/meeting_tab_icon_surface.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .surface import Surface, SurfaceType
+
+
+class MeetingTabIconSurface(Surface):
+    """Specifies meeting tab icon surface.
+
+    :param tab_entity_id: The tab entity Id of this MeetingTabIconSurface.
+    :type tab_entity_id: str
+    """
+
+    type: SurfaceType = SurfaceType.MEETING_TAB_ICON
+    tab_entity_id: str = None

microsoft_agents/activity/teams/message_actions_payload.py

@@ -0,0 +1,70 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+from typing import Annotated, List
+
+from .message_actions_payload_from import MessageActionsPayloadFrom
+from .message_actions_payload_body import MessageActionsPayloadBody
+from .message_actions_payload_attachment import MessageActionsPayloadAttachment
+from .message_actions_payload_mention import MessageActionsPayloadMention
+from .message_actions_payload_reaction import MessageActionsPayloadReaction
+
+
+class MessageActionsPayload(AgentsModel):
+    """Represents the individual message within a chat or channel where a message action is taken.
+
+    :param id: Unique id of the message.
+    :type id: str
+    :param reply_to_id: Id of the parent/root message of the thread.
+    :type reply_to_id: str
+    :param message_type: Type of message - automatically set to message.
+    :type message_type: str
+    :param created_date_time: Timestamp of when the message was created.
+    :type created_date_time: str
+    :param last_modified_date_time: Timestamp of when the message was edited or updated.
+    :type last_modified_date_time: str
+    :param deleted: Indicates whether a message has been soft deleted.
+    :type deleted: bool
+    :param subject: Subject line of the message.
+    :type subject: str
+    :param summary: Summary text of the message that could be used for notifications.
+    :type summary: str
+    :param importance: The importance of the message. Possible values include: 'normal', 'high', 'urgent'
+    :type importance: Annotated[str, Field(pattern=r"^(normal|high|urgent)$")]
+    :param locale: Locale of the message set by the client.
+    :type locale: str
+    :param link_to_message: Link back to the message.
+    :type link_to_message: str
+    :param from_property: Sender of the message.
+    :type from_property: MessageActionsPayloadFrom
+    :param body: Plaintext/HTML representation of the content of the message.
+    :type body: MessageActionsPayloadBody
+    :param attachment_layout: How the attachment(s) are displayed in the message.
+    :type attachment_layout: str
+    :param attachments: Attachments in the message - card, image, file, etc.
+    :type attachments: List[MessageActionsPayloadAttachment]
+    :param mentions: List of entities mentioned in the message.
+    :type mentions: List[MessageActionsPayloadMention]
+    :param reactions: Reactions for the message.
+    :type reactions: List[MessageActionsPayloadReaction]
+    """
+
+    id: str = None
+    reply_to_id: str = None
+    message_type: str = None
+    created_date_time: str = None
+    last_modified_date_time: str = None
+    deleted: bool = None
+    subject: str = None
+    summary: str = None
+    importance: Annotated[str, Field(pattern=r"^(normal|high|urgent)$")] = None
+    locale: str = None
+    link_to_message: str = None
+    from_property: MessageActionsPayloadFrom = None
+    body: MessageActionsPayloadBody = None
+    attachment_layout: str = None
+    attachments: List[MessageActionsPayloadAttachment] = None
+    mentions: List[MessageActionsPayloadMention] = None
+    reactions: List[MessageActionsPayloadReaction] = None

microsoft_agents/activity/teams/message_actions_payload_app.py

@@ -0,0 +1,29 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+from typing import Annotated, Optional
+
+
+class MessageActionsPayloadApp(AgentsModel):
+    """Represents an application entity.
+
+    :param application_identity_type: The type of application. Possible values include: 'aadApplication', 'bot', 'tenantBot', 'office365Connector', 'webhook'
+    :type application_identity_type: Optional[str]
+    :param id: The id of the application.
+    :type id: Optional[str]
+    :param display_name: The plaintext display name of the application.
+    :type display_name: Optional[str]
+    """
+
+    application_identity_type: Optional[
+        Annotated[
+            str,
+            Field(
+                pattern=r"^(aadApplication|bot|tenantBot|office365Connector|webhook)$"
+            ),
+        ]
+    ]
+    id: Optional[str]
+    display_name: Optional[str]

microsoft_agents/activity/teams/message_actions_payload_attachment.py

@@ -0,0 +1,30 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Any, Optional
+
+
+class MessageActionsPayloadAttachment(AgentsModel):
+    """Represents the attachment in a message.
+
+    :param id: The id of the attachment.
+    :type id: Optional[str]
+    :param content_type: The type of the attachment.
+    :type content_type: Optional[str]
+    :param content_url: The url of the attachment, in case of an external link.
+    :type content_url: Optional[str]
+    :param content: The content of the attachment, in case of a code snippet, email, or file.
+    :type content: Optional[Any]
+    :param name: The plaintext display name of the attachment.
+    :type name: Optional[str]
+    :param thumbnail_url: The url of a thumbnail image that might be embedded in the attachment, in case of a card.
+    :type thumbnail_url: Optional[str]
+    """
+
+    id: Optional[str]
+    content_type: Optional[str]
+    content_url: Optional[str]
+    content: Optional[Any]
+    name: Optional[str]
+    thumbnail_url: Optional[str]

microsoft_agents/activity/teams/message_actions_payload_body.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class MessageActionsPayloadBody(AgentsModel):
+    """Plaintext/HTML representation of the content of the message.
+
+    :param content_type: Type of the content. Possible values include: 'html', 'text'
+    :type content_type: str
+    :param content: The content of the body.
+    :type content: str
+    """
+
+    content_type: str = None
+    content: str = None

microsoft_agents/activity/teams/message_actions_payload_conversation.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class MessageActionsPayloadConversation(AgentsModel):
+    """Represents a team or channel entity.
+
+    :param conversation_identity_type: The type of conversation, whether a team or channel.
+    :type conversation_identity_type: str
+    :param id: The id of the team or channel.
+    :type id: str
+    :param display_name: The plaintext display name of the team or channel entity.
+    :type display_name: str
+    """
+
+    conversation_identity_type: str = None
+    id: str = None
+    display_name: str = None

microsoft_agents/activity/teams/message_actions_payload_from.py

@@ -0,0 +1,25 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+from .message_actions_payload_user import MessageActionsPayloadUser
+from .message_actions_payload_app import MessageActionsPayloadApp
+from .message_actions_payload_conversation import MessageActionsPayloadConversation
+
+
+class MessageActionsPayloadFrom(AgentsModel):
+    """Represents a user, application, or conversation type that either sent or was referenced in a message.
+
+    :param user: Represents details of the user.
+    :type user: Optional["MessageActionsPayloadUser"]
+    :param application: Represents details of the app.
+    :type application: Optional["MessageActionsPayloadApp"]
+    :param conversation: Represents details of the conversation.
+    :type conversation: Optional["MessageActionsPayloadConversation"]
+    """
+
+    user: Optional[MessageActionsPayloadUser]
+    application: Optional[MessageActionsPayloadApp]
+    conversation: Optional[MessageActionsPayloadConversation]