SDK regeneration

.fern/metadata.json

@@ -18,6 +18,6 @@
       "skip_validation": true
     }
   },
-  "originGitCommit": "f03678b950bc1ad4cb8f8de2037cc502935efaae",
-  "sdkVersion": "5.0.2"
+  "originGitCommit": "2d067b2a3ef8d760c87a8aae2f6f4ac7e195ad85",
+  "sdkVersion": "5.0.3"
 }

pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "brevo-python"
-version = "5.0.2"
+version = "5.0.3"
 description = ""
 readme = "README.md"
 authors = []

reference.md

@@ -19756,7 +19756,7 @@ client.email_campaigns.upload_image_to_gallery(
 <dl>
 <dd>
 
-**name:** `typing.Optional[str]` — Name of the image.
+**name:** `typing.Optional[str]` — Name shown in your Brevo image gallery. Include the file extension, e.g. product-banner.png
 
 </dd>
 </dl>

src/brevo/__init__.py

@@ -624,7 +624,9 @@
         GetParameterSubscriptionInfoResponseBalance,
         GetParameterSubscriptionInfoResponseBalanceBalancesItem,
         GetParameterSubscriptionInfoResponseMembersItem,
+        GetParameterSubscriptionInfoResponseMembership,
         GetParameterSubscriptionInfoResponseRewardItem,
+        GetParameterSubscriptionInfoResponseRewardItemUnit,
         GetParameterSubscriptionInfoResponseTierItem,
         SubscribeMemberToASubscriptionResponse,
         SubscribeToLoyaltyProgramResponse,
@@ -1277,7 +1279,9 @@
     "GetParameterSubscriptionInfoResponseBalance": ".program",
     "GetParameterSubscriptionInfoResponseBalanceBalancesItem": ".program",
     "GetParameterSubscriptionInfoResponseMembersItem": ".program",
+    "GetParameterSubscriptionInfoResponseMembership": ".program",
     "GetParameterSubscriptionInfoResponseRewardItem": ".program",
+    "GetParameterSubscriptionInfoResponseRewardItemUnit": ".program",
     "GetParameterSubscriptionInfoResponseTierItem": ".program",
     "GetPaymentRequestResponse": ".payments",
     "GetPaymentRequestResponseStatus": ".payments",
@@ -2094,7 +2098,9 @@ def __dir__():
     "GetParameterSubscriptionInfoResponseBalance",
     "GetParameterSubscriptionInfoResponseBalanceBalancesItem",
     "GetParameterSubscriptionInfoResponseMembersItem",
+    "GetParameterSubscriptionInfoResponseMembership",
     "GetParameterSubscriptionInfoResponseRewardItem",
+    "GetParameterSubscriptionInfoResponseRewardItemUnit",
     "GetParameterSubscriptionInfoResponseTierItem",
     "GetPaymentRequestResponse",
     "GetPaymentRequestResponseStatus",

src/brevo/core/client_wrapper.py

@@ -27,12 +27,12 @@ def get_headers(self) -> typing.Dict[str, str]:
         import platform
 
         headers: typing.Dict[str, str] = {
-            "User-Agent": "brevo-python/5.0.2",
+            "User-Agent": "brevo-python/5.0.3",
             "X-Fern-Language": "Python",
             "X-Fern-Runtime": f"python/{platform.python_version()}",
             "X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}",
             "X-Fern-SDK-Name": "brevo-python",
-            "X-Fern-SDK-Version": "5.0.2",
+            "X-Fern-SDK-Version": "5.0.3",
             **(self.get_custom_headers() or {}),
         }
         headers["api-key"] = self.api_key

src/brevo/email_campaigns/client.py

@@ -354,7 +354,7 @@ def upload_image_to_gallery(
             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.
+            Name shown in your Brevo image gallery. Include the file extension, e.g. product-banner.png
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1278,7 +1278,7 @@ async def upload_image_to_gallery(
             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.
+            Name shown in your Brevo image gallery. Include the file extension, e.g. product-banner.png
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

src/brevo/email_campaigns/raw_client.py

@@ -421,7 +421,7 @@ def upload_image_to_gallery(
             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.
+            Name shown in your Brevo image gallery. Include the file extension, e.g. product-banner.png
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1765,7 +1765,7 @@ async def upload_image_to_gallery(
             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.
+            Name shown in your Brevo image gallery. Include the file extension, e.g. product-banner.png
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

src/brevo/program/__init__.py

@@ -14,7 +14,9 @@
         GetParameterSubscriptionInfoResponseBalance,
         GetParameterSubscriptionInfoResponseBalanceBalancesItem,
         GetParameterSubscriptionInfoResponseMembersItem,
+        GetParameterSubscriptionInfoResponseMembership,
         GetParameterSubscriptionInfoResponseRewardItem,
+        GetParameterSubscriptionInfoResponseRewardItemUnit,
         GetParameterSubscriptionInfoResponseTierItem,
         SubscribeMemberToASubscriptionResponse,
         SubscribeToLoyaltyProgramResponse,
@@ -27,7 +29,9 @@
     "GetParameterSubscriptionInfoResponseBalance": ".types",
     "GetParameterSubscriptionInfoResponseBalanceBalancesItem": ".types",
     "GetParameterSubscriptionInfoResponseMembersItem": ".types",
+    "GetParameterSubscriptionInfoResponseMembership": ".types",
     "GetParameterSubscriptionInfoResponseRewardItem": ".types",
+    "GetParameterSubscriptionInfoResponseRewardItemUnit": ".types",
     "GetParameterSubscriptionInfoResponseTierItem": ".types",
     "SubscribeMemberToASubscriptionResponse": ".types",
     "SubscribeToLoyaltyProgramResponse": ".types",
@@ -63,7 +67,9 @@ def __dir__():
     "GetParameterSubscriptionInfoResponseBalance",
     "GetParameterSubscriptionInfoResponseBalanceBalancesItem",
     "GetParameterSubscriptionInfoResponseMembersItem",
+    "GetParameterSubscriptionInfoResponseMembership",
     "GetParameterSubscriptionInfoResponseRewardItem",
+    "GetParameterSubscriptionInfoResponseRewardItemUnit",
     "GetParameterSubscriptionInfoResponseTierItem",
     "SubscribeMemberToASubscriptionResponse",
     "SubscribeToLoyaltyProgramResponse",

src/brevo/program/types/__init__.py

@@ -15,7 +15,11 @@
         GetParameterSubscriptionInfoResponseBalanceBalancesItem,
     )
     from .get_parameter_subscription_info_response_members_item import GetParameterSubscriptionInfoResponseMembersItem
+    from .get_parameter_subscription_info_response_membership import GetParameterSubscriptionInfoResponseMembership
     from .get_parameter_subscription_info_response_reward_item import GetParameterSubscriptionInfoResponseRewardItem
+    from .get_parameter_subscription_info_response_reward_item_unit import (
+        GetParameterSubscriptionInfoResponseRewardItemUnit,
+    )
     from .get_parameter_subscription_info_response_tier_item import GetParameterSubscriptionInfoResponseTierItem
     from .subscribe_member_to_a_subscription_response import SubscribeMemberToASubscriptionResponse
     from .subscribe_to_loyalty_program_response import SubscribeToLoyaltyProgramResponse
@@ -27,7 +31,9 @@
     "GetParameterSubscriptionInfoResponseBalance": ".get_parameter_subscription_info_response_balance",
     "GetParameterSubscriptionInfoResponseBalanceBalancesItem": ".get_parameter_subscription_info_response_balance_balances_item",
     "GetParameterSubscriptionInfoResponseMembersItem": ".get_parameter_subscription_info_response_members_item",
+    "GetParameterSubscriptionInfoResponseMembership": ".get_parameter_subscription_info_response_membership",
     "GetParameterSubscriptionInfoResponseRewardItem": ".get_parameter_subscription_info_response_reward_item",
+    "GetParameterSubscriptionInfoResponseRewardItemUnit": ".get_parameter_subscription_info_response_reward_item_unit",
     "GetParameterSubscriptionInfoResponseTierItem": ".get_parameter_subscription_info_response_tier_item",
     "SubscribeMemberToASubscriptionResponse": ".subscribe_member_to_a_subscription_response",
     "SubscribeToLoyaltyProgramResponse": ".subscribe_to_loyalty_program_response",
@@ -63,7 +69,9 @@ def __dir__():
     "GetParameterSubscriptionInfoResponseBalance",
     "GetParameterSubscriptionInfoResponseBalanceBalancesItem",
     "GetParameterSubscriptionInfoResponseMembersItem",
+    "GetParameterSubscriptionInfoResponseMembership",
     "GetParameterSubscriptionInfoResponseRewardItem",
+    "GetParameterSubscriptionInfoResponseRewardItemUnit",
     "GetParameterSubscriptionInfoResponseTierItem",
     "SubscribeMemberToASubscriptionResponse",
     "SubscribeToLoyaltyProgramResponse",

src/brevo/program/types/get_parameter_subscription_info_response.py

@@ -3,10 +3,13 @@
 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_parameter_subscription_info_response_balance import GetParameterSubscriptionInfoResponseBalance
 from .get_parameter_subscription_info_response_members_item import GetParameterSubscriptionInfoResponseMembersItem
+from .get_parameter_subscription_info_response_membership import GetParameterSubscriptionInfoResponseMembership
 from .get_parameter_subscription_info_response_reward_item import GetParameterSubscriptionInfoResponseRewardItem
 from .get_parameter_subscription_info_response_tier_item import GetParameterSubscriptionInfoResponseTierItem
 
@@ -17,13 +20,23 @@ class GetParameterSubscriptionInfoResponse(UncheckedBaseModel):
     Balance details for the subscription.
     """
 
+    loyalty_program_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="loyaltyProgramName"),
+        pydantic.Field(alias="loyaltyProgramName", description="Name of the loyalty program."),
+    ] = None
     members: typing.Optional[typing.List[GetParameterSubscriptionInfoResponseMembersItem]] = pydantic.Field(
         default=None
     )
     """
     List of members associated with the subscription.
     """
 
+    membership: typing.Optional[GetParameterSubscriptionInfoResponseMembership] = pydantic.Field(default=None)
+    """
+    Membership details of the subscription. Returned when the subscription could be resolved from the provided `contactId` or `loyaltySubscriptionId`.
+    """
+
     reward: typing.Optional[typing.List[GetParameterSubscriptionInfoResponseRewardItem]] = pydantic.Field(default=None)
     """
     List of rewards associated with the subscription.

src/brevo/program/types/get_parameter_subscription_info_response_balance_balances_item.py

@@ -15,6 +15,11 @@ class GetParameterSubscriptionInfoResponseBalanceBalancesItem(UncheckedBaseModel
         FieldMetadata(alias="balanceDefinitionId"),
         pydantic.Field(alias="balanceDefinitionId", description="Unique identifier for the balance definition)."),
     ] = None
+    balance_definition_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="balanceDefinitionName"),
+        pydantic.Field(alias="balanceDefinitionName", description="Name of the balance definition."),
+    ] = None
     value: typing.Optional[float] = pydantic.Field(default=None)
     """
     The amount of the balance.

src/brevo/program/types/get_parameter_subscription_info_response_membership.py

@@ -0,0 +1,41 @@
+# 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 GetParameterSubscriptionInfoResponseMembership(UncheckedBaseModel):
+    """
+    Membership details of the subscription. Returned when the subscription could be resolved from the provided `contactId` or `loyaltySubscriptionId`.
+    """
+
+    created_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="createdAt"),
+        pydantic.Field(alias="createdAt", description="Timestamp when the subscription was created."),
+    ] = None
+    loyalty_subscription_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="loyaltySubscriptionId"),
+        pydantic.Field(alias="loyaltySubscriptionId", description="Unique identifier of the loyalty subscription."),
+    ] = None
+    updated_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="updatedAt"),
+        pydantic.Field(alias="updatedAt", description="Timestamp when the subscription 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

src/brevo/program/types/get_parameter_subscription_info_response_reward_item.py

@@ -8,6 +8,9 @@
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 from ...core.serialization import FieldMetadata
 from ...core.unchecked_base_model import UncheckedBaseModel
+from .get_parameter_subscription_info_response_reward_item_unit import (
+    GetParameterSubscriptionInfoResponseRewardItemUnit,
+)
 
 
 class GetParameterSubscriptionInfoResponseRewardItem(UncheckedBaseModel):
@@ -46,11 +49,32 @@ class GetParameterSubscriptionInfoResponseRewardItem(UncheckedBaseModel):
     Additional metadata related to the reward.
     """
 
+    public_description: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="publicDescription"),
+        pydantic.Field(
+            alias="publicDescription",
+            description="Customer-facing description of the reward, as configured on the reward definition.",
+        ),
+    ] = None
     reward_id: typing_extensions.Annotated[
         typing.Optional[str],
         FieldMetadata(alias="rewardId"),
         pydantic.Field(alias="rewardId", description="Unique identifier of the reward definition."),
     ] = None
+    reward_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="rewardName"),
+        pydantic.Field(
+            alias="rewardName",
+            description="Customer-facing name of the reward. Falls back to the internal reward name when no public name is set.",
+        ),
+    ] = None
+    unit: typing.Optional[GetParameterSubscriptionInfoResponseRewardItemUnit] = pydantic.Field(default=None)
+    """
+    Unit the reward's value is expressed in — one of the currency codes listed below, or PERCENT. Omitted when the reward has no unit (e.g. free-product rewards).
+    """
+
     updated_at: typing_extensions.Annotated[
         typing.Optional[dt.datetime],
         FieldMetadata(alias="updatedAt"),
@@ -61,6 +85,10 @@ class GetParameterSubscriptionInfoResponseRewardItem(UncheckedBaseModel):
         FieldMetadata(alias="validFrom"),
         pydantic.Field(alias="validFrom", description="Date from which the voucher becomes valid."),
     ] = None
+    value: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The value recorded when this reward was attributed to the contact — a snapshot, not necessarily the reward's current configured value. Omitted when not set.
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

src/brevo/program/types/get_parameter_subscription_info_response_reward_item_unit.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetParameterSubscriptionInfoResponseRewardItemUnit = typing.Union[
+    typing.Literal[
+        "PERCENT",
+        "EUR",
+        "USD",
+        "MXN",
+        "GBP",
+        "INR",
+        "CAD",
+        "SGD",
+        "RON",
+        "JPY",
+        "MYR",
+        "CLP",
+        "PEN",
+        "MAD",
+        "AUD",
+        "CHF",
+        "BRL",
+    ],
+    typing.Any,
+]

