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

wavix/types/call_create_response.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_create_response_event_type import CallCreateResponseEventType
+from .call_direction import CallDirection
+from .on_call_event_payload import OnCallEventPayload
+
+
+class CallCreateResponse(UniversalBaseModel):
+    uuid_: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="uuid"),
+        pydantic.Field(alias="uuid", description="Call ID. Deprecated — use `id` instead."),
+    ] = None
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Call ID. Alias of `uuid`.
+    """
+
+    direction: typing.Optional[CallDirection] = None
+    event_type: typing.Optional[CallCreateResponseEventType] = pydantic.Field(default=None)
+    """
+    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: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time of the latest event
+    """
+
+    event_payload: typing.Optional[OnCallEventPayload] = pydantic.Field(default=None)
+    """
+    Event-specific data
+    """
+
+    from_: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="from"), pydantic.Field(alias="from", description="Caller ID")
+    ] = None
+    to: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Destination number
+    """
+
+    call_started: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time when the call started
+    """
+
+    call_answered: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time when the call was answered
+    """
+
+    call_completed: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time when the call ended
+    """
+
+    machine_detected: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the call was answered by an answering machine
+    """
+
+    tag: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    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_create_response_event_type.py

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CallCreateResponseEventType = typing.Union[
+    typing.Literal[
+        "call_setup",
+        "ringing",
+        "early_media",
+        "answered",
+        "completed",
+        "busy",
+        "cancelled",
+        "rejected",
+        "on_call_event",
+    ],
+    typing.Any,
+]

wavix/types/call_direction.py

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

wavix/types/call_disposition.py

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

wavix/types/call_event_type.py

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CallEventType = typing.Union[
+    typing.Literal[
+        "call_setup",
+        "ringing",
+        "early_media",
+        "answered",
+        "completed",
+        "busy",
+        "cancelled",
+        "rejected",
+        "on_call_event",
+    ],
+    typing.Any,
+]

wavix/types/call_list_response.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 .call import Call
+
+
+class CallListResponse(UniversalBaseModel):
+    calls: typing.List[Call] = pydantic.Field()
+    """
+    List of calls
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the request was successful.
+    """
+
+    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_recording_list_response.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 .invalid_recording import InvalidRecording
+from .pagination import Pagination
+from .recording import Recording
+
+
+class CallRecordingListResponse(UniversalBaseModel):
+    recordings: typing.Optional[typing.List[Recording]] = pydantic.Field(default=None)
+    """
+    Call recordings that match the request.
+    """
+
+    invalid: typing.Optional[InvalidRecording] = None
+    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/call_response.py

@@ -0,0 +1,24 @@
+# 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 .call import Call
+
+
+class CallResponse(UniversalBaseModel):
+    call: Call
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the request was successful.
+    """
+
+    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_status_webhook.py

@@ -0,0 +1,70 @@
+# 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_disposition import CallDisposition
+from .call_status_webhook_direction import CallStatusWebhookDirection
+
+
+class CallStatusWebhook(UniversalBaseModel):
+    """
+    Post-call webhook payload
+    """
+
+    direction: CallStatusWebhookDirection = pydantic.Field()
+    """
+    Direction of the call. One of `inbound` (call received by the account) or `outbound` (call placed by the account).
+    """
+
+    uuid_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid", description="Call ID")
+    ]
+    destination: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Destination of the call. For outbound calls, it contains the country name and, optionally, a mobile carrier or city name. For inbound calls, the destination includes the user-defined SIP trunk name, SIP URI, or PSTN number that the call is forwarded to.
+    """
+
+    duration: int = pydantic.Field()
+    """
+    Duration of the call, in seconds
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total charge for the call, in USD
+    """
+
+    date: dt.datetime = pydantic.Field()
+    """
+    Date and time of the call
+    """
+
+    disposition: CallDisposition
+    from_: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="from"),
+        pydantic.Field(alias="from", description="ANI/From attribute of the call"),
+    ] = None
+    to: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    DNIS/To attribute of the call
+    """
+
+    per_minute: str = pydantic.Field()
+    """
+    Price per minute, 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/call_status_webhook_direction.py

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

wavix/types/call_stream_channel.py

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

wavix/types/call_stream_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 CallStreamResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates that the request was successful
+    """
+
+    stream_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Stream 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/call_stream_type.py

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

wavix/types/call_webhook.py

@@ -0,0 +1,37 @@
+# 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 .call_webhook_event_type import CallWebhookEventType
+
+
+class CallWebhook(UniversalBaseModel):
+    """
+    A call webhook response
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the request was successful.
+    """
+
+    event_type: CallWebhookEventType = pydantic.Field()
+    """
+    Type of call event the webhook subscribes to. One of `post-call` (delivered once after the call ends) or `on-call` (delivered for in-call events while the call is active).
+    """
+
+    url: str = pydantic.Field()
+    """
+    Webhook 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/call_webhook_event_type.py

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

