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

microsoft_agents/activity/teams/o365_connector_card_section.py

@@ -0,0 +1,42 @@
+# 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_fact import O365ConnectorCardFact
+from .o365_connector_card_image import O365ConnectorCardImage
+from .o365_connector_card_action_base import O365ConnectorCardActionBase
+
+
+class O365ConnectorCardSection(AgentsModel):
+    """O365 connector card section.
+
+    :param title: Title of the section.
+    :type title: Optional[str]
+    :param text: Text for the section.
+    :type text: Optional[str]
+    :param activity_title: Activity title.
+    :type activity_title: Optional[str]
+    :param activity_subtitle: Activity subtitle.
+    :type activity_subtitle: Optional[str]
+    :param activity_image: Activity image URL.
+    :type activity_image: Optional[str]
+    :param activity_text: Activity text.
+    :type activity_text: Optional[str]
+    :param facts: List of facts for the section.
+    :type facts: Optional[List["O365ConnectorCardFact"]]
+    :param images: List of images for the section.
+    :type images: Optional[List["O365ConnectorCardImage"]]
+    :param potential_action: List of actions for the section.
+    :type potential_action: Optional[List["O365ConnectorCardActionBase"]]
+    """
+
+    title: Optional[str] = None
+    text: Optional[str] = None
+    activity_title: Optional[str] = None
+    activity_subtitle: Optional[str] = None
+    activity_image: Optional[str] = None
+    activity_text: Optional[str] = None
+    facts: Optional[List[O365ConnectorCardFact]] = None
+    images: Optional[List[O365ConnectorCardImage]] = None
+    potential_action: Optional[List[O365ConnectorCardActionBase]] = None

microsoft_agents/activity/teams/o365_connector_card_text_input.py

@@ -0,0 +1,31 @@
+# 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 O365ConnectorCardTextInput(AgentsModel):
+    """O365 connector card text input.
+
+    :param type: Input type name. Default is 'textInput'.
+    :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 is_multiline: Define if this input field allows multiple lines of text. Default value is false.
+    :type is_multiline: Optional[bool]
+    """
+
+    type: str = Field(None, alias="@type")
+    id: str = None
+    is_required: Optional[bool] = None
+    title: Optional[str] = None
+    value: Optional[str] = None
+    is_multiline: Optional[bool] = None

microsoft_agents/activity/teams/o365_connector_card_view_action.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 O365ConnectorCardViewAction(AgentsModel):
+    """O365 connector card ViewAction action.
+
+    :param type: Type of the action. Default is 'ViewAction'.
+    :type type: str
+    :param name: Name of the ViewAction action.
+    :type name: str
+    :param id: Id of the ViewAction action.
+    :type id: str
+    :param target: Target URL for the ViewAction action.
+    :type target: Optional[str]
+    """
+
+    type: str = Field(None, alias="@type")
+    name: str = None
+    id: str = Field(None, alias="@id")
+    target: Optional[str] = None

microsoft_agents/activity/teams/on_behalf_of.py

@@ -0,0 +1,23 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class OnBehalfOf(AgentsModel):
+    """Specifies the OnBehalfOf entity for meeting notifications.
+
+    :param item_id: The item id of the OnBehalfOf entity.
+    :type item_id: str
+    :param mention_type: The mention type. Default is "person".
+    :type mention_type: str
+    :param display_name: The display name of the OnBehalfOf entity.
+    :type display_name: str
+    :param mri: The MRI of the OnBehalfOf entity.
+    :type mri: str
+    """
+
+    item_id: str = None
+    mention_type: str = None
+    display_name: str = None
+    mri: str = None

microsoft_agents/activity/teams/read_receipt_info.py

