brevo-python 4.0.1__py3-none-any.whl

brevo/whats_app_campaigns/client.py

@@ -0,0 +1,1064 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawWhatsAppCampaignsClient, RawWhatsAppCampaignsClient
+from .types.create_whats_app_campaign_request_recipients import CreateWhatsAppCampaignRequestRecipients
+from .types.create_whats_app_campaign_response import CreateWhatsAppCampaignResponse
+from .types.create_whats_app_template_request_category import CreateWhatsAppTemplateRequestCategory
+from .types.create_whats_app_template_request_source import CreateWhatsAppTemplateRequestSource
+from .types.create_whats_app_template_response import CreateWhatsAppTemplateResponse
+from .types.get_whats_app_campaign_response import GetWhatsAppCampaignResponse
+from .types.get_whats_app_campaigns_request_sort import GetWhatsAppCampaignsRequestSort
+from .types.get_whats_app_campaigns_response import GetWhatsAppCampaignsResponse
+from .types.get_whats_app_config_response import GetWhatsAppConfigResponse
+from .types.get_whats_app_templates_request_sort import GetWhatsAppTemplatesRequestSort
+from .types.get_whats_app_templates_request_source import GetWhatsAppTemplatesRequestSource
+from .types.get_whats_app_templates_response import GetWhatsAppTemplatesResponse
+from .types.update_whats_app_campaign_request_campaign_status import UpdateWhatsAppCampaignRequestCampaignStatus
+from .types.update_whats_app_campaign_request_recipients import UpdateWhatsAppCampaignRequestRecipients
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class WhatsAppCampaignsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawWhatsAppCampaignsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawWhatsAppCampaignsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWhatsAppCampaignsClient
+        """
+        return self._raw_client
+
+    def get_whats_app_campaigns(
+        self,
+        *,
+        start_date: typing.Optional[str] = None,
+        end_date: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetWhatsAppCampaignsRequestSort] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetWhatsAppCampaignsResponse:
+        """
+        Parameters
+        ----------
+        start_date : typing.Optional[str]
+            **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        end_date : typing.Optional[str]
+            **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page
+
+        sort : typing.Optional[GetWhatsAppCampaignsRequestSort]
+            Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppCampaignsResponse
+            WhatsApp campaigns information
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.get_whats_app_campaigns()
+        """
+        _response = self._raw_client.get_whats_app_campaigns(
+            start_date=start_date,
+            end_date=end_date,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_whats_app_campaign(
+        self,
+        *,
+        name: str,
+        recipients: CreateWhatsAppCampaignRequestRecipients,
+        scheduled_at: str,
+        template_id: int,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateWhatsAppCampaignResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        <Note>
+        This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
+
+        [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
+
+        [Get all the Segments](https://developers.brevo.com/reference/getsegments)
+        </Note>
+
+        Parameters
+        ----------
+        name : str
+            Name of the WhatsApp campaign creation
+
+        recipients : CreateWhatsAppCampaignRequestRecipients
+            Segment ids and List ids to include/exclude from campaign
+
+        scheduled_at : str
+            Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00**
+
+        template_id : int
+            Id of the WhatsApp template in **approved** state
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateWhatsAppCampaignResponse
+            successfully created
+
+        Examples
+        --------
+        from brevo import Brevo
+        from brevo.whats_app_campaigns import CreateWhatsAppCampaignRequestRecipients
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.create_whats_app_campaign(
+            name="Test Campaign",
+            recipients=CreateWhatsAppCampaignRequestRecipients(),
+            scheduled_at="2017-06-01T12:30:00+02:00",
+            template_id=19,
+        )
+        """
+        _response = self._raw_client.create_whats_app_campaign(
+            name=name,
+            recipients=recipients,
+            scheduled_at=scheduled_at,
+            template_id=template_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_whats_app_config(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetWhatsAppConfigResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppConfigResponse
+            Get all the information of your WhatsApp API account
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.get_whats_app_config()
+        """
+        _response = self._raw_client.get_whats_app_config(request_options=request_options)
+        return _response.data
+
+    def create_whats_app_template(
+        self,
+        *,
+        body_text: str,
+        category: CreateWhatsAppTemplateRequestCategory,
+        language: str,
+        name: str,
+        header_text: typing.Optional[str] = OMIT,
+        media_url: typing.Optional[str] = OMIT,
+        source: typing.Optional[CreateWhatsAppTemplateRequestSource] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateWhatsAppTemplateResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        body_text : str
+            Body of the template. **Maximum allowed characters are 1024**
+
+        category : CreateWhatsAppTemplateRequestCategory
+            Category of the template
+
+        language : str
+            Language of the template. For Example :
+            **en** for English
+
+        name : str
+            Name of the template
+
+        header_text : typing.Optional[str]
+            Text content of the header in the template.  **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty**
+
+        media_url : typing.Optional[str]
+            Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf
+
+        source : typing.Optional[CreateWhatsAppTemplateRequestSource]
+            source of the template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateWhatsAppTemplateResponse
+            successfully created
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.create_whats_app_template(
+            body_text="making it look like readable English",
+            category="MARKETING",
+            language="en",
+            name="Test template",
+        )
+        """
+        _response = self._raw_client.create_whats_app_template(
+            body_text=body_text,
+            category=category,
+            language=language,
+            name=name,
+            header_text=header_text,
+            media_url=media_url,
+            source=source,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_whats_app_templates(
+        self,
+        *,
+        start_date: typing.Optional[str] = None,
+        end_date: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetWhatsAppTemplatesRequestSort] = None,
+        source: typing.Optional[GetWhatsAppTemplatesRequestSource] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetWhatsAppTemplatesResponse:
+        """
+        Parameters
+        ----------
+        start_date : typing.Optional[str]
+            **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        end_date : typing.Optional[str]
+            **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page
+
+        sort : typing.Optional[GetWhatsAppTemplatesRequestSort]
+            Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
+
+        source : typing.Optional[GetWhatsAppTemplatesRequestSource]
+            source of the template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppTemplatesResponse
+            WhatsApp templates informations
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.get_whats_app_templates()
+        """
+        _response = self._raw_client.get_whats_app_templates(
+            start_date=start_date,
+            end_date=end_date,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            source=source,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def send_whats_app_template_approval(
+        self, template_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        template_id : int
+            id of the template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.send_whats_app_template_approval(
+            template_id=1000000,
+        )
+        """
+        _response = self._raw_client.send_whats_app_template_approval(template_id, request_options=request_options)
+        return _response.data
+
+    def get_whats_app_campaign(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetWhatsAppCampaignResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppCampaignResponse
+            Get whatsApp campaign information on the basis of campaignId
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.get_whats_app_campaign(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.get_whats_app_campaign(campaign_id, request_options=request_options)
+        return _response.data
+
+    def update_whats_app_campaign(
+        self,
+        campaign_id: int,
+        *,
+        campaign_name: typing.Optional[str] = OMIT,
+        campaign_status: typing.Optional[UpdateWhatsAppCampaignRequestCampaignStatus] = OMIT,
+        recipients: typing.Optional[UpdateWhatsAppCampaignRequestRecipients] = OMIT,
+        reschedule_for: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        <Note>
+        This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
+
+        [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
+
+        [Get all the Segments](https://developers.brevo.com/reference/getsegments)
+        </Note>
+
+        Parameters
+        ----------
+        campaign_id : int
+            id of the campaign
+
+        campaign_name : typing.Optional[str]
+            Name of the campaign
+
+        campaign_status : typing.Optional[UpdateWhatsAppCampaignRequestCampaignStatus]
+            Status of the campaign
+
+        recipients : typing.Optional[UpdateWhatsAppCampaignRequestRecipients]
+            Segment ids and List ids to include/exclude from campaign
+
+        reschedule_for : typing.Optional[str]
+            Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.update_whats_app_campaign(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.update_whats_app_campaign(
+            campaign_id,
+            campaign_name=campaign_name,
+            campaign_status=campaign_status,
+            recipients=recipients,
+            reschedule_for=reschedule_for,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete_whats_app_campaign(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            id of the campaign
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.whats_app_campaigns.delete_whats_app_campaign(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.delete_whats_app_campaign(campaign_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncWhatsAppCampaignsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawWhatsAppCampaignsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWhatsAppCampaignsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWhatsAppCampaignsClient
+        """
+        return self._raw_client
+
+    async def get_whats_app_campaigns(
+        self,
+        *,
+        start_date: typing.Optional[str] = None,
+        end_date: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetWhatsAppCampaignsRequestSort] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetWhatsAppCampaignsResponse:
+        """
+        Parameters
+        ----------
+        start_date : typing.Optional[str]
+            **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        end_date : typing.Optional[str]
+            **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page
+
+        sort : typing.Optional[GetWhatsAppCampaignsRequestSort]
+            Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppCampaignsResponse
+            WhatsApp campaigns information
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.get_whats_app_campaigns()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_whats_app_campaigns(
+            start_date=start_date,
+            end_date=end_date,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_whats_app_campaign(
+        self,
+        *,
+        name: str,
+        recipients: CreateWhatsAppCampaignRequestRecipients,
+        scheduled_at: str,
+        template_id: int,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateWhatsAppCampaignResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        <Note>
+        This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
+
+        [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
+
+        [Get all the Segments](https://developers.brevo.com/reference/getsegments)
+        </Note>
+
+        Parameters
+        ----------
+        name : str
+            Name of the WhatsApp campaign creation
+
+        recipients : CreateWhatsAppCampaignRequestRecipients
+            Segment ids and List ids to include/exclude from campaign
+
+        scheduled_at : str
+            Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00**
+
+        template_id : int
+            Id of the WhatsApp template in **approved** state
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateWhatsAppCampaignResponse
+            successfully created
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+        from brevo.whats_app_campaigns import CreateWhatsAppCampaignRequestRecipients
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.create_whats_app_campaign(
+                name="Test Campaign",
+                recipients=CreateWhatsAppCampaignRequestRecipients(),
+                scheduled_at="2017-06-01T12:30:00+02:00",
+                template_id=19,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_whats_app_campaign(
+            name=name,
+            recipients=recipients,
+            scheduled_at=scheduled_at,
+            template_id=template_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_whats_app_config(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetWhatsAppConfigResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppConfigResponse
+            Get all the information of your WhatsApp API account
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.get_whats_app_config()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_whats_app_config(request_options=request_options)
+        return _response.data
+
+    async def create_whats_app_template(
+        self,
+        *,
+        body_text: str,
+        category: CreateWhatsAppTemplateRequestCategory,
+        language: str,
+        name: str,
+        header_text: typing.Optional[str] = OMIT,
+        media_url: typing.Optional[str] = OMIT,
+        source: typing.Optional[CreateWhatsAppTemplateRequestSource] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateWhatsAppTemplateResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        body_text : str
+            Body of the template. **Maximum allowed characters are 1024**
+
+        category : CreateWhatsAppTemplateRequestCategory
+            Category of the template
+
+        language : str
+            Language of the template. For Example :
+            **en** for English
+
+        name : str
+            Name of the template
+
+        header_text : typing.Optional[str]
+            Text content of the header in the template.  **Maximum allowed characters are 45** **Use this field to add text content in template header and if mediaUrl is empty**
+
+        media_url : typing.Optional[str]
+            Absolute url of the media file **(no local file)** for the header. **Use this field in you want to add media in Template header and headerText is empty** Allowed extensions for media files are: #### jpeg | png | mp4 | pdf
+
+        source : typing.Optional[CreateWhatsAppTemplateRequestSource]
+            source of the template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateWhatsAppTemplateResponse
+            successfully created
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.create_whats_app_template(
+                body_text="making it look like readable English",
+                category="MARKETING",
+                language="en",
+                name="Test template",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_whats_app_template(
+            body_text=body_text,
+            category=category,
+            language=language,
+            name=name,
+            header_text=header_text,
+            media_url=media_url,
+            source=source,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_whats_app_templates(
+        self,
+        *,
+        start_date: typing.Optional[str] = None,
+        end_date: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetWhatsAppTemplatesRequestSort] = None,
+        source: typing.Optional[GetWhatsAppTemplatesRequestSource] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetWhatsAppTemplatesResponse:
+        """
+        Parameters
+        ----------
+        start_date : typing.Optional[str]
+            **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        end_date : typing.Optional[str]
+            **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer to pass your timezone in date-time format for accurate result**
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page
+
+        sort : typing.Optional[GetWhatsAppTemplatesRequestSort]
+            Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed
+
+        source : typing.Optional[GetWhatsAppTemplatesRequestSource]
+            source of the template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppTemplatesResponse
+            WhatsApp templates informations
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.get_whats_app_templates()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_whats_app_templates(
+            start_date=start_date,
+            end_date=end_date,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            source=source,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def send_whats_app_template_approval(
+        self, template_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating WhatsApp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        template_id : int
+            id of the template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.send_whats_app_template_approval(
+                template_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.send_whats_app_template_approval(
+            template_id, request_options=request_options
+        )
+        return _response.data
+
+    async def get_whats_app_campaign(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetWhatsAppCampaignResponse:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetWhatsAppCampaignResponse
+            Get whatsApp campaign information on the basis of campaignId
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.get_whats_app_campaign(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_whats_app_campaign(campaign_id, request_options=request_options)
+        return _response.data
+
+    async def update_whats_app_campaign(
+        self,
+        campaign_id: int,
+        *,
+        campaign_name: typing.Optional[str] = OMIT,
+        campaign_status: typing.Optional[UpdateWhatsAppCampaignRequestCampaignStatus] = OMIT,
+        recipients: typing.Optional[UpdateWhatsAppCampaignRequestRecipients] = OMIT,
+        reschedule_for: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        <Note>
+        You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below.
+
+        [Activating Whatsapp](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account
+        </Note>
+
+        <Note>
+        This API requires the List and Segment ids as recipients in Body params. You can use the below Contact endpoints to get the required information.
+
+        [Get all the Lists](https://developers.brevo.com/reference/getlists-1)
+
+        [Get all the Segments](https://developers.brevo.com/reference/getsegments)
+        </Note>
+
+        Parameters
+        ----------
+        campaign_id : int
+            id of the campaign
+
+        campaign_name : typing.Optional[str]
+            Name of the campaign
+
+        campaign_status : typing.Optional[UpdateWhatsAppCampaignRequestCampaignStatus]
+            Status of the campaign
+
+        recipients : typing.Optional[UpdateWhatsAppCampaignRequestRecipients]
+            Segment ids and List ids to include/exclude from campaign
+
+        reschedule_for : typing.Optional[str]
+            Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: **2017-06-01T12:30:00+02:00** Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.update_whats_app_campaign(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_whats_app_campaign(
+            campaign_id,
+            campaign_name=campaign_name,
+            campaign_status=campaign_status,
+            recipients=recipients,
+            reschedule_for=reschedule_for,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete_whats_app_campaign(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            id of the campaign
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.whats_app_campaigns.delete_whats_app_campaign(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_whats_app_campaign(campaign_id, request_options=request_options)
+        return _response.data