wavix-python-sdk 1.0.0__py3-none-any.whl

wavix/types/sip_trunk_create_request.py

@@ -0,0 +1,132 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .sip_trunk_create_request_allowed_ips_item import SipTrunkCreateRequestAllowedIpsItem
+from .sip_trunk_create_request_host_request import SipTrunkCreateRequestHostRequest
+
+
+class SipTrunkCreateRequest(UniversalBaseModel):
+    label: str = pydantic.Field()
+    """
+    User-defined name of the SIP trunk
+    """
+
+    password: str = pydantic.Field()
+    """
+    Password set for the SIP trunk. A strong password helps keep the trunk secure.
+    """
+
+    host_request: typing.Optional[SipTrunkCreateRequestHostRequest] = pydantic.Field(default=None)
+    """
+    For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the authentication request. Wavix authenticates all SIP traffic originating from this IP address.
+    """
+
+    callerid: str = pydantic.Field()
+    """
+    Caller ID associated with the SIP trunk. Must be an active or verified number on the account.
+    """
+
+    multiple_numbers: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk.
+    """
+
+    ip_restrict: bool = pydantic.Field()
+    """
+    Indicates whether SIP trunk registration is allowed from only specific public static IP addresses. When set to `true`, the `allowed_ips` parameter must be provided.
+    """
+
+    allowed_ips: typing.Optional[typing.List[SipTrunkCreateRequestAllowedIpsItem]] = pydantic.Field(default=None)
+    """
+    A list of public static IP addresses allowed to register with the SIP trunk
+    """
+
+    didinfo_enabled: bool = pydantic.Field()
+    """
+    Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests
+    """
+
+    call_restrict: bool = pydantic.Field()
+    """
+    Indicates whether a maximum call duration limit is enforced for the SIP trunk
+    """
+
+    call_limit: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Maximum call duration for the SIP trunk, in seconds. Must not exceed the maximum duration set for the account. Ignored when `call_restrict` is `false`.
+    """
+
+    cost_limit: bool = pydantic.Field()
+    """
+    Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.
+    """
+
+    max_call_cost: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Maximum cost for an outbound call, in USD
+    """
+
+    channels_restrict: bool = pydantic.Field()
+    """
+    Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk
+    """
+
+    max_channels: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Maximum number of concurrent outbound calls for the SIP trunk. Must not exceed the outbound channel capacity set for the account. Ignored when `channels_restrict` is `false`.
+    """
+
+    rewrite_enabled: bool = pydantic.Field()
+    """
+    Indicates whether a custom dial plan is activated for the SIP trunk
+    """
+
+    rewrite_prefix: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Digits to automatically prepend to each dialed phone number
+    """
+
+    rewrite_cond: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Number of leading digits to automatically remove from each dialed phone number
+    """
+
+    call_recording_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether outbound call recording is enabled for the SIP trunk
+    """
+
+    transcription_enabled: bool = pydantic.Field()
+    """
+    Indicates whether automatic call transcription is enabled for the SIP trunk.
+    Available for `Flex Pro` customers only.
+    """
+
+    transcription_threshold: int = pydantic.Field()
+    """
+    Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds.
+    Available for `Flex Pro` customers only.
+    """
+
+    machine_detection_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether automatic voicemail detection is enabled for the SIP trunk.
+    Available for `Flex Pro` customers only.
+    """
+
+    encrypted_media: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether SRTP media encryption is enabled for the SIP trunk.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sip_trunk_create_request_allowed_ips_item.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SipTrunkCreateRequestAllowedIpsItem(UniversalBaseModel):
+    ip: str = pydantic.Field()
+    """
+    Public static IP address allowed to register with the SIP trunk.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sip_trunk_create_request_host_request.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SipTrunkCreateRequestHostRequest(UniversalBaseModel):
+    """
+    For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the authentication request. Wavix authenticates all SIP traffic originating from this IP address.
+    """
+
+    host: str = pydantic.Field()
+    """
+    SIP endpoint public static IP address
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sip_trunk_list_response.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .pagination import Pagination
+from .sip_trunk_summary import SipTrunkSummary
+
+
+class SipTrunkListResponse(UniversalBaseModel):
+    sip_trunks: typing.Optional[typing.List[SipTrunkSummary]] = pydantic.Field(default=None)
+    """
+    SIP trunks associated with the account.
+    """
+
+    pagination: Pagination
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sip_trunk_response.py

