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

microsoft_agents/activity/paged_members_result.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .channel_account import ChannelAccount
+from ._type_aliases import NonEmptyString
+from .agents_model import AgentsModel
+
+
+class PagedMembersResult(AgentsModel):
+    """Page of members.
+
+    :param continuation_token: Paging token
+    :type continuation_token: str
+    :param members: The Channel Accounts.
+    :type members: list[~microsoft_agents.activity.ChannelAccount]
+    """
+
+    continuation_token: NonEmptyString = None
+    members: list[ChannelAccount] = None

microsoft_agents/activity/receipt_card.py

@@ -0,0 +1,39 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .fact import Fact
+from .receipt_item import ReceiptItem
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ReceiptCard(AgentsModel):
+    """A receipt card.
+
+    :param title: Title of the card
+    :type title: str
+    :param facts: Array of Fact objects
+    :type facts: list[~microsoft_agents.activity.Fact]
+    :param items: Array of Receipt Items
+    :type items: list[~microsoft_agents.activity.ReceiptItem]
+    :param tap: This action will be activated when user taps on the card
+    :type tap: ~microsoft_agents.activity.CardAction
+    :param total: Total amount of money paid (or to be paid)
+    :type total: str
+    :param tax: Total amount of tax paid (or to be paid)
+    :type tax: str
+    :param vat: Total amount of VAT paid (or to be paid)
+    :type vat: str
+    :param buttons: Set of actions applicable to the current card
+    :type buttons: list[~microsoft_agents.activity.CardAction]
+    """
+
+    title: NonEmptyString = None
+    facts: list[Fact] = None
+    items: list[ReceiptItem] = None
+    tap: CardAction = None
+    total: NonEmptyString = None
+    tax: NonEmptyString = None
+    vat: NonEmptyString = None
+    buttons: list[CardAction] = None

microsoft_agents/activity/receipt_item.py

@@ -0,0 +1,38 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .card_image import CardImage
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ReceiptItem(AgentsModel):
+    """An item on a receipt card.
+
+    :param title: Title of the Card
+    :type title: str
+    :param subtitle: Subtitle appears just below Title field, differs from
+     Title in font styling only
+    :type subtitle: str
+    :param text: Text field appears just below subtitle, differs from Subtitle
+     in font styling only
+    :type text: str
+    :param image: Image
+    :type image: ~microsoft_agents.activity.CardImage
+    :param price: Amount with currency
+    :type price: str
+    :param quantity: Number of items of given kind
+    :type quantity: str
+    :param tap: This action will be activated when user taps on the Item
+     bubble.
+    :type tap: ~microsoft_agents.activity.CardAction
+    """
+
+    title: NonEmptyString = None
+    subtitle: NonEmptyString = None
+    text: str = None
+    image: CardImage = None
+    price: NonEmptyString = None
+    quantity: NonEmptyString = None
+    tap: CardAction = None

microsoft_agents/activity/resource_response.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ResourceResponse(AgentsModel):
+    """A response containing a resource ID.
+
+    :param id: Id of the resource
+    :type id: str
+    """
+
+    id: NonEmptyString = None

microsoft_agents/activity/role_types.py

@@ -0,0 +1,12 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class RoleTypes(str, Enum):
+    user = "user"
+    agent = "bot"
+    skill = "skill"
+    agentic_identity = "agenticAppInstance"
+    agentic_user = "agenticUser"

microsoft_agents/activity/semantic_action.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class SemanticAction(AgentsModel):
+    """Represents a reference to a programmatic action.
+
+    :param id: ID of this action
+    :type id: str
+    :param entities: Entities associated with this action
+    :type entities: dict[str, :class:`microsoft_agents.activity.entity.Entity`]
+    :param state: State of this action. Allowed values: `start`, `continue`, `done`
+    :type state: str or :class:`microsoft_agents.activity.semantic_actions_states.SemanticActionsStates`
+    """
+
+    id: NonEmptyString
+    entities: dict = None
+    state: NonEmptyString = None

microsoft_agents/activity/semantic_actions_states.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class SemanticActionsStates(str, Enum):
+    start_action = "start"
+    continue_action = "continue"
+    done_action = "done"

