sinch.domains.conversation.models.v1.sinch_events.opt_in_out package

• sinch.domains.conversation.models.v1.sinch_events.opt_in_out.opt_error_details module
  • OptErrorDetails
• sinch.domains.conversation.models.v1.sinch_events.opt_in_out.opt_in_event module
  • OptInEvent
• sinch.domains.conversation.models.v1.sinch_events.opt_in_out.opt_in_notification module
  • OptInNotification
• sinch.domains.conversation.models.v1.sinch_events.opt_in_out.opt_out_event module
  • OptOutEvent
• sinch.domains.conversation.models.v1.sinch_events.opt_in_out.opt_out_notification module
  • OptOutNotification

class sinch.domains.conversation.models.v1.sinch_events.opt_in_out.OptErrorDetails(

*,

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

**extra_data: Any,

)

Bases: SinchEvent

Parameters:

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

• extra_data (Any)

description: 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(_SnakifyExtrasOnInit__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_SnakifyExtrasOnInit__context (Any)

Return type:

None

class sinch.domains.conversation.models.v1.sinch_events.opt_in_out.OptInEvent(

*,

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

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

accepted_time: datetime | None = None,

event_time: datetime | None = None,

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

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

opt_in_notification: OptInNotification,

**extra_data: Any,

)

Bases: ConversationSinchEventBase

Sinch Event for OPT_IN (opt-in notification from the channels).

Parameters:

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

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

• accepted_time (datetime | None)

• event_time (datetime | None)

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

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

• opt_in_notification (OptInNotification)

• extra_data (Any)

opt_in_notification: OptInNotification

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(_SnakifyExtrasOnInit__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_SnakifyExtrasOnInit__context (Any)

Return type:

None

class sinch.domains.conversation.models.v1.sinch_events.opt_in_out.OptInNotification(

*,

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

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

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

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

status: Literal['OPT_IN_SUCCEEDED', 'OPT_IN_FAILED', 'OPT_IN_STATUS_UNSPECIFIED'] | Annotated[str, Strict(strict=True)] | None = None,

error_details: OptErrorDetails | None = None,

processing_mode: Literal['CONVERSATION', 'DISPATCH'] | Annotated[str, Strict(strict=True)] | None = None,

**extra_data: Any,

)

Bases: SinchEvent

Parameters:

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

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

• channel (Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

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

• status (Literal['OPT_IN_SUCCEEDED', 'OPT_IN_FAILED', 'OPT_IN_STATUS_UNSPECIFIED'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

• error_details (OptErrorDetails | None)

• processing_mode (Literal['CONVERSATION', 'DISPATCH'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

• extra_data (Any)

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

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

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

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

status: Literal['OPT_IN_SUCCEEDED', 'OPT_IN_FAILED', 'OPT_IN_STATUS_UNSPECIFIED'] | Annotated[str, Strict(strict=True)] | None

error_details: OptErrorDetails | None

processing_mode: Literal['CONVERSATION', 'DISPATCH'] | 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(_SnakifyExtrasOnInit__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_SnakifyExtrasOnInit__context (Any)

Return type:

None

class sinch.domains.conversation.models.v1.sinch_events.opt_in_out.OptOutEvent(

*,

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

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

accepted_time: datetime | None = None,

event_time: datetime | None = None,

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

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

opt_out_notification: OptOutNotification,

**extra_data: Any,

)

Bases: ConversationSinchEventBase

Sinch Event for OPT_OUT (opt-out notification from the channels).

Parameters:

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

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

• accepted_time (datetime | None)

• event_time (datetime | None)

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

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

• opt_out_notification (OptOutNotification)

• extra_data (Any)

opt_out_notification: OptOutNotification

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(_SnakifyExtrasOnInit__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_SnakifyExtrasOnInit__context (Any)

Return type:

None

class sinch.domains.conversation.models.v1.sinch_events.opt_in_out.OptOutNotification(

*,

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

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

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

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

status: Literal['OPT_OUT_SUCCEEDED', 'OPT_OUT_FAILED', 'OPT_OUT_STATUS_UNSPECIFIED'] | Annotated[str, Strict(strict=True)] | None = None,

error_details: OptErrorDetails | None = None,

processing_mode: Literal['CONVERSATION', 'DISPATCH'] | Annotated[str, Strict(strict=True)] | None = None,

**extra_data: Any,

)

Bases: SinchEvent

Parameters:

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

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

• channel (Literal['WHATSAPP', 'RCS', 'SMS', 'MESSENGER', 'VIBERBM', 'MMS', 'INSTAGRAM', 'TELEGRAM', 'KAKAOTALK', 'KAKAOTALKCHAT', 'LINE', 'WECHAT', 'APPLEBC'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

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

• status (Literal['OPT_OUT_SUCCEEDED', 'OPT_OUT_FAILED', 'OPT_OUT_STATUS_UNSPECIFIED'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

• error_details (OptErrorDetails | None)

• processing_mode (Literal['CONVERSATION', 'DISPATCH'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

• extra_data (Any)

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

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

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

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

status: Literal['OPT_OUT_SUCCEEDED', 'OPT_OUT_FAILED', 'OPT_OUT_STATUS_UNSPECIFIED'] | Annotated[str, Strict(strict=True)] | None

error_details: OptErrorDetails | None

processing_mode: Literal['CONVERSATION', 'DISPATCH'] | 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(_SnakifyExtrasOnInit__context: Any) → None

Marks applied non-None defaults as set.

Parameters:

_SnakifyExtrasOnInit__context (Any)

Return type:

None