brevo-python 4.0.1__py3-none-any.whl

brevo/email_campaigns/types/__init__.py

@@ -0,0 +1,141 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .create_email_campaign_request_email_expiration_date import CreateEmailCampaignRequestEmailExpirationDate
+    from .create_email_campaign_request_email_expiration_date_unit import (
+        CreateEmailCampaignRequestEmailExpirationDateUnit,
+    )
+    from .create_email_campaign_request_recipients import CreateEmailCampaignRequestRecipients
+    from .create_email_campaign_request_sender import CreateEmailCampaignRequestSender
+    from .create_email_campaign_request_winner_criteria import CreateEmailCampaignRequestWinnerCriteria
+    from .create_email_campaign_response import CreateEmailCampaignResponse
+    from .email_export_recipients_request_recipients_type import EmailExportRecipientsRequestRecipientsType
+    from .email_export_recipients_response import EmailExportRecipientsResponse
+    from .get_ab_test_campaign_result_response import GetAbTestCampaignResultResponse
+    from .get_ab_test_campaign_result_response_clicked_links import GetAbTestCampaignResultResponseClickedLinks
+    from .get_ab_test_campaign_result_response_statistics import GetAbTestCampaignResultResponseStatistics
+    from .get_ab_test_campaign_result_response_winning_criteria import GetAbTestCampaignResultResponseWinningCriteria
+    from .get_ab_test_campaign_result_response_winning_version import GetAbTestCampaignResultResponseWinningVersion
+    from .get_email_campaign_request_statistics import GetEmailCampaignRequestStatistics
+    from .get_email_campaign_response import GetEmailCampaignResponse
+    from .get_email_campaign_response_sender import GetEmailCampaignResponseSender
+    from .get_email_campaign_response_status import GetEmailCampaignResponseStatus
+    from .get_email_campaign_response_type import GetEmailCampaignResponseType
+    from .get_email_campaigns_request_sort import GetEmailCampaignsRequestSort
+    from .get_email_campaigns_request_statistics import GetEmailCampaignsRequestStatistics
+    from .get_email_campaigns_request_status import GetEmailCampaignsRequestStatus
+    from .get_email_campaigns_request_type import GetEmailCampaignsRequestType
+    from .get_email_campaigns_response import GetEmailCampaignsResponse
+    from .get_email_campaigns_response_campaigns_item import GetEmailCampaignsResponseCampaignsItem
+    from .get_email_campaigns_response_campaigns_item_sender import GetEmailCampaignsResponseCampaignsItemSender
+    from .get_email_campaigns_response_campaigns_item_status import GetEmailCampaignsResponseCampaignsItemStatus
+    from .get_email_campaigns_response_campaigns_item_type import GetEmailCampaignsResponseCampaignsItemType
+    from .get_shared_template_url_response import GetSharedTemplateUrlResponse
+    from .update_email_campaign_request_email_expiration_date import UpdateEmailCampaignRequestEmailExpirationDate
+    from .update_email_campaign_request_email_expiration_date_unit import (
+        UpdateEmailCampaignRequestEmailExpirationDateUnit,
+    )
+    from .update_email_campaign_request_recipients import UpdateEmailCampaignRequestRecipients
+    from .update_email_campaign_request_sender import UpdateEmailCampaignRequestSender
+    from .update_email_campaign_request_winner_criteria import UpdateEmailCampaignRequestWinnerCriteria
+    from .upload_image_to_gallery_response import UploadImageToGalleryResponse
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateEmailCampaignRequestEmailExpirationDate": ".create_email_campaign_request_email_expiration_date",
+    "CreateEmailCampaignRequestEmailExpirationDateUnit": ".create_email_campaign_request_email_expiration_date_unit",
+    "CreateEmailCampaignRequestRecipients": ".create_email_campaign_request_recipients",
+    "CreateEmailCampaignRequestSender": ".create_email_campaign_request_sender",
+    "CreateEmailCampaignRequestWinnerCriteria": ".create_email_campaign_request_winner_criteria",
+    "CreateEmailCampaignResponse": ".create_email_campaign_response",
+    "EmailExportRecipientsRequestRecipientsType": ".email_export_recipients_request_recipients_type",
+    "EmailExportRecipientsResponse": ".email_export_recipients_response",
+    "GetAbTestCampaignResultResponse": ".get_ab_test_campaign_result_response",
+    "GetAbTestCampaignResultResponseClickedLinks": ".get_ab_test_campaign_result_response_clicked_links",
+    "GetAbTestCampaignResultResponseStatistics": ".get_ab_test_campaign_result_response_statistics",
+    "GetAbTestCampaignResultResponseWinningCriteria": ".get_ab_test_campaign_result_response_winning_criteria",
+    "GetAbTestCampaignResultResponseWinningVersion": ".get_ab_test_campaign_result_response_winning_version",
+    "GetEmailCampaignRequestStatistics": ".get_email_campaign_request_statistics",
+    "GetEmailCampaignResponse": ".get_email_campaign_response",
+    "GetEmailCampaignResponseSender": ".get_email_campaign_response_sender",
+    "GetEmailCampaignResponseStatus": ".get_email_campaign_response_status",
+    "GetEmailCampaignResponseType": ".get_email_campaign_response_type",
+    "GetEmailCampaignsRequestSort": ".get_email_campaigns_request_sort",
+    "GetEmailCampaignsRequestStatistics": ".get_email_campaigns_request_statistics",
+    "GetEmailCampaignsRequestStatus": ".get_email_campaigns_request_status",
+    "GetEmailCampaignsRequestType": ".get_email_campaigns_request_type",
+    "GetEmailCampaignsResponse": ".get_email_campaigns_response",
+    "GetEmailCampaignsResponseCampaignsItem": ".get_email_campaigns_response_campaigns_item",
+    "GetEmailCampaignsResponseCampaignsItemSender": ".get_email_campaigns_response_campaigns_item_sender",
+    "GetEmailCampaignsResponseCampaignsItemStatus": ".get_email_campaigns_response_campaigns_item_status",
+    "GetEmailCampaignsResponseCampaignsItemType": ".get_email_campaigns_response_campaigns_item_type",
+    "GetSharedTemplateUrlResponse": ".get_shared_template_url_response",
+    "UpdateEmailCampaignRequestEmailExpirationDate": ".update_email_campaign_request_email_expiration_date",
+    "UpdateEmailCampaignRequestEmailExpirationDateUnit": ".update_email_campaign_request_email_expiration_date_unit",
+    "UpdateEmailCampaignRequestRecipients": ".update_email_campaign_request_recipients",
+    "UpdateEmailCampaignRequestSender": ".update_email_campaign_request_sender",
+    "UpdateEmailCampaignRequestWinnerCriteria": ".update_email_campaign_request_winner_criteria",
+    "UploadImageToGalleryResponse": ".upload_image_to_gallery_response",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "CreateEmailCampaignRequestEmailExpirationDate",
+    "CreateEmailCampaignRequestEmailExpirationDateUnit",
+    "CreateEmailCampaignRequestRecipients",
+    "CreateEmailCampaignRequestSender",
+    "CreateEmailCampaignRequestWinnerCriteria",
+    "CreateEmailCampaignResponse",
+    "EmailExportRecipientsRequestRecipientsType",
+    "EmailExportRecipientsResponse",
+    "GetAbTestCampaignResultResponse",
+    "GetAbTestCampaignResultResponseClickedLinks",
+    "GetAbTestCampaignResultResponseStatistics",
+    "GetAbTestCampaignResultResponseWinningCriteria",
+    "GetAbTestCampaignResultResponseWinningVersion",
+    "GetEmailCampaignRequestStatistics",
+    "GetEmailCampaignResponse",
+    "GetEmailCampaignResponseSender",
+    "GetEmailCampaignResponseStatus",
+    "GetEmailCampaignResponseType",
+    "GetEmailCampaignsRequestSort",
+    "GetEmailCampaignsRequestStatistics",
+    "GetEmailCampaignsRequestStatus",
+    "GetEmailCampaignsRequestType",
+    "GetEmailCampaignsResponse",
+    "GetEmailCampaignsResponseCampaignsItem",
+    "GetEmailCampaignsResponseCampaignsItemSender",
+    "GetEmailCampaignsResponseCampaignsItemStatus",
+    "GetEmailCampaignsResponseCampaignsItemType",
+    "GetSharedTemplateUrlResponse",
+    "UpdateEmailCampaignRequestEmailExpirationDate",
+    "UpdateEmailCampaignRequestEmailExpirationDateUnit",
+    "UpdateEmailCampaignRequestRecipients",
+    "UpdateEmailCampaignRequestSender",
+    "UpdateEmailCampaignRequestWinnerCriteria",
+    "UploadImageToGalleryResponse",
+]

