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

microsoft_agents/activity/entity/entity.py

@@ -0,0 +1,41 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Any
+
+from pydantic import model_serializer, model_validator
+from pydantic.alias_generators import to_camel, to_snake
+
+from ..agents_model import AgentsModel, ConfigDict
+
+
+class Entity(AgentsModel):
+    """Metadata object pertaining to an activity.
+
+    :param type: Type of this entity (RFC 3987 IRI)
+    :type type: str
+    """
+
+    model_config = ConfigDict(extra="allow")
+
+    type: str
+
+    @property
+    def additional_properties(self) -> dict[str, Any]:
+        """Returns the set of properties that are not None."""
+        return self.model_extra
+
+    @model_validator(mode="before")
+    @classmethod
+    def to_snake_for_all(cls, data):
+        ret = {to_snake(k): v for k, v in data.items()}
+        return ret
+
+    @model_serializer(mode="plain")
+    def to_camel_for_all(self, config):
+        if config.by_alias:
+            new_data = {}
+            for k, v in self:
+                new_data[to_camel(k)] = v
+            return new_data
+        return {k: v for k, v in self}

microsoft_agents/activity/entity/entity_types.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class EntityTypes(str, Enum):
+    """Well-known enumeration of entity types."""
+
+    GEO_COORDINATES = "GeoCoordinates"
+    MENTION = "mention"
+    PLACE = "Place"
+    THING = "Thing"
+    PRODUCT_INFO = "ProductInfo"

microsoft_agents/activity/entity/geo_coordinates.py

@@ -0,0 +1,33 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
+from .._type_aliases import NonEmptyString
+from .entity import Entity
+from .entity_types import EntityTypes
+
+
+class GeoCoordinates(Entity):
+    """GeoCoordinates (entity type: "https://schema.org/GeoCoordinates").
+
+    :param elevation: Elevation of the location [WGS
+     84](https://en.wikipedia.org/wiki/World_Geodetic_System)
+    :type elevation: float
+    :param latitude: Latitude of the location [WGS
+     84](https://en.wikipedia.org/wiki/World_Geodetic_System)
+    :type latitude: float
+    :param longitude: Longitude of the location [WGS
+     84](https://en.wikipedia.org/wiki/World_Geodetic_System)
+    :type longitude: float
+    :param type: The type of the thing
+    :type type: str
+    :param name: The name of the thing
+    :type name: str
+    """
+
+    elevation: float = None
+    latitude: float = None
+    longitude: float = None
+    type: Literal[EntityTypes.GEO_COORDINATES] = EntityTypes.GEO_COORDINATES
+    name: NonEmptyString = None

microsoft_agents/activity/entity/mention.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
+from ..channel_account import ChannelAccount
+from .entity import Entity
+from .entity_types import EntityTypes
+
+
+class Mention(Entity):
+    """Mention information (entity type: "mention").
+
+    :param mentioned: The mentioned user
+    :type mentioned: ~microsoft_agents.activity.ChannelAccount
+    :param text: Sub Text which represents the mention (can be null or empty)
+    :type text: str
+    :param type: Type of this entity (RFC 3987 IRI)
+    :type type: str
+    """
+
+    mentioned: ChannelAccount = None
+    text: str = None
+    type: Literal[EntityTypes.MENTION] = EntityTypes.MENTION

microsoft_agents/activity/entity/place.py

@@ -0,0 +1,33 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
+from .._type_aliases import NonEmptyString
+from .entity import Entity
+from .entity_types import EntityTypes
+
+
+class Place(Entity):
+    """Place (entity type: "https://schema.org/Place").
+
+    :param address: Address of the place (may be `string` or complex object of
+     type `PostalAddress`)
+    :type address: object
+    :param geo: Geo coordinates of the place (may be complex object of type
+     `GeoCoordinates` or `GeoShape`)
+    :type geo: object
+    :param has_map: Map to the place (may be `string` (URL) or complex object
+     of type `Map`)
+    :type has_map: object
+    :param type: The type of the thing
+    :type type: str
+    :param name: The name of the thing
+    :type name: str
+    """
+
+    address: object = None
+    geo: object = None
+    has_map: object = None
+    type: Literal[EntityTypes.PLACE] = EntityTypes.PLACE
+    name: NonEmptyString = None

microsoft_agents/activity/entity/product_info.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
+from .entity import Entity
+from .entity_types import EntityTypes
+
+
+class ProductInfo(Entity):
+    """Product information (entity type: "productInfo").
+
+    :param type: The type of the entity, always "productInfo".
+    :type type: str
+    :param id: The unique identifier for the product.
+    :type id: str
+    """
+
+    type: Literal[EntityTypes.PRODUCT_INFO] = EntityTypes.PRODUCT_INFO
+    id: str = None

microsoft_agents/activity/entity/thing.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
+from .._type_aliases import NonEmptyString
+from .entity import Entity
+from .entity_types import EntityTypes
+
+
+class Thing(Entity):
+    """Thing (entity type: "https://schema.org/Thing").
+
+    :param type: The type of the thing
+    :type type: str
+    :param name: The name of the thing
+    :type name: str
+    """
+
+    type: Literal[EntityTypes.THING] = EntityTypes.THING
+    name: NonEmptyString = None

microsoft_agents/activity/error.py

@@ -0,0 +1,22 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .inner_http_error import InnerHttpError
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class Error(AgentsModel):
+    """Object representing error information.
+
+    :param code: Error code
+    :type code: str
+    :param message: Error message
+    :type message: str
+    :param inner_http_error: Error from inner http call
+    :type inner_http_error: ~microsoft_agents.activity.InnerHttpError
+    """
+
+    code: NonEmptyString = None
+    message: NonEmptyString = None
+    inner_http_error: InnerHttpError = None

microsoft_agents/activity/error_response.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from .error import Error
+
+
+class ErrorResponse(AgentsModel):
+    """An HTTP API response.
+
+    :param error: Error message
+    :type error: ~microsoft_agents.activity.Error
+    """
+
+    error: Error = None

microsoft_agents/activity/errors/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""
+Error resources for Microsoft Agents Activity package.
+"""
+
+from .error_message import ErrorMessage
+from .error_resources import ActivityErrorResources
+
+# Singleton instance
+activity_errors = ActivityErrorResources()
+
+__all__ = ["ErrorMessage", "ActivityErrorResources", "activity_errors"]

microsoft_agents/activity/errors/error_message.py

@@ -0,0 +1,64 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""
+ErrorMessage class for formatting error messages with error codes and help URLs.
+"""
+
+
+class ErrorMessage:
+    """
+    Represents a formatted error message with error code and help URL.
+
+    This class formats error messages according to the Microsoft Agents SDK pattern:
+    - Original error message
+    - Error Code: [negative number]
+    - Help URL: https://aka.ms/M365AgentsErrorCodes/#[error_code]
+    """
+
+    def __init__(
+        self,
+        message_template: str,
+        error_code: int,
+    ):
+        """
+        Initialize an ErrorMessage.
+
+        :param message_template: The error message template (may include format placeholders)
+        :type message_template: str
+        :param error_code: The error code (should be negative)
+        :type error_code: int
+        """
+        self.message_template = message_template
+        self.error_code = error_code
+        self.base_url = "https://aka.ms/M365AgentsErrorCodes"
+
+    def format(self, *args, **kwargs) -> str:
+        """
+        Format the error message with the provided arguments.
+
+        :param args: Positional arguments for string formatting
+        :param kwargs: Keyword arguments for string formatting
+        :return: Formatted error message with error code and help URL
+        :rtype: str
+        """
+        # Format the main message
+        if args or kwargs:
+            message = self.message_template.format(*args, **kwargs)
+        else:
+            message = self.message_template
+
+        # Append error code and help URL
+        return (
+            f"{message}\n\n"
+            f"Error Code: {self.error_code}\n"
+            f"Help URL: {self.base_url}/#{self.error_code}"
+        )
+
+    def __str__(self) -> str:
+        """Return the formatted error message without any arguments."""
+        return self.format()
+
+    def __repr__(self) -> str:
+        """Return a representation of the ErrorMessage."""
+        return f"ErrorMessage(code={self.error_code}, message='{self.message_template[:50]}...')"

