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

microsoft_agents/activity/teams/teams_batch_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 TeamsBatchOperationResponse(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/teams_channel_account.py

@@ -0,0 +1,44 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Any
+from pydantic import ConfigDict
+from ..agents_model import AgentsModel
+
+
+class TeamsChannelAccount(AgentsModel):
+    """Teams channel account detailing user Azure Active Directory details.
+
+    :param id: Channel id for the user or bot on this channel (Example: ``joe@smith.com``, or ``@joesmith`` or ``123456``)
+    :type id: str
+    :param name: Display friendly name
+    :type name: str
+    :param given_name: Given name part of the user name.
+    :type given_name: str
+    :param surname: Surname part of the user name.
+    :type surname: str
+    :param email: Email Id of the user.
+    :type email: str
+    :param user_principal_name: Unique user principal name.
+    :type user_principal_name: str
+    :param tenant_id: Tenant Id of the user.
+    :type tenant_id: str
+    :param user_role: User Role of the user.
+    :type user_role: str
+    """
+
+    model_config = ConfigDict(extra="allow")
+
+    id: str = None
+    name: str = None
+    given_name: str = None
+    surname: str = None
+    email: str = None
+    user_principal_name: str = None
+    tenant_id: str = None
+    user_role: str = None
+
+    @property
+    def properties(self) -> dict[str, Any]:
+        """Returns the set of properties that are not None."""
+        return self.model_extra

microsoft_agents/activity/teams/teams_channel_data.py

@@ -0,0 +1,43 @@
+# 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
+from .team_info import TeamInfo
+from .notification_info import NotificationInfo
+from .tenant_info import TenantInfo
+from .teams_meeting_info import TeamsMeetingInfo
+from .teams_channel_data_settings import TeamsChannelDataSettings
+from .on_behalf_of import OnBehalfOf
+
+
+class TeamsChannelData(AgentsModel):
+    """Channel data specific to messages received in Microsoft Teams.
+
+    :param channel: Information about the channel in which the message was sent
+    :type channel: ChannelInfo
+    :param event_type: Type of event.
+    :type event_type: str
+    :param team: Information about the team in which the message was sent
+    :type team: TeamInfo
+    :param notification: Notification settings for the message
+    :type notification: NotificationInfo
+    :param tenant: Information about the tenant in which the message was sent
+    :type tenant: TenantInfo
+    :param meeting: Information about the meeting in which the message was sent
+    :type meeting: TeamsMeetingInfo
+    :param settings: Information about the settings in which the message was sent
+    :type settings: TeamsChannelDataSettings
+    :param on_behalf_of: The OnBehalfOf list for user attribution
+    :type on_behalf_of: List[OnBehalfOf]
+    """
+
+    channel: ChannelInfo = None
+    event_type: str = None
+    team: TeamInfo = None
+    notification: NotificationInfo = None
+    tenant: TenantInfo = None
+    meeting: TeamsMeetingInfo = None
+    settings: TeamsChannelDataSettings = None
+    on_behalf_of: List[OnBehalfOf] = None

microsoft_agents/activity/teams/teams_channel_data_settings.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from .channel_info import ChannelInfo
+
+
+class TeamsChannelDataSettings(AgentsModel):
+    """Represents the settings information for a Teams channel data.
+
+    :param selected_channel: Information about the selected Teams channel.
+    :type selected_channel: ChannelInfo
+    """
+
+    selected_channel: ChannelInfo = None

microsoft_agents/activity/teams/teams_meeting_info.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TeamsMeetingInfo(AgentsModel):
+    """Describes a Teams Meeting.
+
+    :param id: Unique identifier representing a meeting
+    :type id: str
+    """
+
+    id: str = None

microsoft_agents/activity/teams/teams_meeting_member.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+from .teams_channel_account import TeamsChannelAccount
+from .user_meeting_details import UserMeetingDetails
+
+
+class TeamsMeetingMember(AgentsModel):
+    """Data about the meeting participants.
+
+    :param user: The channel user data.
+    :type user: TeamsChannelAccount
+    :param meeting: The user meeting details.
+    :type meeting: UserMeetingDetails
+    """
+
+    user: TeamsChannelAccount = None
+    meeting: UserMeetingDetails = None

microsoft_agents/activity/teams/teams_meeting_participant.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+from .teams_channel_account import TeamsChannelAccount
+from .meeting_participant_info import MeetingParticipantInfo
+from ..conversation_account import ConversationAccount
+
+
+class TeamsMeetingParticipant(AgentsModel):
+    """Teams participant channel account detailing user Azure Active Directory and meeting participant details.
+
+    :param user: Teams Channel Account information for this meeting participant
+    :type user: TeamsChannelAccount
+    :param meeting: Information specific to this participant in the specific meeting.
+    :type meeting: MeetingParticipantInfo
+    :param conversation: Conversation Account for the meeting.
+    :type conversation: ConversationAccount
+    """
+
+    user: TeamsChannelAccount = None
+    meeting: MeetingParticipantInfo = None
+    conversation: ConversationAccount = None

microsoft_agents/activity/teams/teams_member.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TeamsMember(AgentsModel):
+    """Describes a member.
+
+    :param id: Unique identifier representing a member (user or channel).
+    :type id: str
+    """
+
+    id: str = None

microsoft_agents/activity/teams/teams_paged_members_result.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 .teams_channel_account import TeamsChannelAccount
+
+
+class TeamsPagedMembersResult(AgentsModel):
+    """Page of members for Teams.
+
+    :param continuation_token: Paging token
+    :type continuation_token: str
+    :param members: The Teams Channel Accounts.
+    :type members: list[TeamsChannelAccount]
+    """
+
+    continuation_token: str = None
+    members: List[TeamsChannelAccount] = None

microsoft_agents/activity/teams/tenant_info.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class TenantInfo(AgentsModel):
+    """Describes a tenant.
+
+    :param id: Unique identifier representing a tenant
+    :type id: str
+    """
+
+    id: str = None

microsoft_agents/activity/teams/user_meeting_details.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from ..agents_model import AgentsModel
+
+
+class UserMeetingDetails(AgentsModel):
+    """Specific details of a user in a Teams meeting.
+
+    :param role: Role of the participant in the current meeting.
+    :type role: str
+    :param in_meeting: True, if the participant is in the meeting.
+    :type in_meeting: bool
+    """
+
+    role: str = None
+    in_meeting: bool = None

microsoft_agents/activity/text_format_types.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class TextFormatTypes(str, Enum):
+    markdown = "markdown"
+    plain = "plain"
+    xml = "xml"

microsoft_agents/activity/text_highlight.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class TextHighlight(AgentsModel):
+    """Refers to a substring of content within another field.
+
+    :param text: Defines the snippet of text to highlight
+    :type text: str
+    :param occurrence: Occurrence of the text field within the referenced
+     text, if multiple exist.
+    :type occurrence: int
+    """
+
+    text: str
+    occurrence: int

microsoft_agents/activity/thumbnail_card.py

@@ -0,0 +1,33 @@
+# 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 ThumbnailCard(AgentsModel):
+    """A thumbnail card (card with a single, small thumbnail image).
+
+    :param title: Title of the card
+    :type title: str
+    :param subtitle: Subtitle of the card
+    :type subtitle: str
+    :param text: Text for the card
+    :type text: str
+    :param images: Array of images for the card
+    :type images: list[~microsoft_agents.activity.CardImage]
+    :param buttons: Set of actions applicable to the current card
+    :type buttons: list[~microsoft_agents.activity.CardAction]
+    :param tap: This action will be activated when user taps on the card
+     itself
+    :type tap: ~microsoft_agents.activity.CardAction
+    """
+
+    title: NonEmptyString = None
+    subtitle: NonEmptyString = None
+    text: str = None
+    images: list[CardImage] = None
+    buttons: list[CardAction] = None
+    tap: CardAction = None

microsoft_agents/activity/thumbnail_url.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ThumbnailUrl(AgentsModel):
+    """Thumbnail URL.
+
+    :param url: URL pointing to the thumbnail to use for media content
+    :type url: str
+    :param alt: HTML alt text to include on this thumbnail image
+    :type alt: str
+    """
+
+    url: NonEmptyString = None
+    alt: NonEmptyString = None

microsoft_agents/activity/token_exchange_invoke_request.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class TokenExchangeInvokeRequest(AgentsModel):
+    """TokenExchangeInvokeRequest.
+
+    :param id: The id from the OAuthCard.
+    :type id: str
+    :param connection_name: The connection name.
+    :type connection_name: str
+    :param token: The user token that can be exchanged.
+    :type token: str
+    :param properties: Extension data for overflow of properties.
+    :type properties: dict[str, object]
+    """
+
+    id: NonEmptyString = None
+    connection_name: NonEmptyString = None
+    token: NonEmptyString = None
+    properties: dict = None

microsoft_agents/activity/token_exchange_invoke_response.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class TokenExchangeInvokeResponse(AgentsModel):
+    """TokenExchangeInvokeResponse.
+
+    :param id: The id from the OAuthCard.
+    :type id: str
+    :param connection_name: The connection name.
+    :type connection_name: str
+    :param failure_detail: The details of why the token exchange failed.
+    :type failure_detail: str
+    :param properties: Extension data for overflow of properties.
+    :type properties: dict[str, object]
+    """
+
+    id: NonEmptyString = None
+    connection_name: NonEmptyString = None
+    failure_detail: NonEmptyString = None
+    properties: dict = None

microsoft_agents/activity/token_exchange_resource.py

@@ -0,0 +1,16 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+
+from ._type_aliases import NonEmptyString
+
+
+class TokenExchangeResource(AgentsModel):
+    """
+    A type containing information for token exchange.
+    """
+
+    id: NonEmptyString = None
+    uri: NonEmptyString = None
+    provider_id: NonEmptyString = None

microsoft_agents/activity/token_exchange_state.py

@@ -0,0 +1,41 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import base64
+import json
+from typing import Optional
+from pydantic import Field
+
+from .conversation_reference import ConversationReference
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class TokenExchangeState(AgentsModel):
+    """TokenExchangeState
+
+    :param connection_name: The connection name that was used.
+    :type connection_name: str
+    :param conversation: Gets or sets a reference to the conversation.
+    :type conversation: ~microsoft_agents.activity.ConversationReference
+    :param relates_to: Gets or sets a reference to a related parent conversation for this token exchange.
+    :type relates_to: ~microsoft_agents.activity.ConversationReference
+    :param agent_url: The URL of the agent messaging endpoint.
+    :type agent_url: str
+    :param ms_app_id: The agent's registered application ID.
+    :type ms_app_id: str
+    """
+
+    connection_name: NonEmptyString = None
+    conversation: ConversationReference = None
+    relates_to: Optional[ConversationReference] = None
+    agent_url: NonEmptyString = Field(None, alias="bot_url")
+    ms_app_id: NonEmptyString = None
+
+    def get_encoded_state(self) -> str:
+        """Returns the encoded state for the token exchange."""
+        return base64.b64encode(
+            json.dumps(
+                self.model_dump(by_alias=True, exclude_none=True, exclude_unset=True)
+            ).encode(encoding="UTF-8", errors="strict")
+        ).decode()

microsoft_agents/activity/token_or_sign_in_resource_response.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from .token_response import TokenResponse
+from .sign_in_resource import SignInResource
+
+
+class TokenOrSignInResourceResponse(AgentsModel):
+    """Represents the response containing either a token or a sign-in resource.
+
+    One of the two properties should be set (if returned from the 'getTokenOrSignInResource' endpoint), not both.
+
+    :param token_response: The token response.
+    :type token_response: TokenResponse
+    :param sign_in_resource: The sign-in resource.
+    :type sign_in_resource: SignInResource
+    """
+
+    token_response: TokenResponse = None
+    sign_in_resource: SignInResource = None

microsoft_agents/activity/token_post_resource.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+
+from ._type_aliases import NonEmptyString
+
+
+class TokenPostResource(AgentsModel):
+    """
+    A type containing information for token posting.
+    """
+
+    sas_url: NonEmptyString = None

microsoft_agents/activity/token_request.py

@@ -0,0 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class TokenRequest(AgentsModel):
+    """A request to receive a user token.
+
+    :param provider: The provider to request a user token from
+    :type provider: str
+    :param settings: A collection of settings for the specific provider for
+     this request
+    :type settings: dict[str, object]
+    """
+
+    provider: NonEmptyString = None
+    settings: dict = None

microsoft_agents/activity/token_response.py

@@ -0,0 +1,46 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import jwt
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class TokenResponse(AgentsModel):
+    """A response that includes a user token.
+
+    :param connection_name: The connection name
+    :type connection_name: str
+    :param token: The user token
+    :type token: str
+    :param expiration: Expiration for the token, in ISO 8601 format (e.g.
+     "2007-04-05T14:30Z")
+    :type expiration: str
+    :param channel_id: The channelId of the TokenResponse
+    :type channel_id: str
+    """
+
+    connection_name: NonEmptyString = None
+    token: NonEmptyString = None
+    expiration: NonEmptyString = None
+    channel_id: NonEmptyString = None
+
+    def __bool__(self):
+        return bool(self.token)
+
+    def is_exchangeable(self) -> bool:
+        """
+        Checks if a token is exchangeable (has api:// audience).
+
+        :param token: The token to check.
+        :type token: str
+        :return: True if the token is exchangeable, False otherwise.
+        """
+        try:
+            # Decode without verification to check the audience
+            payload = jwt.decode(self.token, options={"verify_signature": False})
+            aud = payload.get("aud")
+            return isinstance(aud, str) and aud.startswith("api://")
+        except Exception:
+            return False

microsoft_agents/activity/token_status.py

@@ -0,0 +1,32 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""Models for token status operations."""
+
+from typing import Optional
+from pydantic import Field
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class TokenStatus(AgentsModel):
+    """
+    The status of a user token.
+
+    :param channel_id: The channelId of the token status pertains to.
+    :type channel_id: str
+    :param connection_name: The name of the connection the token status pertains to.
+    :type connection_name: str
+    :param has_token: True if a token is stored for this ConnectionName.
+    :type has_token: bool
+    :param service_provider_display_name: The display name of the service provider for which this Token belongs to.
+    :type service_provider_display_name: str
+    """
+
+    channel_id: Optional[NonEmptyString] = Field(None, alias="channelId")
+    connection_name: Optional[NonEmptyString] = Field(None, alias="connectionName")
+    has_token: Optional[bool] = Field(None, alias="hasToken")
+    service_provider_display_name: Optional[NonEmptyString] = Field(
+        None, alias="serviceProviderDisplayName"
+    )

microsoft_agents/activity/transcript.py

@@ -0,0 +1,16 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .activity import Activity
+from .agents_model import AgentsModel
+
+
+class Transcript(AgentsModel):
+    """Transcript.
+
+    :param activities: A collection of Activities that conforms to the
+     Transcript schema.
+    :type activities: list[~microsoft_agents.activity.Activity]
+    """
+
+    activities: list[Activity] = None

microsoft_agents/activity/turn_context_protocol.py

@@ -0,0 +1,68 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from __future__ import annotations
+
+from typing import Protocol, List, Callable, Optional, Generic, TypeVar
+from abc import abstractmethod
+
+from microsoft_agents.activity import (
+    Activity,
+    ResourceResponse,
+    ConversationReference,
+)
+
+# TODO: refactor circular dependency
+# from .channel_adapter_protocol import ChannelAdapterProtocol
+
+T = TypeVar("T", bound=Activity)
+
+
+class TurnContextProtocol(Protocol, Generic[T]):
+    adapter: "ChannelAdapterProtocol"
+    activity: Activity | T
+    responded: bool
+    turn_state: dict
+
+    @abstractmethod
+    async def send_activity(
+        self,
+        activity_or_text: Activity | str,
+        speak: Optional[str] = None,
+        input_hint: Optional[str] = None,
+    ) -> Optional[ResourceResponse]:
+        pass
+
+    @abstractmethod
+    async def send_activities(
+        self, activities: List[Activity]
+    ) -> List[ResourceResponse]:
+        pass
+
+    @abstractmethod
+    async def update_activity(self, activity: Activity) -> Optional[ResourceResponse]:
+        pass
+
+    @abstractmethod
+    async def delete_activity(
+        self, id_or_reference: str | ConversationReference
+    ) -> None:
+        pass
+
+    @abstractmethod
+    def on_send_activities(self, handler: Callable) -> "TurnContextProtocol":
+        pass
+
+    @abstractmethod
+    def on_update_activity(self, handler: Callable) -> "TurnContextProtocol":
+        pass
+
+    @abstractmethod
+    def on_delete_activity(self, handler: Callable) -> "TurnContextProtocol":
+        pass
+
+    @abstractmethod
+    async def send_trace_activity(
+        self, name: str, value: object = None, value_type: str = None, label: str = None
+    ) -> ResourceResponse:
+        pass