@@ -0,0 +1,47 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class ReadReceiptInfo(AgentsModel):
+    """General information about a read receipt.
+
+    :param last_read_message_id: The id of the last read message.
+    :type last_read_message_id: str
+    """
+
+    last_read_message_id: str = None
+
+    @staticmethod
+    def is_message_read(compare_message_id: str, last_read_message_id: str) -> bool:
+        """
+        Helper method useful for determining if a message has been read.
+        This method converts the strings to integers. If the compare_message_id is
+        less than or equal to the last_read_message_id, then the message has been read.
+
+        :param compare_message_id: The id of the message to compare.
+        :param last_read_message_id: The id of the last message read by the user.
+        :return: True if the compare_message_id is less than or equal to the last_read_message_id.
+        """
+        if not compare_message_id or not last_read_message_id:
+            return False
+
+        try:
+            compare_message_id_long = int(compare_message_id)
+            last_read_message_id_long = int(last_read_message_id)
+        except ValueError:
+            return False
+
+        return compare_message_id_long <= last_read_message_id_long
+
+    def is_message_read_instance(self, compare_message_id: str) -> bool:
+        """
+        Helper method useful for determining if a message has been read.
+        If the compare_message_id is less than or equal to the last_read_message_id,
+        then the message has been read.
+
+        :param compare_message_id: The id of the message to compare.
+        :return: True if the compare_message_id is less than or equal to the last_read_message_id.
+        """
+        return self.is_message_read(compare_message_id, self.last_read_message_id)

microsoft_agents/activity/teams/signin_state_verification_query.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class SigninStateVerificationQuery(AgentsModel):
+    """Represents the state verification query for sign-in.
+
+    :param state: The state value used for verification.
+    :type state: str
+    """
+
+    state: str = None

microsoft_agents/activity/teams/surface.py

@@ -0,0 +1,18 @@
+from ..agents_model import AgentsModel
+from enum import Enum
+
+
+class SurfaceType(int, Enum):
+    UNKNOWN = 0
+    MEETING_STAGE = 1
+    MEETING_TAB_ICON = 2
+
+
+class Surface(AgentsModel):
+    """Specifies where the notification will be rendered in the meeting UX.
+
+    :param type: The value indicating where the notification will be rendered in the meeting UX.
+    :type type: SurfaceType
+    """
+
+    type: SurfaceType

microsoft_agents/activity/teams/tab_context.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TabContext(AgentsModel):
+    """Current tab request context, i.e., the current theme.
+
+    :param theme: Gets or sets the current user's theme.
+    :type theme: str
+    """
+
+    theme: str = None

microsoft_agents/activity/teams/tab_entity_context.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TabEntityContext(AgentsModel):
+    """
+    Current TabRequest entity context, or 'tabEntityId'.
+
+    :param tab_entity_id: Gets or sets the entity id of the tab.
+    :type tab_entity_id: str
+    """
+
+    tab_entity_id: str

microsoft_agents/activity/teams/tab_request.py

@@ -0,0 +1,22 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from .tab_entity_context import TabEntityContext
+from .tab_context import TabContext
+
+
+class TabRequest(AgentsModel):
+    """Invoke ('tab/fetch') request value payload.
+
+    :param tab_entity_context: Gets or sets current tab entity request context.
+    :type tab_entity_context: TabEntityContext
+    :param context: Gets or sets current tab entity request context.
+    :type context: TabContext
+    :param state: Gets or sets state, which is the magic code for OAuth Flow.
+    :type state: str
+    """
+
+    tab_entity_context: TabEntityContext = None
+    context: TabContext = None
+    state: str = None

microsoft_agents/activity/teams/tab_response.py

@@ -0,0 +1,16 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+from .tab_response_payload import TabResponsePayload
+
+
+class TabResponse(AgentsModel):
+    """Envelope for Card Tab Response Payload.
+
+    :param tab: Possible values include: 'continue', 'auth' or 'silentAuth'
+    :type type: TabResponsePayload
+    """
+
+    tab: TabResponsePayload = None

microsoft_agents/activity/teams/tab_response_card.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TabResponseCard(AgentsModel):
+    """Envelope for cards for a Tab request.
+
+    :param card: Gets or sets adaptive card for this card tab response.
+    :type card: object
+    """
+
+    card: object = None

microsoft_agents/activity/teams/tab_response_cards.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.from ..agents_model import AgentsModel
+
+from ..agents_model import AgentsModel
+from typing import List
+
+from .tab_response_card import TabResponseCard
+
+
+class TabResponseCards(AgentsModel):
+    """Envelope for cards for a TabResponse.
+
+    :param cards: Gets or sets adaptive card for this card tab response.
+    :type cards: list[TabResponseCard]
+    """
+
+    cards: List[TabResponseCard] = None

microsoft_agents/activity/teams/tab_response_payload.py

