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

wavix/types/ten_dlc_campaign_list_response_pagination.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
+
+
+class TenDlcCampaignListResponsePagination(UniversalBaseModel):
+    """
+    Pagination metadata for the result set.
+    """
+
+    current_page: int = pydantic.Field()
+    """
+    Current page number.
+    """
+
+    per_page: int = pydantic.Field()
+    """
+    Number of records per page.
+    """
+
+    total: int = pydantic.Field()
+    """
+    Total number of records.
+    """
+
+    total_pages: int = pydantic.Field()
+    """
+    Total number of pages.
+    """
+
+    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/ten_dlc_campaign_nudge_request.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 TenDlcCampaignNudgeRequest(UniversalBaseModel):
+    """
+    Nudge configuration. Set the nudge intent to `REVIEW` to request action on a pending approval, or to `APPEAL_REJECTION` to submit an appeal for a rejected campaign.
+    """
+
+    nudge_intent: str = pydantic.Field()
+    """
+    Nudge intent. Allowed values: `REVIEW`, `APPEAL_REJECTION`. 
+    Use `nudge_intent` to specify the action: - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.
+    """
+
+    description: str = pydantic.Field()
+    """
+    Description of the nudge request.
+    """
+
+    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/ten_dlc_campaign_number.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 TenDlcCampaignNumber(UniversalBaseModel):
+    number: str = pydantic.Field()
+    """
+    Phone number assigned to the 10DLC Campaign, in E.164 format.
+    """
+
+    status: str = pydantic.Field()
+    """
+    Provisioning status of the phone number, such as `APPROVED`. Only `APPROVED` numbers can be used as Sender IDs.
+    """
+
+    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/ten_dlc_campaign_number_list_response.py

