Fixing docstrings (#105)

* Fixing docstrings

* fixing import

Author: axelsrz

libraries/microsoft-agents-activity/microsoft_agents/activity/activity.py

@@ -27,7 +27,7 @@ class Activity(AgentsModel):
         'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate',
         'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion',
         'trace', 'handoff'
-    :type type: str or ~microsoft_agents.protocols.models.ActivityTypes
+    :type type: str or ~microsoft_agents.activity.ActivityTypes
     :param id: Contains an ID that uniquely identifies the activity on the channel.
     :type id: str
     :param timestamp: Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.
@@ -43,23 +43,23 @@ class Activity(AgentsModel):
     :param channel_id: Contains an ID that uniquely identifies the channel. Set by the channel.
     :type channel_id: str
     :param from_property: Identifies the sender of the message.
-    :type from_property: ~microsoft_agents.protocols.models.ChannelAccount
+    :type from_property: ~microsoft_agents.activity.ChannelAccount
     :param conversation: Identifies the conversation to which the activity belongs.
-    :type conversation: ~microsoft_agents.protocols.models.ConversationAccount
+    :type conversation: ~microsoft_agents.activity.ConversationAccount
     :param recipient: Identifies the recipient of the message.
-    :type recipient: ~microsoft_agents.protocols.models.ChannelAccount
+    :type recipient: ~microsoft_agents.activity.ChannelAccount
     :param text_format: Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'
-    :type text_format: str or ~microsoft_agents.protocols.models.TextFormatTypes
+    :type text_format: str or ~microsoft_agents.activity.TextFormatTypes
     :param attachment_layout: The layout hint for multiple attachments. Default: list. Possible values include: 'list', 'carousel'
-    :type attachment_layout: str or ~microsoft_agents.protocols.models.AttachmentLayoutTypes
+    :type attachment_layout: str or ~microsoft_agents.activity.AttachmentLayoutTypes
     :param members_added: The collection of members added to the conversation.
-    :type members_added: list[~microsoft_agents.protocols.models.ChannelAccount]
+    :type members_added: list[~microsoft_agents.activity.ChannelAccount]
     :param members_removed: The collection of members removed from the conversation.
-    :type members_removed: list[~microsoft_agents.protocols.models.ChannelAccount]
+    :type members_removed: list[~microsoft_agents.activity.ChannelAccount]
     :param reactions_added: The collection of reactions added to the conversation.
-    :type reactions_added: list[~microsoft_agents.protocols.models.MessageReaction]
+    :type reactions_added: list[~microsoft_agents.activity.MessageReaction]
     :param reactions_removed: The collection of reactions removed from the conversation.
-    :type reactions_removed: list[~microsoft_agents.protocols.models.MessageReaction]
+    :type reactions_removed: list[~microsoft_agents.activity.MessageReaction]
     :param topic_name: The updated topic name of the conversation.
     :type topic_name: str
     :param history_disclosed: Indicates whether the prior history of the channel is disclosed.
@@ -74,15 +74,15 @@ class Activity(AgentsModel):
     :type speak: str
     :param input_hint: Indicates whether your agent is accepting, expecting, or ignoring user input after the message is delivered to the client.
         Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
-    :type input_hint: str or ~microsoft_agents.protocols.models.InputHints
+    :type input_hint: str or ~microsoft_agents.activity.InputHints
     :param summary: The text to display if the channel cannot render cards.
     :type summary: str
     :param suggested_actions: The suggested actions for the activity.
-    :type suggested_actions: ~microsoft_agents.protocols.models.SuggestedActions
+    :type suggested_actions: ~microsoft_agents.activity.SuggestedActions
     :param attachments: Attachments
-    :type attachments: list[~microsoft_agents.protocols.models.Attachment]
+    :type attachments: list[~microsoft_agents.activity.Attachment]
     :param entities: Represents the entities that were mentioned in the message.
-    :type entities: list[~microsoft_agents.protocols.models.Entity]
+    :type entities: list[~microsoft_agents.activity.Entity]
     :param channel_data: Contains channel-specific content.
     :type channel_data: object
     :param action: Indicates whether the recipient of a contactRelationUpdate was added or removed from the sender's contact list.
@@ -98,23 +98,23 @@ class Activity(AgentsModel):
     :param name: The name of the operation associated with an invoke or event activity.
     :type name: str
     :param relates_to: A reference to another conversation or activity.
-    :type relates_to: ~microsoft_agents.protocols.models.ConversationReference
+    :type relates_to: ~microsoft_agents.activity.ConversationReference
     :param code: The a code for endOfConversation activities that indicates why the conversation ended. Possible values include: 'unknown',
         'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
-    :type code: str or ~microsoft_agents.protocols.models.EndOfConversationCodes
+    :type code: str or ~microsoft_agents.activity.EndOfConversationCodes
     :param expiration: The time at which the activity should be considered to be "expired" and should not be presented to the recipient.
     :type expiration: datetime
     :param importance: The importance of the activity. Possible values include: 'low', 'normal', 'high'
-    :type importance: str or ~microsoft_agents.protocols.models.ActivityImportance
+    :type importance: str or ~microsoft_agents.activity.ActivityImportance
     :param delivery_mode: A delivery hint to signal to the recipient alternate delivery paths for the activity.
         The default delivery mode is "default". Possible values include: 'normal', 'notification', 'expectReplies', 'ephemeral'
-    :type delivery_mode: str or ~microsoft_agents.protocols.models.DeliveryModes
+    :type delivery_mode: str or ~microsoft_agents.activity.DeliveryModes
     :param listen_for: List of phrases and references that speech and language priming systems should listen for
     :type listen_for: list[str]
     :param text_highlights: The collection of text fragments to highlight when the activity contains a ReplyToId value.
-    :type text_highlights: list[~microsoft_agents.protocols.models.TextHighlight]
+    :type text_highlights: list[~microsoft_agents.activity.TextHighlight]
     :param semantic_action: An optional programmatic action accompanying this request
-    :type semantic_action: ~microsoft_agents.protocols.models.SemanticAction
+    :type semantic_action: ~microsoft_agents.activity.SemanticAction
     :param caller_id: A string containing an IRI identifying the caller of an agent. This field is not intended to be transmitted over the wire,
         but is instead populated by agents and clients based on cryptographically verifiable data that asserts the identity of the callers (e.g. tokens).
     :type caller_id: str

libraries/microsoft-agents-activity/microsoft_agents/activity/animation_card.py

@@ -15,12 +15,12 @@ class AnimationCard(AgentsModel):
     :param text: Text of this card
     :type text: str
     :param image: Thumbnail placeholder
-    :type image: ~microsoft_agents.protocols.models.ThumbnailUrl
+    :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.protocols.models.MediaUrl]
+    :type media: list[~microsoft_agents.activity.MediaUrl]
     :param buttons: Actions on this card
