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

wavix/types/cdr_response.py

@@ -0,0 +1,104 @@
+# 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 .transcription_reference import TranscriptionReference
+
+
+class CdrResponse(UniversalBaseModel):
+    date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Call date and time in ISO 8601 format.
+    """
+
+    from_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="from"), pydantic.Field(alias="from", description="Caller ID (ANI).")
+    ]
+    to: str = pydantic.Field()
+    """
+    Dialed number (DNIS).
+    """
+
+    disposition: CallDisposition
+    duration: int = pydantic.Field()
+    """
+    Call duration in seconds.
+    """
+
+    destination: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    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: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Price per minute in USD.
+    """
+
+    recording_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL of the recorded call file. Call recording can be enabled
+     on a SIP trunk for outbound calls and on
+      a phone number for inbound calls.
+    """
+
+    charge: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    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`.
+    """
+
+    transcription: typing.Optional[TranscriptionReference] = 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/cdr_transcription_completed_webhook.py

@@ -0,0 +1,28 @@
+# 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 .cdr_transcription_completed_webhook_status import CdrTranscriptionCompletedWebhookStatus
+
+
+class CdrTranscriptionCompletedWebhook(UniversalBaseModel):
+    uuid_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid", description="Call UUID")
+    ]
+    status: CdrTranscriptionCompletedWebhookStatus = pydantic.Field()
+    """
+    Outcome of the transcription. One of `completed` (the transcript was produced) or `failed` (the transcription could not be produced).
+    """
+
+    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_transcription_completed_webhook_status.py

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

wavix/types/cdr_transcription_response.py

