brevo-python 4.0.1__py3-none-any.whl

brevo/email_campaigns/client.py

@@ -0,0 +1,1864 @@
+# 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 ..types.send_report_email import SendReportEmail
+from ..types.send_report_language import SendReportLanguage
+from ..types.update_campaign_status_status import UpdateCampaignStatusStatus
+from .raw_client import AsyncRawEmailCampaignsClient, RawEmailCampaignsClient
+from .types.create_email_campaign_request_email_expiration_date import CreateEmailCampaignRequestEmailExpirationDate
+from .types.create_email_campaign_request_recipients import CreateEmailCampaignRequestRecipients
+from .types.create_email_campaign_request_sender import CreateEmailCampaignRequestSender
+from .types.create_email_campaign_request_winner_criteria import CreateEmailCampaignRequestWinnerCriteria
+from .types.create_email_campaign_response import CreateEmailCampaignResponse
+from .types.email_export_recipients_request_recipients_type import EmailExportRecipientsRequestRecipientsType
+from .types.email_export_recipients_response import EmailExportRecipientsResponse
+from .types.get_ab_test_campaign_result_response import GetAbTestCampaignResultResponse
+from .types.get_email_campaign_request_statistics import GetEmailCampaignRequestStatistics
+from .types.get_email_campaign_response import GetEmailCampaignResponse
+from .types.get_email_campaigns_request_sort import GetEmailCampaignsRequestSort
+from .types.get_email_campaigns_request_statistics import GetEmailCampaignsRequestStatistics
+from .types.get_email_campaigns_request_status import GetEmailCampaignsRequestStatus
+from .types.get_email_campaigns_request_type import GetEmailCampaignsRequestType
+from .types.get_email_campaigns_response import GetEmailCampaignsResponse
+from .types.get_shared_template_url_response import GetSharedTemplateUrlResponse
+from .types.update_email_campaign_request_email_expiration_date import UpdateEmailCampaignRequestEmailExpirationDate
+from .types.update_email_campaign_request_recipients import UpdateEmailCampaignRequestRecipients
+from .types.update_email_campaign_request_sender import UpdateEmailCampaignRequestSender
+from .types.update_email_campaign_request_winner_criteria import UpdateEmailCampaignRequestWinnerCriteria
+from .types.upload_image_to_gallery_response import UploadImageToGalleryResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class EmailCampaignsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawEmailCampaignsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawEmailCampaignsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawEmailCampaignsClient
+        """
+        return self._raw_client
+
+    def get_email_campaigns(
+        self,
+        *,
+        type: typing.Optional[GetEmailCampaignsRequestType] = None,
+        status: typing.Optional[GetEmailCampaignsRequestStatus] = None,
+        statistics: typing.Optional[GetEmailCampaignsRequestStatistics] = None,
+        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[GetEmailCampaignsRequestSort] = None,
+        exclude_html_content: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetEmailCampaignsResponse:
+        """
+        <Note>
+        The response payload for this endpoint has changed
+
+        You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/get-all-marketing-campaigns).
+        </Note>
+
+        Parameters
+        ----------
+        type : typing.Optional[GetEmailCampaignsRequestType]
+            Filter on the type of the campaigns
+
+        status : typing.Optional[GetEmailCampaignsRequestStatus]
+            Filter on the status of the campaign
+
+        statistics : typing.Optional[GetEmailCampaignsRequestStatistics]
+            Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.This option only returns data for events occurred in the last 6 months.For older campaigns, it’s advisable to use the **Get Campaign Report** endpoint.
+
+        start_date : typing.Optional[str]
+            **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
+
+        end_date : typing.Optional[str]
+            **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page
+
+        sort : typing.Optional[GetEmailCampaignsRequestSort]
+            Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+
+        exclude_html_content : typing.Optional[bool]
+            Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetEmailCampaignsResponse
+            Email campaigns informations
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.get_email_campaigns()
+        """
+        _response = self._raw_client.get_email_campaigns(
+            type=type,
+            status=status,
+            statistics=statistics,
+            start_date=start_date,
+            end_date=end_date,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            exclude_html_content=exclude_html_content,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_email_campaign(
+        self,
+        *,
+        name: str,
+        sender: CreateEmailCampaignRequestSender,
+        ab_testing: typing.Optional[bool] = OMIT,
+        attachment_url: typing.Optional[str] = OMIT,
+        email_expiration_date: typing.Optional[CreateEmailCampaignRequestEmailExpirationDate] = OMIT,
+        footer: typing.Optional[str] = OMIT,
+        header: typing.Optional[str] = OMIT,
+        html_content: typing.Optional[str] = OMIT,
+        html_url: typing.Optional[str] = OMIT,
+        increase_rate: typing.Optional[int] = OMIT,
+        initial_quota: typing.Optional[int] = OMIT,
+        inline_image_activation: typing.Optional[bool] = OMIT,
+        ip_warmup_enable: typing.Optional[bool] = OMIT,
+        mirror_active: typing.Optional[bool] = OMIT,
+        params: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        recipients: typing.Optional[CreateEmailCampaignRequestRecipients] = OMIT,
+        reply_to: typing.Optional[str] = OMIT,
+        scheduled_at: typing.Optional[str] = OMIT,
+        send_at_best_time: typing.Optional[bool] = OMIT,
+        split_rule: typing.Optional[int] = OMIT,
+        subject: typing.Optional[str] = OMIT,
+        subject_a: typing.Optional[str] = OMIT,
+        subject_b: typing.Optional[str] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        template_id: typing.Optional[int] = OMIT,
+        to_field: typing.Optional[str] = OMIT,
+        unsubscription_page_id: typing.Optional[str] = OMIT,
+        update_form_id: typing.Optional[str] = OMIT,
+        utm_campaign: typing.Optional[str] = OMIT,
+        winner_criteria: typing.Optional[CreateEmailCampaignRequestWinnerCriteria] = OMIT,
+        winner_delay: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateEmailCampaignResponse:
+        """
+        Parameters
+        ----------
+        name : str
+            Name of the campaign
+
+        sender : CreateEmailCampaignRequestSender
+            Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}**
+
+        ab_testing : typing.Optional[bool]
+            Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
+
+        attachment_url : typing.Optional[str]
+            Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
+
+        email_expiration_date : typing.Optional[CreateEmailCampaignRequestEmailExpirationDate]
+            To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , ``https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign``
+
+        footer : typing.Optional[str]
+            Footer of the email campaign
+
+        header : typing.Optional[str]
+            Header of the email campaign
+
+        html_content : typing.Optional[str]
+            Mandatory if htmlUrl and templateId are empty. Body of the message (HTML).
+
+        html_url : typing.Optional[str]
+            **Mandatory if htmlContent and templateId are empty**. Url to the message (HTML). For example: **https://html.domain.com**
+
+        increase_rate : typing.Optional[int]
+            **Mandatory if ipWarmupEnable is set to true**. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
+
+        initial_quota : typing.Optional[int]
+            **Mandatory if ipWarmupEnable is set to true**. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
+
+        inline_image_activation : typing.Optional[bool]
+            Use true to embedded the images in your email. Final size of the email should be less than **4MB**. Campaigns with embedded images can _not be sent to more than 5000 contacts_
+
+        ip_warmup_enable : typing.Optional[bool]
+            **Available for dedicated ip clients**. Set this to true if you wish to warm up your ip.
+
+        mirror_active : typing.Optional[bool]
+            Use true to enable the mirror link
+
+        params : typing.Optional[typing.Dict[str, typing.Any]]
+            Pass the set of attributes to customize the type classic campaign. For example: **{"FNAME":"Joe", "LNAME":"Doe"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**
+
+        preview_text : typing.Optional[str]
+            Preview text or preheader of the email campaign
+
+        recipients : typing.Optional[CreateEmailCampaignRequestRecipients]
+            Segment ids and List ids to include/exclude from campaign
+
+        reply_to : typing.Optional[str]
+            Email on which the campaign recipients will be able to reply to
+
+        scheduled_at : typing.Optional[str]
+            Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result**. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: **2017-06-01T12:30:00+02:00**
+
+        send_at_best_time : typing.Optional[bool]
+            Set this to true if you want to send your campaign at best time.
+
+        split_rule : typing.Optional[int]
+            Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
+
+        subject : typing.Optional[str]
+            Subject of the campaign. **Mandatory if abTesting is false**. Ignored if abTesting is true.
+
+        subject_a : typing.Optional[str]
+            Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        subject_b : typing.Optional[str]
+            Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        tag : typing.Optional[str]
+            Tag of the campaign
+
+        template_id : typing.Optional[int]
+            **Mandatory if htmlContent and htmlUrl are empty**. Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
+
+        to_field : typing.Optional[str]
+            To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization
+
+        unsubscription_page_id : typing.Optional[str]
+            Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used.
+
+        update_form_id : typing.Optional[str]
+            **Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.
+
+        utm_campaign : typing.Optional[str]
+            Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
+
+        winner_criteria : typing.Optional[CreateEmailCampaignRequestWinnerCriteria]
+            Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed
+
+        winner_delay : typing.Optional[int]
+            Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateEmailCampaignResponse
+            successfully created
+
+        Examples
+        --------
+        from brevo import Brevo
+        from brevo.email_campaigns import CreateEmailCampaignRequestSender
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.create_email_campaign(
+            name="Newsletter - May 2017",
+            sender=CreateEmailCampaignRequestSender(),
+        )
+        """
+        _response = self._raw_client.create_email_campaign(
+            name=name,
+            sender=sender,
+            ab_testing=ab_testing,
+            attachment_url=attachment_url,
+            email_expiration_date=email_expiration_date,
+            footer=footer,
+            header=header,
+            html_content=html_content,
+            html_url=html_url,
+            increase_rate=increase_rate,
+            initial_quota=initial_quota,
+            inline_image_activation=inline_image_activation,
+            ip_warmup_enable=ip_warmup_enable,
+            mirror_active=mirror_active,
+            params=params,
+            preview_text=preview_text,
+            recipients=recipients,
+            reply_to=reply_to,
+            scheduled_at=scheduled_at,
+            send_at_best_time=send_at_best_time,
+            split_rule=split_rule,
+            subject=subject,
+            subject_a=subject_a,
+            subject_b=subject_b,
+            tag=tag,
+            template_id=template_id,
+            to_field=to_field,
+            unsubscription_page_id=unsubscription_page_id,
+            update_form_id=update_form_id,
+            utm_campaign=utm_campaign,
+            winner_criteria=winner_criteria,
+            winner_delay=winner_delay,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def upload_image_to_gallery(
+        self,
+        *,
+        image_url: str,
+        name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UploadImageToGalleryResponse:
+        """
+        Parameters
+        ----------
+        image_url : str
+            The absolute url of the image (**no local file**). Maximum allowed size for image is **2MB**. Allowed extensions for images are: #### jpeg, jpg, png, bmp, gif.
+
+        name : typing.Optional[str]
+            Name of the image.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UploadImageToGalleryResponse
+            Image has been successfully uploaded
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.upload_image_to_gallery(
+            image_url="https://somedomain.com/image1.jpg",
+        )
+        """
+        _response = self._raw_client.upload_image_to_gallery(
+            image_url=image_url, name=name, request_options=request_options
+        )
+        return _response.data
+
+    def get_email_campaign(
+        self,
+        campaign_id: int,
+        *,
+        statistics: typing.Optional[GetEmailCampaignRequestStatistics] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetEmailCampaignResponse:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        statistics : typing.Optional[GetEmailCampaignRequestStatistics]
+            Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetEmailCampaignResponse
+            Email campaign informations
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.get_email_campaign(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.get_email_campaign(
+            campaign_id, statistics=statistics, request_options=request_options
+        )
+        return _response.data
+
+    def update_email_campaign(
+        self,
+        campaign_id: int,
+        *,
+        ab_testing: typing.Optional[bool] = OMIT,
+        attachment_url: typing.Optional[str] = OMIT,
+        email_expiration_date: typing.Optional[UpdateEmailCampaignRequestEmailExpirationDate] = OMIT,
+        footer: typing.Optional[str] = OMIT,
+        header: typing.Optional[str] = OMIT,
+        html_content: typing.Optional[str] = OMIT,
+        html_url: typing.Optional[str] = OMIT,
+        increase_rate: typing.Optional[int] = OMIT,
+        initial_quota: typing.Optional[int] = OMIT,
+        inline_image_activation: typing.Optional[bool] = OMIT,
+        ip_warmup_enable: typing.Optional[bool] = OMIT,
+        mirror_active: typing.Optional[bool] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        params: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        recipients: typing.Optional[UpdateEmailCampaignRequestRecipients] = OMIT,
+        recurring: typing.Optional[bool] = OMIT,
+        reply_to: typing.Optional[str] = OMIT,
+        scheduled_at: typing.Optional[str] = OMIT,
+        send_at_best_time: typing.Optional[bool] = OMIT,
+        sender: typing.Optional[UpdateEmailCampaignRequestSender] = OMIT,
+        split_rule: typing.Optional[int] = OMIT,
+        subject: typing.Optional[str] = OMIT,
+        subject_a: typing.Optional[str] = OMIT,
+        subject_b: typing.Optional[str] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        to_field: typing.Optional[str] = OMIT,
+        unsubscription_page_id: typing.Optional[str] = OMIT,
+        update_form_id: typing.Optional[str] = OMIT,
+        utm_campaign: typing.Optional[str] = OMIT,
+        winner_criteria: typing.Optional[UpdateEmailCampaignRequestWinnerCriteria] = OMIT,
+        winner_delay: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        ab_testing : typing.Optional[bool]
+            Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
+
+        attachment_url : typing.Optional[str]
+            Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'
+
+        email_expiration_date : typing.Optional[UpdateEmailCampaignRequestEmailExpirationDate]
+            To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy.
+
+        footer : typing.Optional[str]
+            Footer of the email campaign
+
+        header : typing.Optional[str]
+            Header of the email campaign
+
+        html_content : typing.Optional[str]
+            Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. **REQUIRED if htmlUrl is empty**
+
+        html_url : typing.Optional[str]
+            Url which contents the body of the email message. **REQUIRED if htmlContent is empty**
+
+        increase_rate : typing.Optional[int]
+            Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
+
+        initial_quota : typing.Optional[int]
+            Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
+
+        inline_image_activation : typing.Optional[bool]
+            Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than **4MB** with images embedded in the email. Campaigns with the images embedded in the email _must be sent to less than 5000 contacts_.
+
+        ip_warmup_enable : typing.Optional[bool]
+            **Available for dedicated ip clients**. Set this to true if you wish to warm up your ip.
+
+        mirror_active : typing.Optional[bool]
+            Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
+
+        name : typing.Optional[str]
+            Name of the campaign
+
+        params : typing.Optional[typing.Dict[str, typing.Any]]
+            Pass the set of attributes to customize the type classic campaign. For example: **{"FNAME":"Joe", "LNAME":"Doe"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**
+
+        preview_text : typing.Optional[str]
+            Preview text or preheader of the email campaign
+
+        recipients : typing.Optional[UpdateEmailCampaignRequestRecipients]
+            Segment ids and List ids to include/exclude from campaign
+
+        recurring : typing.Optional[bool]
+            **FOR TRIGGER ONLY !** Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
+
+        reply_to : typing.Optional[str]
+            Email on which campaign recipients will be able to reply to
+
+        scheduled_at : typing.Optional[str]
+            UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
+
+        send_at_best_time : typing.Optional[bool]
+            Set this to true if you want to send your campaign at best time. Note:- **if true, warmup ip will be disabled.**
+
+        sender : typing.Optional[UpdateEmailCampaignRequestSender]
+            Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}**
+
+        split_rule : typing.Optional[int]
+            Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
+
+        subject : typing.Optional[str]
+            Subject of the campaign
+
+        subject_a : typing.Optional[str]
+            Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        subject_b : typing.Optional[str]
+            Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        tag : typing.Optional[str]
+            Tag of the campaign
+
+        to_field : typing.Optional[str]
+            To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization
+
+        unsubscription_page_id : typing.Optional[str]
+            Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.
+
+        update_form_id : typing.Optional[str]
+            **Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.
+
+        utm_campaign : typing.Optional[str]
+            Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
+
+        winner_criteria : typing.Optional[UpdateEmailCampaignRequestWinnerCriteria]
+            Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed
+
+        winner_delay : typing.Optional[int]
+            Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.update_email_campaign(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.update_email_campaign(
+            campaign_id,
+            ab_testing=ab_testing,
+            attachment_url=attachment_url,
+            email_expiration_date=email_expiration_date,
+            footer=footer,
+            header=header,
+            html_content=html_content,
+            html_url=html_url,
+            increase_rate=increase_rate,
+            initial_quota=initial_quota,
+            inline_image_activation=inline_image_activation,
+            ip_warmup_enable=ip_warmup_enable,
+            mirror_active=mirror_active,
+            name=name,
+            params=params,
+            preview_text=preview_text,
+            recipients=recipients,
+            recurring=recurring,
+            reply_to=reply_to,
+            scheduled_at=scheduled_at,
+            send_at_best_time=send_at_best_time,
+            sender=sender,
+            split_rule=split_rule,
+            subject=subject,
+            subject_a=subject_a,
+            subject_b=subject_b,
+            tag=tag,
+            to_field=to_field,
+            unsubscription_page_id=unsubscription_page_id,
+            update_form_id=update_form_id,
+            utm_campaign=utm_campaign,
+            winner_criteria=winner_criteria,
+            winner_delay=winner_delay,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete_email_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.email_campaigns.delete_email_campaign(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.delete_email_campaign(campaign_id, request_options=request_options)
+        return _response.data
+
+    def get_ab_test_campaign_result(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetAbTestCampaignResultResponse:
+        """
+        Obtain winning version of an A/B test email campaign
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the A/B test campaign
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAbTestCampaignResultResponse
+            A/B test email campaign Result
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.get_ab_test_campaign_result(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.get_ab_test_campaign_result(campaign_id, request_options=request_options)
+        return _response.data
+
+    def email_export_recipients(
+        self,
+        campaign_id: int,
+        *,
+        recipients_type: EmailExportRecipientsRequestRecipientsType,
+        notify_url: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> EmailExportRecipientsResponse:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        recipients_type : EmailExportRecipientsRequestRecipientsType
+            Type of recipients to export for a campaign
+
+        notify_url : typing.Optional[str]
+            Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        EmailExportRecipientsResponse
+            process id created
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.email_export_recipients(
+            campaign_id=1000000,
+            recipients_type="all",
+        )
+        """
+        _response = self._raw_client.email_export_recipients(
+            campaign_id, recipients_type=recipients_type, notify_url=notify_url, request_options=request_options
+        )
+        return _response.data
+
+    def send_email_campaign_now(
+        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.email_campaigns.send_email_campaign_now(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.send_email_campaign_now(campaign_id, request_options=request_options)
+        return _response.data
+
+    def send_report(
+        self,
+        campaign_id: int,
+        *,
+        email: SendReportEmail,
+        language: typing.Optional[SendReportLanguage] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        A PDF will be sent to the specified email addresses
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        email : SendReportEmail
+            Custom attributes for the report email.
+
+        language : typing.Optional[SendReportLanguage]
+            Language of email content for campaign report sending.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo, SendReportEmail
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.send_report(
+            campaign_id=1000000,
+            email=SendReportEmail(
+                body="Please find attached the report of our last email campaign.",
+                to=["jim.suehan@example.com"],
+            ),
+        )
+        """
+        _response = self._raw_client.send_report(
+            campaign_id, email=email, language=language, request_options=request_options
+        )
+        return _response.data
+
+    def send_test_email(
+        self,
+        campaign_id: int,
+        *,
+        email_to: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        email_to : typing.Optional[typing.Sequence[str]]
+            List of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.send_test_email(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.send_test_email(campaign_id, email_to=email_to, request_options=request_options)
+        return _response.data
+
+    def get_shared_template_url(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetSharedTemplateUrlResponse:
+        """
+        Get a unique URL to share & import an email template from one Brevo account to another.
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign or template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetSharedTemplateUrlResponse
+            Shared template URL information
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.get_shared_template_url(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.get_shared_template_url(campaign_id, request_options=request_options)
+        return _response.data
+
+    def update_campaign_status(
+        self,
+        campaign_id: int,
+        *,
+        status: typing.Optional[UpdateCampaignStatusStatus] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        status : typing.Optional[UpdateCampaignStatusStatus]
+            Note:- **replicateTemplate** status will be available **only for template type campaigns.**
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.email_campaigns.update_campaign_status(
+            campaign_id=1000000,
+        )
+        """
+        _response = self._raw_client.update_campaign_status(campaign_id, status=status, request_options=request_options)
+        return _response.data
+
+
+class AsyncEmailCampaignsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawEmailCampaignsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawEmailCampaignsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawEmailCampaignsClient
+        """
+        return self._raw_client
+
+    async def get_email_campaigns(
+        self,
+        *,
+        type: typing.Optional[GetEmailCampaignsRequestType] = None,
+        status: typing.Optional[GetEmailCampaignsRequestStatus] = None,
+        statistics: typing.Optional[GetEmailCampaignsRequestStatistics] = None,
+        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[GetEmailCampaignsRequestSort] = None,
+        exclude_html_content: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetEmailCampaignsResponse:
+        """
+        <Note>
+        The response payload for this endpoint has changed
+
+        You now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/get-all-marketing-campaigns).
+        </Note>
+
+        Parameters
+        ----------
+        type : typing.Optional[GetEmailCampaignsRequestType]
+            Filter on the type of the campaigns
+
+        status : typing.Optional[GetEmailCampaignsRequestStatus]
+            Filter on the status of the campaign
+
+        statistics : typing.Optional[GetEmailCampaignsRequestStatistics]
+            Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.This option only returns data for events occurred in the last 6 months.For older campaigns, it’s advisable to use the **Get Campaign Report** endpoint.
+
+        start_date : typing.Optional[str]
+            **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
+
+        end_date : typing.Optional[str]
+            **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' )
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page
+
+        sort : typing.Optional[GetEmailCampaignsRequestSort]
+            Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
+
+        exclude_html_content : typing.Optional[bool]
+            Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetEmailCampaignsResponse
+            Email campaigns informations
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.get_email_campaigns()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_email_campaigns(
+            type=type,
+            status=status,
+            statistics=statistics,
+            start_date=start_date,
+            end_date=end_date,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            exclude_html_content=exclude_html_content,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_email_campaign(
+        self,
+        *,
+        name: str,
+        sender: CreateEmailCampaignRequestSender,
+        ab_testing: typing.Optional[bool] = OMIT,
+        attachment_url: typing.Optional[str] = OMIT,
+        email_expiration_date: typing.Optional[CreateEmailCampaignRequestEmailExpirationDate] = OMIT,
+        footer: typing.Optional[str] = OMIT,
+        header: typing.Optional[str] = OMIT,
+        html_content: typing.Optional[str] = OMIT,
+        html_url: typing.Optional[str] = OMIT,
+        increase_rate: typing.Optional[int] = OMIT,
+        initial_quota: typing.Optional[int] = OMIT,
+        inline_image_activation: typing.Optional[bool] = OMIT,
+        ip_warmup_enable: typing.Optional[bool] = OMIT,
+        mirror_active: typing.Optional[bool] = OMIT,
+        params: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        recipients: typing.Optional[CreateEmailCampaignRequestRecipients] = OMIT,
+        reply_to: typing.Optional[str] = OMIT,
+        scheduled_at: typing.Optional[str] = OMIT,
+        send_at_best_time: typing.Optional[bool] = OMIT,
+        split_rule: typing.Optional[int] = OMIT,
+        subject: typing.Optional[str] = OMIT,
+        subject_a: typing.Optional[str] = OMIT,
+        subject_b: typing.Optional[str] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        template_id: typing.Optional[int] = OMIT,
+        to_field: typing.Optional[str] = OMIT,
+        unsubscription_page_id: typing.Optional[str] = OMIT,
+        update_form_id: typing.Optional[str] = OMIT,
+        utm_campaign: typing.Optional[str] = OMIT,
+        winner_criteria: typing.Optional[CreateEmailCampaignRequestWinnerCriteria] = OMIT,
+        winner_delay: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateEmailCampaignResponse:
+        """
+        Parameters
+        ----------
+        name : str
+            Name of the campaign
+
+        sender : CreateEmailCampaignRequestSender
+            Sender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}**
+
+        ab_testing : typing.Optional[bool]
+            Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
+
+        attachment_url : typing.Optional[str]
+            Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps
+
+        email_expiration_date : typing.Optional[CreateEmailCampaignRequestEmailExpirationDate]
+            To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , ``https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign``
+
+        footer : typing.Optional[str]
+            Footer of the email campaign
+
+        header : typing.Optional[str]
+            Header of the email campaign
+
+        html_content : typing.Optional[str]
+            Mandatory if htmlUrl and templateId are empty. Body of the message (HTML).
+
+        html_url : typing.Optional[str]
+            **Mandatory if htmlContent and templateId are empty**. Url to the message (HTML). For example: **https://html.domain.com**
+
+        increase_rate : typing.Optional[int]
+            **Mandatory if ipWarmupEnable is set to true**. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
+
+        initial_quota : typing.Optional[int]
+            **Mandatory if ipWarmupEnable is set to true**. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
+
+        inline_image_activation : typing.Optional[bool]
+            Use true to embedded the images in your email. Final size of the email should be less than **4MB**. Campaigns with embedded images can _not be sent to more than 5000 contacts_
+
+        ip_warmup_enable : typing.Optional[bool]
+            **Available for dedicated ip clients**. Set this to true if you wish to warm up your ip.
+
+        mirror_active : typing.Optional[bool]
+            Use true to enable the mirror link
+
+        params : typing.Optional[typing.Dict[str, typing.Any]]
+            Pass the set of attributes to customize the type classic campaign. For example: **{"FNAME":"Joe", "LNAME":"Doe"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**
+
+        preview_text : typing.Optional[str]
+            Preview text or preheader of the email campaign
+
+        recipients : typing.Optional[CreateEmailCampaignRequestRecipients]
+            Segment ids and List ids to include/exclude from campaign
+
+        reply_to : typing.Optional[str]
+            Email on which the campaign recipients will be able to reply to
+
+        scheduled_at : typing.Optional[str]
+            Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result**. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: **2017-06-01T12:30:00+02:00**
+
+        send_at_best_time : typing.Optional[bool]
+            Set this to true if you want to send your campaign at best time.
+
+        split_rule : typing.Optional[int]
+            Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
+
+        subject : typing.Optional[str]
+            Subject of the campaign. **Mandatory if abTesting is false**. Ignored if abTesting is true.
+
+        subject_a : typing.Optional[str]
+            Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        subject_b : typing.Optional[str]
+            Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        tag : typing.Optional[str]
+            Tag of the campaign
+
+        template_id : typing.Optional[int]
+            **Mandatory if htmlContent and htmlUrl are empty**. Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
+
+        to_field : typing.Optional[str]
+            To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization
+
+        unsubscription_page_id : typing.Optional[str]
+            Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used.
+
+        update_form_id : typing.Optional[str]
+            **Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.
+
+        utm_campaign : typing.Optional[str]
+            Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
+
+        winner_criteria : typing.Optional[CreateEmailCampaignRequestWinnerCriteria]
+            Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed
+
+        winner_delay : typing.Optional[int]
+            Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateEmailCampaignResponse
+            successfully created
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+        from brevo.email_campaigns import CreateEmailCampaignRequestSender
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.create_email_campaign(
+                name="Newsletter - May 2017",
+                sender=CreateEmailCampaignRequestSender(),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_email_campaign(
+            name=name,
+            sender=sender,
+            ab_testing=ab_testing,
+            attachment_url=attachment_url,
+            email_expiration_date=email_expiration_date,
+            footer=footer,
+            header=header,
+            html_content=html_content,
+            html_url=html_url,
+            increase_rate=increase_rate,
+            initial_quota=initial_quota,
+            inline_image_activation=inline_image_activation,
+            ip_warmup_enable=ip_warmup_enable,
+            mirror_active=mirror_active,
+            params=params,
+            preview_text=preview_text,
+            recipients=recipients,
+            reply_to=reply_to,
+            scheduled_at=scheduled_at,
+            send_at_best_time=send_at_best_time,
+            split_rule=split_rule,
+            subject=subject,
+            subject_a=subject_a,
+            subject_b=subject_b,
+            tag=tag,
+            template_id=template_id,
+            to_field=to_field,
+            unsubscription_page_id=unsubscription_page_id,
+            update_form_id=update_form_id,
+            utm_campaign=utm_campaign,
+            winner_criteria=winner_criteria,
+            winner_delay=winner_delay,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def upload_image_to_gallery(
+        self,
+        *,
+        image_url: str,
+        name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UploadImageToGalleryResponse:
+        """
+        Parameters
+        ----------
+        image_url : str
+            The absolute url of the image (**no local file**). Maximum allowed size for image is **2MB**. Allowed extensions for images are: #### jpeg, jpg, png, bmp, gif.
+
+        name : typing.Optional[str]
+            Name of the image.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UploadImageToGalleryResponse
+            Image has been successfully uploaded
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.upload_image_to_gallery(
+                image_url="https://somedomain.com/image1.jpg",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.upload_image_to_gallery(
+            image_url=image_url, name=name, request_options=request_options
+        )
+        return _response.data
+
+    async def get_email_campaign(
+        self,
+        campaign_id: int,
+        *,
+        statistics: typing.Optional[GetEmailCampaignRequestStatistics] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetEmailCampaignResponse:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        statistics : typing.Optional[GetEmailCampaignRequestStatistics]
+            Filter on type of the statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned response.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetEmailCampaignResponse
+            Email campaign informations
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.get_email_campaign(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_email_campaign(
+            campaign_id, statistics=statistics, request_options=request_options
+        )
+        return _response.data
+
+    async def update_email_campaign(
+        self,
+        campaign_id: int,
+        *,
+        ab_testing: typing.Optional[bool] = OMIT,
+        attachment_url: typing.Optional[str] = OMIT,
+        email_expiration_date: typing.Optional[UpdateEmailCampaignRequestEmailExpirationDate] = OMIT,
+        footer: typing.Optional[str] = OMIT,
+        header: typing.Optional[str] = OMIT,
+        html_content: typing.Optional[str] = OMIT,
+        html_url: typing.Optional[str] = OMIT,
+        increase_rate: typing.Optional[int] = OMIT,
+        initial_quota: typing.Optional[int] = OMIT,
+        inline_image_activation: typing.Optional[bool] = OMIT,
+        ip_warmup_enable: typing.Optional[bool] = OMIT,
+        mirror_active: typing.Optional[bool] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        params: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        recipients: typing.Optional[UpdateEmailCampaignRequestRecipients] = OMIT,
+        recurring: typing.Optional[bool] = OMIT,
+        reply_to: typing.Optional[str] = OMIT,
+        scheduled_at: typing.Optional[str] = OMIT,
+        send_at_best_time: typing.Optional[bool] = OMIT,
+        sender: typing.Optional[UpdateEmailCampaignRequestSender] = OMIT,
+        split_rule: typing.Optional[int] = OMIT,
+        subject: typing.Optional[str] = OMIT,
+        subject_a: typing.Optional[str] = OMIT,
+        subject_b: typing.Optional[str] = OMIT,
+        tag: typing.Optional[str] = OMIT,
+        to_field: typing.Optional[str] = OMIT,
+        unsubscription_page_id: typing.Optional[str] = OMIT,
+        update_form_id: typing.Optional[str] = OMIT,
+        utm_campaign: typing.Optional[str] = OMIT,
+        winner_criteria: typing.Optional[UpdateEmailCampaignRequestWinnerCriteria] = OMIT,
+        winner_delay: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        ab_testing : typing.Optional[bool]
+            Status of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. **subjectA, subjectB, splitRule, winnerCriteria & winnerDelay** will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. **Can be set to true only if sendAtBestTime is false**. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B
+
+        attachment_url : typing.Optional[str]
+            Absolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'
+
+        email_expiration_date : typing.Optional[UpdateEmailCampaignRequestEmailExpirationDate]
+            To reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy.
+
+        footer : typing.Optional[str]
+            Footer of the email campaign
+
+        header : typing.Optional[str]
+            Header of the email campaign
+
+        html_content : typing.Optional[str]
+            Body of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. **REQUIRED if htmlUrl is empty**
+
+        html_url : typing.Optional[str]
+            Url which contents the body of the email message. **REQUIRED if htmlContent is empty**
+
+        increase_rate : typing.Optional[int]
+            Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
+
+        initial_quota : typing.Optional[int]
+            Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
+
+        inline_image_activation : typing.Optional[bool]
+            Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than **4MB** with images embedded in the email. Campaigns with the images embedded in the email _must be sent to less than 5000 contacts_.
+
+        ip_warmup_enable : typing.Optional[bool]
+            **Available for dedicated ip clients**. Set this to true if you wish to warm up your ip.
+
+        mirror_active : typing.Optional[bool]
+            Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
+
+        name : typing.Optional[str]
+            Name of the campaign
+
+        params : typing.Optional[typing.Dict[str, typing.Any]]
+            Pass the set of attributes to customize the type classic campaign. For example: **{"FNAME":"Joe", "LNAME":"Doe"}**. Only available if **type** is **classic**. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of **subject, htmlContent/htmlUrl, sender.name & toField**
+
+        preview_text : typing.Optional[str]
+            Preview text or preheader of the email campaign
+
+        recipients : typing.Optional[UpdateEmailCampaignRequestRecipients]
+            Segment ids and List ids to include/exclude from campaign
+
+        recurring : typing.Optional[bool]
+            **FOR TRIGGER ONLY !** Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
+
+        reply_to : typing.Optional[str]
+            Email on which campaign recipients will be able to reply to
+
+        scheduled_at : typing.Optional[str]
+            UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).
+
+        send_at_best_time : typing.Optional[bool]
+            Set this to true if you want to send your campaign at best time. Note:- **if true, warmup ip will be disabled.**
+
+        sender : typing.Optional[UpdateEmailCampaignRequestSender]
+            Sender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: **{"name":"xyz", "email":"example@abc.com"}** **{"name":"xyz", "id":123}**
+
+        split_rule : typing.Optional[int]
+            Add the size of your test groups. **Mandatory if abTesting = true & 'recipients' is passed**. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else
+
+        subject : typing.Optional[str]
+            Subject of the campaign
+
+        subject_a : typing.Optional[str]
+            Subject A of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        subject_b : typing.Optional[str]
+            Subject B of the campaign. **Mandatory if abTesting = true**. subjectA & subjectB should have unique value
+
+        tag : typing.Optional[str]
+            Tag of the campaign
+
+        to_field : typing.Optional[str]
+            To personalize the **To** Field. If you want to include the first name and last name of your recipient, add **{FNAME} {LNAME}**. These contact attributes must already exist in your Brevo account. If input parameter **params** used please use **{{contact.FNAME}} {{contact.LNAME}}** for personalization
+
+        unsubscription_page_id : typing.Optional[str]
+            Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.
+
+        update_form_id : typing.Optional[str]
+            **Mandatory if templateId is used containing the {{ update_profile }} tag**. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.
+
+        utm_campaign : typing.Optional[str]
+            Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
+
+        winner_criteria : typing.Optional[UpdateEmailCampaignRequestWinnerCriteria]
+            Choose the metrics that will determinate the winning version. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerCriteria` is ignored if passed
+
+        winner_delay : typing.Optional[int]
+            Choose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. **Mandatory if _splitRule_ >= 1 and < 50**. If splitRule = 50, `winnerDelay` is ignored if passed
+
+        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.email_campaigns.update_email_campaign(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_email_campaign(
+            campaign_id,
+            ab_testing=ab_testing,
+            attachment_url=attachment_url,
+            email_expiration_date=email_expiration_date,
+            footer=footer,
+            header=header,
+            html_content=html_content,
+            html_url=html_url,
+            increase_rate=increase_rate,
+            initial_quota=initial_quota,
+            inline_image_activation=inline_image_activation,
+            ip_warmup_enable=ip_warmup_enable,
+            mirror_active=mirror_active,
+            name=name,
+            params=params,
+            preview_text=preview_text,
+            recipients=recipients,
+            recurring=recurring,
+            reply_to=reply_to,
+            scheduled_at=scheduled_at,
+            send_at_best_time=send_at_best_time,
+            sender=sender,
+            split_rule=split_rule,
+            subject=subject,
+            subject_a=subject_a,
+            subject_b=subject_b,
+            tag=tag,
+            to_field=to_field,
+            unsubscription_page_id=unsubscription_page_id,
+            update_form_id=update_form_id,
+            utm_campaign=utm_campaign,
+            winner_criteria=winner_criteria,
+            winner_delay=winner_delay,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete_email_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.email_campaigns.delete_email_campaign(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_email_campaign(campaign_id, request_options=request_options)
+        return _response.data
+
+    async def get_ab_test_campaign_result(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetAbTestCampaignResultResponse:
+        """
+        Obtain winning version of an A/B test email campaign
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the A/B test campaign
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAbTestCampaignResultResponse
+            A/B test email campaign Result
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.get_ab_test_campaign_result(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_ab_test_campaign_result(campaign_id, request_options=request_options)
+        return _response.data
+
+    async def email_export_recipients(
+        self,
+        campaign_id: int,
+        *,
+        recipients_type: EmailExportRecipientsRequestRecipientsType,
+        notify_url: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> EmailExportRecipientsResponse:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        recipients_type : EmailExportRecipientsRequestRecipientsType
+            Type of recipients to export for a campaign
+
+        notify_url : typing.Optional[str]
+            Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        EmailExportRecipientsResponse
+            process id created
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.email_export_recipients(
+                campaign_id=1000000,
+                recipients_type="all",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.email_export_recipients(
+            campaign_id, recipients_type=recipients_type, notify_url=notify_url, request_options=request_options
+        )
+        return _response.data
+
+    async def send_email_campaign_now(
+        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.email_campaigns.send_email_campaign_now(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.send_email_campaign_now(campaign_id, request_options=request_options)
+        return _response.data
+
+    async def send_report(
+        self,
+        campaign_id: int,
+        *,
+        email: SendReportEmail,
+        language: typing.Optional[SendReportLanguage] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        A PDF will be sent to the specified email addresses
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        email : SendReportEmail
+            Custom attributes for the report email.
+
+        language : typing.Optional[SendReportLanguage]
+            Language of email content for campaign report sending.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo, SendReportEmail
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.send_report(
+                campaign_id=1000000,
+                email=SendReportEmail(
+                    body="Please find attached the report of our last email campaign.",
+                    to=["jim.suehan@example.com"],
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.send_report(
+            campaign_id, email=email, language=language, request_options=request_options
+        )
+        return _response.data
+
+    async def send_test_email(
+        self,
+        campaign_id: int,
+        *,
+        email_to: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        email_to : typing.Optional[typing.Sequence[str]]
+            List of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_.
+
+        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.email_campaigns.send_test_email(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.send_test_email(
+            campaign_id, email_to=email_to, request_options=request_options
+        )
+        return _response.data
+
+    async def get_shared_template_url(
+        self, campaign_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetSharedTemplateUrlResponse:
+        """
+        Get a unique URL to share & import an email template from one Brevo account to another.
+
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign or template
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetSharedTemplateUrlResponse
+            Shared template URL information
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.email_campaigns.get_shared_template_url(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_shared_template_url(campaign_id, request_options=request_options)
+        return _response.data
+
+    async def update_campaign_status(
+        self,
+        campaign_id: int,
+        *,
+        status: typing.Optional[UpdateCampaignStatusStatus] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Parameters
+        ----------
+        campaign_id : int
+            Id of the campaign
+
+        status : typing.Optional[UpdateCampaignStatusStatus]
+            Note:- **replicateTemplate** status will be available **only for template type campaigns.**
+
+        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.email_campaigns.update_campaign_status(
+                campaign_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_campaign_status(
+            campaign_id, status=status, request_options=request_options
+        )
+        return _response.data