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

microsoft_agents/activity/teams/message_actions_payload_mention.py

@@ -0,0 +1,23 @@
+# 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_from import MessageActionsPayloadFrom
+
+
+class MessageActionsPayloadMention(AgentsModel):
+    """Represents the entity that was mentioned in the message.
+
+    :param id: The id of the mentioned entity.
+    :type id: Optional[int]
+    :param mention_text: The plaintext display name of the mentioned entity.
+    :type mention_text: Optional[str]
+    :param mentioned: Provides more details on the mentioned entity.
+    :type mentioned: Optional["MessageActionsPayloadFrom"]
+    """
+
+    id: Optional[int]
+    mention_text: Optional[str]
+    mentioned: Optional[MessageActionsPayloadFrom]

microsoft_agents/activity/teams/message_actions_payload_reaction.py

@@ -0,0 +1,23 @@
+# 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_from import MessageActionsPayloadFrom
+
+
+class MessageActionsPayloadReaction(AgentsModel):
+    """Represents the reaction of a user to a message.
+
+    :param reaction_type: The type of reaction given to the message. Possible values include: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry'
+    :type reaction_type: Optional[str]
+    :param created_date_time: Timestamp of when the user reacted to the message.
+    :type created_date_time: Optional[str]
+    :param user: The user with which the reaction is associated.
+    :type user: Optional["MessageActionsPayloadFrom"]
+    """
+
+    reaction_type: Optional[str]
+    created_date_time: Optional[str]
+    user: Optional[MessageActionsPayloadFrom]

microsoft_agents/activity/teams/message_actions_payload_user.py

@@ -0,0 +1,27 @@
+# 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 MessageActionsPayloadUser(AgentsModel):
+    """Represents a user entity.
+
+    :param user_identity_type: The identity type of the user. Possible values include: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser'
+    :type user_identity_type: Optional[str]
+    :param id: The id of the user.
+    :type id: Optional[str]
+    :param display_name: The plaintext display name of the user.
+    :type display_name: Optional[str]
+    """
+
+    user_identity_type: Optional[
+        Annotated[
+            str,
+            Field(pattern=r"^(aadUser|onPremiseAadUser|anonymousGuest|federatedUser)$"),
+        ]
+    ]
+    id: Optional[str]
+    display_name: Optional[str]

microsoft_agents/activity/teams/messaging_extension_action.py

@@ -0,0 +1,37 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Any, List
+
+from .task_module_request_context import TaskModuleRequestContext
+from .message_actions_payload import MessageActionsPayload
+from ..activity import Activity
+
+
+class MessagingExtensionAction(AgentsModel):
+    """Messaging extension action.
+
+    :param data: User input data. Free payload with key-value pairs.
+    :type data: object
+    :param context: Current user context, i.e., the current theme
+    :type context: TaskModuleRequestContext
+    :param command_id: Id of the command assigned by Bot
+    :type command_id: str
+    :param command_context: The context from which the command originates. Possible values include: 'message', 'compose', 'commandbox'
+    :type command_context: str
+    :param bot_message_preview_action: Bot message preview action taken by user. Possible values include: 'edit', 'send'
+    :type bot_message_preview_action: str
+    :param bot_activity_preview: List of bot activity previews.
+    :type bot_activity_preview: List[Activity]
+    :param message_payload: Message content sent as part of the command request.
+    :type message_payload: MessageActionsPayload
+    """
+
+    data: object = None
+    context: TaskModuleRequestContext = None
+    command_id: str = None
+    command_context: str = None
+    bot_message_preview_action: str = None
+    bot_activity_preview: List[Activity] = None
+    message_payload: MessageActionsPayload = None

microsoft_agents/activity/teams/messaging_extension_action_response.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+from .task_module_response_base import TaskModuleResponseBase
+from .messaging_extension_result import MessagingExtensionResult
+from .cache_info import CacheInfo
+
+
+class MessagingExtensionActionResponse(AgentsModel):
+    """Response of messaging extension action.
+
+    :param task: The JSON for the Adaptive card to appear in the task module.
+    :type task: "TaskModuleResponseBase"
+    :param compose_extension: The compose extension result.
+    :type compose_extension: "MessagingExtensionResult"
+    :param cache_info: CacheInfo for this MessagingExtensionActionResponse.
+    :type cache_info: "CacheInfo"
+    """
+
+    task: TaskModuleResponseBase = None
+    compose_extension: MessagingExtensionResult = None
+    cache_info: CacheInfo = None

microsoft_agents/activity/teams/messaging_extension_attachment.py