microsoft_agents/activity/sign_in_constants.py

@@ -0,0 +1,13 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class SignInConstants(str, Enum):
+    # Name for the signin invoke to verify the 6-digit authentication code as part of sign-in.
+    verify_state_operation_name = "signin/verifyState"
+    # Name for signin invoke to perform a token exchange.
+    token_exchange_operation_name = "signin/tokenExchange"
+    # The EventActivity name when a token is sent to the agent.
+    token_response_event_name = "tokens/response"

microsoft_agents/activity/sign_in_resource.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ._type_aliases import NonEmptyString
+from .agents_model import AgentsModel
+from .token_exchange_resource import TokenExchangeResource
+from .token_post_resource import TokenPostResource
+
+
+class SignInResource(AgentsModel):
+    """
+    A type containing information for single sign-on.
+    """
+
+    sign_in_link: NonEmptyString = None
+    token_exchange_resource: TokenExchangeResource = None
+    token_post_resource: TokenPostResource = None

microsoft_agents/activity/signin_card.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class SigninCard(AgentsModel):
+    """A card representing a request to sign in.
+
+    :param text: Text for signin request
+    :type text: str
+    :param buttons: Action to use to perform signin
+    :type buttons: list[~microsoft_agents.activity.CardAction]
+    """
+
+    text: str = None
+    buttons: list[CardAction] = None

microsoft_agents/activity/suggested_actions.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class SuggestedActions(AgentsModel):
+    """SuggestedActions that can be performed.
+
+    :param to: Ids of the recipients that the actions should be shown to.
+     These Ids are relative to the channelId and a subset of all recipients of
+     the activity
+    :type to: list[str]
+    :param actions: Actions that can be shown to the user
+    :type actions: list[~microsoft_agents.activity.CardAction]
+    """
+
+    to: list[NonEmptyString]
+    actions: list[CardAction]

microsoft_agents/activity/teams/__init__.py

@@ -0,0 +1,198 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .app_based_link_query import AppBasedLinkQuery
+from .batch_operation_response import BatchOperationResponse
+from .batch_operation_state_response import BatchOperationStateResponse
+from .batch_failed_entries_response import BatchFailedEntriesResponse
+from .cancel_operation_response import CancelOperationResponse
+from .channel_info import ChannelInfo
+from .conversation_list import ConversationList
+from .file_consent_card import FileConsentCard
+from .file_consent_card_response import FileConsentCardResponse
+from .file_download_info import FileDownloadInfo
+from .file_info_card import FileInfoCard
+from .file_upload_info import FileUploadInfo
+from .meeting_details import MeetingDetails
+from .meeting_info import MeetingInfo
+from .meeting_start_event_details import MeetingStartEventDetails
+from .meeting_end_event_details import MeetingEndEventDetails
+from .message_actions_payload import MessageActionsPayload
+from .message_actions_payload_app import MessageActionsPayloadApp
+from .message_actions_payload_attachment import MessageActionsPayloadAttachment
+from .message_actions_payload_body import MessageActionsPayloadBody
+from .message_actions_payload_conversation import MessageActionsPayloadConversation
+from .message_actions_payload_from import MessageActionsPayloadFrom
+from .message_actions_payload_mention import MessageActionsPayloadMention
+from .message_actions_payload_reaction import MessageActionsPayloadReaction
+from .message_actions_payload_user import MessageActionsPayloadUser
+from .messaging_extension_action import MessagingExtensionAction
+from .messaging_extension_action_response import MessagingExtensionActionResponse
+from .messaging_extension_attachment import MessagingExtensionAttachment
+from .messaging_extension_parameter import MessagingExtensionParameter
+from .messaging_extension_query import MessagingExtensionQuery
+from .messaging_extension_query_options import MessagingExtensionQueryOptions
+from .messaging_extension_response import MessagingExtensionResponse
+from .messaging_extension_result import MessagingExtensionResult
+from .messaging_extension_suggested_action import MessagingExtensionSuggestedAction
+from .notification_info import NotificationInfo
+from .o365_connector_card import O365ConnectorCard
+from .o365_connector_card_action_base import O365ConnectorCardActionBase
+from .o365_connector_card_action_card import O365ConnectorCardActionCard
+from .o365_connector_card_action_query import O365ConnectorCardActionQuery
+from .o365_connector_card_date_input import O365ConnectorCardDateInput
+from .o365_connector_card_fact import O365ConnectorCardFact
+from .o365_connector_card_http_post import O365ConnectorCardHttpPOST
+from .o365_connector_card_image import O365ConnectorCardImage
+from .o365_connector_card_input_base import O365ConnectorCardInputBase
+from .o365_connector_card_multichoice_input import O365ConnectorCardMultichoiceInput
+from .o365_connector_card_multichoice_input_choice import (
+    O365ConnectorCardMultichoiceInputChoice,
+)
+from .o365_connector_card_open_uri import O365ConnectorCardOpenUri
+from .o365_connector_card_open_uri_target import O365ConnectorCardOpenUriTarget
+from .o365_connector_card_section import O365ConnectorCardSection
+from .o365_connector_card_text_input import O365ConnectorCardTextInput
+from .o365_connector_card_view_action import O365ConnectorCardViewAction
+from .signin_state_verification_query import SigninStateVerificationQuery
+from .task_module_continue_response import TaskModuleContinueResponse
+from .task_module_message_response import TaskModuleMessageResponse
+from .task_module_request import TaskModuleRequest
+from .task_module_request_context import TaskModuleRequestContext
+from .task_module_response import TaskModuleResponse
+from .task_module_response_base import TaskModuleResponseBase
+from .task_module_task_info import TaskModuleTaskInfo
+from .team_details import TeamDetails
+from .team_info import TeamInfo
+from .teams_channel_account import TeamsChannelAccount
+from .teams_channel_data_settings import TeamsChannelDataSettings
+from .teams_channel_data import TeamsChannelData
+from .teams_member import TeamsMember
+from .teams_paged_members_result import TeamsPagedMembersResult
+from .tenant_info import TenantInfo
+from .teams_meeting_info import TeamsMeetingInfo
+from .teams_meeting_participant import TeamsMeetingParticipant
+from .meeting_participant_info import MeetingParticipantInfo
+from .cache_info import CacheInfo
+from .tab_context import TabContext
+from .tab_entity_context import TabEntityContext
+from .tab_request import TabRequest
+from .tab_response_card import TabResponseCard
+from .tab_response_cards import TabResponseCards
+from .tab_response_payload import TabResponsePayload
+from .tab_response import TabResponse
+from .tab_submit import TabSubmit
+from .tab_submit_data import TabSubmitData
+from .tab_suggested_actions import TabSuggestedActions
+from .task_module_card_response import TaskModuleCardResponse
+from .user_meeting_details import UserMeetingDetails
+from .teams_meeting_member import TeamsMeetingMember
+from .meeting_participants_event_details import MeetingParticipantsEventDetails
+from .read_receipt_info import ReadReceiptInfo
+from .bot_config_auth import BotConfigAuth
+from .config_auth_response import ConfigAuthResponse
+from .config_response import ConfigResponse
+from .config_task_response import ConfigTaskResponse
+from .meeting_notification_base import MeetingNotificationBase
+from .meeting_notification import MeetingNotification
+from .meeting_notification_response import MeetingNotificationResponse
+from .on_behalf_of import OnBehalfOf
+from .teams_batch_operation_response import TeamsBatchOperationResponse
+
+__all__ = [
+    "AppBasedLinkQuery",
+    "BatchOperationResponse",
+    "BatchOperationStateResponse",
+    "BatchFailedEntriesResponse",
+    "CancelOperationResponse",
+    "ChannelInfo",
+    "ConversationList",
+    "FileConsentCard",
+    "FileConsentCardResponse",
+    "FileDownloadInfo",
+    "FileInfoCard",
+    "FileUploadInfo",
+    "MeetingDetails",
+    "MeetingInfo",
+    "MeetingStartEventDetails",
+    "MeetingEndEventDetails",
+    "MessageActionsPayload",
+    "MessageActionsPayloadApp",
+    "MessageActionsPayloadAttachment",
+    "MessageActionsPayloadBody",
+    "MessageActionsPayloadConversation",
+    "MessageActionsPayloadFrom",
+    "MessageActionsPayloadMention",
+    "MessageActionsPayloadReaction",
+    "MessageActionsPayloadUser",
+    "MessagingExtensionAction",
+    "MessagingExtensionActionResponse",
+    "MessagingExtensionAttachment",
+    "MessagingExtensionParameter",
+    "MessagingExtensionQuery",
+    "MessagingExtensionQueryOptions",
+    "MessagingExtensionResponse",
+    "MessagingExtensionResult",
+    "MessagingExtensionSuggestedAction",
+    "NotificationInfo",
+    "O365ConnectorCard",
+    "O365ConnectorCardActionBase",
+    "O365ConnectorCardActionCard",
+    "O365ConnectorCardActionQuery",
+    "O365ConnectorCardDateInput",
+    "O365ConnectorCardFact",
+    "O365ConnectorCardHttpPOST",
+    "O365ConnectorCardImage",
+    "O365ConnectorCardInputBase",
+    "O365ConnectorCardMultichoiceInput",
+    "O365ConnectorCardMultichoiceInputChoice",
+    "O365ConnectorCardOpenUri",
+    "O365ConnectorCardOpenUriTarget",
+    "O365ConnectorCardSection",
+    "O365ConnectorCardTextInput",
+    "O365ConnectorCardViewAction",
+    "SigninStateVerificationQuery",
+    "TaskModuleContinueResponse",
+    "TaskModuleMessageResponse",
+    "TaskModuleRequest",
+    "TaskModuleRequestContext",
+    "TaskModuleResponse",
+    "TaskModuleResponseBase",
+    "TaskModuleTaskInfo",
+    "TeamDetails",
+    "TeamInfo",
+    "TeamsChannelAccount",
+    "TeamsChannelDataSettings",
+    "TeamsChannelData",
+    "TeamsPagedMembersResult",
+    "TenantInfo",
+    "TeamsMember",
+    "TeamsMeetingInfo",
+    "TeamsMeetingParticipant",
+    "MeetingParticipantInfo",
+    "CacheInfo",
+    "TabContext",
+    "TabEntityContext",
+    "TabRequest",
+    "TabResponseCard",
+    "TabResponseCards",
+    "TabResponsePayload",
+    "TabResponse",
+    "TabSubmit",
+    "TabSubmitData",
+    "TabSuggestedActions",
+    "TaskModuleCardResponse",
+    "UserMeetingDetails",
+    "TeamsMeetingMember",
+    "MeetingParticipantsEventDetails",
+    "ReadReceiptInfo",
+    "BotConfigAuth",
+    "ConfigAuthResponse",
+    "ConfigResponse",
+    "ConfigTaskResponse",
+    "MeetingNotificationBase",
+    "MeetingNotification",
+    "MeetingNotificationResponse",
+    "OnBehalfOf",
+    "TeamsBatchOperationResponse",
+]