@@ -0,0 +1,145 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .allowed_i_ps import AllowedIPs
+
+
+class SipTrunkResponse(UniversalBaseModel):
+    id: int = pydantic.Field()
+    """
+    Unique identifier of the SIP trunk on the platform
+    """
+
+    name: str = pydantic.Field()
+    """
+    System-generated login name of the SIP trunk
+    """
+
+    callerid: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Caller ID configured on the SIP trunk. Contains `null` if no Caller ID is set, or an empty string if multiple Caller IDs are allowed.
+    """
+
+    label: str = pydantic.Field()
+    """
+    User-defined name of the SIP trunk
+    """
+
+    ip_restrict: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether IP restriction must be enabled on the SIP trunk
+    """
+
+    allowed_ips: AllowedIPs
+    channels_restrict: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.
+    """
+
+    max_channels: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    A maximum number of concurrent outbound calls placed via the SIP trunk. Cannot be higher than the outbound channel capacity configured on the account.
+    """
+
+    cost_limit: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.
+    """
+
+    max_call_cost: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A maximum cost of an outbound call, in USD.
+    """
+
+    call_restrict: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if maximum call duration limit is activated for the SIP trunk.
+    """
+
+    call_limit: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    A maximum call duration for the SIP trunk, in seconds. Cannot be higher than the max call duration set for the account.
+    """
+
+    didinfo_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites
+    """
+
+    rewrite_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if a custom dial plan is activated for the SIP trunk.
+    """
+
+    rewrite_prefix: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Leading digits to be added before the dialed phone numbers.
+    """
+
+    rewrite_cond: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Leading digits to be deleted from the dialed phone numbers.
+    """
+
+    call_recording_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if outbound call recording is enabled on the SIP trunk. Available for `Flex Pro` customers only.
+    """
+
+    machine_detection_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for `Flex Pro` customers only.
+    """
+
+    transcription_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates if automatic call transcription is enabled on the SIP trunk. Available for `Flex Pro` customers only.
+    """
+
+    transcription_threshold: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Date and time the SIP trunk was created
+    """
+
+    host: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Registration host for the SIP trunk. `dynamic` for credential-based registration, or a public static IP address for IP authentication.
+    """
+
+    multiple_numbers: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk.
+    """
+
+    encrypted_media: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether SRTP media encryption is enabled for the SIP trunk.
+    """
+
+    passthrough: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether Caller ID passthrough is enabled.
+    """
+
+    access_token: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Static authentication token for the SIP trunk.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sip_trunk_summary.py