@@ -0,0 +1,33 @@
+# 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_campaign_number import TenDlcCampaignNumber
+
+
+class TenDlcCampaignNumberListResponse(UniversalBaseModel):
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the 10DLC Brand that owns the Campaign.
+    """
+
+    campaign_id: str = pydantic.Field()
+    """
+    Unique identifier of the 10DLC Campaign the numbers belong to.
+    """
+
+    numbers: typing.List[TenDlcCampaignNumber] = pydantic.Field()
+    """
+    Phone numbers assigned to the Campaign, with their provisioning status.
+    """
+
+    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/ten_dlc_event_subscription.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 TenDlcEventSubscription(UniversalBaseModel):
+    """
+    Represents a subscription that delivers 10DLC lifecycle events to a webhook URL.
+    """
+
+    subscription_category: str = pydantic.Field()
+    """
+    Category of 10DLC events to subscribe to. One of `brand` (brand status changes), `campaign` (campaign status changes), or `number` (number provisioning changes).
+    """
+
+    url: str = pydantic.Field()
+    """
+    Webhook URL that events in this category are delivered to.
+    """
+
+    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/ten_dlcmno_metadata.py

@@ -0,0 +1,101 @@
+# 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 TenDlcmnoMetadata(UniversalBaseModel):
+    """
+    Represents per-MNO 10DLC requirements and throughput limits that apply to a campaign use case.
+    """
+
+    att_mms_tpm: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    MMS throughput per minute allowed on the AT&T network.
+    """
+
+    att_msg_class: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Message class assigned by AT&T.
+    """
+
+    att_sms_tpm: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    SMS throughput per minute allowed on the AT&T network.
+    """
+
+    att_tpm_scope: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Scope of the AT&T throughput-per-minute allocation.
+    """
+
+    help_required: bool = pydantic.Field()
+    """
+    Indicates whether help keywords and an acknowledgement are mandatory for the use case.
+    """
+
+    optin_required: bool = pydantic.Field()
+    """
+    Indicates whether an opt-in mechanism is mandatory for the use case.
+    """
+
+    optout_required: bool = pydantic.Field()
+    """
+    Indicates whether an opt-out mechanism is mandatory for the use case.
+    """
+
+    min_msg_samples: int = pydantic.Field()
+    """
+    Minimum number of message samples the MNO requires for the use case.
+    """
+
+    mno: str = pydantic.Field()
+    """
+    Name of the mobile network operator (MNO) these requirements apply to.
+    """
+
+    mno_qualify: bool = pydantic.Field()
+    """
+    Indicates whether the Brand qualifies with the MNO for the selected use case.
+    """
+
+    mno_review: bool = pydantic.Field()
+    """
+    Indicates whether the MNO requires a post-approval review of the use case.
+    """
+
+    mno_support: bool = pydantic.Field()
+    """
+    Indicates whether the MNO supports the use case.
+    """
+
+    no_embedded_links: bool = pydantic.Field()
+    """
+    Indicates whether embedded links are prohibited in message content for the use case.
+    """
+
+    no_embedded_phone: bool = pydantic.Field()
+    """
+    Indicates whether embedded phone numbers are prohibited in message content for the use case.
+    """
+
+    tmobile_brand_dcap: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Daily message cap allowed on the T-Mobile network.
+    """
+
+    tmobile_brand_tier: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Brand tier assigned on the T-Mobile network, such as `LOW`.
+    """
+
+    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/transaction_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TransactionStatus = typing.Union[typing.Literal["Created", "Pending", "Committed", "Reverted"], typing.Any]

wavix/types/transaction_type.py

@@ -0,0 +1,50 @@
+# This file was auto-generated by Fern from our API Definition.
+
+TransactionType = int
+"""
+Transaction type:
+  * 0   - Payment adjustment
+  * 2   - Phone number activation fee
+  * 3   - Phone number monthly fees
+  * 6   - Phone number forwarding
+  * 11  - PSTN forwarding fee
+  * 14  - Outbound call
+  * 15  - Outbound SMS
+  * 19  - Credit card payment
+  * 20  - Payment fee
+  * 23  - Porting fee
+  * 24  - Inbound SMS
+  * 25  - Admin payment
+  * 26  - Subscription payment
+  * 29  - Number validator
+  * 30  - Call recording
+  * 31  - Storage charge
+  * 32  - Campaign builder
+  * 33  - Voicemail detection
+  * 34  - Sender ID registration
+  * 35  - Sender ID monthly fee
+  * 36  - 2FA
+  * 37  - IVR
+  * 38  - E911 activation
+  * 39  - Outbound MMS
+  * 40  - Inbound MMS
+  * 41  - Call transcription
+  * 42  - 10DLC Brand registration
+  * 43  - 10DLC Campaign registration
+  * 44  - Phone number order
+  * 45  - Adjustment in
+  * 46  - URL shortener
+  * 47  - 10DLC Brand update
+  * 48  - 10DLC Brand appeal
+  * 49  - Audio transcription
+  * 50  - 10DLC Brand vetting
+  * 51  - 10DLC Brand vetting appeal
+  * 52  - Outbound SMS carrier fee
+  * 53  - Inbound SMS carrier fee
+  * 54  - Outbound MMS carrier fee
+  * 55  - Inbound MMS carrier fee
+  * 57  - Outbound SMS segment
+  * 58  - Inbound SMS segment
+  * 59  - Outbound MMS segment
+  * 60  - Inbound MMS segment
+"""

wavix/types/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 TranscriptTurn(UniversalBaseModel):
+    """
+    Represents a single turn in a call transcript. Each turn carries the text attributed to one speaker, with the start and end times for that text.
+    """
+
+    type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Phone number of the speaker attributed to this turn, in E.164 format.
+    """
+
+    s: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Start of the `turn`, in milliseconds. The start time is calculated from the moment the call was answered.
+    """
+
+    e: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    End of the `turn`, in milliseconds. The end time is calculated from the moment the call was answered.
+    """
+
+    text: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Transcribed text attributed to the speaker for this turn.
+    """
+
+    sentiment: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sentiment detected in the speaker's text for this turn, such as `neutral`, `positive`, or `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/transcription_filter.py

@@ -0,0 +1,35 @@
+# 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 .transcription_filter_agent import TranscriptionFilterAgent
+from .transcription_filter_any import TranscriptionFilterAny
+from .transcription_filter_client import TranscriptionFilterClient
+
+
+class TranscriptionFilter(UniversalBaseModel):
+    agent: TranscriptionFilterAgent = pydantic.Field()
+    """
+    Search in an agent's spoken words and phrases
+    """
+
+    client: TranscriptionFilterClient = pydantic.Field()
+    """
+    Search in an customer's spoken words and phrases
+    """
+
+    any: TranscriptionFilterAny = pydantic.Field()
+    """
+    Search in both speakers' spoken words and phrases
+    """
+
+    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/transcription_filter_agent.py

@@ -0,0 +1,36 @@
+# 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 TranscriptionFilterAgent(UniversalBaseModel):
+    """
+    Search in an agent's spoken words and phrases
+    """
+
+    must: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND
+    """
+
+    match: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR
+    """
+
+    exclude: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR
+    """
+
+    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/transcription_filter_any.py

