sinch.domains.numbers.models.v1.response package

• sinch.domains.numbers.models.v1.response.active_number module
  • ActiveNumber
• sinch.domains.numbers.models.v1.response.available_number module
  • AvailableNumber
• sinch.domains.numbers.models.v1.response.available_region module
  • AvailableRegion
• sinch.domains.numbers.models.v1.response.event_destination_response module
  • EventDestinationResponse

class sinch.domains.numbers.models.v1.response.ActiveNumber(

*,

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

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

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

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

type: Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | Annotated[str, Strict(strict=True)] | None = None,

capabilities: Annotated[list[Literal['SMS', 'VOICE'] | Annotated[str, Strict(strict=True)]], Len(min_length=0, max_length=None)] | None = None,

money: Money | None = None,

paymentIntervalMonths: Annotated[int, Strict(strict=True)] | None = None,

nextChargeDate: datetime | None = None,

expireAt: datetime | None = None,

smsConfiguration: SmsConfiguration | None = None,

voiceConfiguration: VoiceConfigurationEST | VoiceConfigurationRTC | VoiceConfigurationFAX | None = None,

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

**extra_data: Any,

)

Bases: SnakeCaseExtrasModel

Parameters:

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

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

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

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

• type (Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

• capabilities (Annotated[list[Literal['SMS', 'VOICE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)]], ~annotated_types.Len(min_length=0, max_length=None)] | None)

• money (Money | None)

• paymentIntervalMonths (Annotated[int, Strict(strict=True)] | None)

• nextChargeDate (datetime | None)

• expireAt (datetime | None)

• smsConfiguration (SmsConfiguration | None)

• voiceConfiguration (VoiceConfigurationEST | VoiceConfigurationRTC | VoiceConfigurationFAX | None)

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

• extra_data (Any)

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

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

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

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

type: Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | Annotated[str, Strict(strict=True)] | None

capabilities: Annotated[list[Literal['SMS', 'VOICE'] | Annotated[str, Strict(strict=True)]], Len(min_length=0, max_length=None)] | None

money: Money | None

payment_interval_months: Annotated[int, Strict(strict=True)] | None

next_charge_date: datetime | None

expire_at: datetime | None

sms_configuration: SmsConfiguration | None

voice_configuration: VoiceConfigurationEST | VoiceConfigurationRTC | VoiceConfigurationFAX | None

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

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

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

class sinch.domains.numbers.models.v1.response.AvailableNumber(

*,

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

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

type: Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | Annotated[str, Strict(strict=True)] | None = None,

capability: Annotated[list[Literal['SMS', 'VOICE'] | Annotated[str, Strict(strict=True)]], Len(min_length=0, max_length=None)] | None = None,

setupPrice: Money | None = None,

monthlyPrice: Money | None = None,

paymentIntervalMonths: Annotated[int, Strict(strict=True)] | None = None,

supportingDocumentationRequired: Annotated[bool, Strict(strict=True)] | None = None,

**extra_data: Any,

)

Bases: SnakeCaseExtrasModel

Parameters:

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

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

• type (Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

• capability (Annotated[list[Literal['SMS', 'VOICE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)]], ~annotated_types.Len(min_length=0, max_length=None)] | None)

• setupPrice (Money | None)

• monthlyPrice (Money | None)

• paymentIntervalMonths (Annotated[int, Strict(strict=True)] | None)

• supportingDocumentationRequired (Annotated[bool, Strict(strict=True)] | None)

• extra_data (Any)

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

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

type: Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | Annotated[str, Strict(strict=True)] | None

capability: Annotated[list[Literal['SMS', 'VOICE'] | Annotated[str, Strict(strict=True)]], Len(min_length=0, max_length=None)] | None

setup_price: Money | None

monthly_price: Money | None

payment_interval_months: Annotated[int, Strict(strict=True)] | None

supporting_documentation_required: Annotated[bool, Strict(strict=True)] | None

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

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

class sinch.domains.numbers.models.v1.response.AvailableRegion(

*,

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

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

types: Annotated[list[Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | Annotated[str, Strict(strict=True)]], Len(min_length=0, max_length=None)] | None = None,

**extra_data: Any,

)

Bases: SnakeCaseExtrasModel

Parameters:

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

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

• types (Annotated[list[Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)]], ~annotated_types.Len(min_length=0, max_length=None)] | None)

• extra_data (Any)

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

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

types: Annotated[list[Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | Annotated[str, Strict(strict=True)]], Len(min_length=0, max_length=None)] | None

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

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

class sinch.domains.numbers.models.v1.response.EventDestinationResponse(

*,

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

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

**extra_data: Any,

)

Bases: SnakeCaseExtrasModel

Parameters:

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

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

• extra_data (Any)

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

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

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

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