@@ -0,0 +1,25 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+from .tab_response_cards import TabResponseCards
+from .tab_suggested_actions import TabSuggestedActions
+
+
+class TabResponsePayload(AgentsModel):
+    """Initializes a new instance of the TabResponsePayload class.
+
+    :param type: Gets or sets choice of action options when responding to the
+     tab/fetch message. Possible values include: 'continue', 'auth' or 'silentAuth'
+    :type type: str
+    :param value: Gets or sets the TabResponseCards when responding to
+     tab/fetch activity with type of 'continue'.
+    :type value: TabResponseCards
+    :param suggested_actions: Gets or sets the Suggested Actions for this card tab.
+    :type suggested_actions: TabSuggestedActions
+    """
+
+    type: str = None
+    value: TabResponseCards = None
+    suggested_actions: TabSuggestedActions = None

microsoft_agents/activity/teams/tab_submit.py

@@ -0,0 +1,23 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from .tab_entity_context import TabEntityContext
+from .tab_context import TabContext
+from .tab_submit_data import TabSubmitData
+
+
+class TabSubmit(AgentsModel):
+    """Initializes a new instance of the TabSubmit class.
+
+    :param tab_entity_context: Gets or sets current tab entity request context.
+    :type tab_entity_context: TabEntityContext
+    :param context: Gets or sets current user context, i.e., the current theme.
+    :type context: TabContext
+    :param data: User input data. Free payload containing properties of key-value pairs.
+    :type data: TabSubmitData
+    """
+
+    tab_entity_context: TabEntityContext = None
+    context: TabContext = None
+    data: TabSubmitData = None

microsoft_agents/activity/teams/tab_submit_data.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TabSubmitData(AgentsModel):
+    """Invoke ('tab/submit') request value payload data.
+
+    :param type: Currently, 'tab/submit'.
+    :type type: str
+    :param properties: Gets or sets properties that are not otherwise defined by the TabSubmit
+     type but that might appear in the serialized REST JSON object.
+    :type properties: object
+    """
+
+    type: str = None
+    properties: object = None

microsoft_agents/activity/teams/tab_suggested_actions.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 TabSuggestedActions(AgentsModel):
+    """Tab SuggestedActions (Only when type is 'auth' or 'silentAuth').
+
+    :param actions: Gets or sets adaptive card for this card tab response.
+    :type actions: list[CardAction]
+    """
+
+    actions: List[CardAction] = None

microsoft_agents/activity/teams/targeted_meeting_notification.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .meeting_notification import MeetingNotification
+from .targeted_meeting_notification_value import TargetedMeetingNotificationValue
+from .meeting_notification_channel_data import MeetingNotificationChannelData
+
+
+class TargetedMeetingNotification(MeetingNotification):
+    """Specifies Teams targeted meeting notification.
+
+    :param value: The value of the TargetedMeetingNotification.
+    :type value: TargetedMeetingNotificationValue
+    :param channel_data: Teams Bot meeting notification channel data.
+    :type channel_data: MeetingNotificationChannelData
+    """
+
+    value: TargetedMeetingNotificationValue = None
+    channel_data: MeetingNotificationChannelData = None

microsoft_agents/activity/teams/targeted_meeting_notification_value.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import List
+from .surface import Surface
+
+
+class TargetedMeetingNotificationValue(AgentsModel):
+    """Specifies the value for targeted meeting notifications.
+
+    :param recipients: List of recipient MRIs for the notification.
+    :type recipients: List[str]
+    :param message: The message content of the notification.
+    :type message: str
+    """
+
+    recipients: List[str] = None
+    surfaces: List[Surface] = None

microsoft_agents/activity/teams/task_module_card_response.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from .tab_response import TabResponse
+
+
+class TaskModuleCardResponse(AgentsModel):
+    """Tab Response to 'task/submit' from a tab.
+
+    :param value: The JSON for the Adaptive cards to appear in the tab.
+    :type value: TabResponse
+    """
+
+    value: TabResponse = None

microsoft_agents/activity/teams/task_module_continue_response.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from typing import Optional
+from .task_module_task_info import TaskModuleTaskInfo
+
+
+class TaskModuleContinueResponse(AgentsModel):
+    """Response to continue a task module.
+
+    :param type: The type of response. Default is 'continue'.
+    :type type: str
+    :param value: The task module task info.
+    :type value: Optional["TaskModuleTaskInfo"]
+    """
+
+    type: str = None
+    value: Optional[TaskModuleTaskInfo] = None

