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

wavix/types/ten_dlc_brand_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_brand import TenDlcBrand
+from .ten_dlc_brand_list_response_pagination import TenDlcBrandListResponsePagination
+
+
+class TenDlcBrandListResponse(UniversalBaseModel):
+    """
+    A list of 10DLC Brands
+    """
+
+    items: typing.List[TenDlcBrand] = pydantic.Field()
+    """
+    A paginated list of 10DLC Brands matching the filter criteria
+    """
+
+    pagination: TenDlcBrandListResponsePagination = 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/types/ten_dlc_brand_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 TenDlcBrandListResponsePagination(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/types/ten_dlc_brand_qualification_result.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_dlcmno_metadata import TenDlcmnoMetadata
+
+
+class TenDlcBrandQualificationResult(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/types/ten_dlc_brand_status.py

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

wavix/types/ten_dlc_brand_vetting.py

@@ -0,0 +1,71 @@
+# 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 TenDlcBrandVetting(UniversalBaseModel):
+    """
+    Represents the result of an external vetting performed on a 10DLC brand. Vetting can raise a Brand's trust score and unlock higher messaging throughput.
+    """
+
+    evp_id: str = pydantic.Field()
+    """
+    Code identifying the external vetting provider that performed the vetting.
+    """
+
+    create_date: str = pydantic.Field()
+    """
+    Timestamp when the vetting request was created, in ISO 8601 format.
+    """
+
+    vetting_details: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Additional provider-specific details about the vetting request.
+    """
+
+    vetted_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Timestamp when the vetting was completed, in ISO 8601 format. Null while the vetting is still in progress.
+    """
+
+    vetting_id: str = pydantic.Field()
+    """
+    Unique identifier of the vetting request.
+    """
+
+    vetting_token: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Token issued by the vetting provider that uniquely identifies this vetting result.
+    """
+
+    vetting_score: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Score assigned to the Brand by the vetting provider. Null until vetting completes.
+    """
+
+    vetting_class: str = pydantic.Field()
+    """
+    Class of vetting performed, such as `STANDARD` or `ENHANCED`.
+    """
+
+    vetting_status: str = pydantic.Field()
+    """
+    Current status of the vetting request, such as `PENDING` or `ACTIVE`.
+    """
+
+    reasons: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Reasons explaining the assigned `vetting_score`. Null when no reasons are provided.
+    """
+
+    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_brand_vetting_appeal.py

@@ -0,0 +1,78 @@
+# 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 .ten_dlc_brand_vetting_appeal_appeal_outcome import TenDlcBrandVettingAppealAppealOutcome
+
+
+class TenDlcBrandVettingAppeal(UniversalBaseModel):
+    """
+    Represents an appeal against a 10DLC brand vetting result. An appeal asks the vetting provider to reconsider the assigned score.
+    """
+
+    appeal_outcome: TenDlcBrandVettingAppealAppealOutcome = pydantic.Field()
+    """
+    Outcome of the appeal, including the revised vetting status and score.
+    """
+
+    appeal_status: str = pydantic.Field()
+    """
+    Current status of the appeal, such as `PENDING` or `COMPLETE`.
+    """
+
+    appeal_status_update_date: dt.datetime = pydantic.Field()
+    """
+    Timestamp when the appeal status was last updated, in ISO 8601 format.
+    """
+
+    attachment_uuid_list: typing.List[str] = pydantic.Field()
+    """
+    UUIDs of the evidence files submitted in support of the appeal.
+    """
+
+    brand_id: str = pydantic.Field()
+    """
+    Unique identifier of the Brand the appeal is associated with.
+    """
+
+    category_list: typing.List[str] = pydantic.Field()
+    """
+    Categories that classify the appeal, such as `LOW_SCORE`.
+    """
+
+    create_date: str = pydantic.Field()
+    """
+    Timestamp when the appeal was created, in ISO 8601 format.
+    """
+
+    explanation: str = pydantic.Field()
+    """
+    Justification provided for the appeal.
+    """
+
+    evp_id: str = pydantic.Field()
+    """
+    Code identifying the external vetting provider that handled the appeal.
+    """
+
+    vetting_class: str = pydantic.Field()
+    """
+    Class of the vetting being appealed, such as `STANDARD` or `ENHANCED`.
+    """
+
+    vetting_id: str = pydantic.Field()
+    """
+    Unique identifier of the vetting request being appealed.
+    """
+
+    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_brand_vetting_appeal_appeal_outcome.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
+from .ten_dlc_brand_vetting_appeal_appeal_outcome_feedback import TenDlcBrandVettingAppealAppealOutcomeFeedback
+
+
+class TenDlcBrandVettingAppealAppealOutcome(UniversalBaseModel):
+    """
+    Outcome of the appeal, including the revised vetting status and score.
+    """
+
+    vet_status: str = pydantic.Field()
+    """
+    Current status of the Brand vetting
+    """
+
+    vet_score: int = pydantic.Field()
+    """
+    The Brand vetting score
+    """
+
+    feedback: TenDlcBrandVettingAppealAppealOutcomeFeedback = pydantic.Field()
+    """
+    The feedback provided by the external vetting provider
+    """
+
+    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_brand_vetting_appeal_appeal_outcome_feedback.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
+
+
+class TenDlcBrandVettingAppealAppealOutcomeFeedback(UniversalBaseModel):
+    """
+    The feedback provided by the external vetting provider
+    """
+
+    reasons: typing.List[str] = pydantic.Field()
+    """
+    An list of human-readable explanations returned by TCR
+    """
+
+    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_brand_vetting_appeal_outcome.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_brand_vetting_appeal_outcome_feedback import TenDlcBrandVettingAppealOutcomeFeedback
+
+
+class TenDlcBrandVettingAppealOutcome(UniversalBaseModel):
+    vet_status: str = pydantic.Field()
+    """
+    Current status of the Brand vetting
+    """
+
+    vet_score: int = pydantic.Field()
+    """
+    The Brand vetting score
+    """
+
+    feedback: TenDlcBrandVettingAppealOutcomeFeedback = pydantic.Field()
+    """
+    The feedback provided by the external vetting provider
+    """
+
+    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_brand_vetting_appeal_outcome_feedback.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
+
+
+class TenDlcBrandVettingAppealOutcomeFeedback(UniversalBaseModel):
+    """
+    The feedback provided by the external vetting provider
+    """
+
+    reasons: typing.List[str] = pydantic.Field()
+    """
+    An list of human-readable explanations returned by TCR
+    """
+
+    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_brand_vetting_appeal_outcome_reason.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 TenDlcBrandVettingAppealOutcomeReason(UniversalBaseModel):
+    reasons: typing.List[str] = pydantic.Field()
+    """
+    An list of human-readable explanations returned by TCR
+    """
+
+    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.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 TenDlcCampaign(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/types/ten_dlc_campaign_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 import TenDlcCampaign
+from .ten_dlc_campaign_list_response_pagination import TenDlcCampaignListResponsePagination
+
+
+class TenDlcCampaignListResponse(UniversalBaseModel):
+    """
+    Paginated list of 10DLC Campaigns.
+    """
+
+    items: typing.List[TenDlcCampaign] = pydantic.Field()
+    """
+    10DLC Campaigns on the current page that match the filter criteria.
+    """
+
+    pagination: TenDlcCampaignListResponsePagination = 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