brevo-python 4.0.1__py3-none-any.whl

brevo/account/types/get_account_response_plan_item.py

@@ -0,0 +1,53 @@
+# 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_account_response_plan_item_type import GetAccountResponsePlanItemType
+
+
+class GetAccountResponsePlanItem(UncheckedBaseModel):
+    credits: float = pydantic.Field()
+    """
+    Remaining credits of the user
+    """
+
+    credits_type: typing_extensions.Annotated[
+        typing.Literal["sendLimit"],
+        FieldMetadata(alias="creditsType"),
+        pydantic.Field(
+            alias="creditsType",
+            description='This is the type of the credit, "Send Limit" is one\nof the possible types of credit of a user. "Send\nLimit" implies the total number of emails you can\nsend to the subscribers in your account.',
+        ),
+    ] = "sendLimit"
+    end_date: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="endDate"),
+        pydantic.Field(
+            alias="endDate", description="Date of the period from which the plan will end\n(Unix timestamp format)"
+        ),
+    ] = None
+    start_date: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="startDate"),
+        pydantic.Field(
+            alias="startDate", description="Date of the period from which the plan will start\n(Unix timestamp format)"
+        ),
+    ] = None
+    type: GetAccountResponsePlanItemType = pydantic.Field()
+    """
+    Displays the plan type of the user
+    """
+
+    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/account/types/get_account_response_plan_item_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetAccountResponsePlanItemType = typing.Union[typing.Literal["payAsYouGo", "free", "subscription", "sms"], typing.Any]

brevo/account/types/get_account_response_plan_verticals_item.py

