brevo-python 4.0.1__py3-none-any.whl

brevo/notes/raw_client.py

@@ -0,0 +1,766 @@
+# 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 ..errors.unsupported_media_type_error import UnsupportedMediaTypeError
+from ..types.error_model import ErrorModel
+from ..types.note import Note
+from .types.get_crm_notes_request_entity import GetCrmNotesRequestEntity
+from .types.get_crm_notes_request_sort import GetCrmNotesRequestSort
+from .types.post_crm_notes_response import PostCrmNotesResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawNotesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_all_notes(
+        self,
+        *,
+        entity: typing.Optional[GetCrmNotesRequestEntity] = None,
+        entity_ids: typing.Optional[str] = None,
+        date_from: typing.Optional[int] = None,
+        date_to: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        sort: typing.Optional[GetCrmNotesRequestSort] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[typing.List[Note]]:
+        """
+        Parameters
+        ----------
+        entity : typing.Optional[GetCrmNotesRequestEntity]
+            Filter by note entity type
+
+        entity_ids : typing.Optional[str]
+            Filter by note entity IDs
+
+        date_from : typing.Optional[int]
+            dateFrom to date range filter type (timestamp in milliseconds)
+
+        date_to : typing.Optional[int]
+            dateTo to date range filter type (timestamp in milliseconds)
+
+        offset : typing.Optional[int]
+            Index of the first document of the page
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        sort : typing.Optional[GetCrmNotesRequestSort]
+            Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.List[Note]]
+            Returns notes list with filters
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "crm/notes",
+            method="GET",
+            params={
+                "entity": entity,
+                "entityIds": entity_ids,
+                "dateFrom": date_from,
+                "dateTo": date_to,
+                "offset": offset,
+                "limit": limit,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[Note],
+                    construct_type(
+                        type_=typing.List[Note],  # 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 create_a_note(
+        self,
+        *,
+        text: str,
+        company_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        deal_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PostCrmNotesResponse]:
+        """
+        Parameters
+        ----------
+        text : str
+            Text content of a note
+
+        company_ids : typing.Optional[typing.Sequence[str]]
+            Company Ids linked to a note
+
+        contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact Ids linked to a note
+
+        deal_ids : typing.Optional[typing.Sequence[str]]
+            Deal Ids linked to a note
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PostCrmNotesResponse]
+            Created new note
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "crm/notes",
+            method="POST",
+            json={
+                "companyIds": company_ids,
+                "contactIds": contact_ids,
+                "dealIds": deal_ids,
+                "text": text,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PostCrmNotesResponse,
+                    construct_type(
+                        type_=PostCrmNotesResponse,  # 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 == 415:
+                raise UnsupportedMediaTypeError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorModel,
+                        construct_type(
+                            type_=ErrorModel,  # 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_a_note(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Note]:
+        """
+        Parameters
+        ----------
+        id : str
+            Note ID to get
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[Note]
+            Returns the Note by id
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"crm/notes/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Note,
+                    construct_type(
+                        type_=Note,  # 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)
+
+    def delete_a_note(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]:
+        """
+        Parameters
+        ----------
+        id : str
+            Note ID to delete
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[None]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"crm/notes/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return HttpResponse(response=_response, data=None)
+            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)
+
+    def update_a_note(
+        self,
+        id: str,
+        *,
+        text: str,
+        company_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        deal_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[None]:
+        """
+        Parameters
+        ----------
+        id : str
+            Note ID to update
+
+        text : str
+            Text content of a note
+
+        company_ids : typing.Optional[typing.Sequence[str]]
+            Company Ids linked to a note
+
+        contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact Ids linked to a note
+
+        deal_ids : typing.Optional[typing.Sequence[str]]
+            Deal Ids linked to a note
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[None]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"crm/notes/{jsonable_encoder(id)}",
+            method="PATCH",
+            json={
+                "companyIds": company_ids,
+                "contactIds": contact_ids,
+                "dealIds": deal_ids,
+                "text": text,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return HttpResponse(response=_response, data=None)
+            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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 415:
+                raise UnsupportedMediaTypeError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorModel,
+                        construct_type(
+                            type_=ErrorModel,  # 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 AsyncRawNotesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_all_notes(
+        self,
+        *,
+        entity: typing.Optional[GetCrmNotesRequestEntity] = None,
+        entity_ids: typing.Optional[str] = None,
+        date_from: typing.Optional[int] = None,
+        date_to: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        sort: typing.Optional[GetCrmNotesRequestSort] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[typing.List[Note]]:
+        """
+        Parameters
+        ----------
+        entity : typing.Optional[GetCrmNotesRequestEntity]
+            Filter by note entity type
+
+        entity_ids : typing.Optional[str]
+            Filter by note entity IDs
+
+        date_from : typing.Optional[int]
+            dateFrom to date range filter type (timestamp in milliseconds)
+
+        date_to : typing.Optional[int]
+            dateTo to date range filter type (timestamp in milliseconds)
+
+        offset : typing.Optional[int]
+            Index of the first document of the page
+
+        limit : typing.Optional[int]
+            Number of documents per page
+
+        sort : typing.Optional[GetCrmNotesRequestSort]
+            Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.List[Note]]
+            Returns notes list with filters
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "crm/notes",
+            method="GET",
+            params={
+                "entity": entity,
+                "entityIds": entity_ids,
+                "dateFrom": date_from,
+                "dateTo": date_to,
+                "offset": offset,
+                "limit": limit,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[Note],
+                    construct_type(
+                        type_=typing.List[Note],  # 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 create_a_note(
+        self,
+        *,
+        text: str,
+        company_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        deal_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PostCrmNotesResponse]:
+        """
+        Parameters
+        ----------
+        text : str
+            Text content of a note
+
+        company_ids : typing.Optional[typing.Sequence[str]]
+            Company Ids linked to a note
+
+        contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact Ids linked to a note
+
+        deal_ids : typing.Optional[typing.Sequence[str]]
+            Deal Ids linked to a note
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PostCrmNotesResponse]
+            Created new note
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "crm/notes",
+            method="POST",
+            json={
+                "companyIds": company_ids,
+                "contactIds": contact_ids,
+                "dealIds": deal_ids,
+                "text": text,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PostCrmNotesResponse,
+                    construct_type(
+                        type_=PostCrmNotesResponse,  # 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 == 415:
+                raise UnsupportedMediaTypeError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorModel,
+                        construct_type(
+                            type_=ErrorModel,  # 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_a_note(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[Note]:
+        """
+        Parameters
+        ----------
+        id : str
+            Note ID to get
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[Note]
+            Returns the Note by id
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"crm/notes/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    Note,
+                    construct_type(
+                        type_=Note,  # 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)
+
+    async def delete_a_note(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[None]:
+        """
+        Parameters
+        ----------
+        id : str
+            Note ID to delete
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[None]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"crm/notes/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return AsyncHttpResponse(response=_response, data=None)
+            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)
+
+    async def update_a_note(
+        self,
+        id: str,
+        *,
+        text: str,
+        company_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        contact_ids: typing.Optional[typing.Sequence[int]] = OMIT,
+        deal_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[None]:
+        """
+        Parameters
+        ----------
+        id : str
+            Note ID to update
+
+        text : str
+            Text content of a note
+
+        company_ids : typing.Optional[typing.Sequence[str]]
+            Company Ids linked to a note
+
+        contact_ids : typing.Optional[typing.Sequence[int]]
+            Contact Ids linked to a note
+
+        deal_ids : typing.Optional[typing.Sequence[str]]
+            Deal Ids linked to a note
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[None]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"crm/notes/{jsonable_encoder(id)}",
+            method="PATCH",
+            json={
+                "companyIds": company_ids,
+                "contactIds": contact_ids,
+                "dealIds": deal_ids,
+                "text": text,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return AsyncHttpResponse(response=_response, data=None)
+            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(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 415:
+                raise UnsupportedMediaTypeError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorModel,
+                        construct_type(
+                            type_=ErrorModel,  # 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)