From fcffc8ca83dbc2d562c457868bd14a340a4a21a8 Mon Sep 17 00:00:00 2001 From: Corina Gum <14900841+corinagum@users.noreply.github.com> Date: Fri, 3 Apr 2026 11:48:34 -0700 Subject: [PATCH] Update generated Adaptive Cards core from latest codegen - New types: CollabStageInvokeDataValue, OpenUrlDialogAction, PopoverAction, ProgressBar, ProgressRing, Resources, StringResource, TabInfo Co-Authored-By: Claude Opus 4.6 (1M context) --- .../cards/src/microsoft_teams/cards/core.py | 783 ++++++++++++------ 1 file changed, 550 insertions(+), 233 deletions(-) diff --git a/packages/cards/src/microsoft_teams/cards/core.py b/packages/cards/src/microsoft_teams/cards/core.py index 1ec829bf..c5e7e03c 100644 --- a/packages/cards/src/microsoft_teams/cards/core.py +++ b/packages/cards/src/microsoft_teams/cards/core.py @@ -1,7 +1,8 @@ -# This file was automatically generated by a tool on 03/31/2026, 12:11 AM UTC. DO NOT UPDATE MANUALLY. +# This file was automatically generated by a tool on 04/02/2026, 8:47 PM UTC. DO NOT UPDATE MANUALLY. # It includes declarations for Adaptive Card features available in Teams, Copilot, Outlook, Word, Excel, PowerPoint. -from typing import Dict, List, Any, Optional, Union, Literal, Self +from typing import Any, Dict, List, Literal, Optional, Self, Union + from pydantic import AliasGenerator, BaseModel, ConfigDict, Field, SerializeAsAny from pydantic.alias_generators import to_camel @@ -12,46 +13,46 @@ class SerializableObject(BaseModel): @staticmethod def validation_alias_generator(field: str) -> str: "Handles deserialization aliasing" - + # Handle parameters that start with "@" if field.startswith("at_"): return f"@{field[3:]}" - + # Handles from field which is a duplicate reserved internal name if field == "from_": return "from" - + # Handle ms_teams field which should deserialize from msteams if field == "ms_teams": return "msteams" - + # Handle choices_data field which should deserialize from choices.data if field == "choices_data": return "choices.data" - + # All other fields are converted to camelCase return to_camel(field) - + @staticmethod def serialization_alias_generator(field: str) -> str: "Handles serialization aliasing and casing" - + # Handle parameters that start with "@" if field.startswith("at_"): return f"@{field[3:]}" - + # Handles from field which is a duplicate reserved internal name if field == "from_": return "from" - + # Handle ms_teams field which should serialize to msteams if field == "ms_teams": return "msteams" - + # Handle choices_data field which should serialize to choices.data if field == "choices_data": return "choices.data" - + # All other fields are converted to camelCase return to_camel(field) @@ -64,19 +65,24 @@ def serialization_alias_generator(field: str) -> str: alias_generator=AliasGenerator( validation_alias=validation_alias_generator, serialization_alias=serialization_alias_generator ), - ) + ) class CardElement(SerializableObject): """Base class for CardElement.""" + pass + class Action(SerializableObject): """Base class for Action.""" + pass + class ContainerLayout(SerializableObject): """Base class for ContainerLayout.""" + pass @@ -92,7 +98,20 @@ class ContainerLayout(SerializableObject): Spacing = Literal["None", "ExtraSmall", "Small", "Default", "Medium", "Large", "ExtraLarge", "Padding"] -TargetWidth = Literal["VeryNarrow", "Narrow", "Standard", "Wide", "atLeast:VeryNarrow", "atMost:VeryNarrow", "atLeast:Narrow", "atMost:Narrow", "atLeast:Standard", "atMost:Standard", "atLeast:Wide", "atMost:Wide"] +TargetWidth = Literal[ + "VeryNarrow", + "Narrow", + "Standard", + "Wide", + "atLeast:VeryNarrow", + "atMost:VeryNarrow", + "atLeast:Narrow", + "atMost:Narrow", + "atLeast:Standard", + "atMost:Standard", + "atLeast:Wide", + "atMost:Wide", +] ContainerStyle = Literal["default", "emphasis", "accent", "good", "attention", "warning"] @@ -152,9 +171,67 @@ class ContainerLayout(SerializableObject): ProgressBarColor = Literal["Accent", "Good", "Warning", "Attention"] -ChartColorSet = Literal["categorical", "sequential", "sequentialred", "sequentialgreen", "sequentialyellow", "diverging"] - -ChartColor = Literal["good", "warning", "attention", "neutral", "categoricalRed", "categoricalPurple", "categoricalLavender", "categoricalBlue", "categoricalLightBlue", "categoricalTeal", "categoricalGreen", "categoricalLime", "categoricalMarigold", "sequential1", "sequential2", "sequential3", "sequential4", "sequential5", "sequential6", "sequential7", "sequential8", "divergingBlue", "divergingLightBlue", "divergingCyan", "divergingTeal", "divergingYellow", "divergingPeach", "divergingLightRed", "divergingRed", "divergingMaroon", "divergingGray", "sequentialRed1", "sequentialRed2", "sequentialRed3", "sequentialRed4", "sequentialRed5", "sequentialRed6", "sequentialRed7", "sequentialRed8", "sequentialGreen1", "sequentialGreen2", "sequentialGreen3", "sequentialGreen4", "sequentialGreen5", "sequentialGreen6", "sequentialGreen7", "sequentialGreen8", "sequentialYellow1", "sequentialYellow2", "sequentialYellow3", "sequentialYellow4", "sequentialYellow5", "sequentialYellow6", "sequentialYellow7", "sequentialYellow8"] +ChartColorSet = Literal[ + "categorical", "sequential", "sequentialred", "sequentialgreen", "sequentialyellow", "diverging" +] + +ChartColor = Literal[ + "good", + "warning", + "attention", + "neutral", + "categoricalRed", + "categoricalPurple", + "categoricalLavender", + "categoricalBlue", + "categoricalLightBlue", + "categoricalTeal", + "categoricalGreen", + "categoricalLime", + "categoricalMarigold", + "sequential1", + "sequential2", + "sequential3", + "sequential4", + "sequential5", + "sequential6", + "sequential7", + "sequential8", + "divergingBlue", + "divergingLightBlue", + "divergingCyan", + "divergingTeal", + "divergingYellow", + "divergingPeach", + "divergingLightRed", + "divergingRed", + "divergingMaroon", + "divergingGray", + "sequentialRed1", + "sequentialRed2", + "sequentialRed3", + "sequentialRed4", + "sequentialRed5", + "sequentialRed6", + "sequentialRed7", + "sequentialRed8", + "sequentialGreen1", + "sequentialGreen2", + "sequentialGreen3", + "sequentialGreen4", + "sequentialGreen5", + "sequentialGreen6", + "sequentialGreen7", + "sequentialGreen8", + "sequentialYellow1", + "sequentialYellow2", + "sequentialYellow3", + "sequentialYellow4", + "sequentialYellow5", + "sequentialYellow6", + "sequentialYellow7", + "sequentialYellow8", +] DonutThickness = Literal["Thin", "Thick"] @@ -162,7 +239,32 @@ class ContainerLayout(SerializableObject): GaugeChartValueFormat = Literal["Percentage", "Fraction"] -CodeLanguage = Literal["Bash", "C", "Cpp", "CSharp", "Css", "Dos", "Go", "Graphql", "Html", "Java", "JavaScript", "Json", "ObjectiveC", "Perl", "Php", "PlainText", "PowerShell", "Python", "Sql", "TypeScript", "VbNet", "Verilog", "Vhdl", "Xml"] +CodeLanguage = Literal[ + "Bash", + "C", + "Cpp", + "CSharp", + "Css", + "Dos", + "Go", + "Graphql", + "Html", + "Java", + "JavaScript", + "Json", + "ObjectiveC", + "Perl", + "Php", + "PlainText", + "PowerShell", + "Python", + "Sql", + "TypeScript", + "VbNet", + "Verilog", + "Vhdl", + "Xml", +] PersonaIconStyle = Literal["profilePicture", "contactCard", "none"] @@ -189,6 +291,7 @@ class ContainerLayout(SerializableObject): class HostCapabilities(SerializableObject): """Represents a list of versioned capabilities a host application must support.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ @@ -196,8 +299,10 @@ def with_key(self, value: str) -> Self: self.key = value return self + class ThemedUrl(SerializableObject): """Defines a theme-specific URL.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ theme: Optional[ThemeName] = "Light" @@ -217,8 +322,10 @@ def with_url(self, value: str) -> Self: self.url = value return self + class BackgroundImage(SerializableObject): """Defines a container's background image and the way it should be rendered.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ url: Optional[str] = None @@ -256,8 +363,10 @@ def with_themed_urls(self, value: List[ThemedUrl]) -> Self: self.themed_urls = value return self + class SubmitActionData(SerializableObject): """Represents the data of an Action.Submit.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ msteams: Optional[Dict[str, Any]] = None @@ -271,11 +380,13 @@ def with_msteams(self, value: Dict[str, Any]) -> Self: self.msteams = value return self + class ExecuteAction(Action): """Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can respond synchronously and return an updated Adaptive Card to be displayed by the client. Action.Execute works in all Adaptive Card hosts.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.Execute'] = 'Action.Execute' + type: Literal["Action.Execute"] = "Action.Execute" """ Must be **Action.Execute**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -303,7 +414,7 @@ class ExecuteAction(Action): """ The data to send to the Bot when the action is executed. When expressed as an object, `data` is sent back to the Bot when the action is executed, adorned with the values of the inputs expressed as key/value pairs, where the key is the Id of the input. If `data` is expressed as a string, input values are not sent to the Bot. """ associated_inputs: Optional[AssociatedInputs] = None """ The Ids of the inputs associated with the Action.Submit. When the action is executed, the values of the associated inputs are sent to the Bot. See [Input validation](topic:input-validation) for more details. """ - conditionally_enabled: Optional[bool] = None + conditionally_enabled: Optional[bool] = False """ Controls if the action is enabled only if at least one required input has been filled by the user. """ verb: Optional[str] = None """ The verb of the action. """ @@ -374,8 +485,10 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class RefreshDefinition(SerializableObject): """Defines how a card can be refreshed by making a request to the target Bot.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ action: Optional[ExecuteAction] = None @@ -395,8 +508,10 @@ def with_user_ids(self, value: List[str]) -> Self: self.user_ids = value return self + class AuthCardButton(SerializableObject): """Defines a button as displayed when prompting a user to authenticate. For more information, refer to the [Bot Framework CardAction type](https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.cardaction).""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ type: Optional[str] = None @@ -428,8 +543,10 @@ def with_value(self, value: str) -> Self: self.value = value return self + class TokenExchangeResource(SerializableObject): """Defines information required to enable on-behalf-of single sign-on user authentication. For more information, refer to the [Bot Framework TokenExchangeResource type](https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.tokenexchangeresource)""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ id: Optional[str] = None @@ -455,8 +572,10 @@ def with_provider_id(self, value: str) -> Self: self.provider_id = value return self + class Authentication(SerializableObject): """Defines authentication information associated with a card. For more information, refer to the [Bot Framework OAuthCard type](https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.oauthcard)""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ text: Optional[str] = None @@ -488,8 +607,10 @@ def with_token_exchange_resource(self, value: TokenExchangeResource) -> Self: self.token_exchange_resource = value return self + class MentionedEntity(SerializableObject): """Represents a mentioned person or tag.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ id: Optional[str] = None @@ -515,11 +636,13 @@ def with_mention_type(self, value: MentionType) -> Self: self.mention_type = value return self + class Mention(SerializableObject): """Represents a mention to a person.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['mention'] = 'mention' + type: Literal["mention"] = "mention" """ Must be **mention**. """ text: Optional[str] = None """ The text that will be substituted with the mention. """ @@ -538,8 +661,10 @@ def with_mentioned(self, value: MentionedEntity) -> Self: self.mentioned = value return self + class TeamsCardProperties(SerializableObject): """Represents a set of Teams-specific properties on a card.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ width: Optional[TeamsCardWidth] = None @@ -561,8 +686,10 @@ def with_entities(self, value: List[Mention]) -> Self: self.entities = value return self + class CardMetadata(SerializableObject): """Card-level metadata.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ web_url: Optional[str] = None @@ -576,8 +703,10 @@ def with_web_url(self, value: str) -> Self: self.web_url = value return self + class StringResource(SerializableObject): """Defines the replacement string values.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ default_value: Optional[str] = None @@ -597,8 +726,10 @@ def with_localized_values(self, value: Dict[str, str]) -> Self: self.localized_values = value return self + class Resources(SerializableObject): """The resources that can be used in the body of the card.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ strings: Optional[Dict[str, StringResource]] = None @@ -612,11 +743,13 @@ def with_strings(self, value: Dict[str, StringResource]) -> Self: self.strings = value return self + class AdaptiveCard(CardElement): """An Adaptive Card, containing a free-form body of card elements, and an optional set of actions.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['AdaptiveCard'] = 'AdaptiveCard' + type: Literal["AdaptiveCard"] = "AdaptiveCard" """ Must be **AdaptiveCard**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -624,7 +757,7 @@ class AdaptiveCard(CardElement): """ A list of capabilities the element requires the host application to support. If the host application doesn't support at least one of the listed capabilities, the element is not rendered (or its fallback is rendered if provided). """ lang: Optional[str] = None """ The locale associated with the element. """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the element is tapped or clicked. Action.ShowCard is not supported. """ @@ -767,11 +900,13 @@ def with_actions(self, value: List[Action]) -> Self: self.actions = value return self + class InsertImageAction(Action): """Inserts an image into the host application's canvas.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.InsertImage'] = 'Action.InsertImage' + type: Literal["Action.InsertImage"] = "Action.InsertImage" """ Must be **Action.InsertImage**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -864,11 +999,13 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class OpenUrlAction(Action): """Opens the provided URL in either a separate browser tab or within the host application.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.OpenUrl'] = 'Action.OpenUrl' + type: Literal["Action.OpenUrl"] = "Action.OpenUrl" """ Must be **Action.OpenUrl**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -949,11 +1086,13 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class OpenUrlDialogAction(Action): """Opens a task module in a modal dialog hosting the content at a provided URL.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.OpenUrlDialog'] = 'Action.OpenUrlDialog' + type: Literal["Action.OpenUrlDialog"] = "Action.OpenUrlDialog" """ Must be **Action.OpenUrlDialog**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1052,11 +1191,13 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class ResetInputsAction(Action): """Resets the values of the inputs in the card.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.ResetInputs'] = 'Action.ResetInputs' + type: Literal["Action.ResetInputs"] = "Action.ResetInputs" """ Must be **Action.ResetInputs**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1137,8 +1278,10 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class TeamsSubmitActionFeedback(SerializableObject): """Represents feedback options for an [Action.Submit](https://adaptivecards.microsoft.com/?topic=Action.Submit).""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ hide: Optional[bool] = None @@ -1152,8 +1295,10 @@ def with_hide(self, value: bool) -> Self: self.hide = value return self + class TeamsSubmitActionProperties(SerializableObject): """Teams-specific properties associated with the action.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ feedback: Optional[TeamsSubmitActionFeedback] = None @@ -1167,11 +1312,13 @@ def with_feedback(self, value: TeamsSubmitActionFeedback) -> Self: self.feedback = value return self + class SubmitAction(Action): """Gathers input values, merges them with the data property if specified, and sends them to the Bot via an Invoke activity. The Bot can only acknowledge is has received the request.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.Submit'] = 'Action.Submit' + type: Literal["Action.Submit"] = "Action.Submit" """ Must be **Action.Submit**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1199,7 +1346,7 @@ class SubmitAction(Action): """ The data to send to the Bot when the action is executed. When expressed as an object, `data` is sent back to the Bot when the action is executed, adorned with the values of the inputs expressed as key/value pairs, where the key is the Id of the input. If `data` is expressed as a string, input values are not sent to the Bot. """ associated_inputs: Optional[AssociatedInputs] = None """ The Ids of the inputs associated with the Action.Submit. When the action is executed, the values of the associated inputs are sent to the Bot. See [Input validation](topic:input-validation) for more details. """ - conditionally_enabled: Optional[bool] = None + conditionally_enabled: Optional[bool] = False """ Controls if the action is enabled only if at least one required input has been filled by the user. """ msteams: Optional[TeamsSubmitActionProperties] = None """ Teams-specific metadata associated with the action. """ @@ -1270,8 +1417,10 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class TargetElement(SerializableObject): """Defines a target element in an Action.ToggleVisibility.""" + element_id: Optional[str] = None """ The Id of the element to change the visibility of. """ is_visible: Optional[bool] = None @@ -1285,11 +1434,13 @@ def with_is_visible(self, value: bool) -> Self: self.is_visible = value return self + class ToggleVisibilityAction(Action): """Toggles the visibility of a set of elements. Action.ToggleVisibility is useful for creating "Show more" type UI patterns.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.ToggleVisibility'] = 'Action.ToggleVisibility' + type: Literal["Action.ToggleVisibility"] = "Action.ToggleVisibility" """ Must be **Action.ToggleVisibility**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1370,11 +1521,13 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class ShowCardAction(Action): """Expands or collapses an embedded card within the main card.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.ShowCard'] = 'Action.ShowCard' + type: Literal["Action.ShowCard"] = "Action.ShowCard" """ Must be **Action.ShowCard**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1455,11 +1608,13 @@ def with_card(self, value: AdaptiveCard) -> Self: self.card = value return self + class PopoverAction(Action): """Shows a popover to display more information to the user.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Action.Popover'] = 'Action.Popover' + type: Literal["Action.Popover"] = "Action.Popover" """ Must be **Action.Popover**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1552,11 +1707,13 @@ def with_fallback(self, value: Union[Action, FallbackAction]) -> Self: self.fallback = value return self + class ActionSet(CardElement): """Displays a set of action, which can be placed anywhere in the card.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['ActionSet'] = 'ActionSet' + type: Literal["ActionSet"] = "ActionSet" """ Must be **ActionSet**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1566,7 +1723,7 @@ class ActionSet(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -1576,7 +1733,7 @@ class ActionSet(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ grid_area: Optional[str] = None """ The area of a Layout.AreaGrid layout in which an element should be displayed. """ @@ -1641,11 +1798,13 @@ def with_actions(self, value: List[Action]) -> Self: self.actions = value return self + class Container(CardElement): """A container for other elements. Use containers for styling purposes and/or to logically group a set of elements together, which can be especially useful when used with Action.ToggleVisibility.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Container'] = 'Container' + type: Literal["Container"] = "Container" """ Must be **Container**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1655,7 +1814,7 @@ class Container(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -1665,19 +1824,19 @@ class Container(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the element is tapped or clicked. Action.ShowCard is not supported. """ style: Optional[ContainerStyle] = None """ The style of the container. Container styles control the colors of the background, border and text inside the container, in such a way that contrast requirements are always met. """ - show_border: Optional[bool] = None + show_border: Optional[bool] = False """ Controls if a border should be displayed around the container. """ - rounded_corners: Optional[bool] = None + rounded_corners: Optional[bool] = False """ Controls if the container should have rounded corners. """ layouts: Optional[List[SerializeAsAny[ContainerLayout]]] = None """ The layouts associated with the container. The container can dynamically switch from one layout to another as the card's width changes. See [Container layouts](topic:container-layouts) for more details. """ - bleed: Optional[bool] = None + bleed: Optional[bool] = False """ Controls if the container should bleed into its parent. A bleeding container extends into its parent's padding. """ min_height: Optional[str] = None """ The minimum height, in pixels, of the container, in the `px` format. """ @@ -1796,11 +1955,13 @@ def with_items(self, value: List[CardElement]) -> Self: self.items = value return self + class StackLayout(ContainerLayout): """A layout that stacks elements on top of each other. Layout.Stack is the default layout used by AdaptiveCard and all containers.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Layout.Stack'] = 'Layout.Stack' + type: Literal["Layout.Stack"] = "Layout.Stack" """ Must be **Layout.Stack**. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the layout should be used. """ @@ -1813,11 +1974,13 @@ def with_target_width(self, value: TargetWidth) -> Self: self.target_width = value return self + class FlowLayout(ContainerLayout): """A layout that spreads elements horizontally and wraps them across multiple rows, as needed.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Layout.Flow'] = 'Layout.Flow' + type: Literal["Layout.Flow"] = "Layout.Flow" """ Must be **Layout.Flow**. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the layout should be used. """ @@ -1878,8 +2041,10 @@ def with_row_spacing(self, value: Spacing) -> Self: self.row_spacing = value return self + class GridArea(SerializableObject): """Defines an area in a Layout.AreaGrid layout.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ name: Optional[str] = None @@ -1917,11 +2082,13 @@ def with_row_span(self, value: float) -> Self: self.row_span = value return self + class AreaGridLayout(ContainerLayout): """A layout that divides a container into named areas into which elements can be placed.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Layout.AreaGrid'] = 'Layout.AreaGrid' + type: Literal["Layout.AreaGrid"] = "Layout.AreaGrid" """ Must be **Layout.AreaGrid**. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the layout should be used. """ @@ -1958,11 +2125,13 @@ def with_row_spacing(self, value: Spacing) -> Self: self.row_spacing = value return self + class Column(CardElement): """A column in a ColumnSet element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Column'] = 'Column' + type: Literal["Column"] = "Column" """ Optional. If specified, must be **Column**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -1972,7 +2141,7 @@ class Column(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -1982,19 +2151,19 @@ class Column(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the element is tapped or clicked. Action.ShowCard is not supported. """ style: Optional[ContainerStyle] = None """ The style of the container. Container styles control the colors of the background, border and text inside the container, in such a way that contrast requirements are always met. """ - show_border: Optional[bool] = None + show_border: Optional[bool] = False """ Controls if a border should be displayed around the container. """ - rounded_corners: Optional[bool] = None + rounded_corners: Optional[bool] = False """ Controls if the container should have rounded corners. """ layouts: Optional[List[SerializeAsAny[ContainerLayout]]] = None """ The layouts associated with the container. The container can dynamically switch from one layout to another as the card's width changes. See [Container layouts](topic:container-layouts) for more details. """ - bleed: Optional[bool] = None + bleed: Optional[bool] = False """ Controls if the container should bleed into its parent. A bleeding container extends into its parent's padding. """ min_height: Optional[str] = None """ The minimum height, in pixels, of the container, in the `px` format. """ @@ -2119,11 +2288,13 @@ def with_items(self, value: List[CardElement]) -> Self: self.items = value return self + class ColumnSet(CardElement): """Splits the available horizontal space into separate columns, so elements can be organized in a row.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['ColumnSet'] = 'ColumnSet' + type: Literal["ColumnSet"] = "ColumnSet" """ Must be **ColumnSet**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -2133,7 +2304,7 @@ class ColumnSet(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -2143,17 +2314,17 @@ class ColumnSet(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the element is tapped or clicked. Action.ShowCard is not supported. """ style: Optional[ContainerStyle] = None """ The style of the container. Container styles control the colors of the background, border and text inside the container, in such a way that contrast requirements are always met. """ - show_border: Optional[bool] = None + show_border: Optional[bool] = False """ Controls if a border should be displayed around the container. """ - rounded_corners: Optional[bool] = None + rounded_corners: Optional[bool] = False """ Controls if the container should have rounded corners. """ - bleed: Optional[bool] = None + bleed: Optional[bool] = False """ Controls if the container should bleed into its parent. A bleeding container extends into its parent's padding. """ min_height: Optional[str] = None """ The minimum height, in pixels, of the container, in the `px` format. """ @@ -2250,8 +2421,10 @@ def with_columns(self, value: List[Column]) -> Self: self.columns = value return self + class MediaSource(SerializableObject): """Defines the source URL of a media stream. YouTube, Dailymotion, Vimeo and Microsoft Stream URLs are supported.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ mime_type: Optional[str] = None @@ -2271,8 +2444,10 @@ def with_url(self, value: str) -> Self: self.url = value return self + class CaptionSource(SerializableObject): """Defines a source URL for a video captions.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ mime_type: Optional[str] = None @@ -2298,11 +2473,13 @@ def with_label(self, value: str) -> Self: self.label = value return self + class Media(CardElement): """A media element, that makes it possible to embed videos inside a card.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Media'] = 'Media' + type: Literal["Media"] = "Media" """ Must be **Media**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -2312,7 +2489,7 @@ class Media(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -2320,7 +2497,7 @@ class Media(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ sources: Optional[List[MediaSource]] = None """ The sources for the media. For YouTube, Dailymotion and Vimeo, only one source can be specified. """ @@ -2399,11 +2576,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class RichTextBlock(CardElement): """A rich text block that displays formatted text.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['RichTextBlock'] = 'RichTextBlock' + type: Literal["RichTextBlock"] = "RichTextBlock" """ Must be **RichTextBlock**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -2413,7 +2592,7 @@ class RichTextBlock(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -2423,7 +2602,7 @@ class RichTextBlock(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label_for: Optional[str] = None """ The Id of the input the RichTextBlock should act as the label of. """ @@ -2494,8 +2673,10 @@ def with_inlines(self, value: Union[List[CardElement], List[str]]) -> Self: self.inlines = value return self + class ColumnDefinition(SerializableObject): """Defines a column in a Table element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ horizontal_cell_content_alignment: Optional[HorizontalAlignment] = None @@ -2521,11 +2702,13 @@ def with_width(self, value: Union[str, float]) -> Self: self.width = value return self + class TableCell(CardElement): """Represents a cell in a table row.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['TableCell'] = 'TableCell' + type: Literal["TableCell"] = "TableCell" """ Must be **TableCell**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -2535,7 +2718,7 @@ class TableCell(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -2543,7 +2726,7 @@ class TableCell(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the element is tapped or clicked. Action.ShowCard is not supported. """ @@ -2551,7 +2734,7 @@ class TableCell(CardElement): """ The style of the container. Container styles control the colors of the background, border and text inside the container, in such a way that contrast requirements are always met. """ layouts: Optional[List[SerializeAsAny[ContainerLayout]]] = None """ The layouts associated with the container. The container can dynamically switch from one layout to another as the card's width changes. See [Container layouts](topic:container-layouts) for more details. """ - bleed: Optional[bool] = None + bleed: Optional[bool] = False """ Controls if the container should bleed into its parent. A bleeding container extends into its parent's padding. """ min_height: Optional[str] = None """ The minimum height, in pixels, of the container, in the `px` format. """ @@ -2658,11 +2841,13 @@ def with_items(self, value: List[CardElement]) -> Self: self.items = value return self + class TableRow(CardElement): """Represents a row of cells in a table.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['TableRow'] = 'TableRow' + type: Literal["TableRow"] = "TableRow" """ Must be **TableRow**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -2672,7 +2857,7 @@ class TableRow(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -2682,11 +2867,11 @@ class TableRow(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ - show_border: Optional[bool] = None + show_border: Optional[bool] = False """ Controls if a border should be displayed around the container. """ - rounded_corners: Optional[bool] = None + rounded_corners: Optional[bool] = False """ Controls if the container should have rounded corners. """ style: Optional[ContainerStyle] = None """ The style of the container. Container styles control the colors of the background, border and text inside the container, in such a way that contrast requirements are always met. """ @@ -2777,11 +2962,13 @@ def with_cells(self, value: List[TableCell]) -> Self: self.cells = value return self + class Table(CardElement): """Use tables to display data in a tabular way, with rows, columns and cells.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Table'] = 'Table' + type: Literal["Table"] = "Table" """ Must be **Table**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -2791,7 +2978,7 @@ class Table(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -2801,13 +2988,13 @@ class Table(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ style: Optional[ContainerStyle] = None """ The style of the container. Container styles control the colors of the background, border and text inside the container, in such a way that contrast requirements are always met. """ - show_border: Optional[bool] = None + show_border: Optional[bool] = False """ Controls if a border should be displayed around the container. """ - rounded_corners: Optional[bool] = None + rounded_corners: Optional[bool] = False """ Controls if the container should have rounded corners. """ columns: Optional[List[ColumnDefinition]] = None """ The columns in the table. """ @@ -2926,11 +3113,13 @@ def with_rows(self, value: List[TableRow]) -> Self: self.rows = value return self + class TextBlock(CardElement): """A block of text, optionally formatted using Markdown.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['TextBlock'] = 'TextBlock' + type: Literal["TextBlock"] = "TextBlock" """ Must be **TextBlock**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -2940,7 +3129,7 @@ class TextBlock(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -2950,7 +3139,7 @@ class TextBlock(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ text: Optional[str] = None """ The text to display. A subset of markdown is supported. """ @@ -2964,7 +3153,7 @@ class TextBlock(CardElement): """ Controls whether the text should be renderer using a subtler variant of the select color. """ font_type: Optional[FontType] = None """ The type of font to use for rendering. """ - wrap: Optional[bool] = None + wrap: Optional[bool] = False """ Controls if the text should wrap. """ max_lines: Optional[float] = None """ The maximum number of lines to display. """ @@ -3069,8 +3258,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class Fact(SerializableObject): """A fact in a FactSet element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ title: Optional[str] = None @@ -3090,11 +3281,13 @@ def with_value(self, value: str) -> Self: self.value = value return self + class FactSet(CardElement): """A set of facts, displayed as a table or a vertical list when horizontal space is constrained.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['FactSet'] = 'FactSet' + type: Literal["FactSet"] = "FactSet" """ Must be **FactSet**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3104,7 +3297,7 @@ class FactSet(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -3112,7 +3305,7 @@ class FactSet(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ facts: Optional[List[Fact]] = None """ The facts in the set. """ @@ -3173,8 +3366,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class TeamsImageProperties(SerializableObject): """Represents a set of Teams-specific properties on an image.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ allow_expand: Optional[bool] = None @@ -3188,11 +3383,13 @@ def with_allow_expand(self, value: bool) -> Self: self.allow_expand = value return self + class Image(CardElement): """A standalone image element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Image'] = 'Image' + type: Literal["Image"] = "Image" """ Must be **Image**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3202,7 +3399,7 @@ class Image(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ horizontal_alignment: Optional[HorizontalAlignment] = None """ Controls how the element should be horizontally aligned. """ @@ -3210,7 +3407,7 @@ class Image(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ url: Optional[str] = None """ The URL (or Base64-encoded Data URI) of the image. Acceptable formats are PNG, JPEG, GIF and SVG. """ @@ -3226,7 +3423,7 @@ class Image(CardElement): """ The width of the image. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the image is tapped or clicked. Action.ShowCard is not supported. """ - allow_expand: Optional[bool] = None + allow_expand: Optional[bool] = False """ Controls if the image can be expanded to full screen. """ msteams: Optional[TeamsImageProperties] = None """ Teams-specific metadata associated with the image. """ @@ -3349,11 +3546,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class ImageSet(CardElement): """A set of images, displayed side-by-side and wrapped across multiple rows as needed.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['ImageSet'] = 'ImageSet' + type: Literal["ImageSet"] = "ImageSet" """ Must be **ImageSet**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3363,7 +3562,7 @@ class ImageSet(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -3373,7 +3572,7 @@ class ImageSet(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ images: Optional[List[Image]] = None """ The images in the set. """ @@ -3444,11 +3643,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class TextInput(CardElement): """An input to allow the user to enter text.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Input.Text'] = 'Input.Text' + type: Literal["Input.Text"] = "Input.Text" """ Must be **Input.Text**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3458,7 +3659,7 @@ class TextInput(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -3466,13 +3667,13 @@ class TextInput(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the input. A label should **always** be provided to ensure the best user experience especially for users of assistive technology. """ - is_required: Optional[bool] = None + is_required: Optional[bool] = False """ Controls whether the input is required. See [Input validation](topic:input-validation) for more details. """ error_message: Optional[str] = None """ The error message to display when the input fails validation. See [Input validation](topic:input-validation) for more details. """ @@ -3482,7 +3683,7 @@ class TextInput(CardElement): """ The default value of the input. """ max_length: Optional[float] = None """ The maximum length of the text in the input. """ - is_multiline: Optional[bool] = None + is_multiline: Optional[bool] = False """ Controls if the input should allow multiple lines of text. """ placeholder: Optional[str] = None """ The text to display as a placeholder when the user hasn't entered a value. """ @@ -3589,11 +3790,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class DateInput(CardElement): """An input to allow the user to select a date.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Input.Date'] = 'Input.Date' + type: Literal["Input.Date"] = "Input.Date" """ Must be **Input.Date**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3603,7 +3806,7 @@ class DateInput(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -3611,13 +3814,13 @@ class DateInput(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the input. A label should **always** be provided to ensure the best user experience especially for users of assistive technology. """ - is_required: Optional[bool] = None + is_required: Optional[bool] = False """ Controls whether the input is required. See [Input validation](topic:input-validation) for more details. """ error_message: Optional[str] = None """ The error message to display when the input fails validation. See [Input validation](topic:input-validation) for more details. """ @@ -3716,11 +3919,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class TimeInput(CardElement): """An input to allow the user to select a time.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Input.Time'] = 'Input.Time' + type: Literal["Input.Time"] = "Input.Time" """ Must be **Input.Time**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3730,7 +3935,7 @@ class TimeInput(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -3738,13 +3943,13 @@ class TimeInput(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the input. A label should **always** be provided to ensure the best user experience especially for users of assistive technology. """ - is_required: Optional[bool] = None + is_required: Optional[bool] = False """ Controls whether the input is required. See [Input validation](topic:input-validation) for more details. """ error_message: Optional[str] = None """ The error message to display when the input fails validation. See [Input validation](topic:input-validation) for more details. """ @@ -3843,11 +4048,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class NumberInput(CardElement): """An input to allow the user to enter a number.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Input.Number'] = 'Input.Number' + type: Literal["Input.Number"] = "Input.Number" """ Must be **Input.Number**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3857,7 +4064,7 @@ class NumberInput(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -3865,13 +4072,13 @@ class NumberInput(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the input. A label should **always** be provided to ensure the best user experience especially for users of assistive technology. """ - is_required: Optional[bool] = None + is_required: Optional[bool] = False """ Controls whether the input is required. See [Input validation](topic:input-validation) for more details. """ error_message: Optional[str] = None """ The error message to display when the input fails validation. See [Input validation](topic:input-validation) for more details. """ @@ -3970,11 +4177,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class ToggleInput(CardElement): """An input to allow the user to select between on/off states.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Input.Toggle'] = 'Input.Toggle' + type: Literal["Input.Toggle"] = "Input.Toggle" """ Must be **Input.Toggle**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -3984,7 +4193,7 @@ class ToggleInput(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -3992,13 +4201,13 @@ class ToggleInput(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the input. A label should **always** be provided to ensure the best user experience especially for users of assistive technology. """ - is_required: Optional[bool] = None + is_required: Optional[bool] = False """ Controls whether the input is required. See [Input validation](topic:input-validation) for more details. """ error_message: Optional[str] = None """ The error message to display when the input fails validation. See [Input validation](topic:input-validation) for more details. """ @@ -4109,8 +4318,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class Choice(SerializableObject): """A choice as used by the Input.ChoiceSet input.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ title: Optional[str] = None @@ -4130,11 +4341,13 @@ def with_value(self, value: str) -> Self: self.value = value return self + class QueryData(SerializableObject): """Defines a query to dynamically fetch data from a Bot.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Data.Query'] = 'Data.Query' + type: Literal["Data.Query"] = "Data.Query" """ Must be **Data.Query**. """ dataset: Optional[str] = None """ The dataset from which to fetch the data. """ @@ -4165,11 +4378,13 @@ def with_skip(self, value: float) -> Self: self.skip = value return self + class ChoiceSetInput(CardElement): """An input to allow the user to select one or more values.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Input.ChoiceSet'] = 'Input.ChoiceSet' + type: Literal["Input.ChoiceSet"] = "Input.ChoiceSet" """ Must be **Input.ChoiceSet**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -4179,7 +4394,7 @@ class ChoiceSetInput(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -4187,13 +4402,13 @@ class ChoiceSetInput(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the input. A label should **always** be provided to ensure the best user experience especially for users of assistive technology. """ - is_required: Optional[bool] = None + is_required: Optional[bool] = False """ Controls whether the input is required. See [Input validation](topic:input-validation) for more details. """ error_message: Optional[str] = None """ The error message to display when the input fails validation. See [Input validation](topic:input-validation) for more details. """ @@ -4207,13 +4422,13 @@ class ChoiceSetInput(CardElement): """ A Data.Query object that defines the dataset from which to dynamically fetch the choices for the input. """ style: Optional[ChoiceSetInputStyle] = "compact" """ Controls whether the input should be displayed as a dropdown (compact) or a list of radio buttons or checkboxes (expanded). """ - is_multi_select: Optional[bool] = None + is_multi_select: Optional[bool] = False """ Controls whether multiple choices can be selected. """ placeholder: Optional[str] = None """ The text to display as a placeholder when the user has not entered any value. """ wrap: Optional[bool] = True """ Controls if choice titles should wrap. """ - use_multiple_columns: Optional[bool] = None + use_multiple_columns: Optional[bool] = False """ Controls whether choice items are arranged in multiple columns in expanded mode, or in a single column. Default is false. """ min_column_width: Optional[str] = None """ The minimum width, in pixels, for each column when using a multi-column layout. This ensures that choice items remain readable even when horizontal space is limited. Default is 100 pixels. """ @@ -4322,11 +4537,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class RatingInput(CardElement): """An input to allow the user to rate something using stars.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Input.Rating'] = 'Input.Rating' + type: Literal["Input.Rating"] = "Input.Rating" """ Must be **Input.Rating**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -4336,7 +4553,7 @@ class RatingInput(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -4344,13 +4561,13 @@ class RatingInput(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the input. A label should **always** be provided to ensure the best user experience especially for users of assistive technology. """ - is_required: Optional[bool] = None + is_required: Optional[bool] = False """ Controls whether the input is required. See [Input validation](topic:input-validation) for more details. """ error_message: Optional[str] = None """ The error message to display when the input fails validation. See [Input validation](topic:input-validation) for more details. """ @@ -4360,7 +4577,7 @@ class RatingInput(CardElement): """ The default value of the input. """ max: Optional[float] = 5 """ The number of stars to display. """ - allow_half_steps: Optional[bool] = None + allow_half_steps: Optional[bool] = False """ Controls if the user can select half stars. """ size: Optional[RatingSize] = "Large" """ The size of the stars. """ @@ -4455,11 +4672,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class Rating(CardElement): """A read-only star rating element, to display the rating of something.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Rating'] = 'Rating' + type: Literal["Rating"] = "Rating" """ Must be **Rating**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -4469,7 +4688,7 @@ class Rating(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -4479,7 +4698,7 @@ class Rating(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ value: Optional[float] = None """ The value of the rating. Must be between 0 and max. """ @@ -4574,8 +4793,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class IconInfo(SerializableObject): """Defines information about a Fluent icon and how it should be rendered.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ name: Optional[str] = None @@ -4607,11 +4828,13 @@ def with_color(self, value: TextColor) -> Self: self.color = value return self + class CompoundButton(CardElement): """A special type of button with an icon, title and description.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['CompoundButton'] = 'CompoundButton' + type: Literal["CompoundButton"] = "CompoundButton" """ Must be **CompoundButton**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -4621,7 +4844,7 @@ class CompoundButton(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -4631,7 +4854,7 @@ class CompoundButton(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ icon: Optional[IconInfo] = None """ The icon to show on the button. """ @@ -4720,11 +4943,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class Icon(CardElement): """A standalone icon element. Icons can be picked from the vast [Adaptive Card icon catalog](https://adaptivecards.microsoft.com/?topic=icon-catalog).""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Icon'] = 'Icon' + type: Literal["Icon"] = "Icon" """ Must be **Icon**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -4734,7 +4959,7 @@ class Icon(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ horizontal_alignment: Optional[HorizontalAlignment] = None """ Controls how the element should be horizontally aligned. """ @@ -4742,7 +4967,7 @@ class Icon(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ name: Optional[str] = None """ The name of the icon to display. """ @@ -4827,11 +5052,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class CarouselPage(CardElement): """A page inside a Carousel element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['CarouselPage'] = 'CarouselPage' + type: Literal["CarouselPage"] = "CarouselPage" """ Must be **CarouselPage**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -4845,15 +5072,15 @@ class CarouselPage(CardElement): """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the element is tapped or clicked. Action.ShowCard is not supported. """ style: Optional[ContainerStyle] = None """ The style of the container. Container styles control the colors of the background, border and text inside the container, in such a way that contrast requirements are always met. """ - show_border: Optional[bool] = None + show_border: Optional[bool] = False """ Controls if a border should be displayed around the container. """ - rounded_corners: Optional[bool] = None + rounded_corners: Optional[bool] = False """ Controls if the container should have rounded corners. """ layouts: Optional[List[SerializeAsAny[ContainerLayout]]] = None """ The layouts associated with the container. The container can dynamically switch from one layout to another as the card's width changes. See [Container layouts](topic:container-layouts) for more details. """ @@ -4958,11 +5185,13 @@ def with_items(self, value: List[CardElement]) -> Self: self.items = value return self + class Carousel(CardElement): """A carousel with sliding pages.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Carousel'] = 'Carousel' + type: Literal["Carousel"] = "Carousel" """ Must be **Carousel**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -4972,7 +5201,7 @@ class Carousel(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -4980,9 +5209,9 @@ class Carousel(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ - bleed: Optional[bool] = None + bleed: Optional[bool] = False """ Controls if the container should bleed into its parent. A bleeding container extends into its parent's padding. """ min_height: Optional[str] = None """ The minimum height, in pixels, of the container, in the `px` format. """ @@ -5059,11 +5288,13 @@ def with_pages(self, value: List[CarouselPage]) -> Self: self.pages = value return self + class Badge(CardElement): """A badge element to show an icon and/or text in a compact form over a colored background.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Badge'] = 'Badge' + type: Literal["Badge"] = "Badge" """ Must be **Badge**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -5073,7 +5304,7 @@ class Badge(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -5083,7 +5314,7 @@ class Badge(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ text: Optional[str] = None """ The text to display. """ @@ -5190,11 +5421,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class ProgressRing(CardElement): """A spinning ring element, to indicate progress.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['ProgressRing'] = 'ProgressRing' + type: Literal["ProgressRing"] = "ProgressRing" """ Must be **ProgressRing**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -5204,7 +5437,7 @@ class ProgressRing(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -5214,7 +5447,7 @@ class ProgressRing(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ label: Optional[str] = None """ The label of the progress ring. """ @@ -5291,11 +5524,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class ProgressBar(CardElement): """A progress bar element, to represent a value within a range.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['ProgressBar'] = 'ProgressBar' + type: Literal["ProgressBar"] = "ProgressBar" """ Must be **ProgressBar**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -5305,7 +5540,7 @@ class ProgressBar(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -5315,7 +5550,7 @@ class ProgressBar(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ value: Optional[float] = None """ The value of the progress bar. Must be between 0 and max. """ @@ -5392,13 +5627,15 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class DonutChartData(SerializableObject): """A data point in a Donut chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ legend: Optional[str] = None """ The legend of the chart. """ - value: Optional[float] = None + value: Optional[float] = 0 """ The value associated with the data point. """ color: Optional[ChartColor] = None """ The color to use for the data point. See [Chart colors reference](topic:chart-colors-reference). """ @@ -5419,11 +5656,13 @@ def with_color(self, value: ChartColor) -> Self: self.color = value return self + class DonutChart(CardElement): """A donut chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.Donut'] = 'Chart.Donut' + type: Literal["Chart.Donut"] = "Chart.Donut" """ Must be **Chart.Donut**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -5433,7 +5672,7 @@ class DonutChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -5443,11 +5682,11 @@ class DonutChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -5562,11 +5801,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class PieChart(CardElement): """A pie chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.Pie'] = 'Chart.Pie' + type: Literal["Chart.Pie"] = "Chart.Pie" """ Must be **Chart.Pie**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -5576,7 +5817,7 @@ class PieChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -5586,11 +5827,11 @@ class PieChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -5705,13 +5946,15 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class BarChartDataValue(SerializableObject): """A single data point in a bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ x: Optional[str] = None """ The x axis value of the data point. """ - y: Optional[float] = None + y: Optional[float] = 0 """ The y axis value of the data point. """ def with_key(self, value: str) -> Self: @@ -5726,8 +5969,10 @@ def with_y(self, value: float) -> Self: self.y = value return self + class GroupedVerticalBarChartData(SerializableObject): """Represents a series of data points.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ legend: Optional[str] = None @@ -5753,11 +5998,13 @@ def with_color(self, value: ChartColor) -> Self: self.color = value return self + class GroupedVerticalBarChart(CardElement): """A grouped vertical bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.VerticalBar.Grouped'] = 'Chart.VerticalBar.Grouped' + type: Literal["Chart.VerticalBar.Grouped"] = "Chart.VerticalBar.Grouped" """ Must be **Chart.VerticalBar.Grouped**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -5767,7 +6014,7 @@ class GroupedVerticalBarChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -5777,11 +6024,11 @@ class GroupedVerticalBarChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -5795,13 +6042,13 @@ class GroupedVerticalBarChart(CardElement): """ The title of the y axis. """ color: Optional[ChartColor] = None """ The color to use for all data points. See [Chart colors reference](topic:chart-colors-reference). """ - stacked: Optional[bool] = None + stacked: Optional[bool] = False """ Controls if bars in the chart should be displayed as stacks instead of groups. **Note:** stacked vertical bar charts do not support custom Y ranges nor negative Y values. """ data: Optional[List[GroupedVerticalBarChartData]] = None """ The data points in a series. """ - show_bar_values: Optional[bool] = None + show_bar_values: Optional[bool] = False """ Controls if values should be displayed on each bar. """ y_min: Optional[float] = None """ The requested minimum for the Y axis range. The value used at runtime may be different to optimize visual presentation. @@ -5920,13 +6167,15 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class VerticalBarChartDataValue(SerializableObject): """Represents a data point in a vertical bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ x: Optional[Union[str, float]] = None """ The x axis value of the data point. """ - y: Optional[float] = None + y: Optional[float] = 0 """ The y axis value of the data point. """ color: Optional[ChartColor] = None """ The color to use for the bar associated with the data point. See [Chart colors reference](topic:chart-colors-reference). """ @@ -5947,11 +6196,13 @@ def with_color(self, value: ChartColor) -> Self: self.color = value return self + class VerticalBarChart(CardElement): """A vertical bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.VerticalBar'] = 'Chart.VerticalBar' + type: Literal["Chart.VerticalBar"] = "Chart.VerticalBar" """ Must be **Chart.VerticalBar**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -5961,7 +6212,7 @@ class VerticalBarChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -5971,11 +6222,11 @@ class VerticalBarChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -5991,7 +6242,7 @@ class VerticalBarChart(CardElement): """ The data to display in the chart. """ color: Optional[ChartColor] = None """ The color to use for all data points. See [Chart colors reference](topic:chart-colors-reference). """ - show_bar_values: Optional[bool] = None + show_bar_values: Optional[bool] = False """ Controls if the bar values should be displayed. """ y_min: Optional[float] = None """ The requested minimum for the Y axis range. The value used at runtime may be different to optimize visual presentation. """ @@ -6102,13 +6353,15 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class HorizontalBarChartDataValue(SerializableObject): """Represents a single data point in a horizontal bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ x: Optional[str] = None """ The x axis value of the data point. """ - y: Optional[float] = None + y: Optional[float] = 0 """ The y axis value of the data point. """ color: Optional[ChartColor] = None """ The color of the bar associated with the data point. See [Chart colors reference](topic:chart-colors-reference). """ @@ -6129,11 +6382,13 @@ def with_color(self, value: ChartColor) -> Self: self.color = value return self + class HorizontalBarChart(CardElement): """A horizontal bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.HorizontalBar'] = 'Chart.HorizontalBar' + type: Literal["Chart.HorizontalBar"] = "Chart.HorizontalBar" """ Must be **Chart.HorizontalBar**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -6143,7 +6398,7 @@ class HorizontalBarChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -6153,11 +6408,11 @@ class HorizontalBarChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -6272,13 +6527,15 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class StackedHorizontalBarChartDataPoint(SerializableObject): """A data point in a series.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ legend: Optional[str] = None """ The legend associated with the data point. """ - value: Optional[float] = None + value: Optional[float] = 0 """ The value of the data point. """ color: Optional[ChartColor] = None """ The color to use to render the bar associated with the data point. See [Chart colors reference](topic:chart-colors-reference). """ @@ -6299,8 +6556,10 @@ def with_color(self, value: ChartColor) -> Self: self.color = value return self + class StackedHorizontalBarChartData(SerializableObject): """Defines the collection of data series to display in as a stacked horizontal bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ title: Optional[str] = None @@ -6320,11 +6579,13 @@ def with_data(self, value: List[StackedHorizontalBarChartDataPoint]) -> Self: self.data = value return self + class StackedHorizontalBarChart(CardElement): """A stacked horizontal bar chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.HorizontalBar.Stacked'] = 'Chart.HorizontalBar.Stacked' + type: Literal["Chart.HorizontalBar.Stacked"] = "Chart.HorizontalBar.Stacked" """ Must be **Chart.HorizontalBar.Stacked**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -6334,7 +6595,7 @@ class StackedHorizontalBarChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -6344,11 +6605,11 @@ class StackedHorizontalBarChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -6457,8 +6718,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class LineChartValue(SerializableObject): """Represents a single data point in a line chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ x: Optional[Union[float, str]] = None @@ -6467,7 +6730,7 @@ class LineChartValue(SerializableObject): If all x values of the x [Chart.Line](topic:Chart.Line) are expressed as a number, or if all x values are expressed as a date string in the `YYYY-MM-DD` format, the chart will be rendered as a time series chart, i.e. x axis values will span across the minimum x value to maximum x value range. Otherwise, if x values are represented as a mix of numbers and strings or if at least one x value isn't in the `YYYY-MM-DD` format, the chart will be rendered as a categorical chart, i.e. x axis values will be displayed as categories. """ - y: Optional[float] = None + y: Optional[float] = 0 """ The y axis value of the data point. """ def with_key(self, value: str) -> Self: @@ -6482,8 +6745,10 @@ def with_y(self, value: float) -> Self: self.y = value return self + class LineChartData(SerializableObject): """Represents a collection of data points series in a line chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ legend: Optional[str] = None @@ -6509,11 +6774,13 @@ def with_color(self, value: ChartColor) -> Self: self.color = value return self + class LineChart(CardElement): """A line chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.Line'] = 'Chart.Line' + type: Literal["Chart.Line"] = "Chart.Line" """ Must be **Chart.Line**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -6523,7 +6790,7 @@ class LineChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -6533,11 +6800,11 @@ class LineChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -6658,11 +6925,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class GaugeChartLegend(SerializableObject): """The legend of the chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - size: Optional[float] = None + size: Optional[float] = 0 """ The size of the segment. """ legend: Optional[str] = None """ The legend text associated with the segment. """ @@ -6685,11 +6954,13 @@ def with_color(self, value: ChartColor) -> Self: self.color = value return self + class GaugeChart(CardElement): """A gauge chart.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Chart.Gauge'] = 'Chart.Gauge' + type: Literal["Chart.Gauge"] = "Chart.Gauge" """ Must be **Chart.Gauge**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -6699,7 +6970,7 @@ class GaugeChart(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -6709,11 +6980,11 @@ class GaugeChart(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ title: Optional[str] = None """ The title of the chart. """ - show_title: Optional[bool] = None + show_title: Optional[bool] = False """ Controls whether the chart's title should be displayed. Defaults to `false`. """ color_set: Optional[ChartColorSet] = None """ The name of the set of colors to use to render the chart. See [Chart colors reference](topic:chart-colors-reference). """ @@ -6721,7 +6992,7 @@ class GaugeChart(CardElement): """ The maximum width, in pixels, of the chart, in the `px` format. """ show_legend: Optional[bool] = True """ Controls whether the chart's legend should be displayed. """ - min: Optional[float] = None + min: Optional[float] = 0 """ The minimum value of the gauge. """ max: Optional[float] = None """ The maximum value of the gauge. """ @@ -6735,7 +7006,7 @@ class GaugeChart(CardElement): """ Controls whether the outlines of the gauge segments are displayed. """ segments: Optional[List[GaugeChartLegend]] = None """ The segments to display in the gauge. """ - value: Optional[float] = None + value: Optional[float] = 0 """ The value of the gauge. """ value_format: Optional[GaugeChartValueFormat] = "Percentage" """ The format used to display the gauge's value. """ @@ -6852,11 +7123,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class CodeBlock(CardElement): """A formatted and syntax-colored code block.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['CodeBlock'] = 'CodeBlock' + type: Literal["CodeBlock"] = "CodeBlock" """ Must be **CodeBlock**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -6866,7 +7139,7 @@ class CodeBlock(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -6876,7 +7149,7 @@ class CodeBlock(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ code_snippet: Optional[str] = None """ The code snippet to display. """ @@ -6953,8 +7226,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class PersonaProperties(SerializableObject): """Represents the properties of a Persona component.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ id: Optional[str] = None @@ -6992,11 +7267,13 @@ def with_style(self, value: PersonaDisplayStyle) -> Self: self.style = value return self + class ComUserMicrosoftGraphComponent(CardElement): """Displays a user's information, including their profile picture.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Component'] = 'Component' + type: Literal["Component"] = "Component" """ Must be **Component**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7006,7 +7283,7 @@ class ComUserMicrosoftGraphComponent(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -7016,9 +7293,9 @@ class ComUserMicrosoftGraphComponent(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ - name: Literal['graph.microsoft.com/user'] = 'graph.microsoft.com/user' + name: Literal["graph.microsoft.com/user"] = "graph.microsoft.com/user" """ Must be **graph.microsoft.com/user**. """ properties: Optional[PersonaProperties] = None """ The properties of the Persona component. """ @@ -7083,8 +7360,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class PersonaSetProperties(SerializableObject): """Represents the properties of a PersonaSet component.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ users: Optional[List[PersonaProperties]] = None @@ -7110,11 +7389,13 @@ def with_style(self, value: PersonaDisplayStyle) -> Self: self.style = value return self + class ComUsersMicrosoftGraphComponent(CardElement): """Displays multiple users' information, including their profile pictures.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Component'] = 'Component' + type: Literal["Component"] = "Component" """ Must be **Component**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7124,7 +7405,7 @@ class ComUsersMicrosoftGraphComponent(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -7134,9 +7415,9 @@ class ComUsersMicrosoftGraphComponent(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ - name: Literal['graph.microsoft.com/users'] = 'graph.microsoft.com/users' + name: Literal["graph.microsoft.com/users"] = "graph.microsoft.com/users" """ Must be **graph.microsoft.com/users**. """ properties: Optional[PersonaSetProperties] = None """ The properties of the PersonaSet component. """ @@ -7201,8 +7482,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class ResourceVisualization(SerializableObject): """Represents a visualization of a resource.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ media: Optional[str] = None @@ -7216,8 +7499,10 @@ def with_media(self, value: str) -> Self: self.media = value return self + class ResourceProperties(SerializableObject): """Represents the properties of a resource component.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ id: Optional[str] = None @@ -7243,11 +7528,13 @@ def with_resource_visualization(self, value: ResourceVisualization) -> Self: self.resource_visualization = value return self + class ComResourceMicrosoftGraphComponent(CardElement): """Displays information about a generic graph resource.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Component'] = 'Component' + type: Literal["Component"] = "Component" """ Must be **Component**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7257,7 +7544,7 @@ class ComResourceMicrosoftGraphComponent(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -7267,9 +7554,9 @@ class ComResourceMicrosoftGraphComponent(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ - name: Literal['graph.microsoft.com/resource'] = 'graph.microsoft.com/resource' + name: Literal["graph.microsoft.com/resource"] = "graph.microsoft.com/resource" """ Must be **graph.microsoft.com/resource**. """ properties: Optional[ResourceProperties] = None """ The properties of the resource. """ @@ -7334,8 +7621,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class FileProperties(SerializableObject): """Represents the properties of a file component.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ name: Optional[str] = None @@ -7361,11 +7650,13 @@ def with_url(self, value: str) -> Self: self.url = value return self + class ComFileMicrosoftGraphComponent(CardElement): """Displays information about a file resource.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Component'] = 'Component' + type: Literal["Component"] = "Component" """ Must be **Component**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7375,7 +7666,7 @@ class ComFileMicrosoftGraphComponent(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -7385,9 +7676,9 @@ class ComFileMicrosoftGraphComponent(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ - name: Literal['graph.microsoft.com/file'] = 'graph.microsoft.com/file' + name: Literal["graph.microsoft.com/file"] = "graph.microsoft.com/file" """ Must be **graph.microsoft.com/file**. """ properties: Optional[FileProperties] = None """ The properties of the file. """ @@ -7452,8 +7743,10 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class CalendarEventAttendee(SerializableObject): """Represents a calendar event attendee.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ name: Optional[str] = None @@ -7491,8 +7784,10 @@ def with_status(self, value: str) -> Self: self.status = value return self + class CalendarEventProperties(SerializableObject): """The properties of a calendar event.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ id: Optional[str] = None @@ -7572,11 +7867,13 @@ def with_organizer(self, value: CalendarEventAttendee) -> Self: self.organizer = value return self + class ComEventMicrosoftGraphComponent(CardElement): """Displays information about a calendar event.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['Component'] = 'Component' + type: Literal["Component"] = "Component" """ Must be **Component**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7586,7 +7883,7 @@ class ComEventMicrosoftGraphComponent(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - separator: Optional[bool] = None + separator: Optional[bool] = False """ Controls whether a separator line should be displayed above the element to visually separate it from the previous element. No separator will be displayed for the first element in a container, even if this property is set to true. """ height: Optional[ElementHeight] = "auto" """ The height of the element. When set to stretch, the element will use the remaining vertical space in its container. """ @@ -7596,9 +7893,9 @@ class ComEventMicrosoftGraphComponent(CardElement): """ Controls the amount of space between this element and the previous one. No space will be added for the first element in a container. """ target_width: Optional[TargetWidth] = None """ Controls for which card width the element should be displayed. If targetWidth isn't specified, the element is rendered at all card widths. Using targetWidth makes it possible to author responsive cards that adapt their layout to the available horizontal space. For more details, see [Responsive layout](topic:responsive-layout). """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ - name: Literal['graph.microsoft.com/event'] = 'graph.microsoft.com/event' + name: Literal["graph.microsoft.com/event"] = "graph.microsoft.com/event" """ Must be **graph.microsoft.com/event**. """ properties: Optional[CalendarEventProperties] = None """ The properties of the event. """ @@ -7663,11 +7960,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class TextRun(CardElement): """A block of text inside a RichTextBlock element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['TextRun'] = 'TextRun' + type: Literal["TextRun"] = "TextRun" """ Must be **TextRun**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7675,7 +7974,7 @@ class TextRun(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ text: Optional[str] = None """ The text to display. A subset of markdown is supported. """ @@ -7689,13 +7988,13 @@ class TextRun(CardElement): """ Controls whether the text should be renderer using a subtler variant of the select color. """ font_type: Optional[FontType] = None """ The type of font to use for rendering. """ - italic: Optional[bool] = None + italic: Optional[bool] = False """ Controls if the text should be italicized. """ - strikethrough: Optional[bool] = None + strikethrough: Optional[bool] = False """ Controls if the text should be struck through. """ - highlight: Optional[bool] = None + highlight: Optional[bool] = False """ Controls if the text should be highlighted. """ - underline: Optional[bool] = None + underline: Optional[bool] = False """ Controls if the text should be underlined. """ select_action: Optional[SerializeAsAny[Action]] = None """ An Action that will be invoked when the text is tapped or clicked. Action.ShowCard is not supported. """ @@ -7776,11 +8075,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class IconRun(CardElement): """An inline icon inside a RichTextBlock element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['IconRun'] = 'IconRun' + type: Literal["IconRun"] = "IconRun" """ Must be **IconRun**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7788,7 +8089,7 @@ class IconRun(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ name: Optional[str] = None """ The name of the inline icon to display. """ @@ -7853,11 +8154,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class ImageRun(CardElement): """An inline image inside a RichTextBlock element.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['ImageRun'] = 'ImageRun' + type: Literal["ImageRun"] = "ImageRun" """ Must be **ImageRun**. """ id: Optional[str] = None """ A unique identifier for the element or action. Input elements must have an id, otherwise they will not be validated and their values will not be sent to the Bot. """ @@ -7865,7 +8168,7 @@ class ImageRun(CardElement): """ The locale associated with the element. """ is_visible: Optional[bool] = True """ Controls the visibility of the element. """ - is_sort_key: Optional[bool] = None + is_sort_key: Optional[bool] = False """ Controls whether the element should be used as a sort key by elements that allow sorting across a collection of elements. """ url: Optional[str] = None """ The URL (or Base64-encoded Data URI) of the image. Acceptable formats are PNG, JPEG, GIF and SVG. """ @@ -7930,11 +8233,13 @@ def with_fallback(self, value: Union[CardElement, FallbackElement]) -> Self: self.fallback = value return self + class ImBackSubmitActionData(SerializableObject): """Represents Teams-specific data in an Action.Submit to send an Instant Message back to the Bot.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['imBack'] = 'imBack' + type: Literal["imBack"] = "imBack" """ Must be **imBack**. """ value: Optional[str] = None """ The value that will be sent to the Bot. """ @@ -7947,8 +8252,10 @@ def with_value(self, value: str) -> Self: self.value = value return self + class TabInfo(SerializableObject): """Represents information about the iFrame content, rendered in the collab stage popout window.""" + name: Optional[str] = None """ The name for the content. This will be displayed as the title of the window hosting the iFrame. """ content_url: Optional[str] = None @@ -7974,9 +8281,11 @@ def with_website_url(self, value: str) -> Self: self.website_url = value return self + class CollabStageInvokeDataValue(SerializableObject): """Data for invoking a collaboration stage action.""" - type: Literal['tab/tabInfoAction'] = 'tab/tabInfoAction' + + type: Literal["tab/tabInfoAction"] = "tab/tabInfoAction" """ Must be **tab/tabInfoAction**. """ tab_info: Optional[TabInfo] = None """ Provides information about the iFrame content, rendered in the collab stage popout window. """ @@ -7985,11 +8294,13 @@ def with_tab_info(self, value: TabInfo) -> Self: self.tab_info = value return self + class InvokeSubmitActionData(SerializableObject): """Represents Teams-specific data in an Action.Submit to make an Invoke request to the Bot.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['invoke'] = 'invoke' + type: Literal["invoke"] = "invoke" """ Must be **invoke**. """ value: Optional[Union[Dict[str, Any], CollabStageInvokeDataValue]] = None """ The object to send to the Bot with the Invoke request. Can be strongly typed as one of the below values to trigger a specific action in Teams. """ @@ -8002,11 +8313,13 @@ def with_value(self, value: Union[Dict[str, Any], CollabStageInvokeDataValue]) - self.value = value return self + class MessageBackSubmitActionData(SerializableObject): """Represents Teams-specific data in an Action.Submit to send a message back to the Bot.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['messageBack'] = 'messageBack' + type: Literal["messageBack"] = "messageBack" """ Must be **messageBack**. """ text: Optional[str] = None """ The text that will be sent to the Bot. """ @@ -8031,11 +8344,13 @@ def with_value(self, value: Dict[str, Any]) -> Self: self.value = value return self + class SigninSubmitActionData(SerializableObject): """Represents Teams-specific data in an Action.Submit to sign in a user.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['signin'] = 'signin' + type: Literal["signin"] = "signin" """ Must be **signin**. """ value: Optional[str] = None """ The URL to redirect the end-user for signing in. """ @@ -8048,11 +8363,13 @@ def with_value(self, value: str) -> Self: self.value = value return self + class TaskFetchSubmitActionData(SerializableObject): """Represents Teams-specific data in an Action.Submit to open a task module.""" + key: Optional[str] = None """ Defines an optional key for the object. Keys are seldom needed, but in some scenarios, specifying keys can help maintain visual state in the host application. """ - type: Literal['task/fetch'] = 'task/fetch' + type: Literal["task/fetch"] = "task/fetch" """ Must be **task/fetch**. """ def with_key(self, value: str) -> Self: