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

wavix/ten_dlc/brands/types/__init__.py

@@ -0,0 +1,83 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .create_brands_response import CreateBrandsResponse
+    from .create_brands_response_entity_type import CreateBrandsResponseEntityType
+    from .create_brands_response_status import CreateBrandsResponseStatus
+    from .delete_brands_response import DeleteBrandsResponse
+    from .get_brands_response import GetBrandsResponse
+    from .get_brands_response_entity_type import GetBrandsResponseEntityType
+    from .get_brands_response_status import GetBrandsResponseStatus
+    from .list_brands_response import ListBrandsResponse
+    from .list_brands_response_pagination import ListBrandsResponsePagination
+    from .qualify_usecase_brands_request_use_case import QualifyUsecaseBrandsRequestUseCase
+    from .qualify_usecase_brands_response import QualifyUsecaseBrandsResponse
+    from .ten_dlc_brand_update_request_entity_type import TenDlcBrandUpdateRequestEntityType
+    from .ten_dlc_brand_update_request_vertical import TenDlcBrandUpdateRequestVertical
+    from .update_brands_response import UpdateBrandsResponse
+    from .update_brands_response_entity_type import UpdateBrandsResponseEntityType
+    from .update_brands_response_status import UpdateBrandsResponseStatus
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateBrandsResponse": ".create_brands_response",
+    "CreateBrandsResponseEntityType": ".create_brands_response_entity_type",
+    "CreateBrandsResponseStatus": ".create_brands_response_status",
+    "DeleteBrandsResponse": ".delete_brands_response",
+    "GetBrandsResponse": ".get_brands_response",
+    "GetBrandsResponseEntityType": ".get_brands_response_entity_type",
+    "GetBrandsResponseStatus": ".get_brands_response_status",
+    "ListBrandsResponse": ".list_brands_response",
+    "ListBrandsResponsePagination": ".list_brands_response_pagination",
+    "QualifyUsecaseBrandsRequestUseCase": ".qualify_usecase_brands_request_use_case",
+    "QualifyUsecaseBrandsResponse": ".qualify_usecase_brands_response",
+    "TenDlcBrandUpdateRequestEntityType": ".ten_dlc_brand_update_request_entity_type",
+    "TenDlcBrandUpdateRequestVertical": ".ten_dlc_brand_update_request_vertical",
+    "UpdateBrandsResponse": ".update_brands_response",
+    "UpdateBrandsResponseEntityType": ".update_brands_response_entity_type",
+    "UpdateBrandsResponseStatus": ".update_brands_response_status",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "CreateBrandsResponse",
+    "CreateBrandsResponseEntityType",
+    "CreateBrandsResponseStatus",
+    "DeleteBrandsResponse",
+    "GetBrandsResponse",
+    "GetBrandsResponseEntityType",
+    "GetBrandsResponseStatus",
+    "ListBrandsResponse",
+    "ListBrandsResponsePagination",
+    "QualifyUsecaseBrandsRequestUseCase",
+    "QualifyUsecaseBrandsResponse",
+    "TenDlcBrandUpdateRequestEntityType",
+    "TenDlcBrandUpdateRequestVertical",
+    "UpdateBrandsResponse",
+    "UpdateBrandsResponseEntityType",
+    "UpdateBrandsResponseStatus",
+]

wavix/ten_dlc/brands/types/create_brands_response.py