@@ -0,0 +1,36 @@
+# 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 TranscriptionFilterAny(UniversalBaseModel):
+    """
+    Search in both speakers' spoken words and phrases
+    """
+
+    must: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND
+    """
+
+    match: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR
+    """
+
+    exclude: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR
+    """
+
+    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/transcription_filter_client.py

@@ -0,0 +1,36 @@
+# 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 TranscriptionFilterClient(UniversalBaseModel):
+    """
+    Search in an customer's spoken words and phrases
+    """
+
+    must: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND
+    """
+
+    match: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR
+    """
+
+    exclude: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR
+    """
+
+    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/transcription_language.py

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

wavix/types/transcription_reference.py

@@ -0,0 +1,29 @@
+# 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 TranscriptionReference(UniversalBaseModel):
+    uuid_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="uuid"),
+        pydantic.Field(alias="uuid", description="Unique identifier of the call transcription."),
+    ]
+    url: str = pydantic.Field()
+    """
+    URL for retrieving the full call transcription.
+    """
+
+    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/transcription_status.py

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

wavix/types/tts_language.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TtsLanguage = typing.Union[typing.Literal["ru", "en", "sp", "ge"], typing.Any]

wavix/types/tts_voice_id.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TtsVoiceId = typing.Union[
+    typing.Literal[
+        "Ivy",
+        "Joanna",
+        "Kendra",
+        "Kimberly",
+        "Salli",
+        "Joey",
+        "Justin",
+        "Matthew",
+        "Conchita",
+        "Lucia",
+        "Enrique",
+        "Marlene",
+        "Vicki",
+        "Hans",
+        "Tatyana",
+        "Maxim",
+    ],
+    typing.Any,
+]

wavix/types/two_factor_verification_check_response.py

@@ -0,0 +1,22 @@
+# 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 TwoFactorVerificationCheckResponse(UniversalBaseModel):
+    is_valid: bool = pydantic.Field()
+    """
+    Indicates whether the entered code is valid
+    """
+
+    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/two_factor_verification_event.py

@@ -0,0 +1,47 @@
+# 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 TwoFactorVerificationEvent(UniversalBaseModel):
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Date and time of the event
+    """
+
+    event: str = pydantic.Field()
+    """
+    Human-readable event description. One of the following values:
+    - `Number lookup` — the Wavix platform checked whether the destination phone number is valid. Returned only when number validation is enabled for the 2FA Service.
+    - `Code sent via SMS` — a code was sent via SMS.
+    - `Code sent via voice` — a code was sent via a voice call.
+    - `Verification` — a code verification attempt.
+    """
+
+    status: str = pydantic.Field()
+    """
+    Status of an action associated with the event. Can be either `success`, `failed`, or `pending`.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Cost of an operation associated with the event, in USD
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    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