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

wavix/types/file_transcription_response.py

@@ -0,0 +1,77 @@
+# 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 .file_transcript_response import FileTranscriptResponse
+from .file_transcript_turn import FileTranscriptTurn
+from .file_transcription_response_language import FileTranscriptionResponseLanguage
+from .file_transcription_response_status import FileTranscriptionResponseStatus
+
+
+class FileTranscriptionResponse(UniversalBaseModel):
+    transcript: typing.Optional[FileTranscriptResponse] = pydantic.Field(default=None)
+    """
+    Complete transcription text attributed to each channel.
+    """
+
+    turns: typing.Optional[typing.List[FileTranscriptTurn]] = pydantic.Field(default=None)
+    """
+    List of transcription turns, including speaker attribution, timestamps, and sentiment.
+    """
+
+    request_id: str = pydantic.Field()
+    """
+    Transcription request ID.
+    """
+
+    language: FileTranscriptionResponseLanguage = pydantic.Field()
+    """
+    Transcription language.
+    """
+
+    duration: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    File duration in seconds.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total transcription charge in USD.
+    """
+
+    status: FileTranscriptionResponseStatus = pydantic.Field()
+    """
+    Transcription status. Possible values are `completed`, `failed`.
+    """
+
+    transcription_date: dt.datetime = pydantic.Field()
+    """
+    Date and time of the transcription in ISO 8601 format.
+    """
+
+    transcription_score: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Conversation sentiment score. Scores from 1.0 to 3.0 are negative; scores from 4.0 to 5.0 are positive.
+    """
+
+    transcription_summary: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Transcription summary.
+    """
+
+    original_file: str = pydantic.Field()
+    """
+    Uploaded file URL.
+    """
+
+    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/file_transcription_response_language.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FileTranscriptionResponseLanguage = typing.Union[typing.Literal["en", "de", "es", "fr", "it"], typing.Any]

wavix/types/file_transcription_response_status.py

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

wavix/types/financial_transaction.py

@@ -0,0 +1,57 @@
+# 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 .transaction_status import TransactionStatus
+from .transaction_type import TransactionType
+
+
+class FinancialTransaction(UniversalBaseModel):
+    """
+    Financial transaction.
+    """
+
+    id: int = pydantic.Field()
+    """
+    Transaction ID.
+    """
+
+    date: dt.datetime = pydantic.Field()
+    """
+    Creation date and time in ISO 8601 format.
+    """
+
+    amount: float = pydantic.Field()
+    """
+    Transaction amount. Negative values decrease balance.
+    """
+
+    balance_after: float = pydantic.Field()
+    """
+    Account balance after the transaction.
+    """
+
+    details: str = pydantic.Field()
+    """
+    Transaction details.
+    """
+
+    status: TransactionStatus
+    type: TransactionType
+    show_invoice: bool = pydantic.Field()
+    """
+    Indicates whether a transaction receipt is available. Receipts
+     are available only for transaction types 0, 8, 9, 19, 23, and 25.
+    """
+
+    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/forbidden_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 ForbiddenErrorResponse(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 of why access is forbidden.
+    """
+
+    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/inbound_call_destination.py

@@ -0,0 +1,53 @@
+# 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 InboundCallDestination(UniversalBaseModel):
+    """
+    Inbound call destination
+    """
+
+    id: int = pydantic.Field()
+    """
+    Unique identifier of the inbound call destination
+    """
+
+    destination: str = pydantic.Field()
+    """
+    The destination for inbound call routing. Can be either a SIP URI, a PSTN phone number or system-generated login of a SIP trunk on the platform.
+    """
+
+    priority: int = pydantic.Field()
+    """
+    For phone numbers with several destinations, sets the order in which the platform routes inbound calls. The lower the value, the higher the priority.
+    """
+
+    transport: InboundCallTransport
+    trunk_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Unique identified of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null`
+    """
+
+    srtp: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether SRTP media encryption is enabled for this destination.
+    """
+
+    trunk_label: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A user-defined name of a SIP trunk on the platform. In cases when `transport: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/inbound_call_transport.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+InboundCallTransport = int
+"""
+Transport used to route the inbound call to its destination. One of `1` (SIP URI), `4` (PSTN phone number), or `5` (SIP trunk on the platform).
+"""

wavix/types/inbound_message.py