@@ -0,0 +1,74 @@
+# 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 .transcript_turn import TranscriptTurn
+from .transcription_language import TranscriptionLanguage
+from .transcription_status import TranscriptionStatus
+
+
+class CdrTranscriptionResponse(UniversalBaseModel):
+    transcript: typing.Dict[str, str] = pydantic.Field()
+    """
+    Mapping of phone numbers in the call to transcript text.
+    """
+
+    turns: typing.List[TranscriptTurn] = pydantic.Field()
+    """
+    List of speaker turns with text and start/end times.
+    """
+
+    uuid_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="uuid"), pydantic.Field(alias="uuid", description="Transcription ID.")
+    ]
+    language: TranscriptionLanguage
+    duration: int = pydantic.Field()
+    """
+    Call duration in seconds.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total charge for the transcription in USD.
+    """
+
+    status: TranscriptionStatus
+    transcription_date: dt.datetime = pydantic.Field()
+    """
+    Date and time when the transcription was processed in ISO 8601 format.
+    """
+
+    call_date: dt.datetime = pydantic.Field()
+    """
+    Date and time when the call was placed or received in ISO 8601 format.
+    """
+
+    call_uuid: str = pydantic.Field()
+    """
+    Associated call ID.
+    """
+
+    call_score: str = pydantic.Field()
+    """
+    Call sentiment score. Indicates negative (1.0-3.0), neutral,
+     or positive (4.0-5.0).
+    """
+
+    call_summary: str = pydantic.Field()
+    """
+    One- or two-sentence call summary.
+    """
+
+    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_transcription_search_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_with_transcription import CdrWithTranscription
+from .pagination import Pagination
+
+
+class CdrTranscriptionSearchResponse(UniversalBaseModel):
+    items: typing.List[CdrWithTranscription] = pydantic.Field()
+    """
+    List of CDRs with transcription links.
+    """
+
+    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/cdr_with_transcription.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
+from .transcription_reference import TranscriptionReference
+
+
+class CdrWithTranscription(UniversalBaseModel):
+    """
+    A CDR of a single call with call transcription
+    """
+
+    answered_by: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Who answered the call. Allowed values are `human`, `machine`.
+    """
+
+    date: dt.datetime = pydantic.Field()
+    """
+    Date and time of the call
+    """
+
+    from_: typing_extensions.Annotated[
+        str, FieldMetadata(alias="from"), pydantic.Field(alias="from", description="ANI/From attribute of the call")
+    ]
+    to: str = pydantic.Field()
+    """
+    DNIS/To attribute of the call
+    """
+
+    disposition: CallDisposition
+    duration: int = pydantic.Field()
+    """
+    Duration of the call, in seconds
+    """
+
+    destination: str = pydantic.Field()
+    """
+    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.
+    """
+
+    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 login of a SIP trunk. For `placed` calls only.
+    """
+
+    forward_fee: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    PSTN forwarding price, in USD. For `received` 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`.
+    """
+
+    transcription: typing.Optional[TranscriptionReference] = 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/city.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 City(UniversalBaseModel):
+    id: int = pydantic.Field()
+    """
+    City ID.
+    """
+
+    name: str = pydantic.Field()
+    """
+    City name.
+    """
+
+    area_code: float = pydantic.Field()
+    """
+    Rate center.
+    """
+
+    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/city_list_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 .city import City
+
+
+class CityListResponse(UniversalBaseModel):
+    cities: typing.List[City] = pydantic.Field()
+    """
+    Cities available for the requested country or region.
+    """
+
+    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/country.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 Country(UniversalBaseModel):
+    id: int = pydantic.Field()
+    """
+    Country ID.
+    """
+
+    name: str = pydantic.Field()
+    """
+    Country name.
+    """
+
+    has_provinces_or_states: bool = pydantic.Field()
+    """
+    Indicates whether the country has regions.
+    """
+
+    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/country_has_no_regions_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 CountryHasNoRegionsErrorResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the request succeeded.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable error message.
+    """
+
+    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/country_list_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 .country import Country
+
+
+class CountryListResponse(UniversalBaseModel):
+    countries: typing.List[Country] = pydantic.Field()
+    """
+    Countries where phone numbers are available.
+    """
+
+    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/document_type.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 DocumentType(UniversalBaseModel):
+    id: int = pydantic.Field()
+    """
+    Document type ID.
+    """
+
+    name: str = pydantic.Field()
+    """
+    Document type name.
+    """
+
+    title: str = pydantic.Field()
+    """
+    Human-readable document type 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/document_type_id.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+DocumentTypeId = int
+"""
+Specifies the type of document required to activate the phone number.
+Possible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration.
+"""

wavix/types/file_transcript_response.py

@@ -0,0 +1,30 @@
+# 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
+
+
+class FileTranscriptResponse(UniversalBaseModel):
+    channel1: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="channel_1"),
+        pydantic.Field(alias="channel_1", description="Transcription of speaker one."),
+    ]
+    channel2: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="channel_2"),
+        pydantic.Field(alias="channel_2", description="Transcription of speaker two."),
+    ]
+
+    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_transcript_turn.py

@@ -0,0 +1,46 @@
+# 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 FileTranscriptTurn(UniversalBaseModel):
+    """
+    Transcription `turn` details, including speaker, timestamps, text, and sentiment.
+    """
+
+    speaker: str = pydantic.Field()
+    """
+    Speaker identifier.
+    """
+
+    s: int = pydantic.Field()
+    """
+    Turn start time in milliseconds from the beginning of the file.
+    """
+
+    e: int = pydantic.Field()
+    """
+    Turn end time in milliseconds from the beginning of the file.
+    """
+
+    text: str = pydantic.Field()
+    """
+    Transcription text attributed to the speaker.
+    """
+
+    sentiment: str = pydantic.Field()
+    """
+    Sentiment associated with the turn. Possible values are `positive`, `neutral`, `negative`.
+    """
+
+    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_completed_webhook.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 FileTranscriptionCompletedWebhook(UniversalBaseModel):
+    request_id: str = pydantic.Field()
+    """
+    Transcription request ID
+    """
+
+    status: str = pydantic.Field()
+    """
+    Outcome of the transcription. One of `completed` (the transcript was produced) or `failed` (the transcription could not be produced).
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    A human-readable error description, if any
+    """
+
+    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