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

wavix/types/opt_out_item.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 OptOutItem(UniversalBaseModel):
+    phone_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Opted-out phone number.
+    """
+
+    sender_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sender ID. Contains `null` if the phone number opted out of all messages.
+    """
+
+    campaign_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    10DLC campaign ID, if any.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Opt-out date and time in ISO 8601 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/opt_outs_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 .opt_out_item import OptOutItem
+from .pagination import Pagination
+
+
+class OptOutsListResponse(UniversalBaseModel):
+    items: typing.Optional[typing.List[OptOutItem]] = pydantic.Field(default=None)
+    """
+    Opt-out records that match the request.
+    """
+
+    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/pagination.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
+
+
+class Pagination(UniversalBaseModel):
+    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/phone_lookup_details.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 PhoneLookupDetails(UniversalBaseModel):
+    number_type: str = pydantic.Field()
+    """
+    The destination phone number type
+    """
+
+    country: str = pydantic.Field()
+    """
+    The destination phone number's 2-letter ISO country code
+    """
+
+    current_carrier: str = pydantic.Field()
+    """
+    The carrier name the phone number currently belongs 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/phone_number_validation_type.py

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

wavix/types/phone_validation_batch_response.py

@@ -0,0 +1,38 @@
+# 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 .phone_validation_result_response import PhoneValidationResultResponse
+
+
+class PhoneValidationBatchResponse(UniversalBaseModel):
+    status: str = pydantic.Field()
+    """
+    Validation request status.
+    """
+
+    pending: int = pydantic.Field()
+    """
+    Number of validations still in progress.
+    """
+
+    count: int = pydantic.Field()
+    """
+    Total number of phone numbers in the request.
+    """
+
+    items: typing.List[PhoneValidationResultResponse] = pydantic.Field()
+    """
+    List of validation results for each phone number.
+    """
+
+    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/phone_validation_batch_result_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
+from .phone_validation_result_response import PhoneValidationResultResponse
+
+
+class PhoneValidationBatchResultResponse(UniversalBaseModel):
+    status: str = pydantic.Field()
+    """
+    Request status. Possible values are `success` and `in progress`.
+    
+    - `success`: All numbers were processed. - `in progress`: Several numbers are pending validation.
+    """
+
+    pending: int = pydantic.Field()
+    """
+    The quantity of phone numbers that are pending to be processed.
+    """
+
+    count: int = pydantic.Field()
+    """
+    The quantity of phone numbers passed in the request.
+    """
+
+    items: typing.List[PhoneValidationResultResponse] = pydantic.Field()
+    """
+    Array of objects containing details for each phone number.
+     The returned fields depend on the `type` 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/phone_validation_response.py

@@ -0,0 +1,112 @@
+# 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 PhoneValidationResponse(UniversalBaseModel):
+    phone_number: str = pydantic.Field()
+    """
+    Phone number.
+    """
+
+    valid: bool = pydantic.Field()
+    """
+    Indicates whether the phone number is valid.
+    """
+
+    country_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ISO 3166-1 alpha-2 country code of the phone number.
+     `null` if the number is invalid.
+    """
+
+    e164format: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="e164_format"),
+        pydantic.Field(alias="e164_format", description="Phone number in international E.164 format."),
+    ]
+    national_format: str = pydantic.Field()
+    """
+    Phone number in the national format of the identified country.
+    """
+
+    ported: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the phone number was ported or not. `null` if the phone number is invalid.
+    """
+
+    mcc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile Country Code of the phone number carrier. For mobile phone numbers only. `null` if the phone number is invalid.
+    """
+
+    mnc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile Network Code of the phone number carrier. For mobile phone numbers only. `null` if the phone number is invalid
+    """
+
+    number_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Number type. Possible values are `mobile`, `landline`, or `toll-free`. `null` if the phone number is invalid.
+    """
+
+    carrier_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the phone number carrier. `null` if the phone number is invalid.
+    """
+
+    risky_destination: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the phone number belongs to a number range associated with traffic pumping. `null` if the number is invalid.
+    """
+
+    unallocated_range: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the phone number belongs to an unallocated number range. `null` if the number is invalid
+    """
+
+    reachable: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the number is registered in a mobile network. For mobile phone numbers only. `null` if the number is invalid
+    """
+
+    roaming: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the number is roaming. For mobile phone numbers only. `null` if the number is invalid
+    """
+
+    timezone: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Time zone based on the phone number's country and area code.
+     `null` if the number is invalid.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Charge for the validation.
+    """
+
+    error_code: str = pydantic.Field()
+    """
+    Error code for the request. `000` indicates success.
+    Possible values:
+    - `013`: — Internal service error
+    - `021`: — Invalid phone number length or format
+    - `041`: — Request timeout
+    - `042`: — Request failed
+    - `091`: — Insufficient funds
+    """
+
+    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/phone_validation_result_response.py

@@ -0,0 +1,115 @@
+# 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 PhoneValidationResultResponse(UniversalBaseModel):
+    """
+    Number validator response details.
+    """
+
+    phone_number: str = pydantic.Field()
+    """
+    Phone number.
+    """
+
+    valid: bool = pydantic.Field()
+    """
+    Indicates whether the phone number is valid.
+    """
+
+    country_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Phone number country code in ISO 3166-1 alpha-2 format. `null` if the number is invalid.
+    """
+
+    e164format: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="e164_format"),
+        pydantic.Field(alias="e164_format", description="Phone number in international E.164 format."),
+    ]
+    national_format: str = pydantic.Field()
+    """
+    Phone number in the national format of the identified country.
+    """
+
+    ported: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the phone number is ported. `null` if the phone number is invalid.
+    """
+
+    mcc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile Country Code (MCC). Applies to mobile numbers only. `null` if the phone number is invalid.
+    """
+
+    mnc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Mobile Network Code (MNC). Applies to mobile numbers only. `null` if the phone number is invalid.
+    """
+
+    number_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Phone number type. Allowed values: `mobile`, `landline`, `toll-free`. `null` if the phone number is invalid.
+    """
+
+    carrier_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Carrier name. `null` if the phone number is invalid.
+    """
+
+    risky_destination: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the phone number belongs to a range associated with traffic pumping. `null` if the phone number is invalid.
+    """
+
+    unallocated_range: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the phone number belongs to an unallocated range.
+     `null` if the phone number is invalid.
+    """
+
+    reachable: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the number is registered in a mobile network. Applies to mobile numbers only.  `null` if the phone number is invalid.
+    """
+
+    roaming: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the number is roaming. Applies to mobile numbers only.
+     `null` if the phone number is invalid.
+    """
+
+    timezone: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Time zone identified based on the country and area code.  `null` if the phone number is invalid.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Charge for the validation.
+    """
+
+    error_code: str = pydantic.Field()
+    """
+    Result code for the validation. `000` indicates success. Possible values:
+    - `013` — internal service error, uncategorized.
+    - `021` — invalid phone number length or format.
+    - `041` — remote timeout.
+    - `042` — remote query failed.
+    - `091` — insufficient funds.
+    """
+
+    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/profile_config_response.py

@@ -0,0 +1,25 @@
+# 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 .account_limits import AccountLimits
+
+
+class ProfileConfigResponse(UniversalBaseModel):
+    balance: str = pydantic.Field()
+    """
+    Funds available on the account balance, in USD
+    """
+
+    global_limits: AccountLimits
+
+    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/profile_response.py

@@ -0,0 +1,79 @@
+# 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 .profile_response_company_info import ProfileResponseCompanyInfo
+from .profile_response_default_destinations_item import ProfileResponseDefaultDestinationsItem
+
+
+class ProfileResponse(UniversalBaseModel):
+    id: int = pydantic.Field()
+    """
+    Account ID.
+    """
+
+    email: str = pydantic.Field()
+    """
+    Email associated with the account.
+    """
+
+    first_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Account owner's first name.
+    """
+
+    last_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Account owner's last name.
+    """
+
+    phone: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Account owner's phone number.
+    """
+
+    additional_info: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Additional info associated with the account.
+    """
+
+    contact_email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Additional email address for billing notifications.
+    """
+
+    timezone: str = pydantic.Field()
+    """
+    Timezone configured on the account.
+    """
+
+    job_title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Account owner's job title.
+    """
+
+    default_short_link_endpoint: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Default short link endpoint.
+    """
+
+    default_destinations: typing.List[ProfileResponseDefaultDestinationsItem] = pydantic.Field()
+    """
+    Default destinations configured for the account.
+    """
+
+    company_info: typing.Optional[ProfileResponseCompanyInfo] = pydantic.Field(default=None)
+    """
+    Company details.
+    """
+
+    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/profile_response_company_info.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 .profile_response_company_info_country import ProfileResponseCompanyInfoCountry
+from .profile_response_company_info_industry import ProfileResponseCompanyInfoIndustry
+
+
+class ProfileResponseCompanyInfo(UniversalBaseModel):
+    """
+    Company details.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Company name.
+    """
+
+    industry: typing.Optional[ProfileResponseCompanyInfoIndustry] = pydantic.Field(default=None)
+    """
+    Industry the company operates in. One of `telecommunications`, `information technology and services`, `fintech and finance`, `healthcare and pharmaceuticals`, `ecommerce and retail`, `education and research`, `pickup and delivery`, `transportation and logistics`, `media and entertainment`, `travel and hospitality`, `non-profit and charity organizations`, `manufacturing and industrial goods`, or `other`. Each value names the company's sector. `null` when the industry is not set.
+    """
+
+    address: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Company address.
+    """
+
+    attn_contact_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Billing contact name.
+    """
+
+    vat_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    VAT number.
+    """
+
+    country: typing.Optional[ProfileResponseCompanyInfoCountry] = pydantic.Field(default=None)
+    """
+    Country.
+    """
+
+    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/profile_response_company_info_country.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 ProfileResponseCompanyInfoCountry(UniversalBaseModel):
+    """
+    Country.
+    """
+
+    country_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Country name.
+    """
+
+    country_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Country 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/profile_response_company_info_industry.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProfileResponseCompanyInfoIndustry = typing.Union[
+    typing.Literal[
+        "telecommunications",
+        "information technology and services",
+        "fintech and finance",
+        "healthcare and pharmaceuticals",
+        "ecommerce and retail",
+        "education and research",
+        "pickup and delivery",
+        "transportation and logistics",
+        "media and entertainment",
+        "travel and hospitality",
+        "non-profit and charity organizations",
+        "manufacturing and industrial goods",
+        "other",
+    ],
+    typing.Any,
+]