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

wavix/ten_dlc/campaigns/client.py

@@ -0,0 +1,1493 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...types.success_response import SuccessResponse
+from .raw_client import AsyncRawCampaignsClient, RawCampaignsClient
+from .types.create_campaigns_response import CreateCampaignsResponse
+from .types.delete_campaigns_response import DeleteCampaignsResponse
+from .types.get_campaigns_response import GetCampaignsResponse
+from .types.list_by_brand_campaigns_response import ListByBrandCampaignsResponse
+from .types.list_campaigns_response import ListCampaignsResponse
+from .types.ten_dlc_campaign_update_request_usecase import TenDlcCampaignUpdateRequestUsecase
+from .types.update_campaigns_response import UpdateCampaignsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CampaignsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCampaignsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCampaignsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCampaignsClient
+        """
+        return self._raw_client
+
+    def list(
+        self,
+        *,
+        name: typing.Optional[str] = None,
+        usecase: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        mock: typing.Optional[bool] = None,
+        created_before: typing.Optional[dt.date] = None,
+        created_after: typing.Optional[dt.date] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListCampaignsResponse:
+        """
+        Returns a paginated list of 10DLC Campaigns for the authenticated account, filtered by date, status, and use case.
+
+        Parameters
+        ----------
+        name : typing.Optional[str]
+            Filters Campaigns by name. Matches partial values.
+
+        usecase : typing.Optional[str]
+            Filters Campaigns by use case.
+
+        status : typing.Optional[str]
+            Filters Campaigns by status.
+
+        mock : typing.Optional[bool]
+            When `true`, returns only mock Campaigns used for testing. Default `false`.
+
+        created_before : typing.Optional[dt.date]
+            Returns Campaigns created on or before this date, in `YYYY-MM-DD` format.
+
+        created_after : typing.Optional[dt.date]
+            Returns Campaigns created on or after this date, in `YYYY-MM-DD` format.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListCampaignsResponse
+            Returns a paginated list of 10DLC Campaigns.
+
+        Examples
+        --------
+        import datetime
+
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaigns.list(
+            name="Name",
+            usecase="2FA",
+            status="APPROVED",
+            mock=True,
+            created_before=datetime.date.fromisoformat(
+                "2024-08-22",
+            ),
+            created_after=datetime.date.fromisoformat(
+                "2024-08-22",
+            ),
+            page=1,
+            per_page=25,
+        )
+        """
+        _response = self._raw_client.list(
+            name=name,
+            usecase=usecase,
+            status=status,
+            mock=mock,
+            created_before=created_before,
+            created_after=created_after,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def list_by_brand(
+        self,
+        brand_id: str,
+        *,
+        name: typing.Optional[str] = None,
+        usecase: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        mock: typing.Optional[bool] = None,
+        created_before: typing.Optional[dt.date] = None,
+        created_after: typing.Optional[dt.date] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListByBrandCampaignsResponse:
+        """
+        Returns a paginated list of 10DLC Campaigns associated with the 10DLC Brand identified by `brand_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        name : typing.Optional[str]
+            Filters Campaigns by name. Matches partial values.
+
+        usecase : typing.Optional[str]
+            Filters Campaigns by use case.
+
+        status : typing.Optional[str]
+            Filters Campaigns by status.
+
+        mock : typing.Optional[bool]
+            When `true`, returns only mock Campaigns used for testing. Default `false`.
+
+        created_before : typing.Optional[dt.date]
+            Returns Campaigns created on or before this date, in `YYYY-MM-DD` format.
+
+        created_after : typing.Optional[dt.date]
+            Returns Campaigns created on or after this date, in `YYYY-MM-DD` format.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListByBrandCampaignsResponse
+            Returns a paginated list of 10DLC Campaigns.
+
+        Examples
+        --------
+        import datetime
+
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaigns.list_by_brand(
+            brand_id="BM20QP9",
+            name="Name",
+            usecase="2FA",
+            status="APPROVED",
+            mock=True,
+            created_before=datetime.date.fromisoformat(
+                "2024-08-22",
+            ),
+            created_after=datetime.date.fromisoformat(
+                "2024-08-22",
+            ),
+            page=1,
+            per_page=25,
+        )
+        """
+        _response = self._raw_client.list_by_brand(
+            brand_id,
+            name=name,
+            usecase=usecase,
+            status=status,
+            mock=mock,
+            created_before=created_before,
+            created_after=created_after,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create(
+        self,
+        brand_id: str,
+        *,
+        affiliate_marketing: bool,
+        age_gated: bool,
+        auto_renewal: bool,
+        direct_lending: bool,
+        embedded_links: bool,
+        description: str,
+        optin_workflow: str,
+        help: bool,
+        help_keywords: str,
+        help_message: str,
+        optin: bool,
+        optin_keywords: str,
+        optin_message: str,
+        optout: bool,
+        optout_keywords: str,
+        optout_message: str,
+        name: str,
+        sample1: str,
+        mock: bool,
+        usecase: str,
+        terms_conditions: str,
+        embedded_phones: typing.Optional[bool] = OMIT,
+        embedded_link_sample: typing.Optional[str] = OMIT,
+        sample2: typing.Optional[str] = OMIT,
+        sample3: typing.Optional[str] = OMIT,
+        sample4: typing.Optional[str] = OMIT,
+        sample5: typing.Optional[str] = OMIT,
+        privacy_policy: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateCampaignsResponse:
+        """
+        Registers a 10DLC Campaign under the 10DLC Brand identified by `brand_id`. The Brand must have a verified identity status.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        affiliate_marketing : bool
+            Indicates whether the Campaign is used for affiliate marketing.
+
+        age_gated : bool
+            Indicates whether the Campaign messages contain age-gated content.
+
+        auto_renewal : bool
+            Indicates whether the Campaign is automatically renewed at the end of each billing period.
+
+        direct_lending : bool
+            Indicates whether the Campaign messages contain direct lending content.
+
+        embedded_links : bool
+            Indicates whether the Campaign messages contain embedded links.
+
+        description : str
+            Description of the Campaign and its messaging purpose.
+
+        optin_workflow : str
+            Description of the workflow through which subscribers opt in to the Campaign.
+
+        help : bool
+            Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword such as HELP or INFO.
+
+        help_keywords : str
+            Comma-separated list of help keywords. Keywords are case-insensitive.
+
+        help_message : str
+            Acknowledgement sent when a subscriber texts a help keyword.
+
+        optin : bool
+            Indicates whether the Campaign requires subscribers to opt in before receiving messages.
+
+        optin_keywords : str
+            Comma-separated list of opt-in keywords. Keywords are case-insensitive.
+
+        optin_message : str
+            Acknowledgement sent when a subscriber texts an opt-in keyword.
+
+        optout : bool
+            Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword such as STOP or QUIT.
+
+        optout_keywords : str
+            Comma-separated list of opt-out keywords. Keywords are case-insensitive.
+
+        optout_message : str
+            Acknowledgement sent when a subscriber texts an opt-out keyword.
+
+        name : str
+            Display name of the Campaign.
+
+        sample1 : str
+            Sample message demonstrating the content sent through the Campaign.
+
+        mock : bool
+            Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.
+
+        usecase : str
+            Registered use case for the Campaign, such as `2FA` or `MARKETING`.
+
+        terms_conditions : str
+            URL of the Campaign terms and conditions.
+
+        embedded_phones : typing.Optional[bool]
+            Indicates whether the Campaign messages contain embedded phone numbers.
+
+        embedded_link_sample : typing.Optional[str]
+            Sample of an embedded link used in Campaign messages.
+
+        sample2 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample3 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample4 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample5 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        privacy_policy : typing.Optional[str]
+            URL of the Campaign privacy policy.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateCampaignsResponse
+            Returns the registered 10DLC Campaign.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaigns.create(
+            brand_id="BM20QP9",
+            affiliate_marketing=False,
+            age_gated=False,
+            auto_renewal=False,
+            direct_lending=False,
+            embedded_links=False,
+            embedded_phones=False,
+            embedded_link_sample="https://site.com/verify",
+            description="Our campaign aims to …",
+            optin_workflow="Our SMS ...",
+            help=True,
+            help_keywords="help",
+            help_message="For help, please visit www.site.com. To opt-out, reply STOP.",
+            optin=True,
+            optin_keywords="begin,start",
+            optin_message="You are now opted-in for help please reply HELP, to stop please reply STOP",
+            optout=True,
+            optout_keywords="stop,quit,unsubscribe",
+            optout_message="You are now opted out and will receive no further messages",
+            name="My first campaign",
+            sample1="Your verification code is XXXXXX",
+            sample2="XXXX is your verification code",
+            sample3="Your code is XXXXXX, valid for 10 minutes",
+            sample4="Use code XXXXXX to confirm your login",
+            sample5="XXXXXX is your one-time passcode",
+            mock=False,
+            usecase="2FA",
+            privacy_policy="https://site.com/privacy-policy",
+            terms_conditions="https://site.com/terms-and-conditions",
+        )
+        """
+        _response = self._raw_client.create(
+            brand_id,
+            affiliate_marketing=affiliate_marketing,
+            age_gated=age_gated,
+            auto_renewal=auto_renewal,
+            direct_lending=direct_lending,
+            embedded_links=embedded_links,
+            description=description,
+            optin_workflow=optin_workflow,
+            help=help,
+            help_keywords=help_keywords,
+            help_message=help_message,
+            optin=optin,
+            optin_keywords=optin_keywords,
+            optin_message=optin_message,
+            optout=optout,
+            optout_keywords=optout_keywords,
+            optout_message=optout_message,
+            name=name,
+            sample1=sample1,
+            mock=mock,
+            usecase=usecase,
+            terms_conditions=terms_conditions,
+            embedded_phones=embedded_phones,
+            embedded_link_sample=embedded_link_sample,
+            sample2=sample2,
+            sample3=sample3,
+            sample4=sample4,
+            sample5=sample5,
+            privacy_policy=privacy_policy,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get(
+        self, brand_id: str, campaign_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetCampaignsResponse:
+        """
+        Returns the 10DLC Campaign identified by `campaign_id` under the Brand identified by `brand_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCampaignsResponse
+            Returns the 10DLC Campaign.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaigns.get(
+            brand_id="BM20QP9",
+            campaign_id="CKLCK95",
+        )
+        """
+        _response = self._raw_client.get(brand_id, campaign_id, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        brand_id: str,
+        campaign_id: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        usecase: typing.Optional[TenDlcCampaignUpdateRequestUsecase] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        embedded_links: typing.Optional[bool] = OMIT,
+        embedded_phones: typing.Optional[bool] = OMIT,
+        age_gated: typing.Optional[bool] = OMIT,
+        direct_lending: typing.Optional[bool] = OMIT,
+        optin: typing.Optional[bool] = OMIT,
+        optout: typing.Optional[bool] = OMIT,
+        help: typing.Optional[bool] = OMIT,
+        sample1: typing.Optional[str] = OMIT,
+        sample2: typing.Optional[str] = OMIT,
+        sample3: typing.Optional[str] = OMIT,
+        sample4: typing.Optional[str] = OMIT,
+        sample5: typing.Optional[str] = OMIT,
+        optin_workflow: typing.Optional[str] = OMIT,
+        help_message: typing.Optional[str] = OMIT,
+        optin_message: typing.Optional[str] = OMIT,
+        optout_message: typing.Optional[str] = OMIT,
+        auto_renewal: typing.Optional[bool] = OMIT,
+        optin_keywords: typing.Optional[str] = OMIT,
+        help_keywords: typing.Optional[str] = OMIT,
+        optout_keywords: typing.Optional[str] = OMIT,
+        terms_conditions: typing.Optional[str] = OMIT,
+        privacy_policy: typing.Optional[str] = OMIT,
+        embedded_link_sample: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateCampaignsResponse:
+        """
+        Updates the 10DLC Campaign identified by `campaign_id`. Only the provided fields are changed.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        name : typing.Optional[str]
+            Display name of the Campaign.
+
+        usecase : typing.Optional[TenDlcCampaignUpdateRequestUsecase]
+            Registered use case for the Campaign. One of `CUSTOMER_CARE` (customer support messaging), `MARKETING` (promotional content), `ACCOUNT_NOTIFICATION` (account-related alerts), `FRAUD_ALERT` (fraud and suspicious-activity warnings), `PUBLIC_SERVICE_ANNOUNCEMENT` (public-interest notices), or `SECURITY_ALERT` (security-related warnings).
+
+        description : typing.Optional[str]
+            Description of the Campaign and its messaging purpose.
+
+        embedded_links : typing.Optional[bool]
+            Indicates whether the Campaign messages contain embedded links.
+
+        embedded_phones : typing.Optional[bool]
+            Indicates whether the Campaign messages contain embedded phone numbers.
+
+        age_gated : typing.Optional[bool]
+            Indicates whether the Campaign messages contain age-gated content.
+
+        direct_lending : typing.Optional[bool]
+            Indicates whether the Campaign messages contain direct lending content.
+
+        optin : typing.Optional[bool]
+            Indicates whether the Campaign requires subscribers to opt in before receiving messages.
+
+        optout : typing.Optional[bool]
+            Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword.
+
+        help : typing.Optional[bool]
+            Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword.
+
+        sample1 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample2 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample3 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample4 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample5 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        optin_workflow : typing.Optional[str]
+            Description of the workflow through which subscribers opt in to the Campaign.
+
+        help_message : typing.Optional[str]
+            Acknowledgement sent when a subscriber texts a help keyword.
+
+        optin_message : typing.Optional[str]
+            Acknowledgement sent when a subscriber texts an opt-in keyword.
+
+        optout_message : typing.Optional[str]
+            Acknowledgement sent when a subscriber texts an opt-out keyword.
+
+        auto_renewal : typing.Optional[bool]
+            Indicates whether the Campaign is automatically renewed at the end of each billing period.
+
+        optin_keywords : typing.Optional[str]
+            Comma-separated list of opt-in keywords. Keywords are case-insensitive.
+
+        help_keywords : typing.Optional[str]
+            Comma-separated list of help keywords. Keywords are case-insensitive.
+
+        optout_keywords : typing.Optional[str]
+            Comma-separated list of opt-out keywords. Keywords are case-insensitive.
+
+        terms_conditions : typing.Optional[str]
+            URL of the Campaign terms and conditions.
+
+        privacy_policy : typing.Optional[str]
+            URL of the Campaign privacy policy.
+
+        embedded_link_sample : typing.Optional[str]
+            Sample of an embedded link used in Campaign messages.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateCampaignsResponse
+            Returns the updated 10DLC Campaign.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaigns.update(
+            brand_id="BM20QP9",
+            campaign_id="CKLCK95",
+        )
+        """
+        _response = self._raw_client.update(
+            brand_id,
+            campaign_id,
+            name=name,
+            usecase=usecase,
+            description=description,
+            embedded_links=embedded_links,
+            embedded_phones=embedded_phones,
+            age_gated=age_gated,
+            direct_lending=direct_lending,
+            optin=optin,
+            optout=optout,
+            help=help,
+            sample1=sample1,
+            sample2=sample2,
+            sample3=sample3,
+            sample4=sample4,
+            sample5=sample5,
+            optin_workflow=optin_workflow,
+            help_message=help_message,
+            optin_message=optin_message,
+            optout_message=optout_message,
+            auto_renewal=auto_renewal,
+            optin_keywords=optin_keywords,
+            help_keywords=help_keywords,
+            optout_keywords=optout_keywords,
+            terms_conditions=terms_conditions,
+            privacy_policy=privacy_policy,
+            embedded_link_sample=embedded_link_sample,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete(
+        self, brand_id: str, campaign_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> DeleteCampaignsResponse:
+        """
+        Deletes a 10DLC Campaign. Associated phone numbers cannot be used as Sender IDs once the Campaign is deleted.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteCampaignsResponse
+            Returns a success confirmation. The 10DLC Campaign is deleted.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaigns.delete(
+            brand_id="BM20QP9",
+            campaign_id="CKLCK95",
+        )
+        """
+        _response = self._raw_client.delete(brand_id, campaign_id, request_options=request_options)
+        return _response.data
+
+    def nudge(
+        self,
+        brand_id: str,
+        campaign_id: str,
+        *,
+        nudge_intent: str,
+        description: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SuccessResponse:
+        """
+        Requests action on a pending or rejected 10DLC Campaign. Use `nudge_intent` to specify the action:
+        - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.
+        Note:
+        - The Campaign must be at least 72 hours old.
+        - Only one nudge request per Campaign is allowed every 24 hours.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        nudge_intent : str
+            Nudge intent. Allowed values: `REVIEW`, `APPEAL_REJECTION`.
+            Use `nudge_intent` to specify the action: - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.
+
+        description : str
+            Description of the nudge request.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The nudge request is submitted.
+
+        Examples
+        --------
+        from wavix import Wavix
+
+        client = Wavix(
+            token="YOUR_TOKEN",
+        )
+        client.ten_dlc.campaigns.nudge(
+            brand_id="B9FXYNH",
+            campaign_id="CSJ4TV0",
+            nudge_intent="REVIEW",
+            description="Please review the campaign.",
+        )
+        """
+        _response = self._raw_client.nudge(
+            brand_id, campaign_id, nudge_intent=nudge_intent, description=description, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncCampaignsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCampaignsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCampaignsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCampaignsClient
+        """
+        return self._raw_client
+
+    async def list(
+        self,
+        *,
+        name: typing.Optional[str] = None,
+        usecase: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        mock: typing.Optional[bool] = None,
+        created_before: typing.Optional[dt.date] = None,
+        created_after: typing.Optional[dt.date] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListCampaignsResponse:
+        """
+        Returns a paginated list of 10DLC Campaigns for the authenticated account, filtered by date, status, and use case.
+
+        Parameters
+        ----------
+        name : typing.Optional[str]
+            Filters Campaigns by name. Matches partial values.
+
+        usecase : typing.Optional[str]
+            Filters Campaigns by use case.
+
+        status : typing.Optional[str]
+            Filters Campaigns by status.
+
+        mock : typing.Optional[bool]
+            When `true`, returns only mock Campaigns used for testing. Default `false`.
+
+        created_before : typing.Optional[dt.date]
+            Returns Campaigns created on or before this date, in `YYYY-MM-DD` format.
+
+        created_after : typing.Optional[dt.date]
+            Returns Campaigns created on or after this date, in `YYYY-MM-DD` format.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListCampaignsResponse
+            Returns a paginated list of 10DLC Campaigns.
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaigns.list(
+                name="Name",
+                usecase="2FA",
+                status="APPROVED",
+                mock=True,
+                created_before=datetime.date.fromisoformat(
+                    "2024-08-22",
+                ),
+                created_after=datetime.date.fromisoformat(
+                    "2024-08-22",
+                ),
+                page=1,
+                per_page=25,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(
+            name=name,
+            usecase=usecase,
+            status=status,
+            mock=mock,
+            created_before=created_before,
+            created_after=created_after,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def list_by_brand(
+        self,
+        brand_id: str,
+        *,
+        name: typing.Optional[str] = None,
+        usecase: typing.Optional[str] = None,
+        status: typing.Optional[str] = None,
+        mock: typing.Optional[bool] = None,
+        created_before: typing.Optional[dt.date] = None,
+        created_after: typing.Optional[dt.date] = None,
+        page: typing.Optional[int] = None,
+        per_page: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ListByBrandCampaignsResponse:
+        """
+        Returns a paginated list of 10DLC Campaigns associated with the 10DLC Brand identified by `brand_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        name : typing.Optional[str]
+            Filters Campaigns by name. Matches partial values.
+
+        usecase : typing.Optional[str]
+            Filters Campaigns by use case.
+
+        status : typing.Optional[str]
+            Filters Campaigns by status.
+
+        mock : typing.Optional[bool]
+            When `true`, returns only mock Campaigns used for testing. Default `false`.
+
+        created_before : typing.Optional[dt.date]
+            Returns Campaigns created on or before this date, in `YYYY-MM-DD` format.
+
+        created_after : typing.Optional[dt.date]
+            Returns Campaigns created on or after this date, in `YYYY-MM-DD` format.
+
+        page : typing.Optional[int]
+            Page number to retrieve. Default `1`.
+
+        per_page : typing.Optional[int]
+            Number of records to return per page. Default `25`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListByBrandCampaignsResponse
+            Returns a paginated list of 10DLC Campaigns.
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaigns.list_by_brand(
+                brand_id="BM20QP9",
+                name="Name",
+                usecase="2FA",
+                status="APPROVED",
+                mock=True,
+                created_before=datetime.date.fromisoformat(
+                    "2024-08-22",
+                ),
+                created_after=datetime.date.fromisoformat(
+                    "2024-08-22",
+                ),
+                page=1,
+                per_page=25,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_by_brand(
+            brand_id,
+            name=name,
+            usecase=usecase,
+            status=status,
+            mock=mock,
+            created_before=created_before,
+            created_after=created_after,
+            page=page,
+            per_page=per_page,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create(
+        self,
+        brand_id: str,
+        *,
+        affiliate_marketing: bool,
+        age_gated: bool,
+        auto_renewal: bool,
+        direct_lending: bool,
+        embedded_links: bool,
+        description: str,
+        optin_workflow: str,
+        help: bool,
+        help_keywords: str,
+        help_message: str,
+        optin: bool,
+        optin_keywords: str,
+        optin_message: str,
+        optout: bool,
+        optout_keywords: str,
+        optout_message: str,
+        name: str,
+        sample1: str,
+        mock: bool,
+        usecase: str,
+        terms_conditions: str,
+        embedded_phones: typing.Optional[bool] = OMIT,
+        embedded_link_sample: typing.Optional[str] = OMIT,
+        sample2: typing.Optional[str] = OMIT,
+        sample3: typing.Optional[str] = OMIT,
+        sample4: typing.Optional[str] = OMIT,
+        sample5: typing.Optional[str] = OMIT,
+        privacy_policy: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateCampaignsResponse:
+        """
+        Registers a 10DLC Campaign under the 10DLC Brand identified by `brand_id`. The Brand must have a verified identity status.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        affiliate_marketing : bool
+            Indicates whether the Campaign is used for affiliate marketing.
+
+        age_gated : bool
+            Indicates whether the Campaign messages contain age-gated content.
+
+        auto_renewal : bool
+            Indicates whether the Campaign is automatically renewed at the end of each billing period.
+
+        direct_lending : bool
+            Indicates whether the Campaign messages contain direct lending content.
+
+        embedded_links : bool
+            Indicates whether the Campaign messages contain embedded links.
+
+        description : str
+            Description of the Campaign and its messaging purpose.
+
+        optin_workflow : str
+            Description of the workflow through which subscribers opt in to the Campaign.
+
+        help : bool
+            Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword such as HELP or INFO.
+
+        help_keywords : str
+            Comma-separated list of help keywords. Keywords are case-insensitive.
+
+        help_message : str
+            Acknowledgement sent when a subscriber texts a help keyword.
+
+        optin : bool
+            Indicates whether the Campaign requires subscribers to opt in before receiving messages.
+
+        optin_keywords : str
+            Comma-separated list of opt-in keywords. Keywords are case-insensitive.
+
+        optin_message : str
+            Acknowledgement sent when a subscriber texts an opt-in keyword.
+
+        optout : bool
+            Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword such as STOP or QUIT.
+
+        optout_keywords : str
+            Comma-separated list of opt-out keywords. Keywords are case-insensitive.
+
+        optout_message : str
+            Acknowledgement sent when a subscriber texts an opt-out keyword.
+
+        name : str
+            Display name of the Campaign.
+
+        sample1 : str
+            Sample message demonstrating the content sent through the Campaign.
+
+        mock : bool
+            Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.
+
+        usecase : str
+            Registered use case for the Campaign, such as `2FA` or `MARKETING`.
+
+        terms_conditions : str
+            URL of the Campaign terms and conditions.
+
+        embedded_phones : typing.Optional[bool]
+            Indicates whether the Campaign messages contain embedded phone numbers.
+
+        embedded_link_sample : typing.Optional[str]
+            Sample of an embedded link used in Campaign messages.
+
+        sample2 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample3 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample4 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample5 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        privacy_policy : typing.Optional[str]
+            URL of the Campaign privacy policy.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateCampaignsResponse
+            Returns the registered 10DLC Campaign.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaigns.create(
+                brand_id="BM20QP9",
+                affiliate_marketing=False,
+                age_gated=False,
+                auto_renewal=False,
+                direct_lending=False,
+                embedded_links=False,
+                embedded_phones=False,
+                embedded_link_sample="https://site.com/verify",
+                description="Our campaign aims to …",
+                optin_workflow="Our SMS ...",
+                help=True,
+                help_keywords="help",
+                help_message="For help, please visit www.site.com. To opt-out, reply STOP.",
+                optin=True,
+                optin_keywords="begin,start",
+                optin_message="You are now opted-in for help please reply HELP, to stop please reply STOP",
+                optout=True,
+                optout_keywords="stop,quit,unsubscribe",
+                optout_message="You are now opted out and will receive no further messages",
+                name="My first campaign",
+                sample1="Your verification code is XXXXXX",
+                sample2="XXXX is your verification code",
+                sample3="Your code is XXXXXX, valid for 10 minutes",
+                sample4="Use code XXXXXX to confirm your login",
+                sample5="XXXXXX is your one-time passcode",
+                mock=False,
+                usecase="2FA",
+                privacy_policy="https://site.com/privacy-policy",
+                terms_conditions="https://site.com/terms-and-conditions",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            brand_id,
+            affiliate_marketing=affiliate_marketing,
+            age_gated=age_gated,
+            auto_renewal=auto_renewal,
+            direct_lending=direct_lending,
+            embedded_links=embedded_links,
+            description=description,
+            optin_workflow=optin_workflow,
+            help=help,
+            help_keywords=help_keywords,
+            help_message=help_message,
+            optin=optin,
+            optin_keywords=optin_keywords,
+            optin_message=optin_message,
+            optout=optout,
+            optout_keywords=optout_keywords,
+            optout_message=optout_message,
+            name=name,
+            sample1=sample1,
+            mock=mock,
+            usecase=usecase,
+            terms_conditions=terms_conditions,
+            embedded_phones=embedded_phones,
+            embedded_link_sample=embedded_link_sample,
+            sample2=sample2,
+            sample3=sample3,
+            sample4=sample4,
+            sample5=sample5,
+            privacy_policy=privacy_policy,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get(
+        self, brand_id: str, campaign_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetCampaignsResponse:
+        """
+        Returns the 10DLC Campaign identified by `campaign_id` under the Brand identified by `brand_id`.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCampaignsResponse
+            Returns the 10DLC Campaign.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaigns.get(
+                brand_id="BM20QP9",
+                campaign_id="CKLCK95",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(brand_id, campaign_id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        brand_id: str,
+        campaign_id: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        usecase: typing.Optional[TenDlcCampaignUpdateRequestUsecase] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        embedded_links: typing.Optional[bool] = OMIT,
+        embedded_phones: typing.Optional[bool] = OMIT,
+        age_gated: typing.Optional[bool] = OMIT,
+        direct_lending: typing.Optional[bool] = OMIT,
+        optin: typing.Optional[bool] = OMIT,
+        optout: typing.Optional[bool] = OMIT,
+        help: typing.Optional[bool] = OMIT,
+        sample1: typing.Optional[str] = OMIT,
+        sample2: typing.Optional[str] = OMIT,
+        sample3: typing.Optional[str] = OMIT,
+        sample4: typing.Optional[str] = OMIT,
+        sample5: typing.Optional[str] = OMIT,
+        optin_workflow: typing.Optional[str] = OMIT,
+        help_message: typing.Optional[str] = OMIT,
+        optin_message: typing.Optional[str] = OMIT,
+        optout_message: typing.Optional[str] = OMIT,
+        auto_renewal: typing.Optional[bool] = OMIT,
+        optin_keywords: typing.Optional[str] = OMIT,
+        help_keywords: typing.Optional[str] = OMIT,
+        optout_keywords: typing.Optional[str] = OMIT,
+        terms_conditions: typing.Optional[str] = OMIT,
+        privacy_policy: typing.Optional[str] = OMIT,
+        embedded_link_sample: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateCampaignsResponse:
+        """
+        Updates the 10DLC Campaign identified by `campaign_id`. Only the provided fields are changed.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        name : typing.Optional[str]
+            Display name of the Campaign.
+
+        usecase : typing.Optional[TenDlcCampaignUpdateRequestUsecase]
+            Registered use case for the Campaign. One of `CUSTOMER_CARE` (customer support messaging), `MARKETING` (promotional content), `ACCOUNT_NOTIFICATION` (account-related alerts), `FRAUD_ALERT` (fraud and suspicious-activity warnings), `PUBLIC_SERVICE_ANNOUNCEMENT` (public-interest notices), or `SECURITY_ALERT` (security-related warnings).
+
+        description : typing.Optional[str]
+            Description of the Campaign and its messaging purpose.
+
+        embedded_links : typing.Optional[bool]
+            Indicates whether the Campaign messages contain embedded links.
+
+        embedded_phones : typing.Optional[bool]
+            Indicates whether the Campaign messages contain embedded phone numbers.
+
+        age_gated : typing.Optional[bool]
+            Indicates whether the Campaign messages contain age-gated content.
+
+        direct_lending : typing.Optional[bool]
+            Indicates whether the Campaign messages contain direct lending content.
+
+        optin : typing.Optional[bool]
+            Indicates whether the Campaign requires subscribers to opt in before receiving messages.
+
+        optout : typing.Optional[bool]
+            Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword.
+
+        help : typing.Optional[bool]
+            Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword.
+
+        sample1 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample2 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample3 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample4 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        sample5 : typing.Optional[str]
+            Sample message demonstrating the content sent through the Campaign.
+
+        optin_workflow : typing.Optional[str]
+            Description of the workflow through which subscribers opt in to the Campaign.
+
+        help_message : typing.Optional[str]
+            Acknowledgement sent when a subscriber texts a help keyword.
+
+        optin_message : typing.Optional[str]
+            Acknowledgement sent when a subscriber texts an opt-in keyword.
+
+        optout_message : typing.Optional[str]
+            Acknowledgement sent when a subscriber texts an opt-out keyword.
+
+        auto_renewal : typing.Optional[bool]
+            Indicates whether the Campaign is automatically renewed at the end of each billing period.
+
+        optin_keywords : typing.Optional[str]
+            Comma-separated list of opt-in keywords. Keywords are case-insensitive.
+
+        help_keywords : typing.Optional[str]
+            Comma-separated list of help keywords. Keywords are case-insensitive.
+
+        optout_keywords : typing.Optional[str]
+            Comma-separated list of opt-out keywords. Keywords are case-insensitive.
+
+        terms_conditions : typing.Optional[str]
+            URL of the Campaign terms and conditions.
+
+        privacy_policy : typing.Optional[str]
+            URL of the Campaign privacy policy.
+
+        embedded_link_sample : typing.Optional[str]
+            Sample of an embedded link used in Campaign messages.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateCampaignsResponse
+            Returns the updated 10DLC Campaign.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaigns.update(
+                brand_id="BM20QP9",
+                campaign_id="CKLCK95",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(
+            brand_id,
+            campaign_id,
+            name=name,
+            usecase=usecase,
+            description=description,
+            embedded_links=embedded_links,
+            embedded_phones=embedded_phones,
+            age_gated=age_gated,
+            direct_lending=direct_lending,
+            optin=optin,
+            optout=optout,
+            help=help,
+            sample1=sample1,
+            sample2=sample2,
+            sample3=sample3,
+            sample4=sample4,
+            sample5=sample5,
+            optin_workflow=optin_workflow,
+            help_message=help_message,
+            optin_message=optin_message,
+            optout_message=optout_message,
+            auto_renewal=auto_renewal,
+            optin_keywords=optin_keywords,
+            help_keywords=help_keywords,
+            optout_keywords=optout_keywords,
+            terms_conditions=terms_conditions,
+            privacy_policy=privacy_policy,
+            embedded_link_sample=embedded_link_sample,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete(
+        self, brand_id: str, campaign_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> DeleteCampaignsResponse:
+        """
+        Deletes a 10DLC Campaign. Associated phone numbers cannot be used as Sender IDs once the Campaign is deleted.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteCampaignsResponse
+            Returns a success confirmation. The 10DLC Campaign is deleted.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaigns.delete(
+                brand_id="BM20QP9",
+                campaign_id="CKLCK95",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(brand_id, campaign_id, request_options=request_options)
+        return _response.data
+
+    async def nudge(
+        self,
+        brand_id: str,
+        campaign_id: str,
+        *,
+        nudge_intent: str,
+        description: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SuccessResponse:
+        """
+        Requests action on a pending or rejected 10DLC Campaign. Use `nudge_intent` to specify the action:
+        - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.
+        Note:
+        - The Campaign must be at least 72 hours old.
+        - Only one nudge request per Campaign is allowed every 24 hours.
+
+        Parameters
+        ----------
+        brand_id : str
+            The unique ID of the 10DLC Brand.
+
+        campaign_id : str
+            The unique ID of the 10DLC Campaign.
+
+        nudge_intent : str
+            Nudge intent. Allowed values: `REVIEW`, `APPEAL_REJECTION`.
+            Use `nudge_intent` to specify the action: - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.
+
+        description : str
+            Description of the nudge request.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SuccessResponse
+            Returns a success confirmation. The nudge request is submitted.
+
+        Examples
+        --------
+        import asyncio
+
+        from wavix import AsyncWavix
+
+        client = AsyncWavix(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.ten_dlc.campaigns.nudge(
+                brand_id="B9FXYNH",
+                campaign_id="CSJ4TV0",
+                nudge_intent="REVIEW",
+                description="Please review the campaign.",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.nudge(
+            brand_id, campaign_id, nudge_intent=nudge_intent, description=description, request_options=request_options
+        )
+        return _response.data