brevo-python 4.0.1__py3-none-any.whl

brevo/types/order_billing.py

@@ -0,0 +1,66 @@
+# 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 OrderBilling(UncheckedBaseModel):
+    """
+    Billing details of an order.
+    """
+
+    address: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Full billing address.
+    """
+
+    city: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Exact city of the address.
+    """
+
+    country: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Billing country name.
+    """
+
+    country_code: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="countryCode"),
+        pydantic.Field(alias="countryCode", description="Billing country 2-letter ISO code."),
+    ] = None
+    payment_method: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="paymentMethod"),
+        pydantic.Field(
+            alias="paymentMethod", description="How the visitor will pay for the item(s), e.g. paypal, check, etc."
+        ),
+    ] = None
+    phone: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Billing phone number.
+    """
+
+    post_code: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="postCode"),
+        pydantic.Field(alias="postCode", description="Postcode for delivery and billing."),
+    ] = None
+    region: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Exact region (state/province) for delivery and billing.
+    """
+
+    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/types/order_identifiers.py

@@ -0,0 +1,42 @@
+# 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 OrderIdentifiers(UncheckedBaseModel):
+    """
+    Identifies the contact associated with the order.
+    """
+
+    email_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Email of the contact associated with the order
+    """
+
+    ext_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ext_id associated with the order
+    """
+
+    loyalty_subscription_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    loyalty_subscription_id associated with the order
+    """
+
+    phone_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Phone number of the contact associated with the order
+    """
+
+    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/types/order_meta_info_value.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+OrderMetaInfoValue = typing.Union[str, int, bool]

brevo/types/order_products_item.py

@@ -0,0 +1,43 @@
+# 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 OrderProductsItem(UncheckedBaseModel):
+    """
+    Details for the Products in an order.
+    """
+
+    price: float = pydantic.Field()
+    """
+    The price of a unit of product
+    """
+
+    product_id: typing_extensions.Annotated[
+        str, FieldMetadata(alias="productId"), pydantic.Field(alias="productId", description="ID of the product.")
+    ]
+    quantity: float = pydantic.Field()
+    """
+    How many pieces of the product the visitor has added to the cart.
+    """
+
+    variant_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="variantId"),
+        pydantic.Field(alias="variantId", description="Product ID of the red color shirts."),
+    ] = 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/types/pipeline.py

@@ -0,0 +1,38 @@
+# 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 .pipeline_stages_item import PipelineStagesItem
+
+
+class Pipeline(UncheckedBaseModel):
+    """
+    List of stages
+    """
+
+    pipeline: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Pipeline id
+    """
+
+    pipeline_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Pipeline Name
+    """
+
+    stages: typing.Optional[typing.List[PipelineStagesItem]] = pydantic.Field(default=None)
+    """
+    List of stages
+    """
+
+    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/types/pipeline_stages_item.py

@@ -0,0 +1,32 @@
+# 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 PipelineStagesItem(UncheckedBaseModel):
+    """
+    List of stages
+    """
+
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Stage id
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Stage 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/types/pipelines.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .pipeline import Pipeline
+
+Pipelines = typing.List[Pipeline]

brevo/types/post_contact_info.py

@@ -0,0 +1,21 @@
+# 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 .post_contact_info_contacts import PostContactInfoContacts
+
+
+class PostContactInfo(UncheckedBaseModel):
+    contacts: PostContactInfoContacts
+
+    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/types/post_contact_info_contacts.py

@@ -0,0 +1,37 @@
+# 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 .post_contact_info_contacts_failure import PostContactInfoContactsFailure
+from .post_contact_info_contacts_success import PostContactInfoContactsSuccess
+
+
+class PostContactInfoContacts(UncheckedBaseModel):
+    failure: typing.Optional[PostContactInfoContactsFailure] = None
+    process_id: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="processId"),
+        pydantic.Field(
+            alias="processId",
+            description='Id of the process created to remove contacts from list when user opts for "all" option.',
+        ),
+    ] = None
+    success: typing.Optional[PostContactInfoContactsSuccess] = None
+    total: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Displays the count of total number of contacts removed from list when user opts for "all" option.
+    """
+
+    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/types/post_contact_info_contacts_failure.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PostContactInfoContactsFailure = typing.Union[typing.List[str], typing.List[int]]

brevo/types/post_contact_info_contacts_success.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PostContactInfoContactsSuccess = typing.Union[typing.List[str], typing.List[int]]

brevo/types/post_send_failed.py

@@ -0,0 +1,46 @@
+# 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 PostSendFailed(UncheckedBaseModel):
+    black_listed_emails: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]],
+        FieldMetadata(alias="blackListedEmails"),
+        pydantic.Field(alias="blackListedEmails"),
+    ] = None
+    code: str = pydantic.Field()
+    """
+    Response code
+    """
+
+    message: str = pydantic.Field()
+    """
+    Response message
+    """
+
+    unexisting_emails: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]],
+        FieldMetadata(alias="unexistingEmails"),
+        pydantic.Field(alias="unexistingEmails"),
+    ] = None
+    without_list_emails: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]],
+        FieldMetadata(alias="withoutListEmails"),
+        pydantic.Field(alias="withoutListEmails"),
+    ] = 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/types/redeem.py

@@ -0,0 +1,92 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+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 Redeem(UncheckedBaseModel):
+    cancelled_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="cancelledAt"),
+        pydantic.Field(alias="cancelledAt", description="Timestamp when the redemption was cancelled"),
+    ] = None
+    completed_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="completedAt"),
+        pydantic.Field(alias="completedAt", description="Timestamp when the redemption was completed"),
+    ] = None
+    contact_id: typing_extensions.Annotated[
+        typing.Optional[int],
+        FieldMetadata(alias="contactId"),
+        pydantic.Field(alias="contactId", description="Unique identifier for the contact"),
+    ] = None
+    created_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="createdAt"),
+        pydantic.Field(alias="createdAt", description="Timestamp when the redemption was created"),
+    ] = None
+    debit_transaction_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="debitTransactionId"),
+        pydantic.Field(alias="debitTransactionId", description="Unique identifier for the debit transaction"),
+    ] = None
+    expires_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="expiresAt"),
+        pydantic.Field(alias="expiresAt", description="Timestamp when the redemption expires"),
+    ] = None
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the redemption
+    """
+
+    loyalty_program_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="loyaltyProgramId"),
+        pydantic.Field(alias="loyaltyProgramId", description="Unique identifier for the loyalty program"),
+    ] = None
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Additional metadata associated with the redemption
+    """
+
+    reject_reason: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="rejectReason"),
+        pydantic.Field(alias="rejectReason", description="Reason for rejection if the redemption was rejected"),
+    ] = None
+    rejected_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="rejectedAt"),
+        pydantic.Field(alias="rejectedAt", description="Timestamp when the redemption was rejected"),
+    ] = None
+    reward_attribution_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="rewardAttributionId"),
+        pydantic.Field(alias="rewardAttributionId", description="Unique identifier for the reward attribution"),
+    ] = None
+    status: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Current status of the redemption
+    """
+
+    updated_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="updatedAt"),
+        pydantic.Field(alias="updatedAt", description="Timestamp when the redemption was last updated"),
+    ] = 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/types/rule_condition_response.py

@@ -0,0 +1,52 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, update_forward_refs
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class RuleConditionResponse(UncheckedBaseModel):
+    and_: typing_extensions.Annotated[
+        typing.Optional[typing.List["RuleConditionResponse"]],
+        FieldMetadata(alias="and"),
+        pydantic.Field(alias="and", description="Metric to indicate AND between rules"),
+    ] = None
+    lhs: typing.Optional["ValueResponse"] = pydantic.Field(default=None)
+    """
+    Condition of the rule
+    """
+
+    op: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Selected operator for the rule
+    """
+
+    or_: typing_extensions.Annotated[
+        typing.Optional[typing.List["RuleConditionResponse"]],
+        FieldMetadata(alias="or"),
+        pydantic.Field(alias="or", description="Metric to indicate OR between rules"),
+    ] = None
+    rhs: typing.Optional["ValueResponse"] = pydantic.Field(default=None)
+    """
+    Action of the rule
+    """
+
+    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
+
+
+from .value_response import ValueResponse  # noqa: E402, I001
+
+update_forward_refs(RuleConditionResponse, ValueResponse=ValueResponse)

brevo/types/send_report.py

@@ -0,0 +1,30 @@
+# 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 .send_report_email import SendReportEmail
+from .send_report_language import SendReportLanguage
+
+
+class SendReport(UncheckedBaseModel):
+    email: SendReportEmail = pydantic.Field()
+    """
+    Custom attributes for the report email.
+    """
+
+    language: typing.Optional[SendReportLanguage] = pydantic.Field(default=None)
+    """
+    Language of email content for campaign report sending.
+    """
+
+    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/types/send_report_email.py

@@ -0,0 +1,32 @@
+# 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 SendReportEmail(UncheckedBaseModel):
+    """
+    Custom attributes for the report email.
+    """
+
+    body: str = pydantic.Field()
+    """
+    Custom text message to be presented in the report email.
+    """
+
+    to: typing.List[str] = pydantic.Field()
+    """
+    Email addresses of the recipients
+    """
+
+    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/types/send_report_language.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SendReportLanguage = typing.Union[typing.Literal["fr", "es", "pt", "it", "de", "en"], typing.Any]

brevo/types/send_test_email.py

@@ -0,0 +1,29 @@
+# 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 SendTestEmail(UncheckedBaseModel):
+    email_to: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]],
+        FieldMetadata(alias="emailTo"),
+        pydantic.Field(
+            alias="emailTo",
+            description="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_.",
+        ),
+    ] = 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/types/send_transac_sms.py

@@ -0,0 +1,66 @@
+# 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 .send_transac_sms_tag import SendTransacSmsTag
+from .send_transac_sms_type import SendTransacSmsType
+
+
+class SendTransacSms(UncheckedBaseModel):
+    organisation_prefix: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="organisationPrefix"),
+        pydantic.Field(
+            alias="organisationPrefix",
+            description="A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**",
+        ),
+    ] = None
+    recipient: str = pydantic.Field()
+    """
+    Mobile number to send SMS with the country code
+    """
+
+    sender: str = pydantic.Field()
+    """
+    Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
+    """
+
+    tag: typing.Optional[SendTransacSmsTag] = pydantic.Field(default=None)
+    """
+    Tag of the message
+    """
+
+    type: typing.Optional[SendTransacSmsType] = pydantic.Field(default=None)
+    """
+    Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.
+    """
+
+    unicode_enabled: typing_extensions.Annotated[
+        typing.Optional[bool],
+        FieldMetadata(alias="unicodeEnabled"),
+        pydantic.Field(
+            alias="unicodeEnabled",
+            description="Format of the message. It indicates whether the content should be treated as unicode or not.",
+        ),
+    ] = None
+    web_url: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="webUrl"),
+        pydantic.Field(
+            alias="webUrl", description="Webhook to call for each event triggered by the message (delivered etc.)"
+        ),
+    ] = 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