brevo/email_campaigns/types/create_email_campaign_request_email_expiration_date.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .create_email_campaign_request_email_expiration_date_unit import CreateEmailCampaignRequestEmailExpirationDateUnit
+
+
+class CreateEmailCampaignRequestEmailExpirationDate(UncheckedBaseModel):
+    """
+    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``
+    """
+
+    duration: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Duration of the email expiry. maximum duration can be 3600 days or 480 weeks or 120 months.
+    """
+
+    unit: typing.Optional[CreateEmailCampaignRequestEmailExpirationDateUnit] = pydantic.Field(default=None)
+    """
+    unit of the duration
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/create_email_campaign_request_email_expiration_date_unit.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateEmailCampaignRequestEmailExpirationDateUnit = typing.Union[typing.Literal["days", "weeks", "months"], typing.Any]

brevo/email_campaigns/types/create_email_campaign_request_recipients.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.serialization import FieldMetadata
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateEmailCampaignRequestRecipients(UncheckedBaseModel):
+    """
+    Segment ids and List ids to include/exclude from campaign
+    """
+
+    exclusion_list_ids: typing_extensions.Annotated[
+        typing.Optional[typing.List[int]],
+        FieldMetadata(alias="exclusionListIds"),
+        pydantic.Field(alias="exclusionListIds", description="List ids to exclude from the campaign"),
+    ] = None
+    exclusion_segment_ids: typing_extensions.Annotated[
+        typing.Optional[typing.List[int]],
+        FieldMetadata(alias="exclusionSegmentIds"),
+        pydantic.Field(
+            alias="exclusionSegmentIds", description="Segment ids which have to be excluded from a campaign."
+        ),
+    ] = None
+    list_ids: typing_extensions.Annotated[
+        typing.Optional[typing.List[int]],
+        FieldMetadata(alias="listIds"),
+        pydantic.Field(
+            alias="listIds", description="**Mandatory if scheduledAt is not empty**. List Ids to send the campaign to"
+        ),
+    ] = None
+    segment_ids: typing_extensions.Annotated[
+        typing.Optional[typing.List[int]],
+        FieldMetadata(alias="segmentIds"),
+        pydantic.Field(
+            alias="segmentIds",
+            description="**Mandatory if listIds are not used**. Segment ids to send the campaign to.",
+        ),
+    ] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/create_email_campaign_request_sender.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateEmailCampaignRequestSender(UncheckedBaseModel):
+    """
+    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}**
+    """
+
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sender email
+    """
+
+    id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Select the sender for the campaign on the basis of sender id. _In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email)_.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Sender Name
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/create_email_campaign_request_winner_criteria.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateEmailCampaignRequestWinnerCriteria = typing.Union[typing.Literal["open", "click"], typing.Any]

brevo/email_campaigns/types/create_email_campaign_response.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateEmailCampaignResponse(UncheckedBaseModel):
+    id: int = pydantic.Field()
+    """
+    ID of the object created
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/email_export_recipients_request_recipients_type.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+EmailExportRecipientsRequestRecipientsType = typing.Union[
+    typing.Literal[
+        "all", "nonClickers", "nonOpeners", "clickers", "openers", "softBounces", "hardBounces", "unsubscribed"
+    ],
+    typing.Any,
+]

brevo/email_campaigns/types/email_export_recipients_response.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.serialization import FieldMetadata
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class EmailExportRecipientsResponse(UncheckedBaseModel):
+    process_id: typing_extensions.Annotated[
+        int,
+        FieldMetadata(alias="processId"),
+        pydantic.Field(alias="processId", description="Id of the process created"),
+    ]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/get_ab_test_campaign_result_response.py

@@ -0,0 +1,64 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.serialization import FieldMetadata
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .get_ab_test_campaign_result_response_clicked_links import GetAbTestCampaignResultResponseClickedLinks
+from .get_ab_test_campaign_result_response_statistics import GetAbTestCampaignResultResponseStatistics
+from .get_ab_test_campaign_result_response_winning_criteria import GetAbTestCampaignResultResponseWinningCriteria
+from .get_ab_test_campaign_result_response_winning_version import GetAbTestCampaignResultResponseWinningVersion
+
+
+class GetAbTestCampaignResultResponse(UncheckedBaseModel):
+    click_rate: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="clickRate"),
+        pydantic.Field(alias="clickRate", description="Click rate for current winning version"),
+    ] = None
+    clicked_links: typing_extensions.Annotated[
+        typing.Optional[GetAbTestCampaignResultResponseClickedLinks],
+        FieldMetadata(alias="clickedLinks"),
+        pydantic.Field(alias="clickedLinks"),
+    ] = None
+    open_rate: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="openRate"),
+        pydantic.Field(alias="openRate", description="Open rate for current winning version"),
+    ] = None
+    statistics: typing.Optional[GetAbTestCampaignResultResponseStatistics] = None
+    winning_criteria: typing_extensions.Annotated[
+        typing.Optional[GetAbTestCampaignResultResponseWinningCriteria],
+        FieldMetadata(alias="winningCriteria"),
+        pydantic.Field(alias="winningCriteria", description="Criteria chosen for winning version (Open/Click)"),
+    ] = None
+    winning_subject_line: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="winningSubjectLine"),
+        pydantic.Field(alias="winningSubjectLine", description="Subject Line of current winning version"),
+    ] = None
+    winning_version: typing_extensions.Annotated[
+        typing.Optional[GetAbTestCampaignResultResponseWinningVersion],
+        FieldMetadata(alias="winningVersion"),
+        pydantic.Field(
+            alias="winningVersion",
+            description="Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending.",
+        ),
+    ] = None
+    winning_version_rate: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="winningVersionRate"),
+        pydantic.Field(alias="winningVersionRate", description="Open/Click rate for the winner version"),
+    ] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/get_ab_test_campaign_result_response_clicked_links.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.serialization import FieldMetadata
+from ...core.unchecked_base_model import UncheckedBaseModel
+from ...types.ab_test_version_clicks import AbTestVersionClicks
+
+
+class GetAbTestCampaignResultResponseClickedLinks(UncheckedBaseModel):
+    version_a: typing_extensions.Annotated[
+        AbTestVersionClicks, FieldMetadata(alias="Version A"), pydantic.Field(alias="Version A")
+    ]
+    version_b: typing_extensions.Annotated[
+        AbTestVersionClicks, FieldMetadata(alias="Version B"), pydantic.Field(alias="Version B")
+    ]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/get_ab_test_campaign_result_response_statistics.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.serialization import FieldMetadata
+from ...core.unchecked_base_model import UncheckedBaseModel
+from ...types.ab_test_version_stats import AbTestVersionStats
+
+
+class GetAbTestCampaignResultResponseStatistics(UncheckedBaseModel):
+    clicks: AbTestVersionStats
+    complaints: AbTestVersionStats
+    hard_bounces: typing_extensions.Annotated[
+        AbTestVersionStats, FieldMetadata(alias="hardBounces"), pydantic.Field(alias="hardBounces")
+    ]
+    openers: AbTestVersionStats
+    soft_bounces: typing_extensions.Annotated[
+        AbTestVersionStats, FieldMetadata(alias="softBounces"), pydantic.Field(alias="softBounces")
+    ]
+    unsubscribed: AbTestVersionStats
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

brevo/email_campaigns/types/get_ab_test_campaign_result_response_winning_criteria.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetAbTestCampaignResultResponseWinningCriteria = typing.Union[typing.Literal["Open", "Click"], typing.Any]

brevo/email_campaigns/types/get_ab_test_campaign_result_response_winning_version.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetAbTestCampaignResultResponseWinningVersion = typing.Union[
+    typing.Literal["notAvailable", "pending", "tie", "A", "B"], typing.Any
+]

brevo/email_campaigns/types/get_email_campaign_request_statistics.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetEmailCampaignRequestStatistics = typing.Union[
+    typing.Literal["globalStats", "linksStats", "statsByDomain", "statsByDevice", "statsByBrowser"], typing.Any
+]