@@ -0,0 +1,114 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .sip_trunk_summary_host_request import SipTrunkSummaryHostRequest
+
+
+class SipTrunkSummary(UniversalBaseModel):
+    """
+    A SIP trunk associated with the account.
+    """
+
+    id: int = pydantic.Field()
+    """
+    Unique identifier of the SIP trunk on the platform
+    """
+
+    name: str = pydantic.Field()
+    """
+    System-generated login name of the SIP trunk
+    """
+
+    callerid: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Caller ID associated with the SIP trunk. Contains `null` if no Caller ID is set, or an empty string if multiple Caller IDs are allowed.
+    """
+
+    label: str = pydantic.Field()
+    """
+    User-defined name of the SIP trunk
+    """
+
+    auth_method: str = pydantic.Field()
+    """
+    SIP trunk authentication method. Can be either `Digest` or `IP auth`.
+    """
+
+    host_request: typing.Optional[SipTrunkSummaryHostRequest] = pydantic.Field(default=None)
+    """
+    For SIP trunks with IP-based authentication, contains the status of the IP authentication request.
+    """
+
+    passthrough: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether Caller ID passthrough is enabled for the SIP trunk
+    """
+
+    multiple_numbers: bool = pydantic.Field()
+    """
+    Indicates whether multiple Caller IDs are enabled for the SIP trunk
+    """
+
+    status: str = pydantic.Field()
+    """
+    Status of the SIP trunk. Possible values are:
+    `active` - The SIP trunk is active and can be used to place outbound calls.
+    `pending` - The IP authentication request is under review by the Wavix team.
+    `rejected` - The IP authentication request was rejected by the Wavix team.
+    SIP trunks with a `pending` or `rejected` status can't be used to place calls.
+    """
+
+    talk_time: int = pydantic.Field()
+    """
+    Total duration of all outbound calls placed through the SIP trunk the current month, in seconds. Automatically resets at the beginning of each month.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total cost of all outbound calls placed through the SIP trunk in the current month, in USD. Automatically resets at the beginning of each month.
+    """
+
+    call_recording_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether outbound call recording is enabled for the SIP trunk
+    """
+
+    machine_detection_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether automatic voicemail detection is enabled for the SIP trunk.
+    Available for `Flex Pro` customers only.
+    """
+
+    transcription_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether automatic call transcription is enabled for the SIP trunk.
+    Available for `Flex Pro` customers only.
+    """
+
+    transcription_threshold: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Minimum call duration (in seconds) required to automatically generate a transcription. Transcriptions are created for calls that meet or exceed this value.
+    Available to `Flex Pro` customers only.
+    """
+
+    encrypted_media: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether SRTP media encryption is enabled for the SIP trunk.
+    """
+
+    access_token: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Static authentication token for the SIP trunk.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sip_trunk_summary_host_request.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SipTrunkSummaryHostRequest(UniversalBaseModel):
+    """
+    For SIP trunks with IP-based authentication, contains the status of the IP authentication request.
+    """
+
+    host: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The IP address submitted for authentication
+    """
+
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status of the IP authentication request
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sub_accounts_list_response.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .pagination import Pagination
+from .sub_organization_response import SubOrganizationResponse
+
+
+class SubAccountsListResponse(UniversalBaseModel):
+    sub_organizations: typing.Optional[typing.List[SubOrganizationResponse]] = pydantic.Field(default=None)
+    """
+    Subaccounts belonging to the authenticated account.
+    """
+
+    pagination: typing.Optional[Pagination] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sub_accounts_transactions_list_response.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .pagination import Pagination
+from .sub_accounts_transactions_list_response_transactions_item import (
+    SubAccountsTransactionsListResponseTransactionsItem,
+)
+
+
+class SubAccountsTransactionsListResponse(UniversalBaseModel):
+    transactions: typing.Optional[typing.List[SubAccountsTransactionsListResponseTransactionsItem]] = pydantic.Field(
+        default=None
+    )
+    """
+    Financial transactions for the subaccount.
+    """
+
+    pagination: typing.Optional[Pagination] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sub_accounts_transactions_list_response_transactions_item.py

@@ -0,0 +1,48 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SubAccountsTransactionsListResponseTransactionsItem(UniversalBaseModel):
+    amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Transaction amount.
+    """
+
+    balance_after: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Sub-account balance after the transaction.
+    """
+
+    date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Transaction date and time in ISO 8601 format.
+    """
+
+    details: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Transaction details.
+    """
+
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Transaction status.
+    """
+
+    type: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Transaction type.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/types/sub_organization_response.py

@@ -0,0 +1,59 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .sub_organization_response_default_destinations import SubOrganizationResponseDefaultDestinations
+from .sub_organization_response_status import SubOrganizationResponseStatus
+
+
+class SubOrganizationResponse(UniversalBaseModel):
+    """
+    Sub-account details including API key and webhook configurations.
+    """
+
+    id: int = pydantic.Field()
+    """
+    Sub-account ID.
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Date and time the sub-account was created in ISO 8601 format.
+    """
+
+    name: str = pydantic.Field()
+    """
+    Sub-account name.
+    """
+
+    api_key: str = pydantic.Field()
+    """
+    Sub-account API key.
+    """
+
+    master_organization: int = pydantic.Field()
+    """
+    Master account ID.
+    """
+
+    status: SubOrganizationResponseStatus = pydantic.Field()
+    """
+    Status of the subaccount. One of `enabled` (the subaccount is active and can be used) or `disabled` (the subaccount is suspended).
+    """
+
+    default_destinations: SubOrganizationResponseDefaultDestinations = pydantic.Field()
+    """
+    Default webhook URLs for inbound messages and delivery reports.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow