brevo-python 4.0.1__py3-none-any.whl

brevo/process/raw_client.py

@@ -0,0 +1,372 @@
+# 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.jsonable_encoder import jsonable_encoder
+from ..core.request_options import RequestOptions
+from ..core.unchecked_base_model import construct_type
+from ..errors.bad_request_error import BadRequestError
+from ..errors.not_found_error import NotFoundError
+from .types.get_process_response import GetProcessResponse
+from .types.get_processes_request_sort import GetProcessesRequestSort
+from .types.get_processes_response import GetProcessesResponse
+
+
+class RawProcessClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_processes(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetProcessesRequestSort] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[GetProcessesResponse]:
+        """
+        Retrieves a list of background processes from your Brevo account with filtering and pagination.
+
+        **Use this to:**
+        - Monitor background process activity and status
+        - Track long-running operations and tasks
+        - Find process IDs for detailed status checking
+        - Review process history and performance
+        - Identify failed or stuck processes for troubleshooting
+
+        **Key information returned:**
+        - Process details (ID, name, type, status)
+        - Process creation and completion timestamps
+        - Process progress and completion status
+        - Error information for failed processes
+        - Process result data and download links
+
+        **Important considerations:**
+        - Background processes handle long-running operations like imports and exports
+        - Process status indicates current state (queued, processing, completed, failed, cancelled)
+        - Export processes provide download URLs when completed
+        - Failed processes include error messages for troubleshooting
+        - Use pagination for accounts with many historical processes
+        - Sort options available for creation order (ascending or descending)
+        - Different process types handle specific operations (imports, exports, calculations)
+
+        Parameters
+        ----------
+        limit : typing.Optional[int]
+            Number limitation for the result returned
+
+        offset : typing.Optional[int]
+            Beginning point in the list to retrieve from.
+
+        sort : typing.Optional[GetProcessesRequestSort]
+            Sort the results in the ascending/descending order of record creation.
+            Default order is **descending** if `sort` is not passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetProcessesResponse]
+            Background processes retrieved successfully
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "processes",
+            method="GET",
+            params={
+                "limit": limit,
+                "offset": offset,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetProcessesResponse,
+                    construct_type(
+                        type_=GetProcessesResponse,  # 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)
+
+    def get_process(
+        self, process_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[GetProcessResponse]:
+        """
+        Retrieves detailed information about a specific background process.
+
+        **Use this to:**
+        - Get detailed status of a specific process
+        - Monitor process progress and completion
+        - Download results from completed export processes
+        - Check error details for failed processes
+        - Track process execution times
+
+        **Key information returned:**
+        - Complete process details and status
+        - Import/export statistics and results
+        - Error information for troubleshooting
+        - Download URLs for export processes
+        - Process timing and performance data
+
+        **Important considerations:**
+        - Process ID must exist in your account
+        - Completed processes provide detailed statistics and results
+        - Export processes include download URLs when successful
+        - Failed processes contain error messages for debugging
+        - Timing information helps with performance analysis
+        - Different process types return different result structures
+
+        Parameters
+        ----------
+        process_id : int
+            Id of the process
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetProcessResponse]
+            Process information retrieved successfully
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"processes/{jsonable_encoder(process_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetProcessResponse,
+                    construct_type(
+                        type_=GetProcessResponse,  # 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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    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 AsyncRawProcessClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_processes(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetProcessesRequestSort] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[GetProcessesResponse]:
+        """
+        Retrieves a list of background processes from your Brevo account with filtering and pagination.
+
+        **Use this to:**
+        - Monitor background process activity and status
+        - Track long-running operations and tasks
+        - Find process IDs for detailed status checking
+        - Review process history and performance
+        - Identify failed or stuck processes for troubleshooting
+
+        **Key information returned:**
+        - Process details (ID, name, type, status)
+        - Process creation and completion timestamps
+        - Process progress and completion status
+        - Error information for failed processes
+        - Process result data and download links
+
+        **Important considerations:**
+        - Background processes handle long-running operations like imports and exports
+        - Process status indicates current state (queued, processing, completed, failed, cancelled)
+        - Export processes provide download URLs when completed
+        - Failed processes include error messages for troubleshooting
+        - Use pagination for accounts with many historical processes
+        - Sort options available for creation order (ascending or descending)
+        - Different process types handle specific operations (imports, exports, calculations)
+
+        Parameters
+        ----------
+        limit : typing.Optional[int]
+            Number limitation for the result returned
+
+        offset : typing.Optional[int]
+            Beginning point in the list to retrieve from.
+
+        sort : typing.Optional[GetProcessesRequestSort]
+            Sort the results in the ascending/descending order of record creation.
+            Default order is **descending** if `sort` is not passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetProcessesResponse]
+            Background processes retrieved successfully
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "processes",
+            method="GET",
+            params={
+                "limit": limit,
+                "offset": offset,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetProcessesResponse,
+                    construct_type(
+                        type_=GetProcessesResponse,  # 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)
+
+    async def get_process(
+        self, process_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[GetProcessResponse]:
+        """
+        Retrieves detailed information about a specific background process.
+
+        **Use this to:**
+        - Get detailed status of a specific process
+        - Monitor process progress and completion
+        - Download results from completed export processes
+        - Check error details for failed processes
+        - Track process execution times
+
+        **Key information returned:**
+        - Complete process details and status
+        - Import/export statistics and results
+        - Error information for troubleshooting
+        - Download URLs for export processes
+        - Process timing and performance data
+
+        **Important considerations:**
+        - Process ID must exist in your account
+        - Completed processes provide detailed statistics and results
+        - Export processes include download URLs when successful
+        - Failed processes contain error messages for debugging
+        - Timing information helps with performance analysis
+        - Different process types return different result structures
+
+        Parameters
+        ----------
+        process_id : int
+            Id of the process
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetProcessResponse]
+            Process information retrieved successfully
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"processes/{jsonable_encoder(process_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetProcessResponse,
+                    construct_type(
+                        type_=GetProcessResponse,  # 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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    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/process/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_process_response import GetProcessResponse
+    from .get_process_response_info import GetProcessResponseInfo
+    from .get_process_response_info_export import GetProcessResponseInfoExport
+    from .get_process_response_info_import import GetProcessResponseInfoImport
+    from .get_process_response_name import GetProcessResponseName
+    from .get_process_response_status import GetProcessResponseStatus
+    from .get_processes_request_sort import GetProcessesRequestSort
+    from .get_processes_response import GetProcessesResponse
+    from .get_processes_response_processes_item import GetProcessesResponseProcessesItem
+    from .get_processes_response_processes_item_info import GetProcessesResponseProcessesItemInfo
+    from .get_processes_response_processes_item_info_export import GetProcessesResponseProcessesItemInfoExport
+    from .get_processes_response_processes_item_info_import import GetProcessesResponseProcessesItemInfoImport
+    from .get_processes_response_processes_item_name import GetProcessesResponseProcessesItemName
+    from .get_processes_response_processes_item_status import GetProcessesResponseProcessesItemStatus
+_dynamic_imports: typing.Dict[str, str] = {
+    "GetProcessResponse": ".get_process_response",
+    "GetProcessResponseInfo": ".get_process_response_info",
+    "GetProcessResponseInfoExport": ".get_process_response_info_export",
+    "GetProcessResponseInfoImport": ".get_process_response_info_import",
+    "GetProcessResponseName": ".get_process_response_name",
+    "GetProcessResponseStatus": ".get_process_response_status",
+    "GetProcessesRequestSort": ".get_processes_request_sort",
+    "GetProcessesResponse": ".get_processes_response",
+    "GetProcessesResponseProcessesItem": ".get_processes_response_processes_item",
+    "GetProcessesResponseProcessesItemInfo": ".get_processes_response_processes_item_info",
+    "GetProcessesResponseProcessesItemInfoExport": ".get_processes_response_processes_item_info_export",
+    "GetProcessesResponseProcessesItemInfoImport": ".get_processes_response_processes_item_info_import",
+    "GetProcessesResponseProcessesItemName": ".get_processes_response_processes_item_name",
+    "GetProcessesResponseProcessesItemStatus": ".get_processes_response_processes_item_status",
+}
+
+
+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__ = [
+    "GetProcessResponse",
+    "GetProcessResponseInfo",
+    "GetProcessResponseInfoExport",
+    "GetProcessResponseInfoImport",
+    "GetProcessResponseName",
+    "GetProcessResponseStatus",
+    "GetProcessesRequestSort",
+    "GetProcessesResponse",
+    "GetProcessesResponseProcessesItem",
+    "GetProcessesResponseProcessesItemInfo",
+    "GetProcessesResponseProcessesItemInfoExport",
+    "GetProcessesResponseProcessesItemInfoImport",
+    "GetProcessesResponseProcessesItemName",
+    "GetProcessesResponseProcessesItemStatus",
+]

brevo/process/types/get_process_response.py

@@ -0,0 +1,62 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+from .get_process_response_info import GetProcessResponseInfo
+from .get_process_response_name import GetProcessResponseName
+from .get_process_response_status import GetProcessResponseStatus
+
+
+class GetProcessResponse(UncheckedBaseModel):
+    id: int = pydantic.Field()
+    """
+    Unique identifier of the process
+    """
+
+    name: GetProcessResponseName = pydantic.Field()
+    """
+    Name/type of the process
+    """
+
+    status: GetProcessResponseStatus = pydantic.Field()
+    """
+    Current status of the process
+    """
+
+    info: typing.Optional[GetProcessResponseInfo] = pydantic.Field(default=None)
+    """
+    Additional process information (for completed processes)
+    """
+
+    export_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Download URL for completed export processes
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message for failed processes
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Process creation timestamp
+    """
+
+    completed_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Process completion timestamp
+    """
+
+    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/process/types/get_process_response_info.py

@@ -0,0 +1,36 @@
+# 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_process_response_info_export import GetProcessResponseInfoExport
+from .get_process_response_info_import import GetProcessResponseInfoImport
+
+
+class GetProcessResponseInfo(UncheckedBaseModel):
+    """
+    Additional process information (for completed processes)
+    """
+
+    import_: typing_extensions.Annotated[
+        typing.Optional[GetProcessResponseInfoImport],
+        FieldMetadata(alias="import"),
+        pydantic.Field(alias="import", description="Import process details"),
+    ] = None
+    export: typing.Optional[GetProcessResponseInfoExport] = pydantic.Field(default=None)
+    """
+    Export process details
+    """
+
+    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/process/types/get_process_response_info_export.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 GetProcessResponseInfoExport(UncheckedBaseModel):
+    """
+    Export process details
+    """
+
+    total_records: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of exported records
+    """
+
+    file_size: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Size of exported file in bytes
+    """
+
+    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/process/types/get_process_response_info_import.py

@@ -0,0 +1,57 @@
+# 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 GetProcessResponseInfoImport(UncheckedBaseModel):
+    """
+    Import process details
+    """
+
+    invalid_emails: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of invalid email addresses
+    """
+
+    duplicate_contact_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of duplicate contact IDs
+    """
+
+    duplicate_ext_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of duplicate external IDs
+    """
+
+    duplicate_email_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of duplicate email IDs
+    """
+
+    duplicate_phone_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of duplicate phone numbers
+    """
+
+    duplicate_whatsapp_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of duplicate WhatsApp numbers
+    """
+
+    duplicate_landline_number_id: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of duplicate landline numbers
+    """
+
+    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/process/types/get_process_response_name.py

@@ -0,0 +1,16 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetProcessResponseName = typing.Union[
+    typing.Literal[
+        "IMPORTUSER",
+        "SEARCH_EXPORT_USERS",
+        "TRANS-CALC",
+        "TRANS-GLOBAL-CALC",
+        "CAMPAIGN_PROCESSING",
+        "LIST_EXPORT",
+        "CONTACT_EXPORT",
+    ],
+    typing.Any,
+]

brevo/process/types/get_process_response_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetProcessResponseStatus = typing.Union[
+    typing.Literal["queued", "processing", "completed", "failed", "cancelled"], typing.Any
+]

brevo/process/types/get_processes_request_sort.py

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