sinch.domains.conversation.templates.models.v2.shared package

• sinch.domains.conversation.templates.models.v2.shared.channel_template_override module
  • ChannelTemplateOverride
• sinch.domains.conversation.templates.models.v2.shared.template_translation module
  • TemplateTranslationCardMessage
  • TemplateTranslationCarouselMessage
  • TemplateTranslationChoiceMessage
  • TemplateTranslationLocationMessage
  • TemplateTranslationMediaMessage
  • TemplateTranslationTemplateMessage
  • TemplateTranslationTextMessage
  • TemplateTranslationListMessage
  • TemplateTranslationContactInfoMessage
• sinch.domains.conversation.templates.models.v2.shared.template_translation_base module
  • TemplateTranslationBase
• sinch.domains.conversation.templates.models.v2.shared.template_variable module
  • TemplateVariable

class sinch.domains.conversation.templates.models.v2.shared.ChannelTemplateOverride(

*,

template_reference: TemplateReferenceChannelSpecific | None = None,

parameter_mappings: Dict[Annotated[str, Strict(strict=True)], Annotated[str, Strict(strict=True)]] | None = None,

**extra_data: Any,

)

Bases: BaseConfigModel

Parameters:

• template_reference (TemplateReferenceChannelSpecific | None)

• parameter_mappings (Dict[Annotated[str, Strict(strict=True)], Annotated[str, Strict(strict=True)]] | None)

• extra_data (Any)

template_reference: TemplateReferenceChannelSpecific | None

parameter_mappings: Dict[Annotated[str, Strict(strict=True)], Annotated[str, Strict(strict=True)]] | None

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationBase(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

**extra_data: Any,

)

Bases: BaseConfigModel

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• extra_data (Any)

language_code: Annotated[str, Strict(strict=True)]

version: Annotated[str, Strict(strict=True)] | None

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None

create_time: datetime | None

update_time: datetime | None

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationCardMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

card_message: CardMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• card_message (CardMessage)

• extra_data (Any)

card_message: CardMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationCarouselMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

carousel_message: CarouselMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• carousel_message (CarouselMessage)

• extra_data (Any)

carousel_message: CarouselMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationChoiceMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

choice_message: ChoiceMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• choice_message (ChoiceMessage)

• extra_data (Any)

choice_message: ChoiceMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationContactInfoMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

contact_info_message: ContactInfoMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• contact_info_message (ContactInfoMessage)

• extra_data (Any)

contact_info_message: ContactInfoMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationListMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

list_message: ListMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• list_message (ListMessage)

• extra_data (Any)

list_message: ListMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationLocationMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

location_message: LocationMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• location_message (LocationMessage)

• extra_data (Any)

location_message: LocationMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationMediaMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

media_message: MediaProperties,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• media_message (MediaProperties)

• extra_data (Any)

media_message: MediaProperties

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationTemplateMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

template_message: TemplateMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• template_message (TemplateMessage)

• extra_data (Any)

template_message: TemplateMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateTranslationTextMessage(

*,

language_code: Annotated[str, Strict(strict=True)],

version: Annotated[str, Strict(strict=True)] | None = None,

channel_template_overrides: Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | Annotated[str, Strict(strict=True)], ChannelTemplateOverride] | None = None,

variables: Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None = None,

create_time: datetime | None = None,

update_time: datetime | None = None,

text_message: TextMessage,

**extra_data: Any,

)

Bases: TemplateTranslationBase

Parameters:

• language_code (Annotated[str, Strict(strict=True)])

• version (Annotated[str, Strict(strict=True)] | None)

• channel_template_overrides (Dict[Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)], ~sinch.domains.conversation.templates.models.v2.shared.channel_template_override.ChannelTemplateOverride] | None)

• variables (Annotated[list[TemplateVariable], Len(min_length=0, max_length=None)] | None)

• create_time (datetime | None)

• update_time (datetime | None)

• text_message (TextMessage)

• extra_data (Any)

text_message: TextMessage

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(

_BaseConfigModel__context: Any,

) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None

class sinch.domains.conversation.templates.models.v2.shared.TemplateVariable(

*,

key: Annotated[str, Strict(strict=True)] | None = None,

preview_value: Annotated[str, Strict(strict=True)] | None = None,

**extra_data: Any,

)

Bases: BaseConfigModel

Parameters:

• key (Annotated[str, Strict(strict=True)] | None)

• preview_value (Annotated[str, Strict(strict=True)] | None)

• extra_data (Any)

key: Annotated[str, Strict(strict=True)] | None

preview_value: Annotated[str, Strict(strict=True)] | None

model_config = {'extra': 'allow', 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(_BaseConfigModel__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_BaseConfigModel__context (Any)

Return type:

None