-    :type buttons: list[~microsoft_agents.protocols.models.CardAction]
+    :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

libraries/microsoft-agents-activity/microsoft_agents/activity/attachment_info.py

@@ -11,7 +11,7 @@ class AttachmentInfo(AgentsModel):
     :param type: ContentType of the attachment
     :type type: str
     :param views: attachment views
-    :type views: list[~microsoft_agents.protocols.models.AttachmentView]
+    :type views: list[~microsoft_agents.activity.AttachmentView]
     """
 
     name: NonEmptyString = None

libraries/microsoft-agents-activity/microsoft_agents/activity/audio_card.py

@@ -15,12 +15,12 @@ class AudioCard(AgentsModel):
     :param text: Text of this card
     :type text: str
     :param image: Thumbnail placeholder
-    :type image: ~microsoft_agents.protocols.models.ThumbnailUrl
+    :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.protocols.models.MediaUrl]
+    :type media: list[~microsoft_agents.activity.MediaUrl]
     :param buttons: Actions on this card
-    :type buttons: list[~microsoft_agents.protocols.models.CardAction]
+    :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

libraries/microsoft-agents-activity/microsoft_agents/activity/basic_card.py

@@ -14,12 +14,12 @@ class BasicCard(AgentsModel):
     :param text: Text for the card
     :type text: str
     :param images: Array of images for the card
-    :type images: list[~microsoft_agents.protocols.models.CardImage]
+    :type images: list[~microsoft_agents.activity.CardImage]
     :param buttons: Set of actions applicable to the current card
-    :type buttons: list[~microsoft_agents.protocols.models.CardAction]
+    :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.protocols.models.CardAction
+    :type tap: ~microsoft_agents.activity.CardAction
     """
 
     title: NonEmptyString = None

libraries/microsoft-agents-activity/microsoft_agents/activity/card_action.py

@@ -9,7 +9,7 @@ class CardAction(AgentsModel):
     :param type: The type of action implemented by this button. Possible
      values include: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo',
      'showImage', 'downloadFile', 'signin', 'call', 'messageBack'
-    :type type: str or ~microsoft_agents.protocols.models.ActionTypes
+    :type type: str or ~microsoft_agents.activity.ActionTypes
     :param title: Text description which appears on the button
     :type title: str
     :param image: Image URL which will appear on the button, next to text

libraries/microsoft-agents-activity/microsoft_agents/activity/card_image.py

@@ -11,7 +11,7 @@ class CardImage(AgentsModel):
     :param alt: Image description intended for screen readers
     :type alt: str
     :param tap: Action assigned to specific Attachment
-    :type tap: ~microsoft_agents.protocols.models.CardAction
+    :type tap: ~microsoft_agents.activity.CardAction
     """
 
     url: NonEmptyString = None

libraries/microsoft-agents-activity/microsoft_agents/activity/channel_account.py

@@ -17,7 +17,7 @@ class ChannelAccount(AgentsModel):
      Directory (AAD)
     :type aad_object_id: str
     :param role: Role of the entity behind the account
-    :type role: str or ~microsoft_agents.protocols.models.RoleTypes
+    :type role: str or ~microsoft_agents.activity.RoleTypes
     """
 
     model_config = ConfigDict(extra="allow")

libraries/microsoft-agents-activity/microsoft_agents/activity/conversation_account.py

@@ -21,7 +21,7 @@ class ConversationAccount(AgentsModel):
      Directory (AAD)
     :type aad_object_id: str
     :param role: Role of the entity behind the account
-    :type role: str or ~microsoft_agents.protocols.models.RoleTypes
+    :type role: str or ~microsoft_agents.activity.RoleTypes
     :param tenant_id: This conversation's tenant ID
     :type tenant_id: str
     :param properties: This conversation's properties

libraries/microsoft-agents-activity/microsoft_agents/activity/conversation_members.py

@@ -9,7 +9,7 @@ class ConversationMembers(AgentsModel):
     :param id: Conversation ID
     :type id: str
     :param members: List of members in this conversation
-    :type members: list[~microsoft_agents.protocols.models.ChannelAccount]
+    :type members: list[~microsoft_agents.activity.ChannelAccount]
     """
 
     id: NonEmptyString = None