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

wavix/types/two_factor_verification_resend_response.py

@@ -0,0 +1,38 @@
+# 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 TwoFactorVerificationResendResponse(UniversalBaseModel):
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the verification code was successfully sent
+    """
+
+    channel: str = pydantic.Field()
+    """
+    Indicates whether the code was sent via an SMS or a voice call
+    """
+
+    destination: str = pydantic.Field()
+    """
+    The destination phone number the code was sent to
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Date and time the code was sent
+    """
+
+    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_response.py

@@ -0,0 +1,51 @@
+# 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 .phone_lookup_details import PhoneLookupDetails
+
+
+class TwoFactorVerificationResponse(UniversalBaseModel):
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the 2FA Verification was successfully created
+    """
+
+    service_id: str = pydantic.Field()
+    """
+    Unique identifier of the Wavix 2FA Service
+    """
+
+    session_url: str = pydantic.Field()
+    """
+    Automatically generated 2FA Verification URL. The URL can be used to resend or validate the OTP.
+    """
+
+    session_id: str = pydantic.Field()
+    """
+    Unique identifier of the Wavix 2FA Verification
+    """
+
+    destination: str = pydantic.Field()
+    """
+    The end user's phone number.
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Date and time the 2FA Verification is created
+    """
+
+    number_lookup: PhoneLookupDetails
+
+    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/unauthorized_error_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
+
+
+class UnauthorizedErrorResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the request was successful. Always `false` for this error.
+    """
+
+    error: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates that the response represents an error. Always `true` for this error.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable description stating that authentication is missing or invalid.
+    """
+
+    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/unprocessable_entity_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 UnprocessableEntityErrorBody(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/validation_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 ValidationErrorResponse(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 naming the missing or invalid request parameter.
+    """
+
+    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/voice_campaign_create_request.py

@@ -0,0 +1,20 @@
+# 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 .voice_campaign_response import VoiceCampaignResponse
+
+
+class VoiceCampaignCreateRequest(UniversalBaseModel):
+    voice_campaign: VoiceCampaignResponse
+
+    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/voice_campaign_response.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 VoiceCampaignResponse(UniversalBaseModel):
+    """
+    Represents a voice campaign that places an outbound call running a pre-approved call flow.
+    """
+
+    callflow_id: int = pydantic.Field()
+    """
+    Unique identifier of the call flow to launch, listed on the Call flows page. Every scenario must be pre-approved by the Wavix Service Operations team before it can be used in production.
+    """
+
+    caller_id: str = pydantic.Field()
+    """
+    Phone number on the account used as the Caller ID for the outbound call, in E.164 format.
+    """
+
+    contact: str = pydantic.Field()
+    """
+    Destination phone number the outbound call is placed to, in E.164 format.
+    """
+
+    callback_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Webhook URL that receives voice campaign 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/voice_campaigns_create_response.py

@@ -0,0 +1,20 @@
+# 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 .voice_campaigns_create_response_voice_campaign import VoiceCampaignsCreateResponseVoiceCampaign
+
+
+class VoiceCampaignsCreateResponse(UniversalBaseModel):
+    voice_campaign: typing.Optional[VoiceCampaignsCreateResponseVoiceCampaign] = 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/voice_campaigns_create_response_voice_campaign.py

@@ -0,0 +1,43 @@
+# 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 VoiceCampaignsCreateResponseVoiceCampaign(UniversalBaseModel):
+    id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Unique identifier of the voice campaign.
+    """
+
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Current status of the voice campaign, such as `in_progress`.
+    """
+
+    timestamp: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the voice campaign was created, in ISO 8601 format.
+    """
+
+    caller_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Phone number used as the Caller ID for the outbound call, in E.164 format.
+    """
+
+    contact: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Destination phone number the outbound call is placed to, in E.164 format.
+    """
+
+    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/voice_campaigns_get_response.py

@@ -0,0 +1,20 @@
+# 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 .voice_campaigns_get_response_voice_campaign import VoiceCampaignsGetResponseVoiceCampaign
+
+
+class VoiceCampaignsGetResponse(UniversalBaseModel):
+    voice_campaign: typing.Optional[VoiceCampaignsGetResponseVoiceCampaign] = 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/voice_campaigns_get_response_voice_campaign.py

@@ -0,0 +1,43 @@
+# 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 VoiceCampaignsGetResponseVoiceCampaign(UniversalBaseModel):
+    id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Unique identifier of the voice campaign.
+    """
+
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Current status of the voice campaign, such as `in_progress`.
+    """
+
+    timestamp: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the voice campaign was created, in ISO 8601 format.
+    """
+
+    caller_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Phone number used as the Caller ID for the outbound call, in E.164 format.
+    """
+
+    contact: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Destination phone number the outbound call is placed to, in E.164 format.
+    """
+
+    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/web_rtc_token.py

@@ -0,0 +1,43 @@
+# 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 WebRtcToken(UniversalBaseModel):
+    """
+    Represents a WebRTC token that authorizes the Wavix embeddable widget to register against a SIP trunk.
+    """
+
+    uuid_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="uuid"),
+        pydantic.Field(alias="uuid", description="Unique identifier of the WebRTC token."),
+    ]
+    sip_trunk: str = pydantic.Field()
+    """
+    Name of the SIP trunk the token authenticates against.
+    """
+
+    payload: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Arbitrary client-defined data associated with the token.
+    """
+
+    ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Time to live, in seconds. `null` means no expiration.
+    """
+
+    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/web_rtc_token_response.py

@@ -0,0 +1,44 @@
+# 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 WebRtcTokenResponse(UniversalBaseModel):
+    token: str = pydantic.Field()
+    """
+    Signed JWT used by the Wavix embeddable widget to authenticate.
+    """
+
+    uuid_: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="uuid"),
+        pydantic.Field(alias="uuid", description="Unique identifier of the WebRTC token."),
+    ]
+    sip_trunk: str = pydantic.Field()
+    """
+    Name of the SIP trunk the token authenticates against.
+    """
+
+    payload: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Arbitrary client-defined data associated with the token.
+    """
+
+    ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Lifetime of the token, in seconds. `null` means the token does not expire.
+    """
+
+    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/web_rtc_tokens_list_response.py

@@ -0,0 +1,30 @@
+# 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 .pagination import Pagination
+from .web_rtc_token import WebRtcToken
+
+
+class WebRtcTokensListResponse(UniversalBaseModel):
+    """
+    Paginated list of WebRTC tokens.
+    """
+
+    items: typing.Optional[typing.List[WebRtcToken]] = pydantic.Field(default=None)
+    """
+    WebRTC tokens on the current page.
+    """
+
+    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/version.py

@@ -0,0 +1,3 @@
+from importlib import metadata
+
+__version__ = metadata.version("wavix-python-sdk")

wavix/voice_campaigns/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+