brevo-python 4.0.1__py3-none-any.whl

brevo/account/raw_client.py

@@ -0,0 +1,341 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.request_options import RequestOptions
+from ..core.unchecked_base_model import construct_type
+from ..errors.bad_request_error import BadRequestError
+from .types.get_account_activity_response import GetAccountActivityResponse
+from .types.get_account_response import GetAccountResponse
+
+
+class RawAccountClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_account(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[GetAccountResponse]:
+        """
+        Retrieves details of your Brevo account.
+
+        **Use this to:**
+        - Get account information (email, name, company, address)
+        - Check plan details (type, credits, expiration)
+        - Get relay information (for transactional emails)
+        - Check Marketing Automation status
+        - View date/time preferences and account settings
+        - Access organization and user identifiers
+
+        **Key information returned:**
+        - Complete account details (organization ID, user ID, company information)
+        - Address and contact information
+        - Plan configurations and credit allocations across different verticals
+        - Marketing Automation settings and tracker key
+        - SMTP relay configuration for transactional emails
+        - Date/time preferences and account settings
+        - Enterprise features availability status
+
+        **Important considerations:**
+        - Provides comprehensive account overview for billing and configuration management
+        - Essential for understanding current plan limitations and feature availability
+        - Marketing Automation key required for advanced automation features
+        - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories
+        - Relay configuration crucial for transactional email setup and deliverability
+        - Date/time preferences affect campaign scheduling and reporting displays
+        - Enterprise status determines access to advanced features and sub-account management
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetAccountResponse]
+            Account information retrieved successfully
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "account",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetAccountResponse,
+                    construct_type(
+                        type_=GetAccountResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_account_activity(
+        self,
+        *,
+        start_date: typing.Optional[str] = None,
+        end_date: typing.Optional[str] = None,
+        email: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[GetAccountActivityResponse]:
+        """
+        Retrieves user activity logs from your organization for security monitoring and audit compliance.
+
+        Use this to:
+        - Monitor user login activities and access patterns
+        - Track account modifications and configuration changes
+        - Generate security audit reports and compliance documentation
+        - Investigate suspicious activities and unauthorized access
+        - Monitor team member actions and account usage
+
+        Key information returned:
+        - Complete user activity details and timestamps
+        - User identification (email, IP address, browser)
+        - Action types and activity descriptions
+        - Security-relevant events and access logs
+        - Historical activity data for audit trails
+
+        Note: Requires Enterprise plan for access to organization activity logs.
+
+        Parameters
+        ----------
+        start_date : typing.Optional[str]
+            Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD)
+            format to filter the activity in your account. Maximum time period that
+            can be selected is one month. Additionally, you can retrieve activity
+            logs from the past 12 months from the date of your search.
+
+        end_date : typing.Optional[str]
+            Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD)
+            format to filter the activity in your account. Maximum time period that
+            can be selected is one month.
+
+        email : typing.Optional[str]
+            Enter the user's email address to filter their activity in the account.
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetAccountActivityResponse]
+            list of user activity logs
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "organization/activities",
+            method="GET",
+            params={
+                "startDate": start_date,
+                "endDate": end_date,
+                "email": email,
+                "limit": limit,
+                "offset": offset,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetAccountActivityResponse,
+                    construct_type(
+                        type_=GetAccountActivityResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawAccountClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_account(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[GetAccountResponse]:
+        """
+        Retrieves details of your Brevo account.
+
+        **Use this to:**
+        - Get account information (email, name, company, address)
+        - Check plan details (type, credits, expiration)
+        - Get relay information (for transactional emails)
+        - Check Marketing Automation status
+        - View date/time preferences and account settings
+        - Access organization and user identifiers
+
+        **Key information returned:**
+        - Complete account details (organization ID, user ID, company information)
+        - Address and contact information
+        - Plan configurations and credit allocations across different verticals
+        - Marketing Automation settings and tracker key
+        - SMTP relay configuration for transactional emails
+        - Date/time preferences and account settings
+        - Enterprise features availability status
+
+        **Important considerations:**
+        - Provides comprehensive account overview for billing and configuration management
+        - Essential for understanding current plan limitations and feature availability
+        - Marketing Automation key required for advanced automation features
+        - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories
+        - Relay configuration crucial for transactional email setup and deliverability
+        - Date/time preferences affect campaign scheduling and reporting displays
+        - Enterprise status determines access to advanced features and sub-account management
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetAccountResponse]
+            Account information retrieved successfully
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "account",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetAccountResponse,
+                    construct_type(
+                        type_=GetAccountResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_account_activity(
+        self,
+        *,
+        start_date: typing.Optional[str] = None,
+        end_date: typing.Optional[str] = None,
+        email: typing.Optional[str] = None,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[GetAccountActivityResponse]:
+        """
+        Retrieves user activity logs from your organization for security monitoring and audit compliance.
+
+        Use this to:
+        - Monitor user login activities and access patterns
+        - Track account modifications and configuration changes
+        - Generate security audit reports and compliance documentation
+        - Investigate suspicious activities and unauthorized access
+        - Monitor team member actions and account usage
+
+        Key information returned:
+        - Complete user activity details and timestamps
+        - User identification (email, IP address, browser)
+        - Action types and activity descriptions
+        - Security-relevant events and access logs
+        - Historical activity data for audit trails
+
+        Note: Requires Enterprise plan for access to organization activity logs.
+
+        Parameters
+        ----------
+        start_date : typing.Optional[str]
+            Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD)
+            format to filter the activity in your account. Maximum time period that
+            can be selected is one month. Additionally, you can retrieve activity
+            logs from the past 12 months from the date of your search.
+
+        end_date : typing.Optional[str]
+            Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD)
+            format to filter the activity in your account. Maximum time period that
+            can be selected is one month.
+
+        email : typing.Optional[str]
+            Enter the user's email address to filter their activity in the account.
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        offset : typing.Optional[int]
+            Index of the first document in the page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetAccountActivityResponse]
+            list of user activity logs
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "organization/activities",
+            method="GET",
+            params={
+                "startDate": start_date,
+                "endDate": end_date,
+                "email": email,
+                "limit": limit,
+                "offset": offset,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetAccountActivityResponse,
+                    construct_type(
+                        type_=GetAccountActivityResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

brevo/account/types/__init__.py

@@ -0,0 +1,77 @@
+# 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 .get_account_activity_response import GetAccountActivityResponse
+    from .get_account_activity_response_logs_item import GetAccountActivityResponseLogsItem
+    from .get_account_response import GetAccountResponse
+    from .get_account_response_address import GetAccountResponseAddress
+    from .get_account_response_date_time_preferences import GetAccountResponseDateTimePreferences
+    from .get_account_response_marketing_automation import GetAccountResponseMarketingAutomation
+    from .get_account_response_plan_item import GetAccountResponsePlanItem
+    from .get_account_response_plan_item_type import GetAccountResponsePlanItemType
+    from .get_account_response_plan_verticals_item import GetAccountResponsePlanVerticalsItem
+    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
+    from .get_account_response_relay import GetAccountResponseRelay
+    from .get_account_response_relay_data import GetAccountResponseRelayData
+_dynamic_imports: typing.Dict[str, str] = {
+    "GetAccountActivityResponse": ".get_account_activity_response",
+    "GetAccountActivityResponseLogsItem": ".get_account_activity_response_logs_item",
+    "GetAccountResponse": ".get_account_response",
+    "GetAccountResponseAddress": ".get_account_response_address",
+    "GetAccountResponseDateTimePreferences": ".get_account_response_date_time_preferences",
+    "GetAccountResponseMarketingAutomation": ".get_account_response_marketing_automation",
+    "GetAccountResponsePlanItem": ".get_account_response_plan_item",
+    "GetAccountResponsePlanItemType": ".get_account_response_plan_item_type",
+    "GetAccountResponsePlanVerticalsItem": ".get_account_response_plan_verticals_item",
+    "GetAccountResponsePlanVerticalsItemPlanCategory": ".get_account_response_plan_verticals_item_plan_category",
+    "GetAccountResponsePlanVerticalsItemStatus": ".get_account_response_plan_verticals_item_status",
+    "GetAccountResponsePlanVerticalsItemUsers": ".get_account_response_plan_verticals_item_users",
+    "GetAccountResponseRelay": ".get_account_response_relay",
+    "GetAccountResponseRelayData": ".get_account_response_relay_data",
+}
+
+
+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__ = [
+    "GetAccountActivityResponse",
+    "GetAccountActivityResponseLogsItem",
+    "GetAccountResponse",
+    "GetAccountResponseAddress",
+    "GetAccountResponseDateTimePreferences",
+    "GetAccountResponseMarketingAutomation",
+    "GetAccountResponsePlanItem",
+    "GetAccountResponsePlanItemType",
+    "GetAccountResponsePlanVerticalsItem",
+    "GetAccountResponsePlanVerticalsItemPlanCategory",
+    "GetAccountResponsePlanVerticalsItemStatus",
+    "GetAccountResponsePlanVerticalsItemUsers",
+    "GetAccountResponseRelay",
+    "GetAccountResponseRelayData",
+]

brevo/account/types/get_account_activity_response.py

@@ -0,0 +1,24 @@
+# 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_activity_response_logs_item import GetAccountActivityResponseLogsItem
+
+
+class GetAccountActivityResponse(UncheckedBaseModel):
+    logs: typing.Optional[typing.List[GetAccountActivityResponseLogsItem]] = pydantic.Field(default=None)
+    """
+    Get user activity logs
+    """
+
+    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_activity_response_logs_item.py

@@ -0,0 +1,45 @@
+# 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 GetAccountActivityResponseLogsItem(UncheckedBaseModel):
+    action: str = pydantic.Field()
+    """
+    Type of activity in the account.
+    """
+
+    date: str = pydantic.Field()
+    """
+    Time of the activity.
+    """
+
+    user_agent: str = pydantic.Field()
+    """
+    Browser details of the user who performed the activity.
+    """
+
+    user_email: str = pydantic.Field()
+    """
+    Email address of the user who performed activity in the
+    account.
+    """
+
+    user_ip: str = pydantic.Field()
+    """
+    IP address of the user who performed activity in the
+    account.
+    """
+
+    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.py

@@ -0,0 +1,85 @@
+# 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_address import GetAccountResponseAddress
+from .get_account_response_date_time_preferences import GetAccountResponseDateTimePreferences
+from .get_account_response_marketing_automation import GetAccountResponseMarketingAutomation
+from .get_account_response_plan_item import GetAccountResponsePlanItem
+from .get_account_response_plan_verticals_item import GetAccountResponsePlanVerticalsItem
+from .get_account_response_relay import GetAccountResponseRelay
+
+
+class GetAccountResponse(UncheckedBaseModel):
+    organization_id: str = pydantic.Field()
+    """
+    Unique identifier for the organization
+    """
+
+    user_id: int = pydantic.Field()
+    """
+    Unique identifier for the user
+    """
+
+    enterprise: bool = pydantic.Field()
+    """
+    Indicates if the account has enterprise features
+    """
+
+    company_name: typing_extensions.Annotated[
+        str, FieldMetadata(alias="companyName"), pydantic.Field(alias="companyName", description="Name of the company")
+    ]
+    email: str = pydantic.Field()
+    """
+    Login Email
+    """
+
+    first_name: typing_extensions.Annotated[
+        str, FieldMetadata(alias="firstName"), pydantic.Field(alias="firstName", description="First Name")
+    ]
+    last_name: typing_extensions.Annotated[
+        str, FieldMetadata(alias="lastName"), pydantic.Field(alias="lastName", description="Last Name")
+    ]
+    address: GetAccountResponseAddress = pydantic.Field()
+    """
+    Address informations
+    """
+
+    date_time_preferences: typing_extensions.Annotated[
+        GetAccountResponseDateTimePreferences,
+        FieldMetadata(alias="dateTimePreferences"),
+        pydantic.Field(alias="dateTimePreferences", description="User's date and time preferences"),
+    ]
+    marketing_automation: typing_extensions.Annotated[
+        typing.Optional[GetAccountResponseMarketingAutomation],
+        FieldMetadata(alias="marketingAutomation"),
+        pydantic.Field(alias="marketingAutomation"),
+    ] = None
+    plan: typing.List[GetAccountResponsePlanItem] = pydantic.Field()
+    """
+    Information about your plans and credits
+    """
+
+    plan_verticals: typing_extensions.Annotated[
+        typing.Optional[typing.List[GetAccountResponsePlanVerticalsItem]],
+        FieldMetadata(alias="planVerticals"),
+        pydantic.Field(alias="planVerticals", description="Detailed information about different plan categories"),
+    ] = None
+    relay: GetAccountResponseRelay = pydantic.Field()
+    """
+    Information about your transactional email account
+    """
+
+    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_address.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 GetAccountResponseAddress(UncheckedBaseModel):
+    """
+    Address informations
+    """
+
+    city: str = pydantic.Field()
+    """
+    City information
+    """
+
+    country: str = pydantic.Field()
+    """
+    Country information
+    """
+
+    street: str = pydantic.Field()
+    """
+    Street information
+    """
+
+    zip_code: typing_extensions.Annotated[
+        str, FieldMetadata(alias="zipCode"), pydantic.Field(alias="zipCode", description="Zip Code information")
+    ]
+
+    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_date_time_preferences.py

@@ -0,0 +1,38 @@
+# 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 GetAccountResponseDateTimePreferences(UncheckedBaseModel):
+    """
+    User's date and time preferences
+    """
+
+    timezone: str = pydantic.Field()
+    """
+    User's timezone setting
+    """
+
+    time_format: typing_extensions.Annotated[
+        str,
+        FieldMetadata(alias="timeFormat"),
+        pydantic.Field(alias="timeFormat", description="Preferred time format (12 or 24 hour)"),
+    ]
+    date_format: typing_extensions.Annotated[
+        str, FieldMetadata(alias="dateFormat"), pydantic.Field(alias="dateFormat", description="Preferred date format")
+    ]
+
+    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_marketing_automation.py

@@ -0,0 +1,29 @@
+# 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 GetAccountResponseMarketingAutomation(UncheckedBaseModel):
+    enabled: bool = pydantic.Field()
+    """
+    Status of Marketing Automation Plateform activation
+    for your account (true=enabled, false=disabled)
+    """
+
+    key: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Marketing Automation Tracker ID
+    """
+
+    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