Feature/devexp 1512 python oas synch sprint 11 (#7)

* feat(conversation): add display_mode field to ChoiceOption and ChoiceOptionDict

* feat(Numbers): update numberSinchEvent with spec

Author: marcos-sinch

CHANGELOG.md

@@ -25,10 +25,13 @@ All notable changes to the **Sinch Python SDK** are documented in this file.
 ### Numbers
 
 - **[refactor]** `voice_configuration`, `sms_configuration`, and `number_pattern` request fields are now typed Pydantic models instead of raw dicts with validators. Added `VoiceConfigurationCustom`/`ScheduledVoiceProvisioningCustom` response variants for unrecognized voice configuration types.
+- **[feature]** `parse_event()` now returns a `NumberSinchEventPayload` resolved to one of two new concrete subclasses depending on `resourceType`: `ActiveNumberSinchEvent` (`ACTIVE_NUMBER`) and `NumberOrderSinchEvent` (`NUMBER_ORDER`), both inheriting from `NumberSinchEvent`.
+- **[deprecation notice]** `NumberSinchEvent` is deprecated; in 3.0 it will be removed in favour of the concrete subclasses plus `NumberBaseSinchEvent`, which will become the fallback for unrecognized resource types.
 
 ### Conversation
 
 - **[feature]** Conversation Apps API: `create`, `get`, `list`, `update`, and `delete` operations, with full model, endpoints and unit/e2e test coverage.
+- **[feature]**  New field `display_mode` added to `ChoiceOption` and `ChoiceOptionDict` to control whether a choice is transient or persistent in the message bubble.
 - **[deprecation notice]** `ConversationProcessingMode` and `ConversationRetentionPolicyType` are deprecated; they are unused by the SDK and will be removed in 3.0.
 - **[deprecation notice]** `ConversationMetadataReportView` is deprecated in favour of `ConversationMetadataReportViewType`; it will be removed in 3.0.
 - **[deprecation notice]** `ConversationChannel` is deprecated in favour of `ConversationChannelType`; it will be removed in 3.0.

sinch/domains/conversation/models/v1/messages/categories/choice/choice_options.py

@@ -1,25 +1,30 @@
 from typing import Any, Optional
+
 from pydantic import Field
+
+from sinch.domains.conversation.models.v1.messages.categories.calendar.calendar_message import (
+    CalendarMessage,
+)
 from sinch.domains.conversation.models.v1.messages.categories.call.call_message import (
     CallMessage,
 )
 from sinch.domains.conversation.models.v1.messages.categories.location.location_message import (
     LocationMessage,
 )
-from sinch.domains.conversation.models.v1.messages.categories.url.url_message import (
-    UrlMessage,
-)
-from sinch.domains.conversation.models.v1.messages.categories.calendar.calendar_message import (
-    CalendarMessage,
-)
 from sinch.domains.conversation.models.v1.messages.categories.sharelocation.share_location_message import (
     ShareLocationMessage,
 )
+from sinch.domains.conversation.models.v1.messages.categories.text import (
+    TextMessage,
+)
+from sinch.domains.conversation.models.v1.messages.categories.url.url_message import (
+    UrlMessage,
+)
 from sinch.domains.conversation.models.v1.messages.internal.base import (
     BaseModelConfiguration,
 )
-from sinch.domains.conversation.models.v1.messages.categories.text import (
-    TextMessage,
+from sinch.domains.conversation.models.v1.messages.types.display_mode_type import (
+    DisplayModeType,
 )
 
 
@@ -28,6 +33,10 @@ class ChoiceMessageWithPostback(BaseModelConfiguration):
         default=None,
         description="An optional field. This data will be returned in the ChoiceResponseMessage. The default is message_id_{text, title}.",
     )
+    display_mode: Optional[DisplayModeType] = Field(
+        default=None,
+        description="Controls the display behavior of a choice.",
+    )
 
 
 class CallChoiceMessage(ChoiceMessageWithPostback):

sinch/domains/conversation/models/v1/messages/types/__init__.py

@@ -1,27 +1,57 @@
 from sinch.domains.conversation.models.v1.messages.types.agent_type import (
     AgentType,
 )
+from sinch.domains.conversation.models.v1.messages.types.card_height_type import (
+    CardHeightType,
+)
+from sinch.domains.conversation.models.v1.messages.types.card_message_dict import (
+    CardMessageDict,
+)
+from sinch.domains.conversation.models.v1.messages.types.carousel_message_dict import (
+    CarouselMessageDict,
+)
 from sinch.domains.conversation.models.v1.messages.types.channel_specific_message_type import (
     ChannelSpecificMessageType,
 )
+from sinch.domains.conversation.models.v1.messages.types.choice_message_dict import (
+    ChoiceMessageDict,
+)
+from sinch.domains.conversation.models.v1.messages.types.contact_info_message_dict import (
+    ContactInfoMessageDict,
+)
 from sinch.domains.conversation.models.v1.messages.types.conversation_channel_type import (
     ConversationChannelType,
 )
+from sinch.domains.conversation.models.v1.messages.types.conversation_direction_type import (
+    ConversationDirectionType,
+)
 from sinch.domains.conversation.models.v1.messages.types.conversation_messages_view_type import (
     ConversationMessagesViewType,
 )
-from sinch.domains.conversation.models.v1.messages.types.conversation_direction_type import (
-    ConversationDirectionType,
+from sinch.domains.conversation.models.v1.messages.types.display_mode_type import (
+    DisplayModeType,
 )
-from sinch.domains.conversation.models.v1.messages.types.processing_mode_type import (
-    ProcessingModeType,
+from sinch.domains.conversation.models.v1.messages.types.list_message_dict import (
+    ListMessageDict,
 )
-from sinch.domains.conversation.models.v1.messages.types.card_height_type import (
-    CardHeightType,
+from sinch.domains.conversation.models.v1.messages.types.location_message_dict import (
+    LocationMessageDict,
+)
+from sinch.domains.conversation.models.v1.messages.types.media_properties_dict import (
+    MediaPropertiesDict,
+)
+from sinch.domains.conversation.models.v1.messages.types.message_content_type import (
+    MessageContentType,
+)
+from sinch.domains.conversation.models.v1.messages.types.message_queue_type import (
+    MessageQueueType,
 )
 from sinch.domains.conversation.models.v1.messages.types.messages_source_type import (
     MessageSourceType,
 )
+from sinch.domains.conversation.models.v1.messages.types.metadata_update_strategy_type import (
+    MetadataUpdateStrategyType,
+)
 from sinch.domains.conversation.models.v1.messages.types.payment_order_goods_type import (
     PaymentOrderGoodsType,
 )
@@ -34,58 +64,31 @@
 from sinch.domains.conversation.models.v1.messages.types.pix_key_type import (
     PixKeyType,
 )
-from sinch.domains.conversation.models.v1.messages.types.reason_code_type import (
-    ReasonCodeType,
-)
-from sinch.domains.conversation.models.v1.messages.types.reason_sub_code_type import (
-    ReasonSubCodeType,
-)
-from sinch.domains.conversation.models.v1.messages.types.whatsapp_interactive_nfm_reply_name_type import (
-    WhatsAppInteractiveNfmReplyNameType,
+from sinch.domains.conversation.models.v1.messages.types.processing_mode_type import (
+    ProcessingModeType,
 )
 from sinch.domains.conversation.models.v1.messages.types.processing_strategy_type import (
     ProcessingStrategyType,
 )
-from sinch.domains.conversation.models.v1.messages.types.metadata_update_strategy_type import (
-    MetadataUpdateStrategyType,
-)
-from sinch.domains.conversation.models.v1.messages.types.message_queue_type import (
-    MessageQueueType,
-)
-from sinch.domains.conversation.models.v1.messages.types.message_content_type import (
-    MessageContentType,
-)
-from sinch.domains.conversation.models.v1.messages.types.list_message_dict import (
-    ListMessageDict,
-)
-from sinch.domains.conversation.models.v1.messages.types.media_properties_dict import (
-    MediaPropertiesDict,
-)
-from sinch.domains.conversation.models.v1.messages.types.card_message_dict import (
-    CardMessageDict,
-)
-from sinch.domains.conversation.models.v1.messages.types.carousel_message_dict import (
-    CarouselMessageDict,
-)
-from sinch.domains.conversation.models.v1.messages.types.choice_message_dict import (
-    ChoiceMessageDict,
-)
-from sinch.domains.conversation.models.v1.messages.types.contact_info_message_dict import (
-    ContactInfoMessageDict,
-)
-from sinch.domains.conversation.models.v1.messages.types.location_message_dict import (
-    LocationMessageDict,
+from sinch.domains.conversation.models.v1.messages.types.reason_code_type import (
+    ReasonCodeType,
 )
-from sinch.domains.conversation.models.v1.messages.types.template_message_dict import (
-    TemplateMessageDict,
+from sinch.domains.conversation.models.v1.messages.types.reason_sub_code_type import (
+    ReasonSubCodeType,
 )
 from sinch.domains.conversation.models.v1.messages.types.recipient_dict import (
-    RecipientDict,
     ChannelRecipientIdentityDict,
+    RecipientDict,
 )
 from sinch.domains.conversation.models.v1.messages.types.send_message_request_body_dict import (
     SendMessageRequestBodyDict,
 )
+from sinch.domains.conversation.models.v1.messages.types.template_message_dict import (
+    TemplateMessageDict,
+)
+from sinch.domains.conversation.models.v1.messages.types.whatsapp_interactive_nfm_reply_name_type import (
+    WhatsAppInteractiveNfmReplyNameType,
+)
 
 __all__ = [
     "AgentType",
@@ -94,6 +97,7 @@
     "ConversationDirectionType",
     "ProcessingModeType",
     "CardHeightType",
+    "DisplayModeType",
     "ChannelSpecificMessageType",
     "ListMessageDict",
     "MediaPropertiesDict",

sinch/domains/conversation/models/v1/messages/types/choice_option_dict.py

@@ -1,4 +1,5 @@
 from typing import Any, TypedDict
+
 from typing_extensions import NotRequired
 
 from sinch.domains.conversation.models.v1.messages.types.calendar_message_dict import (
@@ -7,6 +8,9 @@
 from sinch.domains.conversation.models.v1.messages.types.call_message_dict import (
     CallMessageDict,
 )
+from sinch.domains.conversation.models.v1.messages.types.display_mode_type import (
+    DisplayModeType,
+)
 from sinch.domains.conversation.models.v1.messages.types.location_message_dict import (
     LocationMessageDict,
 )
@@ -25,6 +29,9 @@ class ChoiceOptionDict(TypedDict):
     # Optional metadata returned back to you as postback
     postback_data: NotRequired[Any]
 
+    # Controls the display behavior of a choice
+    display_mode: NotRequired[DisplayModeType]
+
     # Exactly one of the following keys is expected per choice:
     call_message: NotRequired[CallMessageDict]
     location_message: NotRequired[LocationMessageDict]

sinch/domains/conversation/models/v1/messages/types/display_mode_type.py

@@ -0,0 +1,8 @@
+from typing import Literal, Union
+
+from pydantic import StrictStr
+
+DisplayModeType = Union[
+    Literal["DISPLAY_MODE_UNSPECIFIED", "PERSISTENT"],
+    StrictStr,
+]

sinch/domains/numbers/models/v1/internal/update_event_destination_request.py

@@ -9,5 +9,5 @@ class UpdateEventDestinationRequest(BaseModelConfigurationRequest):
     hmac_secret: Optional[StrictStr] = Field(
         default=None,
         alias="hmacSecret",
-        description="The HMAC secret to be updated for the specified project",
+        description="The HMAC secret to be updated for the specified project. It must be between 32 and 64 characters, alphanumeric (A-Z, a-z, 0-9) and hyphens (-) only. Regex pattern: ^[a-zA-Z0-9-]{32,64}$",
     )

sinch/domains/numbers/sinch_events/v1/events/__init__.py

@@ -1,5 +1,21 @@
+from sinch.domains.numbers.sinch_events.v1.events.active_number_sinch_event import (
+    ActiveNumberSinchEvent,
+)
+from sinch.domains.numbers.sinch_events.v1.events.number_order_sinch_event import (
+    NumberOrderSinchEvent,
+)
 from sinch.domains.numbers.sinch_events.v1.events.number_sinch_event import (
     NumberSinchEvent,
 )
+from sinch.domains.numbers.sinch_events.v1.events.number_sinch_event_payload import (
+    NumberSinchEventAdapter,
+    NumberSinchEventPayload,
+)
 
-__all__ = ["NumberSinchEvent"]
+__all__ = [
+    "NumberSinchEvent",
+    "ActiveNumberSinchEvent",
+    "NumberOrderSinchEvent",
+    "NumberSinchEventPayload",
+    "NumberSinchEventAdapter",
+]

sinch/domains/numbers/sinch_events/v1/events/active_number_sinch_event.py

@@ -0,0 +1,71 @@
+from typing import Literal, Optional, Union
+
+from pydantic import Field, StrictStr
+
+from sinch.domains.numbers.sinch_events.v1.events.number_sinch_event import (
+    NumberSinchEvent,
+)
+
+
+class ActiveNumberSinchEvent(NumberSinchEvent):
+    resource_type: Literal["ACTIVE_NUMBER"] = Field(
+        default="ACTIVE_NUMBER", alias="resourceType"
+    )
+    event_type: Optional[
+        Union[
+            Literal[
+                "PROVISIONING_TO_SMS_PLATFORM",
+                "DEPROVISIONING_FROM_SMS_PLATFORM",
+                "PROVISIONING_TO_CAMPAIGN",
+                "DEPROVISIONING_FROM_CAMPAIGN",
+                "PROVISIONING_TO_VOICE_PLATFORM",
+                "DEPROVISIONING_FROM_VOICE_PLATFORM",
+            ],
+            StrictStr,
+        ]
+    ] = Field(
+        default=None, alias="eventType", description="The type of the event."
+    )
+    status: Optional[
+        Union[
+            Literal[
+                "SUCCEEDED",
+                "FAILED",
+            ],
+            StrictStr,
+        ]
+    ] = Field(
+        default=None,
+        description="The status of the event or the state transition it represents.",
+    )
+    failure_code: Optional[
+        Union[
+            Literal[
+                "CAMPAIGN_EXPIRED",
+                "CAMPAIGN_MNO_REJECTED",
+                "CAMPAIGN_MNO_REVIEW",
+                "CAMPAIGN_MNO_SUSPENDED",
+                "CAMPAIGN_NOT_AVAILABLE",
+                "CAMPAIGN_PENDING_ACCEPTANCE",
+                "CAMPAIGN_PROVISIONING_FAILED",
+                "EXCEEDED_10DLC_LIMIT",
+                "INSUFFICIENT_BALANCE",
+                "INVALID_NNID",
+                "MNO_SHARING_ERROR",
+                "MOCK_CAMPAIGN_NOT_ALLOWED",
+                "NUMBER_PROVISIONING_FAILED",
+                "PARTNER_SERVICE_UNAVAILABLE",
+                "TFN_NOT_ALLOWED",
+            ],
+            StrictStr,
+        ]
+    ] = Field(
+        default=None,
+        alias="failureCode",
+        description="If the status is FAILED, a failure code will be provided. For numbers provisioning to SMS platform, there won't be any extra `failureCode`, as the result is binary. For campaign provisioning-related failures, refer to the list for the possible values.",
+    )
+    internal_failure_code: Optional[StrictStr] = Field(
+        default=None,
+        alias="internalFailureCode",
+        description="If the status is FAILED, certain processes (eg. number to campaign provisioning) will have an internalFailureCode in the payload. The details of these codes can be found in our dedicated [Provisioning errors](https://developers.sinch.com/docs/numbers/api-reference/error-codes/provisioning-errors) documentation.",
+    )

sinch/domains/numbers/sinch_events/v1/events/number_base_sinch_event.py

@@ -0,0 +1,27 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import Field, StrictStr
+
+from sinch.domains.numbers.sinch_events.v1.events.resource_type import (
+    ResourceType,
+)
+from sinch.domains.numbers.sinch_events.v1.internal.sinch_event import (
+    SinchEvent,
+)
+
+
+class NumberBaseSinchEvent(SinchEvent):
+    event_id: Optional[StrictStr] = Field(
+        default=None, alias="eventId", description="The ID of the event."
+    )
+    timestamp: Optional[datetime] = Field(
+        default=None,
+        description="The date and time when the callback was created and added to the callbacks queue.",
+    )
+    project_id: Optional[StrictStr] = Field(
+        default=None,
+        alias="projectId",
+        description="The ID of the project to which the event belongs.",
+    )
+    resource_type: ResourceType = Field(default=..., alias="resourceType")