microsoft_agents/activity/teams/app_based_link_query.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 AppBasedLinkQuery(AgentsModel):
+    """Invoke request body type for app-based link query.
+
+    :param url: Url queried by user
+    :type url: Optional[str]
+    :param state: The magic code for OAuth Flow
+    :type state: Optional[str]
+    """
+
+    url: Optional[str]
+    state: Optional[str]

microsoft_agents/activity/teams/batch_failed_entries_response.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from .batch_failed_entry import BatchFailedEntry
+
+
+class BatchFailedEntriesResponse(AgentsModel):
+    """
+    :param operation_id: Unique identifier of the batch operation.
+    :type operation_id: str
+    """
+
+    continuation_token: str = None
+    failed_entries_responses: list[BatchFailedEntry] = None

microsoft_agents/activity/teams/batch_failed_entry.py

@@ -0,0 +1,16 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class BatchFailedEntry(AgentsModel):
+    """
+    :param id: Unique identifier of the entry in the batch operation.
+    :type id: str
+    :param error: Error message associated with the entry.
+    :type error: str
+    """
+
+    id: str = None
+    error: str = None

microsoft_agents/activity/teams/batch_operation_response.py

@@ -0,0 +1,13 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class BatchOperationResponse(AgentsModel):
+    """
+    :param operation_id: Unique identifier of the batch operation.
+    :type operation_id: str
+    """
+
+    operation_id: str = None