microsoft_agents/activity/errors/error_resources.py

@@ -0,0 +1,52 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""
+Activity error resources for Microsoft Agents SDK.
+
+Error codes are in the range -64000 to -64999.
+"""
+
+from .error_message import ErrorMessage
+
+
+class ActivityErrorResources:
+    """
+    Error messages for activity operations.
+
+    Error codes are organized in the range -64000 to -64999.
+    """
+
+    InvalidChannelIdType = ErrorMessage(
+        "Invalid type for channel_id: {0}. Expected ChannelId or str.",
+        -64000,
+    )
+
+    ChannelIdProductInfoConflict = ErrorMessage(
+        "Conflict between channel_id.sub_channel and productInfo entity",
+        -64001,
+    )
+
+    ChannelIdValueConflict = ErrorMessage(
+        "If value is provided, channel and sub_channel must be None",
+        -64002,
+    )
+
+    ChannelIdValueMustBeNonEmpty = ErrorMessage(
+        "value must be a non empty string if provided",
+        -64003,
+    )
+
+    InvalidFromPropertyType = ErrorMessage(
+        "Invalid type for from_property: {0}. Expected ChannelAccount or dict.",
+        -64004,
+    )
+
+    InvalidRecipientType = ErrorMessage(
+        "Invalid type for recipient: {0}. Expected ChannelAccount or dict.",
+        -64005,
+    )
+
+    def __init__(self):
+        """Initialize ActivityErrorResources."""
+        pass

microsoft_agents/activity/expected_replies.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 ExpectedReplies(AgentsModel):
+    """ExpectedReplies.
+
+    :param activities: A collection of Activities that conforms to the
+     ExpectedReplies schema.
+    :type activities: list[~microsoft_agents.activity.Activity]
+    """
+
+    activities: list[Activity] = None

microsoft_agents/activity/fact.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 Fact(AgentsModel):
+    """Set of key-value pairs. Advantage of this section is that key and value
+    properties will be
+    rendered with default style information with some delimiter between them.
+    So there is no need for developer to specify style information.
+
+    :param key: The key for this Fact
+    :type key: str
+    :param value: The value for this Fact
+    :type value: str
+    """
+
+    key: NonEmptyString = None
+    value: NonEmptyString = None

microsoft_agents/activity/hero_card.py

@@ -0,0 +1,33 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .card_action import CardAction
+from .card_image import CardImage
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class HeroCard(AgentsModel):
+    """A Hero card (card with a single, large 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/inner_http_error.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+
+
+class InnerHttpError(AgentsModel):
+    """Object representing inner http error.
+
+    :param status_code: HttpStatusCode from failed request
+    :type status_code: int
+    :param body: Body from failed request
+    :type body: object
+    """
+
+    status_code: int = None
+    body: object = None

microsoft_agents/activity/input_hints.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class InputHints(str, Enum):
+    accepting_input = "acceptingInput"
+    ignoring_input = "ignoringInput"
+    expecting_input = "expectingInput"

microsoft_agents/activity/installation_update_action_types.py

@@ -0,0 +1,9 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class InstallationUpdateActionTypes(str, Enum):
+    add = "add"
+    remove = "remove"

microsoft_agents/activity/invoke_response.py

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+
+
+class InvokeResponse(AgentsModel):
+    """
+    Tuple class containing an HTTP Status Code and a JSON serializable
+    object. The HTTP Status code is, in the invoke activity scenario, what will
+    be set in the resulting POST. The Body of the resulting POST will be
+    JSON serialized content.
+
+    The body content is defined by the producer.  The caller must know what
+    the content is and deserialize as needed.
+    """
+
+    status: int = None
+    body: object = None
+
+    def is_successful_status_code(self) -> bool:
+        """
+        Gets a value indicating whether the invoke response was successful.
+        :return: A value that indicates if the HTTP response was successful. true if status is in
+        the Successful range (200-299); otherwise false.
+        """
+        return 200 <= self.status <= 299

microsoft_agents/activity/media_card.py

@@ -0,0 +1,57 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .thumbnail_url import ThumbnailUrl
+from .media_url import MediaUrl
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class MediaCard(AgentsModel):
+    """Media card.
+
+    :param title: Title of this card
+    :type title: str
+    :param subtitle: Subtitle of this card
+    :type subtitle: str
+    :param text: Text of this card
+    :type text: str
+    :param image: Thumbnail placeholder
+    :type image: ~microsoft_agents.activity.ThumbnailUrl
+    :param media: Media URLs for this card. When this field contains more than
+     one URL, each URL is an alternative format of the same content.
+    :type media: list[~microsoft_agents.activity.MediaUrl]
+    :param buttons: Actions on this card
+    :type buttons: list[~microsoft_agents.activity.CardAction]
+    :param shareable: This content may be shared with others (default:true)
+    :type shareable: bool
+    :param autoloop: Should the client loop playback at end of content
+     (default:true)
+    :type autoloop: bool
+    :param autostart: Should the client automatically start playback of media
+     in this card (default:true)
+    :type autostart: bool
+    :param aspect: Aspect ratio of thumbnail/media placeholder. Allowed values
+     are "16:9" and "4:3"
+    :type aspect: str
+    :param duration: Describes the length of the media content without
+     requiring a receiver to open the content. Formatted as an ISO 8601
+     Duration field.
+    :type duration: str
+    :param value: Supplementary parameter for this card
+    :type value: object
+    """
+
+    title: NonEmptyString = None
+    subtitle: NonEmptyString = None
+    text: str = None
+    image: ThumbnailUrl = None
+    media: list[MediaUrl] = None
+    buttons: list[CardAction] = None
+    shareable: bool = None
+    autoloop: bool = None
+    autostart: bool = None
+    aspect: NonEmptyString = None
+    duration: NonEmptyString = None
+    value: object = None

microsoft_agents/activity/media_event_value.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+
+
+class MediaEventValue(AgentsModel):
+    """Supplementary parameter for media events.
+
+    :param card_value: Callback parameter specified in the Value field of the
+     MediaCard that originated this event
+    :type card_value: object
+    """
+
+    card_value: object = None

microsoft_agents/activity/media_url.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 MediaUrl(AgentsModel):
+    """Media URL.
+
+    :param url: Url for the media
+    :type url: str
+    :param profile: Optional profile hint to the client to differentiate
+     multiple MediaUrl objects from each other
+    :type profile: str
+    """
+
+    url: NonEmptyString = None
+    profile: NonEmptyString = None

microsoft_agents/activity/message_reaction.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 MessageReaction(AgentsModel):
+    """Message reaction object.
+
+    :param type: Message reaction type. Possible values include: 'like',
+     'plusOne'
+    :type type: str or ~microsoft_agents.activity.MessageReactionTypes
+    """
+
+    type: NonEmptyString

microsoft_agents/activity/message_reaction_types.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class MessageReactionTypes(str, Enum):
+    """MessageReactionType
+
+    Enum for message reaction types.
+    """
+
+    REACTIONS_ADDED = "reactionsAdded"
+    REACTIONS_REMOVED = "reactionsRemoved"

microsoft_agents/activity/message_update_types.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class MessageUpdateTypes(str, Enum):
+    EDIT_MESSAGE = "editMessage"
+    SOFT_DELETE_MESSAGE = "softDeleteMessage"
+    UNDELETE_MESSAGE = "undeleteMessage"

microsoft_agents/activity/oauth_card.py

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Optional
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from .token_exchange_resource import TokenExchangeResource
+from .token_post_resource import TokenPostResource
+from ._type_aliases import NonEmptyString
+
+
+class OAuthCard(AgentsModel):
+    """A card representing a request to perform a sign in via OAuth.
+
+    :param text: Text for signin request
+    :type text: str
+    :param connection_name: The name of the registered connection
+    :type connection_name: str
+    :param buttons: Action to use to perform signin
+    :type buttons: list[~microsoft_agents.activity.CardAction]
+    """
+
+    text: str = None
+    connection_name: NonEmptyString = None
+    buttons: list[CardAction] = None
+    token_exchange_resource: Optional[TokenExchangeResource] = None
+    token_post_resource: TokenPostResource = None