@@ -0,0 +1,32 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+
+from ..attachment import Attachment
+
+
+class MessagingExtensionAttachment(AgentsModel):
+    """Messaging extension attachment.
+
+    :param content_type: mimetype/Contenttype for the file
+    :type content_type: str
+    :param content_url: Content Url
+    :type content_url: str
+    :param content: Embedded content
+    :type content: object
+    :param name: (OPTIONAL) The name of the attachment
+    :type name: str
+    :param thumbnail_url: (OPTIONAL) Thumbnail associated with attachment
+    :type thumbnail_url: str
+    :param preview: Preview attachment
+    :type preview: "Attachment"
+    """
+
+    content_type: str
+    content_url: str
+    content: object = None
+    name: Optional[str] = None
+    thumbnail_url: Optional[str] = None
+    preview: Attachment = None

microsoft_agents/activity/teams/messaging_extension_parameter.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class MessagingExtensionParameter(AgentsModel):
+    """Messaging extension query parameters.
+
+    :param name: Name of the parameter
+    :type name: str
+    :param value: Value of the parameter
+    :type value: Any
+    """
+
+    name: str = None
+    value: object = None

microsoft_agents/activity/teams/messaging_extension_query.py

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List, Optional
+
+from .messaging_extension_parameter import MessagingExtensionParameter
+from .messaging_extension_query_options import MessagingExtensionQueryOptions
+
+
+class MessagingExtensionQuery(AgentsModel):
+    """Messaging extension query.
+
+    :param command_id: Id of the command assigned by Bot
+    :type command_id: str
+    :param parameters: Parameters for the query
+    :type parameters: List["MessagingExtensionParameter"]
+    :param query_options: Query options for the extension
+    :type query_options: Optional["MessagingExtensionQueryOptions"]
+    :param state: State parameter passed back to the bot after authentication/configuration flow
+    :type state: str
+    """
+
+    command_id: str = None
+    parameters: List[MessagingExtensionParameter] = None
+    query_options: Optional[MessagingExtensionQueryOptions] = None
+    state: str = None

microsoft_agents/activity/teams/messaging_extension_query_options.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class MessagingExtensionQueryOptions(AgentsModel):
+    """Messaging extension query options.
+
+    :param skip: Number of entities to skip
+    :type skip: int
+    :param count: Number of entities to fetch
+    :type count: int
+    """
+
+    skip: int = None
+    count: int = None

microsoft_agents/activity/teams/messaging_extension_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 Optional
+
+from .messaging_extension_result import MessagingExtensionResult
+from .cache_info import CacheInfo
+
+
+class MessagingExtensionResponse(AgentsModel):
+    """Messaging extension response.
+
+    :param compose_extension: The compose extension result.
+    :type compose_extension: Optional["MessagingExtensionResult"]
+    :param cache_info: CacheInfo for this MessagingExtensionResponse.
+    :type cache_info: Optional["CacheInfo"]
+    """
+
+    compose_extension: Optional[MessagingExtensionResult] = None
+    cache_info: Optional[CacheInfo] = None

microsoft_agents/activity/teams/messaging_extension_result.py

@@ -0,0 +1,34 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List, Optional
+
+from .messaging_extension_attachment import MessagingExtensionAttachment
+from .messaging_extension_suggested_action import MessagingExtensionSuggestedAction
+from ..activity import Activity
+
+
+class MessagingExtensionResult(AgentsModel):
+    """Messaging extension result.
+
+    :param attachment_layout: Hint for how to deal with multiple attachments.
+    :type attachment_layout: str
+    :param type: The type of the result. Possible values include: 'result', 'auth', 'config', 'message', 'botMessagePreview'
+    :type type: str
+    :param attachments: (Only when type is result) Attachments
+    :type attachments: List["MessagingExtensionAttachment"]
+    :param suggested_actions: Suggested actions for the result.
+    :type suggested_actions: Optional["MessagingExtensionSuggestedAction"]
+    :param text: (Only when type is message) Text
+    :type text: Optional[str]
+    :param activity_preview: (Only when type is botMessagePreview) Message activity to preview
+    :type activity_preview: Optional["Activity"]
+    """
+
+    attachment_layout: str = None
+    type: str = None
+    attachments: List[MessagingExtensionAttachment] = None
+    suggested_actions: Optional[MessagingExtensionSuggestedAction] = None
+    text: Optional[str] = None
+    activity_preview: Optional["Activity"] = None

microsoft_agents/activity/teams/messaging_extension_suggested_action.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 ..card_action import CardAction
+
+
+class MessagingExtensionSuggestedAction(AgentsModel):
+    """Messaging extension suggested actions.
+
+    :param actions: List of suggested actions.
+    :type actions: List["CardAction"]
+    """
+
+    actions: List[CardAction] = None

microsoft_agents/activity/teams/notification_info.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 NotificationInfo(AgentsModel):
+    """Specifies if a notification is to be sent for the mentions.
+
+    :param alert: True if notification is to be sent to the user, false otherwise.
+    :type alert: bool
+    :param alert_in_meeting: True if notification is to be sent in a meeting context.
+    :type alert_in_meeting: Optional[bool]
+    :param external_resource_url: URL for external resources related to the notification.
+    :type external_resource_url: Optional[str]
+    """
+
+    alert: bool = None
+    alert_in_meeting: Optional[bool] = None
+    external_resource_url: Optional[str] = None

