brevo-python 4.0.1__py3-none-any.whl

brevo/custom_objects/client.py

@@ -0,0 +1,437 @@
+# 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 AsyncRawCustomObjectsClient, RawCustomObjectsClient
+from .types.batch_delete_object_records_request_identifiers import BatchDeleteObjectRecordsRequestIdentifiers
+from .types.batch_delete_object_records_response import BatchDeleteObjectRecordsResponse
+from .types.getrecords_request_association import GetrecordsRequestAssociation
+from .types.getrecords_request_sort import GetrecordsRequestSort
+from .types.getrecords_response import GetrecordsResponse
+from .types.upsertrecords_request_records_item import UpsertrecordsRequestRecordsItem
+from .types.upsertrecords_response import UpsertrecordsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CustomObjectsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCustomObjectsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCustomObjectsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCustomObjectsClient
+        """
+        return self._raw_client
+
+    def upsertrecords(
+        self,
+        object_type: str,
+        *,
+        records: typing.Sequence[UpsertrecordsRequestRecordsItem],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpsertrecordsResponse:
+        """
+        <Note title="Enterprise access only">
+        Custom objects are only available to Enterprise plans.
+
+        This feature is in beta. These are subject to change.
+        </Note>
+
+        This API allows bulk upsert of object records in a single request. Each object record may include
+          - Attributes
+          - Identifiers
+          - Associations
+        **Response:**
+          The API processes the request asynchronously and returns a processId that you can use to track the background process status.
+        **API and Schema Limitation:**
+          - Size:
+              - Max 1000 objects records per request
+              - Max request body size: 1 MB
+          - Max 500 attributes defined per object record upsert request
+            - This is coherent with schema limitation: an object cannot have more than 500 attributes.
+            - Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
+          - Max 10 associations defined per object record upsert request
+            - This is coherent with schema limitation: an object cannot have more than 10 associations with other objects. and each object record can be linked to max 10 other records.
+        **Errors:**
+            - Make sure both object records exist before associating them, else the API will return an error.
+            - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
+
+        Parameters
+        ----------
+        object_type : str
+            object type for the attribute
+
+        records : typing.Sequence[UpsertrecordsRequestRecordsItem]
+            List of object records to be upsert. Each record can have attributes, identifiers, and associations.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpsertrecordsResponse
+            Batch request accepted for processing of upsert object records.
+
+        Examples
+        --------
+        from brevo import Brevo
+        from brevo.custom_objects import UpsertrecordsRequestRecordsItem
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.custom_objects.upsertrecords(
+            object_type="vehicle",
+            records=[UpsertrecordsRequestRecordsItem()],
+        )
+        """
+        _response = self._raw_client.upsertrecords(object_type, records=records, request_options=request_options)
+        return _response.data
+
+    def getrecords(
+        self,
+        object_type: str,
+        *,
+        limit: int,
+        page_num: int,
+        sort: typing.Optional[GetrecordsRequestSort] = None,
+        association: typing.Optional[GetrecordsRequestAssociation] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetrecordsResponse:
+        """
+        <Note title="Enterprise access only">
+        Custom objects are only available to Enterprise plans.
+
+        This feature is in beta. These are subject to change.
+        </Note>
+
+        This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. **Note**: Contact as object type is not supported in this endpoint.
+
+        Parameters
+        ----------
+        object_type : str
+            object type for the attribute
+
+        limit : int
+            Number of records returned per page
+
+        page_num : int
+            Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer.
+
+        sort : typing.Optional[GetrecordsRequestSort]
+            Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided.
+
+        association : typing.Optional[GetrecordsRequestAssociation]
+            Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetrecordsResponse
+            A list of object records for an object type. If association param is set true it will return 5 associated records per association for an object type.
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.custom_objects.getrecords(
+            object_type="vehicle",
+            limit=1000000,
+            page_num=1000000,
+        )
+        """
+        _response = self._raw_client.getrecords(
+            object_type,
+            limit=limit,
+            page_num=page_num,
+            sort=sort,
+            association=association,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def batch_delete_object_records(
+        self,
+        object_type: str,
+        *,
+        identifiers: typing.Optional[BatchDeleteObjectRecordsRequestIdentifiers] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> BatchDeleteObjectRecordsResponse:
+        """
+        Use this endpoint to delete multiple object records of the same object-type in one request.
+        The request is accepted and processed asynchronously.   You can track the status of the deletion process using the returned **processId**.
+        **API and Schema Limitations:** - Each request can contain up to **1000** object record identifiers   - If more records must be deleted → send multiple batch requests
+
+        Parameters
+        ----------
+        object_type : str
+            Object type for the records to delete
+
+        identifiers : typing.Optional[BatchDeleteObjectRecordsRequestIdentifiers]
+            One of the below must be provided
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BatchDeleteObjectRecordsResponse
+            Batch request accepted for deletion - process started
+
+        Examples
+        --------
+        from brevo import Brevo
+        from brevo.custom_objects import (
+            BatchDeleteObjectRecordsRequestIdentifiersExtIds,
+        )
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.custom_objects.batch_delete_object_records(
+            object_type="vehicle",
+            identifiers=BatchDeleteObjectRecordsRequestIdentifiersExtIds(
+                ext_ids=["ext-001", "ext-002"],
+            ),
+        )
+        """
+        _response = self._raw_client.batch_delete_object_records(
+            object_type, identifiers=identifiers, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncCustomObjectsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCustomObjectsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCustomObjectsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCustomObjectsClient
+        """
+        return self._raw_client
+
+    async def upsertrecords(
+        self,
+        object_type: str,
+        *,
+        records: typing.Sequence[UpsertrecordsRequestRecordsItem],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpsertrecordsResponse:
+        """
+        <Note title="Enterprise access only">
+        Custom objects are only available to Enterprise plans.
+
+        This feature is in beta. These are subject to change.
+        </Note>
+
+        This API allows bulk upsert of object records in a single request. Each object record may include
+          - Attributes
+          - Identifiers
+          - Associations
+        **Response:**
+          The API processes the request asynchronously and returns a processId that you can use to track the background process status.
+        **API and Schema Limitation:**
+          - Size:
+              - Max 1000 objects records per request
+              - Max request body size: 1 MB
+          - Max 500 attributes defined per object record upsert request
+            - This is coherent with schema limitation: an object cannot have more than 500 attributes.
+            - Worth noting: Nothing happens If an attribute is mentioned in the request, but was not previously defined for the object schema (no error, no attribute creation)
+          - Max 10 associations defined per object record upsert request
+            - This is coherent with schema limitation: an object cannot have more than 10 associations with other objects. and each object record can be linked to max 10 other records.
+        **Errors:**
+            - Make sure both object records exist before associating them, else the API will return an error.
+            - This route does not create objects. The object where the object records are upserted by this API must be created already else the API will return an error "invalid object type".
+
+        Parameters
+        ----------
+        object_type : str
+            object type for the attribute
+
+        records : typing.Sequence[UpsertrecordsRequestRecordsItem]
+            List of object records to be upsert. Each record can have attributes, identifiers, and associations.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpsertrecordsResponse
+            Batch request accepted for processing of upsert object records.
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+        from brevo.custom_objects import UpsertrecordsRequestRecordsItem
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.custom_objects.upsertrecords(
+                object_type="vehicle",
+                records=[UpsertrecordsRequestRecordsItem()],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.upsertrecords(object_type, records=records, request_options=request_options)
+        return _response.data
+
+    async def getrecords(
+        self,
+        object_type: str,
+        *,
+        limit: int,
+        page_num: int,
+        sort: typing.Optional[GetrecordsRequestSort] = None,
+        association: typing.Optional[GetrecordsRequestAssociation] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetrecordsResponse:
+        """
+        <Note title="Enterprise access only">
+        Custom objects are only available to Enterprise plans.
+
+        This feature is in beta. These are subject to change.
+        </Note>
+
+        This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. **Note**: Contact as object type is not supported in this endpoint.
+
+        Parameters
+        ----------
+        object_type : str
+            object type for the attribute
+
+        limit : int
+            Number of records returned per page
+
+        page_num : int
+            Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer.
+
+        sort : typing.Optional[GetrecordsRequestSort]
+            Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided.
+
+        association : typing.Optional[GetrecordsRequestAssociation]
+            Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetrecordsResponse
+            A list of object records for an object type. If association param is set true it will return 5 associated records per association for an object type.
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.custom_objects.getrecords(
+                object_type="vehicle",
+                limit=1000000,
+                page_num=1000000,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.getrecords(
+            object_type,
+            limit=limit,
+            page_num=page_num,
+            sort=sort,
+            association=association,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def batch_delete_object_records(
+        self,
+        object_type: str,
+        *,
+        identifiers: typing.Optional[BatchDeleteObjectRecordsRequestIdentifiers] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> BatchDeleteObjectRecordsResponse:
+        """
+        Use this endpoint to delete multiple object records of the same object-type in one request.
+        The request is accepted and processed asynchronously.   You can track the status of the deletion process using the returned **processId**.
+        **API and Schema Limitations:** - Each request can contain up to **1000** object record identifiers   - If more records must be deleted → send multiple batch requests
+
+        Parameters
+        ----------
+        object_type : str
+            Object type for the records to delete
+
+        identifiers : typing.Optional[BatchDeleteObjectRecordsRequestIdentifiers]
+            One of the below must be provided
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BatchDeleteObjectRecordsResponse
+            Batch request accepted for deletion - process started
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+        from brevo.custom_objects import (
+            BatchDeleteObjectRecordsRequestIdentifiersExtIds,
+        )
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.custom_objects.batch_delete_object_records(
+                object_type="vehicle",
+                identifiers=BatchDeleteObjectRecordsRequestIdentifiersExtIds(
+                    ext_ids=["ext-001", "ext-002"],
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.batch_delete_object_records(
+            object_type, identifiers=identifiers, request_options=request_options
+        )
+        return _response.data