src/brevo/program/types/get_parameter_subscription_info_response_tier_item.py

@@ -25,6 +25,11 @@ class GetParameterSubscriptionInfoResponseTierItem(UncheckedBaseModel):
         FieldMetadata(alias="groupId"),
         pydantic.Field(alias="groupId", description="Unique identifier of the group associated with the tier."),
     ] = None
+    group_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="groupName"),
+        pydantic.Field(alias="groupName", description="Name of the group associated with the tier."),
+    ] = None
     loyalty_program_id: typing_extensions.Annotated[
         typing.Optional[str],
         FieldMetadata(alias="loyaltyProgramId"),
@@ -40,6 +45,11 @@ class GetParameterSubscriptionInfoResponseTierItem(UncheckedBaseModel):
         FieldMetadata(alias="tierId"),
         pydantic.Field(alias="tierId", description="Unique identifier of the tier."),
     ] = None
+    tier_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="tierName"),
+        pydantic.Field(alias="tierName", description="Name of the tier."),
+    ] = None
     updated_at: typing_extensions.Annotated[
         typing.Optional[str],
         FieldMetadata(alias="updatedAt"),

src/brevo/types/transaction.py

@@ -27,6 +27,11 @@ class Transaction(UncheckedBaseModel):
     The transaction amount.
     """
 
+    balance: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The contact's total balance for this balance definition after the transaction was applied. Only returned when the transaction actually updated the balance (i.e. it was completed or auto-completed).
+    """
+
     transaction_type: typing_extensions.Annotated[
         typing.Optional[TransactionTransactionType],
         FieldMetadata(alias="transactionType"),

src/brevo/types/transaction_status.py

@@ -2,4 +2,4 @@
 
 import typing
 
-TransactionStatus = typing.Union[typing.Literal["pending", "complete", "rejected", "cancelled", "expired"], typing.Any]
+TransactionStatus = typing.Union[typing.Literal["draft", "completed", "rejected", "cancelled", "expired"], typing.Any]