brevo-python 4.0.1__py3-none-any.whl

brevo/process/__init__.py

@@ -0,0 +1,79 @@
+# 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 (
+        GetProcessResponse,
+        GetProcessResponseInfo,
+        GetProcessResponseInfoExport,
+        GetProcessResponseInfoImport,
+        GetProcessResponseName,
+        GetProcessResponseStatus,
+        GetProcessesRequestSort,
+        GetProcessesResponse,
+        GetProcessesResponseProcessesItem,
+        GetProcessesResponseProcessesItemInfo,
+        GetProcessesResponseProcessesItemInfoExport,
+        GetProcessesResponseProcessesItemInfoImport,
+        GetProcessesResponseProcessesItemName,
+        GetProcessesResponseProcessesItemStatus,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "GetProcessResponse": ".types",
+    "GetProcessResponseInfo": ".types",
+    "GetProcessResponseInfoExport": ".types",
+    "GetProcessResponseInfoImport": ".types",
+    "GetProcessResponseName": ".types",
+    "GetProcessResponseStatus": ".types",
+    "GetProcessesRequestSort": ".types",
+    "GetProcessesResponse": ".types",
+    "GetProcessesResponseProcessesItem": ".types",
+    "GetProcessesResponseProcessesItemInfo": ".types",
+    "GetProcessesResponseProcessesItemInfoExport": ".types",
+    "GetProcessesResponseProcessesItemInfoImport": ".types",
+    "GetProcessesResponseProcessesItemName": ".types",
+    "GetProcessesResponseProcessesItemStatus": ".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__ = [
+    "GetProcessResponse",
+    "GetProcessResponseInfo",
+    "GetProcessResponseInfoExport",
+    "GetProcessResponseInfoImport",
+    "GetProcessResponseName",
+    "GetProcessResponseStatus",
+    "GetProcessesRequestSort",
+    "GetProcessesResponse",
+    "GetProcessesResponseProcessesItem",
+    "GetProcessesResponseProcessesItemInfo",
+    "GetProcessesResponseProcessesItemInfoExport",
+    "GetProcessesResponseProcessesItemInfoImport",
+    "GetProcessesResponseProcessesItemName",
+    "GetProcessesResponseProcessesItemStatus",
+]

brevo/process/client.py

@@ -0,0 +1,304 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawProcessClient, RawProcessClient
+from .types.get_process_response import GetProcessResponse
+from .types.get_processes_request_sort import GetProcessesRequestSort
+from .types.get_processes_response import GetProcessesResponse
+
+
+class ProcessClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawProcessClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawProcessClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawProcessClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        GetProcessesResponse
+            Background processes retrieved successfully
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.process.get_processes()
+        """
+        _response = self._raw_client.get_processes(
+            limit=limit, offset=offset, sort=sort, request_options=request_options
+        )
+        return _response.data
+
+    def get_process(
+        self, process_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> 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
+        -------
+        GetProcessResponse
+            Process information retrieved successfully
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.process.get_process(
+            process_id=1000000,
+        )
+        """
+        _response = self._raw_client.get_process(process_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncProcessClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawProcessClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawProcessClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawProcessClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        GetProcessesResponse
+            Background processes retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.process.get_processes()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_processes(
+            limit=limit, offset=offset, sort=sort, request_options=request_options
+        )
+        return _response.data
+
+    async def get_process(
+        self, process_id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> 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
+        -------
+        GetProcessResponse
+            Process information retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.process.get_process(
+                process_id=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_process(process_id, request_options=request_options)
+        return _response.data