microsoft_agents/activity/teams/batch_operation_state_response.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from datetime import datetime
+from typing import Optional
+from ..agents_model import AgentsModel
+
+
+class BatchOperationStateResponse(AgentsModel):
+    """
+    :param state: The state of the batch operation.
+    :type state: str
+    :param status_map: A map of status codes to their counts.
+    :type status_map: dict[int, int]
+    :param retry_after: The time after which the operation can be retried.
+    :type retry_after: datetime
+    :param total_entries_count: The total number of entries in the batch operation.
+    :type total_entries_count: int
+    """
+
+    state: str = None
+    status_map: dict[int, int] = None
+    retry_after: Optional[datetime] = None
+    total_entries_count: int = None

microsoft_agents/activity/teams/bot_config_auth.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from ..suggested_actions import SuggestedActions
+
+
+class BotConfigAuth(AgentsModel):
+    """Specifies bot config auth, including type and suggestedActions.
+
+    :param type: The type of bot config auth.
+    :type type: str
+    :param suggested_actions: The suggested actions of bot config auth.
+    :type suggested_actions: SuggestedActions
+    """
+
+    type: str = "auth"
+    suggested_actions: SuggestedActions = None

microsoft_agents/activity/teams/cache_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 CacheInfo(AgentsModel):
+    """A cache info object which notifies Teams how long an object should be cached for.
+
+    :param cache_type: Type of Cache Info
+    :type cache_type: Optional[str]
+    :param cache_duration: Duration of the Cached Info.
+    :type cache_duration: Optional[int]
+    """
+
+    cache_type: Optional[str]
+    cache_duration: Optional[int]

microsoft_agents/activity/teams/cancel_operation_response.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .batch_operation_response import BatchOperationResponse
+
+
+class CancelOperationResponse(BatchOperationResponse):
+    """
+    :param operation_id: Unique identifier of the batch operation.
+    :type operation_id: str
+    :param body_as_text: The body of the request as text.
+    :type body_as_text: str
+    :param parsed_body: The parsed body of the request.
+    :type parsed_body: BatchOperationResponse
+    """
+
+    operation_id: str = None
+    body_as_text: str = None
+    parsed_body: BatchOperationResponse = None

microsoft_agents/activity/teams/channel_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 ChannelInfo(AgentsModel):
+    """A channel info object which describes the channel.
+
+    :param id: Unique identifier representing a channel
+    :type id: Optional[str]
+    :param name: Name of the channel
+    :type name: Optional[str]
+    :param type: The channel type
+    :type type: Optional[str]
+    """
+
+    id: Optional[str] = None
+    name: Optional[str] = None
+    type: Optional[str] = None

microsoft_agents/activity/teams/config_auth_response.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import Field
+
+from .config_response import ConfigResponse
+from .bot_config_auth import BotConfigAuth
+
+
+class ConfigAuthResponse(ConfigResponse):
+    """Response for configuration authentication.
+
+    :param suggested_actions: Suggested actions for the configuration authentication.
+    :type suggested_actions: object
+    """
+
+    config: BotConfigAuth = Field(default_factory=lambda: BotConfigAuth())

microsoft_agents/activity/teams/config_response.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .config_response_base import ConfigResponseBase
+from .cache_info import CacheInfo
+
+
+class ConfigResponse(ConfigResponseBase):
+    """Envelope for Config Response Payload.
+
+    :param config: The response to the config message. Possible values: 'auth', 'task'
+    :type config: object
+    :param cache_info: Response cache info
+    :type cache_info: CacheInfo
+    """
+
+    config: object = None
+    cache_info: CacheInfo = None

microsoft_agents/activity/teams/config_response_base.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class ConfigResponseBase(AgentsModel):
+    """Specifies Invoke response base, including response type.
+
+    :param response_type: Response type for invoke request
+    :type response_type: str
+    """
+
+    response_type: str = None