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

wavix/types/message_response.py

@@ -0,0 +1,97 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .message_body import MessageBody
+from .message_delivery_status import MessageDeliveryStatus
+
+
+class MessageResponse(UniversalBaseModel):
+    message_id: str = pydantic.Field()
+    """
+    Message ID.
+    """
+
+    message_type: str = pydantic.Field()
+    """
+    Message type. Possible values are `sms`, `mms`.
+    """
+
+    from_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="from"), pydantic.Field(alias="from", description="Sender ID.")
+    ]
+    to: str = pydantic.Field()
+    """
+    Recipient phone number.
+    """
+
+    direction: str = pydantic.Field()
+    """
+    Message direction. Possible values are `outbound`, `inbound`.
+    """
+
+    mcc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile country code.
+    """
+
+    mnc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile network code.
+    """
+
+    message_body: MessageBody
+    tag: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Tag to group messages, such as for a specific campaign.
+    """
+
+    status: MessageDeliveryStatus
+    segments: int = pydantic.Field()
+    """
+    Number of SMS segments. Always 1 for MMS.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total charge for the message in USD.
+    """
+
+    submitted_at: str = pydantic.Field()
+    """
+    Date and time the message was accepted in ISO 8601 format.
+    """
+
+    sent_at: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the message was sent in ISO 8601 format. For mobile-terminated messages only.
+    """
+
+    delivered_at: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the message was delivered in ISO 8601 format. Refers to DLR reception for mobile-terminated messages
+     or webhook relay for mobile-originated messages.
+    """
+
+    error_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable error message.
+    """
+
+    carrier_fees: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile carrier fees in USD.
+    """
+
+    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/messages_delivery_report.py

@@ -0,0 +1,81 @@
+# 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 .message_delivery_status import MessageDeliveryStatus
+
+
+class MessagesDeliveryReport(UniversalBaseModel):
+    """
+    Message delivery report (DLR).
+    """
+
+    message_id: str = pydantic.Field()
+    """
+    Message ID.
+    """
+
+    message_type: str = pydantic.Field()
+    """
+    Type of message. Possible values are `sms`, `mms`.
+    """
+
+    from_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="from"),
+        pydantic.Field(alias="from", description="Sender ID. Can be numeric or alphanumeric."),
+    ]
+    to: str = pydantic.Field()
+    """
+    Destination phone number.
+    """
+
+    tag: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Tag to identify a group of messages, such as those associated with a campaign.
+    """
+
+    status: MessageDeliveryStatus
+    segments_count: int = pydantic.Field()
+    """
+    Number of message segments for SMS. For MMS, the value is always 1.
+    """
+
+    sent: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time the message was accepted in ISO 8601 format.
+    """
+
+    delivered: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time when the final status was received in ISO 8601 format.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable error description.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total charge for the message in USD.
+    """
+
+    carrier_fees: str = pydantic.Field()
+    """
+    Mobile carrier fees in USD.
+    """
+
+    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/not_found_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 NotFoundErrorBody(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/not_found_error_response.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 NotFoundErrorResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the request was successful. Always `false` for this error.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable description stating that no resource matches the given ID.
+    """
+
+    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/number.py

@@ -0,0 +1,160 @@
+# 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 .inbound_call_destination import InboundCallDestination
+from .number_document import NumberDocument
+
+
+class Number(UniversalBaseModel):
+    id: int = pydantic.Field()
+    """
+    Phone number ID.
+    """
+
+    number: str = pydantic.Field()
+    """
+    Phone number.
+    """
+
+    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.
+    """
+
+    city: str = pydantic.Field()
+    """
+    City or rate center where the phone number originates.
+    """
+
+    state: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    State where the phone number originates. For non-US numbers, this field may be null.
+    """
+
+    country: str = pydantic.Field()
+    """
+    Country where the phone number originates.
+    """
+
+    country_short_name: str = pydantic.Field()
+    """
+    Two-letter ISO country code.
+    """
+
+    destination: typing.List[InboundCallDestination] = pydantic.Field()
+    """
+    Inbound call destinations set for the phone number.
+    """
+
+    channels: int = pydantic.Field()
+    """
+    Maximum number of concurrent inbound calls.
+    """
+
+    require_docs: typing.List[str] = pydantic.Field()
+    """
+    Documents required to activate the phone number.
+    """
+
+    documents: typing.List[NumberDocument] = pydantic.Field()
+    """
+    Uploaded documents for the phone number.
+    """
+
+    domestic_cli: bool = pydantic.Field()
+    """
+    Indicates whether the number can be used as the Caller ID for local calls.
+    """
+
+    free_min: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of free inbound minutes.
+    """
+
+    unlimited: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether usage is unlimited.
+    """
+
+    label: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Label assigned to the phone number.
+    """
+
+    status: str = pydantic.Field()
+    """
+    Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot.
+    """
+
+    seconds: str = pydantic.Field()
+    """
+    Total inbound call duration in seconds for current month.
+    """
+
+    added: dt.datetime = pydantic.Field()
+    """
+    Date and time the phone number was purchased in ISO 8601 format.
+    """
+
+    paid_until: dt.date = pydantic.Field()
+    """
+    Date until which the number is paid.
+    """
+
+    sms_enabled: bool = pydantic.Field()
+    """
+    Indicates whether SMS is enabled.
+    """
+
+    sms_relay_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Callback URL for inbound SMS and MMS messages.
+    """
+
+    cnam: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether CNAM is enabled.
+    """
+
+    call_recording_enabled: bool = pydantic.Field()
+    """
+    Indicates whether call recording is enabled.
+    """
+
+    transcription_enabled: bool = pydantic.Field()
+    """
+    Indicates whether transcription is enabled.
+    """
+
+    transcription_threshold: int = pydantic.Field()
+    """
+    Minimum call duration in seconds to trigger transcription.
+    """
+
+    call_status_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Callback URL for call status updates.
+    """
+
+    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/number_destination.py

@@ -0,0 +1,38 @@
+# 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 .inbound_call_transport import InboundCallTransport
+
+
+class NumberDestination(UniversalBaseModel):
+    """
+    Inbound call destination
+    """
+
+    destination: str = pydantic.Field()
+    """
+    SIP URI, PSTN number, or SIP trunk login for inbound call routing.
+    """
+
+    priority: int = pydantic.Field()
+    """
+    Destination priority (lower is higher priority).
+    """
+
+    transport: InboundCallTransport
+    trunk_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    SIP trunk ID when `transport` is 5, otherwise null.
+    """
+
+    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/number_document.py

@@ -0,0 +1,58 @@
+# 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 .document_type_id import DocumentTypeId
+
+
+class NumberDocument(UniversalBaseModel):
+    """
+    A document uploaded for a phone number
+    """
+
+    id: int = pydantic.Field()
+    """
+    Unique identifier of the uploaded document
+    """
+
+    allow_replace: bool = pydantic.Field()
+    """
+    Indicates whether the document can be replaced. Only documents with `rejected` status can be replaced.
+    """
+
+    did_number: str = pydantic.Field()
+    """
+    The phone number the document was uploaded for
+    """
+
+    doc_content_type: str = pydantic.Field()
+    """
+    The uploaded content type identified by the platform
+    """
+
+    doc_file_name: str = pydantic.Field()
+    """
+    The uploaded document name
+    """
+
+    doc_type_id: DocumentTypeId
+    status: str = pydantic.Field()
+    """
+    Status of the uploaded document. Can be either `approved`, `pending`, or `rejected`
+    """
+
+    url: str = pydantic.Field()
+    """
+    A link to the uploaded document
+    """
+
+    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/number_list_response.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
+from .document_type import DocumentType
+from .number import Number
+from .pagination import Pagination
+
+
+class NumberListResponse(UniversalBaseModel):
+    items: typing.List[Number] = pydantic.Field()
+    """
+    List of phone numbers on the account.
+    """
+
+    doc_types: typing.List[DocumentType] = pydantic.Field()
+    """
+    Documents required to activate phone numbers.
+    """
+
+    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/number_status_updated_webhook.py

@@ -0,0 +1,38 @@
+# 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 .number_status_updated_webhook_status import NumberStatusUpdatedWebhookStatus
+
+
+class NumberStatusUpdatedWebhook(UniversalBaseModel):
+    brand_id: str = pydantic.Field()
+    """
+    10DLC Brand ID.
+    """
+
+    campaign_id: str = pydantic.Field()
+    """
+    10DLC Campaign ID.
+    """
+
+    number: str = pydantic.Field()
+    """
+    Phone number associated with a 10DLC Campaign.
+    """
+
+    status: NumberStatusUpdatedWebhookStatus = pydantic.Field()
+    """
+    Status of the phone number's assignment to the 10DLC Campaign. One of `APPROVED` (the number is registered to the campaign), `PENDING` (registration is in progress), or `REJECTED` (registration was declined).
+    """
+
+    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/number_status_updated_webhook_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+NumberStatusUpdatedWebhookStatus = typing.Union[typing.Literal["APPROVED", "PENDING", "REJECTED"], typing.Any]

wavix/types/number_validator_create_bulk_response.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .number_validator_create_bulk_response_request_id import NumberValidatorCreateBulkResponseRequestId
+from .phone_validation_batch_response import PhoneValidationBatchResponse
+
+NumberValidatorCreateBulkResponse = typing.Union[
+    PhoneValidationBatchResponse, NumberValidatorCreateBulkResponseRequestId
+]

wavix/types/number_validator_create_bulk_response_request_id.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 NumberValidatorCreateBulkResponseRequestId(UniversalBaseModel):
+    """
+    Returned when validation runs asynchronously; poll results using `request_id`.
+    """
+
+    request_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Request ID. Use to poll validation results when `async` is `true`.
+    """
+
+    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/on_call_event_payload.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
+from .on_call_event_payload_type import OnCallEventPayloadType
+
+
+class OnCallEventPayload(UniversalBaseModel):
+    """
+    Payload for the `on_call_event` event type.
+    """
+
+    type: OnCallEventPayloadType = pydantic.Field()
+    """
+    Type of in-call sub-event. One of `audio` (audio playback progress) or `collect` (DTMF digit collection progress).
+    """
+
+    payload: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Sub-event-specific data. Structure depends on the `type` field:
+    - `audio`: `{ "status": "started" | "completed", "playback_id": "<uuid>" }`
+    - `collect`: `{ "digits": "<digits>", "status": "started" | "completed" | "failed" }`
+    """
+
+    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/on_call_event_payload_type.py

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

wavix/types/opt_out.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 OptOut(UniversalBaseModel):
+    number: str = pydantic.Field()
+    """
+    Phone number to opt out.
+    """
+
+    sender_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sender ID. If omitted, the phone number is opted out of all messages.
+    """
+
+    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