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

wavix/ten_dlc/campaigns/types/__init__.py

@@ -0,0 +1,62 @@
+# 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_campaigns_response import CreateCampaignsResponse
+    from .delete_campaigns_response import DeleteCampaignsResponse
+    from .get_campaigns_response import GetCampaignsResponse
+    from .list_by_brand_campaigns_response import ListByBrandCampaignsResponse
+    from .list_by_brand_campaigns_response_pagination import ListByBrandCampaignsResponsePagination
+    from .list_campaigns_response import ListCampaignsResponse
+    from .list_campaigns_response_pagination import ListCampaignsResponsePagination
+    from .ten_dlc_campaign_update_request_usecase import TenDlcCampaignUpdateRequestUsecase
+    from .update_campaigns_response import UpdateCampaignsResponse
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateCampaignsResponse": ".create_campaigns_response",
+    "DeleteCampaignsResponse": ".delete_campaigns_response",
+    "GetCampaignsResponse": ".get_campaigns_response",
+    "ListByBrandCampaignsResponse": ".list_by_brand_campaigns_response",
+    "ListByBrandCampaignsResponsePagination": ".list_by_brand_campaigns_response_pagination",
+    "ListCampaignsResponse": ".list_campaigns_response",
+    "ListCampaignsResponsePagination": ".list_campaigns_response_pagination",
+    "TenDlcCampaignUpdateRequestUsecase": ".ten_dlc_campaign_update_request_usecase",
+    "UpdateCampaignsResponse": ".update_campaigns_response",
+}
+
+
+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__ = [
+    "CreateCampaignsResponse",
+    "DeleteCampaignsResponse",
+    "GetCampaignsResponse",
+    "ListByBrandCampaignsResponse",
+    "ListByBrandCampaignsResponsePagination",
+    "ListCampaignsResponse",
+    "ListCampaignsResponsePagination",
+    "TenDlcCampaignUpdateRequestUsecase",
+    "UpdateCampaignsResponse",
+]

wavix/ten_dlc/campaigns/types/create_campaigns_response.py