microsoft_agents/activity/teams/o365_connector_card.py

@@ -0,0 +1,32 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List, Optional
+from .o365_connector_card_section import O365ConnectorCardSection
+from .o365_connector_card_action_base import O365ConnectorCardActionBase
+
+
+class O365ConnectorCard(AgentsModel):
+    """O365 connector card.
+
+    :param title: Title of the item
+    :type title: str
+    :param text: Text for the card
+    :type text: Optional[str]
+    :param summary: Summary for the card
+    :type summary: Optional[str]
+    :param theme_color: Theme color for the card
+    :type theme_color: Optional[str]
+    :param sections: Set of sections for the current card
+    :type sections: Optional[List["O365ConnectorCardSection"]]
+    :param potential_action: Set of actions for the current card
+    :type potential_action: Optional[List["O365ConnectorCardActionBase"]]
+    """
+
+    title: str = None
+    text: Optional[str] = None
+    summary: Optional[str] = None
+    theme_color: Optional[str] = None
+    sections: Optional[List[O365ConnectorCardSection]] = None
+    potential_action: Optional[List[O365ConnectorCardActionBase]] = None

microsoft_agents/activity/teams/o365_connector_card_action_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 O365ConnectorCardActionBase(AgentsModel):
+    """O365 connector card action base.
+
+    :param type: Type of the action. Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard'
+    :type type: str
+    :param name: Name of the action that will be used as button title
+    :type name: str
+    :param id: Action Id
+    :type id: str
+    """
+
+    type: str = Field(None, alias="@type")
+    name: str = None
+    id: str = Field(None, alias="@id")

microsoft_agents/activity/teams/o365_connector_card_action_card.py

@@ -0,0 +1,30 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+from typing import List
+from .o365_connector_card_input_base import O365ConnectorCardInputBase
+from .o365_connector_card_action_base import O365ConnectorCardActionBase
+
+
+class O365ConnectorCardActionCard(AgentsModel):
+    """O365 connector card ActionCard action.
+
+    :param type: Type of the action. Possible values include: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard'
+    :type type: str
+    :param name: Name of the action that will be used as button title
+    :type name: str
+    :param id: Action Id
+    :type id: str
+    :param inputs: Set of inputs contained in this ActionCard
+    :type inputs: List["O365ConnectorCardInputBase"]
+    :param actions: Set of actions contained in this ActionCard
+    :type actions: List["O365ConnectorCardActionBase"]
+    """
+
+    type: str = Field(None, alias="@type")
+    name: str = None
+    id: str = Field(None, alias="@id")
+    inputs: List[O365ConnectorCardInputBase] = None
+    actions: List[O365ConnectorCardActionBase] = None

microsoft_agents/activity/teams/o365_connector_card_action_query.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class O365ConnectorCardActionQuery(AgentsModel):
+    """O365 connector card action query.
+
+    :param body: Body of the action query.
+    :type body: str
+    """
+
+    body: str = None
+    action_id: str = None

microsoft_agents/activity/teams/o365_connector_card_date_input.py

@@ -0,0 +1,30 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+
+
+class O365ConnectorCardDateInput(AgentsModel):
+    """O365 connector card date input.
+
+    :param type: Input type name. Possible values include: 'textInput', 'dateInput', 'multichoiceInput'
+    :type type: str
+    :param id: Input Id. It must be unique per entire O365 connector card.
+    :type id: str
+    :param is_required: Define if this input is a required field. Default value is false.
+    :type is_required: bool
+    :param title: Input title that will be shown as the placeholder
+    :type title: str
+    :param value: Default value for this input field
+    :type value: str
+    :param include_time: Include time input field. Default value is false (date only).
+    :type include_time: bool
+    """
+
+    type: str = Field(None, alias="@type")
+    id: str = None
+    is_required: bool = None
+    title: str = None
+    value: str = None
+    include_time: bool = None

microsoft_agents/activity/teams/o365_connector_card_fact.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class O365ConnectorCardFact(AgentsModel):
+    """O365 connector card fact.
+
+    :param name: Display name of the fact
+    :type name: str
+    :param value: Display value for the fact
+    :type value: str
+    """
+
+    name: str = None
+    value: str = None

microsoft_agents/activity/teams/o365_connector_card_http_post.py