microsoft_agents/activity/teams/task_module_message_response.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 TaskModuleMessageResponse(AgentsModel):
+    """Response to display a message in a task module.
+
+    :param type: The type of response. Default is 'message'.
+    :type type: str
+    :param value: The message to display.
+    :type value: Optional[str]
+    """
+
+    type: str = None
+    value: Optional[str] = None

microsoft_agents/activity/teams/task_module_request.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 Any, Optional
+
+from .task_module_request_context import TaskModuleRequestContext
+from .tab_entity_context import TabEntityContext
+
+
+class TaskModuleRequest(AgentsModel):
+    """Task module invoke request value payload.
+
+    :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: Optional[Any]
+    :param tab_entity_context: Gets or sets current tab request context.
+    :type tab_entity_context: Optional[TabEntityContext]
+    """
+
+    data: Optional[Any]
+    context: Optional[TaskModuleRequestContext]
+    tab_entity_context: Optional[TabEntityContext] = Field(None, alias="tabContext")

microsoft_agents/activity/teams/task_module_request_context.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 TaskModuleRequestContext(AgentsModel):
+    """Context for a task module request.
+
+    :param theme: The current user's theme.
+    :type theme: Optional[str]
+    """
+
+    theme: Optional[str] = None

microsoft_agents/activity/teams/task_module_response.py

@@ -0,0 +1,20 @@
+# 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 .cache_info import CacheInfo
+
+
+class TaskModuleResponse(TaskModuleResponseBase):
+    """Envelope for Task Module Response.
+
+    :param task: The JSON for the Adaptive card to appear in the task module.
+    :task task: ~botframework.connector.teams.models.TaskModuleResponseBase
+    :param cache_info: CacheInfo for this TaskModuleResponse.
+    :task cache_info: ~botframework.connector.teams.models.CacheInfo
+    """
+
+    task: TaskModuleResponseBase = None
+    cache_info: CacheInfo = None

microsoft_agents/activity/teams/task_module_response_base.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from pydantic import ConfigDict
+from ..agents_model import AgentsModel
+
+
+class TaskModuleResponseBase(AgentsModel):
+    """Base class for task module responses.
+
+    :param type: The type of response.
+    :type type: str
+    """
+
+    model_config = ConfigDict(extra="allow")
+
+    type: str = None

microsoft_agents/activity/teams/task_module_task_info.py

@@ -0,0 +1,30 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+from ..attachment import Attachment
+
+
+class TaskModuleTaskInfo(AgentsModel):
+    """Information about a task module task.
+
+    :param title: The title of the task module.
+    :type title: str
+    :param height: The height of the task module.
+    :type height: int
+    :param width: The width of the task module.
+    :type width: int
+    :param url: The URL of the task module.
+    :type url: str
+    :param card: The adaptive card for the task module.
+    :type card: object
+    """
+
+    title: str = None
+    height: object = None
+    width: object = None
+    url: str = None
+    card: Attachment = None
+    fallback_url: str = None
+    completion_bot_id: str = None

microsoft_agents/activity/teams/team_details.py

@@ -0,0 +1,29 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TeamDetails(AgentsModel):
+    """Details related to a team.
+
+    :param id: Unique identifier representing a team
+    :type id: str
+    :param name: Name of team.
+    :type name: str
+    :param aad_group_id: Azure Active Directory (AAD) Group Id for the team.
+    :type aad_group_id: str
+    :param channel_count: The count of channels in the team.
+    :type channel_count: int
+    :param member_count: The count of members in the team.
+    :type member_count: int
+    :param type: The team type
+    :type type: str
+    """
+
+    id: str = None
+    name: str = None
+    aad_group_id: str = None
+    channel_count: int = None
+    member_count: int = None
+    type: str = None

microsoft_agents/activity/teams/team_info.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TeamInfo(AgentsModel):
+    """Describes a team.
+
+    :param id: Unique identifier representing a team
+    :type id: str
+    :param name: Name of team.
+    :type name: str
+    :param aad_group_id: Azure AD Teams group ID.
+    :type aad_group_id: str
+    """
+
+    id: str = None
+    name: str = None
+    aad_group_id: str = None