wavix/types/call_webhook_list_response.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .call_webhook_list_response_item import CallWebhookListResponseItem
+
+CallWebhookListResponse = typing.List[CallWebhookListResponseItem]
+"""
+List of call webhooks configured for the phone number.
+"""

wavix/types/call_webhook_list_response_item.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 .call_webhook_list_response_item_event_type import CallWebhookListResponseItemEventType
+
+
+class CallWebhookListResponseItem(UniversalBaseModel):
+    event_type: CallWebhookListResponseItemEventType = pydantic.Field()
+    """
+    Type of call event the webhook subscribes to. One of `post-call` (delivered once after the call ends) or `on-call` (delivered for in-call events while the call is active).
+    """
+
+    url: str = pydantic.Field()
+    """
+    Webhook 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/call_webhook_list_response_item_event_type.py

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

wavix/types/campaign_status_updated_webhook.py

@@ -0,0 +1,41 @@
+# 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 .campaign_status_updated_webhook_status import CampaignStatusUpdatedWebhookStatus
+
+
+class CampaignStatusUpdatedWebhook(UniversalBaseModel):
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of a 10DLC Brand
+    """
+
+    campaign_id: str = pydantic.Field()
+    """
+    Unique identifier of a 10DLC Campaign
+    """
+
+    status: CampaignStatusUpdatedWebhookStatus = pydantic.Field()
+    """
+    Current status of the 10DLC Campaign. One of:
+    
+    - `REVIEW` — the campaign is under review.
+    - `APPROVED` — the campaign was approved and can send.
+    - `DECLINED` — the campaign was rejected during review.
+    - `DELETED` — the campaign was removed.
+    - `EXPIRED` — the campaign registration lapsed.
+    - `SUSPENDED` — the campaign is blocked from sending.
+    - `PORTED_OUT` — the campaign was migrated to another provider.
+    """
+
+    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/campaign_status_updated_webhook_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CampaignStatusUpdatedWebhookStatus = typing.Union[
+    typing.Literal["REVIEW", "APPROVED", "DECLINED", "DELETED", "EXPIRED", "SUSPENDED", "PORTED_OUT"], typing.Any
+]

wavix/types/cart_response.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
+from .available_number import AvailableNumber
+from .document_type import DocumentType
+
+
+class CartResponse(UniversalBaseModel):
+    dids: typing.List[AvailableNumber] = pydantic.Field()
+    """
+    List of phone numbers in the cart.
+    """
+
+    doc_types: typing.List[DocumentType] = pydantic.Field()
+    """
+    Document types required to activate phone numbers.
+    """
+
+    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/cdr.py

@@ -0,0 +1,97 @@
+# 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_disposition import CallDisposition
+
+
+class Cdr(UniversalBaseModel):
+    """
+    Call detail record (CDR) for an individual call.
+    """
+
+    date: dt.datetime = pydantic.Field()
+    """
+    Date and time of the call in ISO 8601 format.
+    """
+
+    from_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="from"), pydantic.Field(alias="from", description="Originating phone number (ANI).")
+    ]
+    to: str = pydantic.Field()
+    """
+    Destination phone number (DNIS).
+    """
+
+    disposition: CallDisposition
+    duration: int = pydantic.Field()
+    """
+    Call duration in seconds.
+    """
+
+    destination: str = pydantic.Field()
+    """
+    Destination of the call. For outbound calls,
+     contains the country name and, optionally, a mobile carrier
+      or city name. For inbound calls, includes the SIP trunk name,
+       SIP URI, or PSTN number the call is forwarded to.
+    """
+
+    per_minute: str = pydantic.Field()
+    """
+    Price per minute in USD.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total charge for the call in USD.
+    """
+
+    sip_trunk: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    System-generated SIP trunk login. For outbound calls only.
+    """
+
+    forward_fee: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    PSTN forwarding price in USD. For inbound calls only when forwarded to PSTN.
+    """
+
+    uuid_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="uuid"),
+        pydantic.Field(alias="uuid", description="Call ID. Deprecated — use `call_id` instead."),
+    ]
+    call_id: str = pydantic.Field()
+    """
+    Call ID. Alias of `uuid`.
+    """
+
+    parent_uuid: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parent call ID. Deprecated — use `parent_call_id` instead.
+    """
+
+    parent_call_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parent call ID. Alias of `parent_uuid`.
+    """
+
+    answered_by: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Who answered the call. Possible values are `human`, `machine`.
+    """
+
+    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/cdr_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 .cdr import Cdr
+from .pagination import Pagination
+
+
+class CdrListResponse(UniversalBaseModel):
+    items: typing.List[Cdr] = pydantic.Field()
+    """
+    List of CDRs
+    """
+
+    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