@@ -0,0 +1,25 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class O365ConnectorCardHttpPOST(AgentsModel):
+    """O365 connector card HttpPOST action.
+
+    :param type: Type of the action. Default is 'HttpPOST'.
+    :type type: str
+    :param name: Name of the HttpPOST action.
+    :type name: str
+    :param id: Id of the HttpPOST action.
+    :type id: str
+    :param body: Content of the HttpPOST action.
+    :type body: Optional[str]
+    """
+
+    type: str = Field(None, alias="@type")
+    name: str = None
+    id: str = Field(None, alias="@id")
+    body: Optional[str] = None

microsoft_agents/activity/teams/o365_connector_card_image.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 O365ConnectorCardImage(AgentsModel):
+    """O365 connector card image.
+
+    :param image: URL for the image.
+    :type image: str
+    :param title: Title of the image.
+    :type title: Optional[str]
+    """
+
+    image: str = None
+    title: Optional[str] = None

microsoft_agents/activity/teams/o365_connector_card_input_base.py

@@ -0,0 +1,28 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+from typing import Optional
+
+
+class O365ConnectorCardInputBase(AgentsModel):
+    """Base class for O365 connector card inputs.
+
+    :param type: Input type name. Possible values include: 'textInput', 'dateInput', 'multichoiceInput'
+    :type type: str
+    :param id: Input Id. It must be unique per entire O365 connector card.
+    :type id: str
+    :param is_required: Define if this input is a required field. Default value is false.
+    :type is_required: Optional[bool]
+    :param title: Input title that will be shown as the placeholder
+    :type title: Optional[str]
+    :param value: Default value for this input field
+    :type value: Optional[str]
+    """
+
+    type: str = Field(None, alias="@type")
+    id: str = None
+    is_required: Optional[bool] = None
+    title: Optional[str] = None
+    value: Optional[str] = None

microsoft_agents/activity/teams/o365_connector_card_multichoice_input.py

@@ -0,0 +1,40 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+from typing import List, Optional
+from .o365_connector_card_multichoice_input_choice import (
+    O365ConnectorCardMultichoiceInputChoice,
+)
+
+
+class O365ConnectorCardMultichoiceInput(AgentsModel):
+    """O365 connector card multichoice input.
+
+    :param type: Input type name. Default is 'multichoiceInput'.
+    :type type: str
+    :param id: Input Id. It must be unique per entire O365 connector card.
+    :type id: str
+    :param is_required: Define if this input is a required field. Default value is false.
+    :type is_required: Optional[bool]
+    :param title: Input title that will be shown as the placeholder
+    :type title: Optional[str]
+    :param value: Default value for this input field
+    :type value: Optional[str]
+    :param choices: Set of choices for this input field.
+    :type choices: List["O365ConnectorCardMultichoiceInputChoice"]
+    :param style: Choice style. Possible values include: 'compact', 'expanded'
+    :type style: Optional[str]
+    :param is_multi_select: Define if this input field allows multiple selections. Default value is false.
+    :type is_multi_select: Optional[bool]
+    """
+
+    type: str = Field(None, alias="@type")
+    id: str = None
+    is_required: Optional[bool] = None
+    title: Optional[str] = None
+    value: Optional[str] = None
+    choices: List[O365ConnectorCardMultichoiceInputChoice] = None
+    style: Optional[str] = None
+    is_multi_select: Optional[bool] = None

microsoft_agents/activity/teams/o365_connector_card_multichoice_input_choice.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class O365ConnectorCardMultichoiceInputChoice(AgentsModel):
+    """O365 connector card multichoice input choice.
+
+    :param display: Display text for the choice.
+    :type display: str
+    :param value: Value for the choice.
+    :type value: str
+    """
+
+    display: str = None
+    value: str = None

microsoft_agents/activity/teams/o365_connector_card_open_uri.py

@@ -0,0 +1,26 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+from ..agents_model import AgentsModel
+from typing import List
+from .o365_connector_card_open_uri_target import O365ConnectorCardOpenUriTarget
+
+
+class O365ConnectorCardOpenUri(AgentsModel):
+    """O365 connector card OpenUri action.
+
+    :param type: Type of the action. Default is 'OpenUri'.
+    :type type: str
+    :param name: Name of the OpenUri action.
+    :type name: str
+    :param id: Id of the OpenUri action.
+    :type id: str
+    :param targets: List of targets for the OpenUri action.
+    :type targets: List["O365ConnectorCardOpenUriTarget"]
+    """
+
+    type: str = Field(None, alias="@type")
+    name: str = None
+    id: str = Field(None, alias="@id")
+    targets: List[O365ConnectorCardOpenUriTarget] = None

microsoft_agents/activity/teams/o365_connector_card_open_uri_target.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class O365ConnectorCardOpenUriTarget(AgentsModel):
+    """O365 connector card OpenUri target.
+
+    :param os: Target operating system. Possible values include: 'default', 'iOS', 'android', 'windows'
+    :type os: str
+    :param uri: Target URI.
+    :type uri: str
+    """
+
+    os: str = None
+    uri: str = None