@@ -0,0 +1,63 @@
+# 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_account_response_plan_verticals_item_plan_category import GetAccountResponsePlanVerticalsItemPlanCategory
+from .get_account_response_plan_verticals_item_status import GetAccountResponsePlanVerticalsItemStatus
+from .get_account_response_plan_verticals_item_users import GetAccountResponsePlanVerticalsItemUsers
+
+
+class GetAccountResponsePlanVerticalsItem(UncheckedBaseModel):
+    plan_category: typing_extensions.Annotated[
+        GetAccountResponsePlanVerticalsItemPlanCategory,
+        FieldMetadata(alias="planCategory"),
+        pydantic.Field(alias="planCategory", description="Category of the plan"),
+    ]
+    plan_type: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="planType"),
+        pydantic.Field(alias="planType", description="Type of plan within the category"),
+    ]
+    name: str = pydantic.Field()
+    """
+    Name of the plan
+    """
+
+    status: GetAccountResponsePlanVerticalsItemStatus = pydantic.Field()
+    """
+    Current status of the plan
+    """
+
+    start_date: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="startDate"),
+        pydantic.Field(alias="startDate", description="Plan start date (Unix timestamp)"),
+    ]
+    end_date: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="endDate"),
+        pydantic.Field(alias="endDate", description="Plan end date (Unix timestamp)"),
+    ]
+    users: GetAccountResponsePlanVerticalsItemUsers = pydantic.Field()
+    """
+    User seat information for the plan
+    """
+
+    credits: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Credits allocated for this plan category (optional, may not be present for all plan categories)
+    """
+
+    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/account/types/get_account_response_plan_verticals_item_plan_category.py

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

brevo/account/types/get_account_response_plan_verticals_item_status.py

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

brevo/account/types/get_account_response_plan_verticals_item_users.py

@@ -0,0 +1,35 @@
+# 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 GetAccountResponsePlanVerticalsItemUsers(UncheckedBaseModel):
+    """
+    User seat information for the plan
+    """
+
+    purchased_seats: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="purchasedSeats"),
+        pydantic.Field(alias="purchasedSeats", description="Number of purchased user seats"),
+    ]
+    used_seats: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="usedSeats"),
+        pydantic.Field(alias="usedSeats", description="Number of used user seats"),
+    ]
+
+    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/account/types/get_account_response_relay.py

@@ -0,0 +1,34 @@
+# 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 .get_account_response_relay_data import GetAccountResponseRelayData
+
+
+class GetAccountResponseRelay(UncheckedBaseModel):
+    """
+    Information about your transactional email account
+    """
+
+    data: GetAccountResponseRelayData = pydantic.Field()
+    """
+    Data regarding the transactional email account
+    """
+
+    enabled: bool = pydantic.Field()
+    """
+    Status of your transactional email Account
+    (true=Enabled, false=Disabled)
+    """
+
+    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/account/types/get_account_response_relay_data.py

@@ -0,0 +1,40 @@
+# 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 GetAccountResponseRelayData(UncheckedBaseModel):
+    """
+    Data regarding the transactional email account
+    """
+
+    port: int = pydantic.Field()
+    """
+    Port used for SMTP Relay
+    """
+
+    relay: str = pydantic.Field()
+    """
+    URL of the SMTP Relay
+    """
+
+    user_name: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="userName"),
+        pydantic.Field(alias="userName", description="Email to use as login on transactional platform"),
+    ]
+
+    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/balance/__init__.py

@@ -0,0 +1,139 @@
+# 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 .types import (
+        CreateBalanceLimitRequestConstraintType,
+        CreateBalanceLimitRequestDurationUnit,
+        CreateBalanceLimitRequestTransactionType,
+        CreateBalanceOrderResponse,
+        GetBalanceDefinitionListRequestSort,
+        GetBalanceDefinitionListRequestSortField,
+        GetBalanceDefinitionListRequestVersion,
+        GetBalanceDefinitionListResponse,
+        GetBalanceDefinitionRequestVersion,
+        GetBalanceLimitRequestVersion,
+        GetContactBalancesResponse,
+        GetContactBalancesResponseBalancesItem,
+        GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort,
+        GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField,
+        GetLoyaltyBalanceProgramsPidTransactionHistoryResponse,
+        GetLoyaltyBalanceProgramsPidTransactionHistoryResponseTransactionHistoryItem,
+        GetSubscriptionBalancesResponse,
+        GetSubscriptionBalancesResponseBalanceItem,
+        PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceAvailabilityDurationModifier,
+        PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceAvailabilityDurationUnit,
+        PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionAmountOvertakingStrategy,
+        PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionCreditRounding,
+        PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionDebitRounding,
+        PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestUnit,
+        PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse,
+        UpdateBalanceDefinitionRequestBalanceAvailabilityDurationModifier,
+        UpdateBalanceDefinitionRequestBalanceAvailabilityDurationUnit,
+        UpdateBalanceDefinitionRequestBalanceOptionAmountOvertakingStrategy,
+        UpdateBalanceDefinitionRequestBalanceOptionCreditRounding,
+        UpdateBalanceDefinitionRequestBalanceOptionDebitRounding,
+        UpdateBalanceDefinitionRequestUnit,
+        UpdateBalanceLimitRequestConstraintType,
+        UpdateBalanceLimitRequestDurationUnit,
+        UpdateBalanceLimitRequestTransactionType,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateBalanceLimitRequestConstraintType": ".types",
+    "CreateBalanceLimitRequestDurationUnit": ".types",
+    "CreateBalanceLimitRequestTransactionType": ".types",
+    "CreateBalanceOrderResponse": ".types",
+    "GetBalanceDefinitionListRequestSort": ".types",
+    "GetBalanceDefinitionListRequestSortField": ".types",
+    "GetBalanceDefinitionListRequestVersion": ".types",
+    "GetBalanceDefinitionListResponse": ".types",
+    "GetBalanceDefinitionRequestVersion": ".types",
+    "GetBalanceLimitRequestVersion": ".types",
+    "GetContactBalancesResponse": ".types",
+    "GetContactBalancesResponseBalancesItem": ".types",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort": ".types",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField": ".types",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryResponse": ".types",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryResponseTransactionHistoryItem": ".types",
+    "GetSubscriptionBalancesResponse": ".types",
+    "GetSubscriptionBalancesResponseBalanceItem": ".types",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceAvailabilityDurationModifier": ".types",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceAvailabilityDurationUnit": ".types",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionAmountOvertakingStrategy": ".types",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionCreditRounding": ".types",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionDebitRounding": ".types",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestUnit": ".types",
+    "PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse": ".types",
+    "UpdateBalanceDefinitionRequestBalanceAvailabilityDurationModifier": ".types",
+    "UpdateBalanceDefinitionRequestBalanceAvailabilityDurationUnit": ".types",
+    "UpdateBalanceDefinitionRequestBalanceOptionAmountOvertakingStrategy": ".types",
+    "UpdateBalanceDefinitionRequestBalanceOptionCreditRounding": ".types",
+    "UpdateBalanceDefinitionRequestBalanceOptionDebitRounding": ".types",
+    "UpdateBalanceDefinitionRequestUnit": ".types",
+    "UpdateBalanceLimitRequestConstraintType": ".types",
+    "UpdateBalanceLimitRequestDurationUnit": ".types",
+    "UpdateBalanceLimitRequestTransactionType": ".types",
+}
+
+
+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__ = [
+    "CreateBalanceLimitRequestConstraintType",
+    "CreateBalanceLimitRequestDurationUnit",
+    "CreateBalanceLimitRequestTransactionType",
+    "CreateBalanceOrderResponse",
+    "GetBalanceDefinitionListRequestSort",
+    "GetBalanceDefinitionListRequestSortField",
+    "GetBalanceDefinitionListRequestVersion",
+    "GetBalanceDefinitionListResponse",
+    "GetBalanceDefinitionRequestVersion",
+    "GetBalanceLimitRequestVersion",
+    "GetContactBalancesResponse",
+    "GetContactBalancesResponseBalancesItem",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSort",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryRequestSortField",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryResponse",
+    "GetLoyaltyBalanceProgramsPidTransactionHistoryResponseTransactionHistoryItem",
+    "GetSubscriptionBalancesResponse",
+    "GetSubscriptionBalancesResponseBalanceItem",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceAvailabilityDurationModifier",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceAvailabilityDurationUnit",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionAmountOvertakingStrategy",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionCreditRounding",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestBalanceOptionDebitRounding",
+    "PostLoyaltyBalanceProgramsPidBalanceDefinitionsRequestUnit",
+    "PostLoyaltyBalanceProgramsPidSubscriptionsCidBalancesResponse",
+    "UpdateBalanceDefinitionRequestBalanceAvailabilityDurationModifier",
+    "UpdateBalanceDefinitionRequestBalanceAvailabilityDurationUnit",
+    "UpdateBalanceDefinitionRequestBalanceOptionAmountOvertakingStrategy",
+    "UpdateBalanceDefinitionRequestBalanceOptionCreditRounding",
+    "UpdateBalanceDefinitionRequestBalanceOptionDebitRounding",
+    "UpdateBalanceDefinitionRequestUnit",
+    "UpdateBalanceLimitRequestConstraintType",
+    "UpdateBalanceLimitRequestDurationUnit",
+    "UpdateBalanceLimitRequestTransactionType",
+]