@@ -0,0 +1,211 @@
+# 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 CreateCampaignsResponse(UniversalBaseModel):
+    """
+    Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic.
+    """
+
+    affiliate_marketing: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign is used for affiliate marketing.
+    """
+
+    age_gated: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain age-gated content.
+    """
+
+    auto_renewal: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign should be automatically renewed.
+    """
+
+    last_bill_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the Campaign was last billed in ISO 8601 format. `null` if the Campaign has never been billed.
+    """
+
+    next_bill_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the Campaign will be billed next in ISO 8601 format. `null` if the next billing date is not scheduled.
+    """
+
+    direct_lending: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain direct lending content.
+    """
+
+    embedded_links: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain embedded links.
+    """
+
+    embedded_phones: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain embedded phone numbers.
+    """
+
+    embedded_link_sample: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample of an embedded link used in Campaign messages.
+    """
+
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the Brand that owns the Campaign.
+    """
+
+    campaign_id: str = pydantic.Field()
+    """
+    Unique identifier of the Campaign assigned by the registry.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description of the Campaign and its messaging purpose.
+    """
+
+    optin_workflow: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description of the workflow through which subscribers opt in to the Campaign.
+    """
+
+    feedback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Feedback from the registry explaining the current `status`.
+    """
+
+    help: bool = pydantic.Field()
+    """
+    Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).
+    """
+
+    help_keywords: str = pydantic.Field()
+    """
+    Comma-separated list of help keywords. Keywords are case-insensitive.
+    """
+
+    help_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Help message sent upon receiving a help keyword.
+    """
+
+    optin: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign requires subscriber opt-in.
+    """
+
+    optin_keywords: str = pydantic.Field()
+    """
+    Comma-separated list of opt-in keywords. Keywords are case-insensitive.
+    """
+
+    optin_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Opt-in message sent upon receiving an opt-in keyword.
+    """
+
+    optout: bool = pydantic.Field()
+    """
+    Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).
+    """
+
+    optout_keywords: str = pydantic.Field()
+    """
+    Comma-separated list of opt-out keywords. Keywords are case-insensitive.
+    """
+
+    optout_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Opt-out message sent upon receiving an opt-out keyword.
+    """
+
+    name: str = pydantic.Field()
+    """
+    Display name of the Campaign.
+    """
+
+    created_at: str = pydantic.Field()
+    """
+    Timestamp when the Campaign was created, in ISO 8601 format.
+    """
+
+    sample1: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample2: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample3: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample4: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample5: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    updated_at: str = pydantic.Field()
+    """
+    Timestamp when the Campaign was last updated, in ISO 8601 format.
+    """
+
+    mock: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.
+    """
+
+    usecase: str = pydantic.Field()
+    """
+    Registered use case for the Campaign, such as `2FA` or `MARKETING`.
+    """
+
+    monthly_fee: str = pydantic.Field()
+    """
+    Recurring monthly fee charged for the Campaign, as a decimal string.
+    """
+
+    privacy_policy: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Privacy policy URL.
+    """
+
+    terms_conditions: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Terms and conditions URL.
+    """
+
+    status: str = pydantic.Field()
+    """
+    Current registration status of the Campaign, such as `APPROVED` or `PENDING`.
+    """
+
+    phone_numbers: typing.List[str] = pydantic.Field()
+    """
+    Phone numbers assigned to the Campaign, 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/ten_dlc/campaigns/types/delete_campaigns_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 DeleteCampaignsResponse(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/campaigns/types/get_campaigns_response.py

@@ -0,0 +1,211 @@
+# 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 GetCampaignsResponse(UniversalBaseModel):
+    """
+    Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic.
+    """
+
+    affiliate_marketing: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign is used for affiliate marketing.
+    """
+
+    age_gated: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain age-gated content.
+    """
+
+    auto_renewal: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign should be automatically renewed.
+    """
+
+    last_bill_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the Campaign was last billed in ISO 8601 format. `null` if the Campaign has never been billed.
+    """
+
+    next_bill_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date and time the Campaign will be billed next in ISO 8601 format. `null` if the next billing date is not scheduled.
+    """
+
+    direct_lending: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain direct lending content.
+    """
+
+    embedded_links: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain embedded links.
+    """
+
+    embedded_phones: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign messages contain embedded phone numbers.
+    """
+
+    embedded_link_sample: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample of an embedded link used in Campaign messages.
+    """
+
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the Brand that owns the Campaign.
+    """
+
+    campaign_id: str = pydantic.Field()
+    """
+    Unique identifier of the Campaign assigned by the registry.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description of the Campaign and its messaging purpose.
+    """
+
+    optin_workflow: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description of the workflow through which subscribers opt in to the Campaign.
+    """
+
+    feedback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Feedback from the registry explaining the current `status`.
+    """
+
+    help: bool = pydantic.Field()
+    """
+    Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).
+    """
+
+    help_keywords: str = pydantic.Field()
+    """
+    Comma-separated list of help keywords. Keywords are case-insensitive.
+    """
+
+    help_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Help message sent upon receiving a help keyword.
+    """
+
+    optin: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign requires subscriber opt-in.
+    """
+
+    optin_keywords: str = pydantic.Field()
+    """
+    Comma-separated list of opt-in keywords. Keywords are case-insensitive.
+    """
+
+    optin_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Opt-in message sent upon receiving an opt-in keyword.
+    """
+
+    optout: bool = pydantic.Field()
+    """
+    Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).
+    """
+
+    optout_keywords: str = pydantic.Field()
+    """
+    Comma-separated list of opt-out keywords. Keywords are case-insensitive.
+    """
+
+    optout_message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Opt-out message sent upon receiving an opt-out keyword.
+    """
+
+    name: str = pydantic.Field()
+    """
+    Display name of the Campaign.
+    """
+
+    created_at: str = pydantic.Field()
+    """
+    Timestamp when the Campaign was created, in ISO 8601 format.
+    """
+
+    sample1: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample2: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample3: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample4: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    sample5: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sample message demonstrating the content sent through the Campaign.
+    """
+
+    updated_at: str = pydantic.Field()
+    """
+    Timestamp when the Campaign was last updated, in ISO 8601 format.
+    """
+
+    mock: bool = pydantic.Field()
+    """
+    Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.
+    """
+
+    usecase: str = pydantic.Field()
+    """
+    Registered use case for the Campaign, such as `2FA` or `MARKETING`.
+    """
+
+    monthly_fee: str = pydantic.Field()
+    """
+    Recurring monthly fee charged for the Campaign, as a decimal string.
+    """
+
+    privacy_policy: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Privacy policy URL.
+    """
+
+    terms_conditions: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Terms and conditions URL.
+    """
+
+    status: str = pydantic.Field()
+    """
+    Current registration status of the Campaign, such as `APPROVED` or `PENDING`.
+    """
+
+    phone_numbers: typing.List[str] = pydantic.Field()
+    """
+    Phone numbers assigned to the Campaign, 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/ten_dlc/campaigns/types/list_by_brand_campaigns_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_campaign import TenDlcCampaign
+from .list_by_brand_campaigns_response_pagination import ListByBrandCampaignsResponsePagination
+
+
+class ListByBrandCampaignsResponse(UniversalBaseModel):
+    """
+    Paginated list of 10DLC Campaigns.
+    """
+
+    items: typing.List[TenDlcCampaign] = pydantic.Field()
+    """
+    10DLC Campaigns on the current page that match the filter criteria.
+    """
+
+    pagination: ListByBrandCampaignsResponsePagination = pydantic.Field()
+    """
+    Pagination metadata for the result set.
+    """
+
+    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/campaigns/types/list_by_brand_campaigns_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 ListByBrandCampaignsResponsePagination(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/ten_dlc/campaigns/types/list_campaigns_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_campaign import TenDlcCampaign
+from .list_campaigns_response_pagination import ListCampaignsResponsePagination
+
+
+class ListCampaignsResponse(UniversalBaseModel):
+    """
+    Paginated list of 10DLC Campaigns.
+    """
+
+    items: typing.List[TenDlcCampaign] = pydantic.Field()
+    """
+    10DLC Campaigns on the current page that match the filter criteria.
+    """
+
+    pagination: ListCampaignsResponsePagination = pydantic.Field()
+    """
+    Pagination metadata for the result set.
+    """
+
+    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/campaigns/types/list_campaigns_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 ListCampaignsResponsePagination(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/ten_dlc/campaigns/types/ten_dlc_campaign_update_request_usecase.py

@@ -0,0 +1,15 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TenDlcCampaignUpdateRequestUsecase = typing.Union[
+    typing.Literal[
+        "CUSTOMER_CARE",
+        "MARKETING",
+        "ACCOUNT_NOTIFICATION",
+        "FRAUD_ALERT",
+        "PUBLIC_SERVICE_ANNOUNCEMENT",
+        "SECURITY_ALERT",
+    ],
+    typing.Any,
+]