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

wavix/types/account_limits.py

@@ -0,0 +1,32 @@
+# 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 AccountLimits(UniversalBaseModel):
+    max_call_duration: int = pydantic.Field()
+    """
+    Maximum outbound call duration, in seconds
+    """
+
+    max_sip_channels: int = pydantic.Field()
+    """
+    Maximum number of concurrent outbound calls.
+    """
+
+    max_call_rate: str = pydantic.Field()
+    """
+    Maximum outbound call rate, in cents
+    """
+
+    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/allowed_i_ps.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .allowed_i_ps_item import AllowedIPsItem
+
+AllowedIPs = typing.List[AllowedIPsItem]

wavix/types/allowed_i_ps_item.py

@@ -0,0 +1,27 @@
+# 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 AllowedIPsItem(UniversalBaseModel):
+    id: int = pydantic.Field()
+    """
+    IP address ID.
+    """
+
+    ip: str = pydantic.Field()
+    """
+    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/api_key.py

@@ -0,0 +1,138 @@
+# 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 .api_key_calls_scope_permission import ApiKeyCallsScopePermission
+from .api_key_scope_permission import ApiKeyScopePermission
+
+
+class ApiKey(UniversalBaseModel):
+    """
+    API key details including IP restrictions and scope permissions.
+    """
+
+    id: int = pydantic.Field()
+    """
+    API key ID.
+    """
+
+    label: str = pydantic.Field()
+    """
+    API key label.
+    """
+
+    value: str = pydantic.Field()
+    """
+    API key value.
+    """
+
+    active: bool = pydantic.Field()
+    """
+    Indicates whether the API key is active.
+    """
+
+    restricted: bool = pydantic.Field()
+    """
+    Indicates whether IP restrictions are enabled. When enabled,
+     the API key works only from IP addresses in `permitted_ips`.
+    """
+
+    permitted_ips: typing.List[str] = pydantic.Field()
+    """
+    List of permitted IP addresses. If `restricted` is false,
+     an empty list means no IP restrictions. If `restricted` is true,
+      an empty list prevents all requests.
+    """
+
+    scopes_enabled: bool = pydantic.Field()
+    """
+    When `true`, the key is restricted to the permissions defined in the
+    scope fields below. When `false`, the key has full access.
+    """
+
+    last_used_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp of the most recent authenticated request made with this key.
+    """
+
+    numbers: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    View, buy, release, and configure phone numbers, browse inventory, and manage the cart.
+    """
+
+    trunks: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    View, create, update, and delete SIP trunks and their settings.
+    """
+
+    calls: typing.Optional[ApiKeyCallsScopePermission] = pydantic.Field(default=None)
+    """
+    Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests.
+    """
+
+    messages: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs.
+    """
+
+    recordings: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    List, download, and delete call recordings.
+    """
+
+    campaigns: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links.
+    """
+
+    two_fa: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes.
+    """
+
+    validator: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    View number validation results and trigger single or bulk validation or HLR lookup requests.
+    """
+
+    webhooks: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    List, create, and delete webhooks.
+    """
+
+    embeddable: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    Manage widget tokens, including listing, viewing, creating, updating, and deleting them.
+    """
+
+    billing: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates.
+    """
+
+    account: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    View and update account profile information and timezone.
+    """
+
+    subaccounts: typing.Optional[ApiKeyScopePermission] = pydantic.Field(default=None)
+    """
+    Manage subaccounts: list and view them, create, update, and suspend them.
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation date and time in ISO 8601 format.
+    """
+
+    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/api_key_calls_scope_permission.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 .api_key_calls_scope_permission_allow import ApiKeyCallsScopePermissionAllow
+
+
+class ApiKeyCallsScopePermission(UniversalBaseModel):
+    """
+    Permission level for the `calls` scope group.
+    """
+
+    allow: typing.Optional[ApiKeyCallsScopePermissionAllow] = pydantic.Field(default=None)
+    """
+    Permission level:
+    - `none`: no access
+    - `read`: GET requests, `POST /v1/cdrs`
+    - `write`: all methods (includes read)
+    """
+
+    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/api_key_calls_scope_permission_allow.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ApiKeyCallsScopePermissionAllow = typing.Union[typing.Literal["none", "read", "write"], typing.Any]

wavix/types/api_key_scope_permission.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 .api_key_scope_permission_allow import ApiKeyScopePermissionAllow
+
+
+class ApiKeyScopePermission(UniversalBaseModel):
+    """
+    Permission level for an API key scope group.
+    """
+
+    allow: typing.Optional[ApiKeyScopePermissionAllow] = pydantic.Field(default=None)
+    """
+    Permission level:
+    - `none`: no access
+    - `read`: GET only
+    - `write`: all methods (includes read)
+    """
+
+    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/api_key_scope_permission_allow.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ApiKeyScopePermissionAllow = typing.Union[typing.Literal["none", "read", "write"], typing.Any]

wavix/types/available_number.py

@@ -0,0 +1,97 @@
+# 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 AvailableNumber(UniversalBaseModel):
+    """
+    Phone number available for purchase.
+    """
+
+    id: int = pydantic.Field()
+    """
+    Phone number ID.
+    """
+
+    activation_fee: str = pydantic.Field()
+    """
+    One-time activation fee in USD.
+    """
+
+    monthly_fee: str = pydantic.Field()
+    """
+    Monthly fee in USD.
+    """
+
+    per_min: str = pydantic.Field()
+    """
+    Price per inbound minute in USD.
+    """
+
+    channels: str = pydantic.Field()
+    """
+    Maximum number of concurrent inbound calls.
+    """
+
+    city: str = pydantic.Field()
+    """
+    City where the phone number originates.
+    """
+
+    country: str = pydantic.Field()
+    """
+    Country where the phone number originates.
+    """
+
+    country_short_name: str = pydantic.Field()
+    """
+    Two-letter ISO country code.
+    """
+
+    cnam: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether CNAM can be activated.
+    """
+
+    free_min: int = pydantic.Field()
+    """
+    Number of free inbound minutes.
+    """
+
+    number: str = pydantic.Field()
+    """
+    Phone number in E.164 format.
+    """
+
+    require_docs: typing.List[int] = pydantic.Field()
+    """
+    Documents required to activate the phone number.
+    """
+
+    sms_enabled: bool = pydantic.Field()
+    """
+    Indicates whether the phone number can receive inbound
+     SMS and MMS messages.
+    """
+
+    sms_price: float = pydantic.Field()
+    """
+    Price per inbound SMS segment in USD.
+    """
+
+    domestic_cli: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the number can be used as the Caller ID for local calls.
+    """
+
+    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/available_number_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 .available_number import AvailableNumber
+from .pagination import Pagination
+
+
+class AvailableNumberListResponse(UniversalBaseModel):
+    dids: typing.List[AvailableNumber] = pydantic.Field()
+    """
+    Phone numbers available for purchase that match the search criteria.
+    """
+
+    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/bad_request_error_body.py

@@ -0,0 +1,27 @@
+# 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 BadRequestErrorBody(UniversalBaseModel):
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the request was successful. Always `false` for this error.
+    """
+
+    message: str = pydantic.Field()
+    """
+    Human-readable error description
+    """
+
+    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/billing_transaction_list_response.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
+from .financial_transaction import FinancialTransaction
+from .pagination import Pagination
+
+
+class BillingTransactionListResponse(UniversalBaseModel):
+    is_empty: bool = pydantic.Field()
+    """
+    Indicates whether there are no transactions.
+    """
+
+    transactions: typing.List[FinancialTransaction] = pydantic.Field()
+    """
+    List of transactions.
+    """
+
+    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/brand_status_updated_webhook.py