@@ -0,0 +1,143 @@
+# 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 .create_brands_response_entity_type import CreateBrandsResponseEntityType
+from .create_brands_response_status import CreateBrandsResponseStatus
+
+
+class CreateBrandsResponse(UniversalBaseModel):
+    """
+    Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns.
+    """
+
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the Brand assigned by the registry.
+    """
+
+    dba_name: str = pydantic.Field()
+    """
+    Doing-business-as name, or the public-facing brand name.
+    """
+
+    company_name: str = pydantic.Field()
+    """
+    Registered legal name of the company that owns the Brand.
+    """
+
+    entity_type: CreateBrandsResponseEntityType = pydantic.Field()
+    """
+    Company entity type.
+    """
+
+    vertical: str = pydantic.Field()
+    """
+    Industry vertical the Brand operates in.
+    """
+
+    ein_taxid: str = pydantic.Field()
+    """
+    IRS Employer Identification Number (EIN) or other tax ID of the company.
+    """
+
+    ein_taxid_country: str = pydantic.Field()
+    """
+    ISO 3166-1 alpha-2 country code where the Tax ID was issued.
+    """
+
+    status: CreateBrandsResponseStatus = pydantic.Field()
+    """
+    Brand identity verification status.
+    """
+
+    website: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Business website URL.
+    """
+
+    stock_symbol: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Stock ticker symbol of the company. Required for publicly traded companies.
+    """
+
+    stock_exchange: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Code of the stock exchange the company is listed on. Required for publicly traded companies.
+    """
+
+    first_name: str = pydantic.Field()
+    """
+    Business contact first name.
+    """
+
+    last_name: str = pydantic.Field()
+    """
+    Business contact last name.
+    """
+
+    phone_number: str = pydantic.Field()
+    """
+    Support contact phone number in E.164 format.
+    """
+
+    email: str = pydantic.Field()
+    """
+    Support contact email address.
+    """
+
+    street_address: str = pydantic.Field()
+    """
+    Street address of the business.
+    """
+
+    city: str = pydantic.Field()
+    """
+    City of the business address.
+    """
+
+    state_or_province: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    State or province of the business address.
+    """
+
+    country: str = pydantic.Field()
+    """
+    ISO 3166-1 alpha-2 country code of the business address.
+    """
+
+    zip: str = pydantic.Field()
+    """
+    ZIP or postal code of the business address.
+    """
+
+    feedback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Feedback from the identity verification process explaining the current `status`.
+    """
+
+    mock: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the Brand is a mock brand for testing.
+    """
+
+    created_at: str = pydantic.Field()
+    """
+    Timestamp when the Brand was created, in ISO 8601 format.
+    """
+
+    updated_at: str = pydantic.Field()
+    """
+    Timestamp when the Brand was last updated, 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/ten_dlc/brands/types/create_brands_response_entity_type.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateBrandsResponseEntityType = typing.Union[
+    typing.Literal["PRIVATE_PROFIT", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"], typing.Any
+]

wavix/ten_dlc/brands/types/create_brands_response_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateBrandsResponseStatus = typing.Union[
+    typing.Literal["REVIEW", "VERIFIED", "UNVERIFIED", "VETTED_VERIFIED", "SUSPENDED"], typing.Any
+]

wavix/ten_dlc/brands/types/delete_brands_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 DeleteBrandsResponse(UniversalBaseModel):
+    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/ten_dlc/brands/types/get_brands_response.py

@@ -0,0 +1,143 @@
+# 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 .get_brands_response_entity_type import GetBrandsResponseEntityType
+from .get_brands_response_status import GetBrandsResponseStatus
+
+
+class GetBrandsResponse(UniversalBaseModel):
+    """
+    Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns.
+    """
+
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the Brand assigned by the registry.
+    """
+
+    dba_name: str = pydantic.Field()
+    """
+    Doing-business-as name, or the public-facing brand name.
+    """
+
+    company_name: str = pydantic.Field()
+    """
+    Registered legal name of the company that owns the Brand.
+    """
+
+    entity_type: GetBrandsResponseEntityType = pydantic.Field()
+    """
+    Company entity type.
+    """
+
+    vertical: str = pydantic.Field()
+    """
+    Industry vertical the Brand operates in.
+    """
+
+    ein_taxid: str = pydantic.Field()
+    """
+    IRS Employer Identification Number (EIN) or other tax ID of the company.
+    """
+
+    ein_taxid_country: str = pydantic.Field()
+    """
+    ISO 3166-1 alpha-2 country code where the Tax ID was issued.
+    """
+
+    status: GetBrandsResponseStatus = pydantic.Field()
+    """
+    Brand identity verification status.
+    """
+
+    website: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Business website URL.
+    """
+
+    stock_symbol: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Stock ticker symbol of the company. Required for publicly traded companies.
+    """
+
+    stock_exchange: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Code of the stock exchange the company is listed on. Required for publicly traded companies.
+    """
+
+    first_name: str = pydantic.Field()
+    """
+    Business contact first name.
+    """
+
+    last_name: str = pydantic.Field()
+    """
+    Business contact last name.
+    """
+
+    phone_number: str = pydantic.Field()
+    """
+    Support contact phone number in E.164 format.
+    """
+
+    email: str = pydantic.Field()
+    """
+    Support contact email address.
+    """
+
+    street_address: str = pydantic.Field()
+    """
+    Street address of the business.
+    """
+
+    city: str = pydantic.Field()
+    """
+    City of the business address.
+    """
+
+    state_or_province: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    State or province of the business address.
+    """
+
+    country: str = pydantic.Field()
+    """
+    ISO 3166-1 alpha-2 country code of the business address.
+    """
+
+    zip: str = pydantic.Field()
+    """
+    ZIP or postal code of the business address.
+    """
+
+    feedback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Feedback from the identity verification process explaining the current `status`.
+    """
+
+    mock: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicates whether the Brand is a mock brand for testing.
+    """
+
+    created_at: str = pydantic.Field()
+    """
+    Timestamp when the Brand was created, in ISO 8601 format.
+    """
+
+    updated_at: str = pydantic.Field()
+    """
+    Timestamp when the Brand was last updated, 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/ten_dlc/brands/types/get_brands_response_entity_type.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetBrandsResponseEntityType = typing.Union[
+    typing.Literal["PRIVATE_PROFIT", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"], typing.Any
+]

wavix/ten_dlc/brands/types/get_brands_response_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetBrandsResponseStatus = typing.Union[
+    typing.Literal["REVIEW", "VERIFIED", "UNVERIFIED", "VETTED_VERIFIED", "SUSPENDED"], typing.Any
+]

wavix/ten_dlc/brands/types/list_brands_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 ....types.ten_dlc_brand import TenDlcBrand
+from .list_brands_response_pagination import ListBrandsResponsePagination
+
+
+class ListBrandsResponse(UniversalBaseModel):
+    """
+    A list of 10DLC Brands
+    """
+
+    items: typing.List[TenDlcBrand] = pydantic.Field()
+    """
+    A paginated list of 10DLC Brands matching the filter criteria
+    """
+
+    pagination: ListBrandsResponsePagination = pydantic.Field()
+    """
+    Pagination 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/ten_dlc/brands/types/list_brands_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 ListBrandsResponsePagination(UniversalBaseModel):
+    """
+    Pagination details
+    """
+
+    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/ten_dlc/brands/types/qualify_usecase_brands_request_use_case.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+QualifyUsecaseBrandsRequestUseCase = typing.Union[
+    typing.Literal[
+        "AGENTS_FRANCHISES",
+        "CARRIER_EXEMPT",
+        "CHARITY",
+        "EMERGENCY",
+        "K12_EDUCATION",
+        "LOW_VOLUME",
+        "M2M",
+        "MIXED",
+        "POLITICAL",
+        "PROXY",
+        "SOCIAL",
+        "SOLE_PROPRIETOR",
+        "SWEEPSTAKE",
+        "TRIAL",
+        "UCAAS_HIGH",
+        "UCAAS_LOW",
+        "2FA",
+        "ACCOUNT_NOTIFICATION",
+        "CUSTOMER_CARE",
+        "DELIVERY_NOTIFICATION",
+        "FRAUD_ALERT",
+        "HIGHER_EDUCATION",
+        "MARKETING",
+        "POLLING_VOTING",
+        "PUBLIC_SERVICE_ANNOUNCEMENT",
+        "SECURITY_ALERT",
+    ],
+    typing.Any,
+]

wavix/ten_dlc/brands/types/qualify_usecase_brands_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 ....types.ten_dlcmno_metadata import TenDlcmnoMetadata
+
+
+class QualifyUsecaseBrandsResponse(UniversalBaseModel):
+    mno_metadata: typing.List[TenDlcmnoMetadata] = pydantic.Field()
+    """
+    An array MNO-specific attributes (e.g. AT&T message class) for every MNO the Brand is qualified to run a Campaign with the specified use case.
+    """
+
+    monthly_fee: float = pydantic.Field()
+    """
+    Monthly fee associated with any Campaign with this use case
+    """
+
+    usecase: str = pydantic.Field()
+    """
+    The use case 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/ten_dlc/brands/types/ten_dlc_brand_update_request_entity_type.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TenDlcBrandUpdateRequestEntityType = typing.Union[
+    typing.Literal["PRIVATE_PROFIT", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"], typing.Any
+]

wavix/ten_dlc/brands/types/ten_dlc_brand_update_request_vertical.py

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TenDlcBrandUpdateRequestVertical = typing.Union[
+    typing.Literal[
+        "HEALTHCARE",
+        "PROFESSIONAL",
+        "RETAIL",
+        "TECHNOLOGY",
+        "EDUCATION",
+        "FINANCIAL",
+        "NON_PROFIT",
+        "GOVERNMENT",
+        "OTHER",
+    ],
+    typing.Any,
+]