@@ -0,0 +1,46 @@
+# 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_body import MessageBody
+
+
+class InboundMessage(UniversalBaseModel):
+    """
+    An inbound message
+    """
+
+    message_id: str = pydantic.Field()
+    """
+    Unique identifier of the message generated by the platform
+    """
+
+    from_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="from"),
+        pydantic.Field(alias="from", description="Sender ID used to send the message. Can be numeric or alphanumeric."),
+    ]
+    to: str = pydantic.Field()
+    """
+    Phone number on the account that received the message.
+    """
+
+    message_body: MessageBody
+    received_at: dt.datetime = pydantic.Field()
+    """
+    Timestamp the messages is received by Wavix
+    """
+
+    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/invalid_recording.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 InvalidRecording(UniversalBaseModel):
+    """
+    An invalid recording filter response
+    """
+
+    dids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Phone number IDs that did not match any recording.
+    """
+
+    sip_trunks: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    SIP trunk IDs that did not match any recording.
+    """
+
+    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/invoice.py

@@ -0,0 +1,42 @@
+# 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 Invoice(UniversalBaseModel):
+    """
+    An account financial statement
+    """
+
+    id: int = pydantic.Field()
+    """
+    Unique identifier of the statement
+    """
+
+    amount: str = pydantic.Field()
+    """
+    Statement amount
+    """
+
+    from_date: dt.date = pydantic.Field()
+    """
+    Start of the billing period
+    """
+
+    to_date: dt.date = pydantic.Field()
+    """
+    End of the billing period
+    """
+
+    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/invoice_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 .invoice import Invoice
+from .pagination import Pagination
+
+
+class InvoiceListResponse(UniversalBaseModel):
+    is_empty: bool = pydantic.Field()
+    """
+    Indicates whether the statement list is empty.
+    """
+
+    invoices: typing.List[Invoice] = pydantic.Field()
+    """
+    Auto-generated statements for 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/list_brand_evidence_response.py

@@ -0,0 +1,23 @@
+# 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 .ten_dlc_brand_evidence import TenDlcBrandEvidence
+
+
+class ListBrandEvidenceResponse(UniversalBaseModel):
+    items: typing.List[TenDlcBrandEvidence] = pydantic.Field()
+    """
+    List of uploaded evidence files
+    """
+
+    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/list_sessions_response_item.py

@@ -0,0 +1,58 @@
+# 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 ListSessionsResponseItem(UniversalBaseModel):
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time the 2FA Verification was created in ISO 8601 format.
+    """
+
+    session_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    2FA Verification ID.
+    """
+
+    phone_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Destination phone number.
+    """
+
+    destination_country: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Country code of the destination phone number in ISO 3166-1 alpha-2 format.
+    """
+
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status of the 2FA Verification.
+    """
+
+    charge: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Charge for the 2FA Verification.
+    """
+
+    service_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    2FA Service ID.
+    """
+
+    service_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    2FA Service name.
+    """
+
+    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/message.py

@@ -0,0 +1,103 @@
+# 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 Message(UniversalBaseModel):
+    """
+    SMS or MMS message.
+    """
+
+    message_id: str = pydantic.Field()
+    """
+    Message ID.
+    """
+
+    message_type: str = pydantic.Field()
+    """
+    Message type. Possible values are `sms` or `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()
+    """
+    Recipient phone number.
+    """
+
+    carrier_fees: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Carrier fees for the message in USD.
+    """
+
+    direction: str = pydantic.Field()
+    """
+    Message direction. Possible values are `outbound` or `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)
+    """
+    A 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/message_body.py

@@ -0,0 +1,29 @@
+# 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 MessageBody(UniversalBaseModel):
+    text: str = pydantic.Field()
+    """
+    Message text.
+    """
+
+    media: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    List of media URLs.
+     If provided, the message is sent as an MMS;
+      otherwise, it is sent as an SMS.
+    """
+
+    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/message_create_request.py

@@ -0,0 +1,46 @@
+# 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
+
+
+class MessageCreateRequest(UniversalBaseModel):
+    from_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="from"),
+        pydantic.Field(alias="from", description="Sender ID. Numeric or alphanumeric."),
+    ]
+    to: str = pydantic.Field()
+    """
+    Recipient phone number.
+    """
+
+    message_body: MessageBody
+    callback_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Callback URL for delivery reports.
+    """
+
+    validity: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Message validity period in seconds. Delivery attempts stop after this period expires.
+    """
+
+    tag: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Tag to group messages, such as for a specific campaign.
+    """
+
+    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/message_delivery_status.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+MessageDeliveryStatus = typing.Union[
+    typing.Literal["accepted", "pending", "sent", "delivered", "undelivered", "expired", "rejected", "dlr_expired"],
+    typing.Any,
+]

wavix/types/message_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 .message import Message
+from .pagination import Pagination
+
+
+class MessageListResponse(UniversalBaseModel):
+    items: typing.List[Message] = pydantic.Field()
+    """
+    Messages that match the request.
+    """
+
+    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