@@ -0,0 +1,28 @@
+# 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 .brand_status_updated_webhook_status import BrandStatusUpdatedWebhookStatus
+
+
+class BrandStatusUpdatedWebhook(UniversalBaseModel):
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the 10DLC Brand.
+    """
+
+    status: BrandStatusUpdatedWebhookStatus = pydantic.Field()
+    """
+    Current verification status of the 10DLC Brand. One of `SELF_DECLARED`, `UNVERIFIED`, `VERIFIED`, `VETTED_VERIFIED`, `REVIEW`, or `SUSPENDED`. `SELF_DECLARED` means the Brand registered without external verification; `UNVERIFIED` means verification has not yet succeeded; `VERIFIED` means the Brand passed standard verification; `VETTED_VERIFIED` means the Brand also passed third-party vetting; `REVIEW` means verification is in progress; `SUSPENDED` means the Brand is blocked from sending.
+    """
+
+    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/brand_status_updated_webhook_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+BrandStatusUpdatedWebhookStatus = typing.Union[
+    typing.Literal["SELF_DECLARED", "UNVERIFIED", "VERIFIED", "VETTED_VERIFIED", "REVIEW", "SUSPENDED"], typing.Any
+]

wavix/types/call.py

@@ -0,0 +1,92 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .call_direction import CallDirection
+from .call_event_type import CallEventType
+from .on_call_event_payload import OnCallEventPayload
+
+
+class Call(UniversalBaseModel):
+    uuid_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="uuid"),
+        pydantic.Field(alias="uuid", description="Call ID. Deprecated — use `id` instead."),
+    ]
+    id: str = pydantic.Field()
+    """
+    Call ID. Alias of `uuid`.
+    """
+
+    direction: typing.Optional[CallDirection] = None
+    event_type: CallEventType = pydantic.Field()
+    """
+    Most recent lifecycle event for the call. One of:
+    
+    - `call_setup` — the call is being initiated.
+    - `ringing` — the destination is ringing.
+    - `early_media` — early media (such as ringback) is playing before answer.
+    - `answered` — the destination answered the call.
+    - `completed` — the call ended normally.
+    - `busy` — the destination was busy.
+    - `cancelled` — the call was cancelled before answer.
+    - `rejected` — the destination rejected the call.
+    - `on_call_event` — an in-call event occurred (see `event_payload`).
+    """
+
+    event_time: dt.datetime = pydantic.Field()
+    """
+    Date and time of the latest event in ISO 8601 format.
+    """
+
+    event_payload: typing.Optional[OnCallEventPayload] = pydantic.Field(default=None)
+    """
+    Event-specific metadata.
+    """
+
+    from_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="from"), pydantic.Field(alias="from", description="Caller ID.")
+    ]
+    to: str = pydantic.Field()
+    """
+    Destination number.
+    """
+
+    call_started: dt.datetime = pydantic.Field()
+    """
+    Date and time when the call started in ISO 8601 format.
+    """
+
+    call_answered: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time when the call was answered in ISO 8601 format.
+    """
+
+    call_completed: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time when the call ended in ISO 8601 format.
+    """
+
+    machine_detected: bool = pydantic.Field()
+    """
+    Indicates whether the call was answered by a machine.
+    """
+
+    tag: str = pydantic.Field()
+    """
+    Call metadata
+    """
+
+    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/call_control_validation_error_response.py

@@ -0,0 +1,34 @@
+# 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 CallControlValidationErrorResponse(UniversalBaseModel):
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the request was successful. Always `false` for this error.
+    """
+
+    message: str = pydantic.Field()
+    """
+    Human-readable summary of the validation failure.
+    """
+
+    errors: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
+    """
+    Field-level validation messages, keyed by the offending request
+    field name (snake_case). Absent when the request body could not be
+    parsed at all (for example, malformed JSON).
+    """
+
+    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