usebridge-api 0.1.0__py3-none-any.whl

rtaylor_205/notes/client.py

@@ -0,0 +1,471 @@
+# 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 AsyncRawNotesClient, RawNotesClient
+from .types.note_addenda_list_v_1_order_created_at import NoteAddendaListV1OrderCreatedAt
+from .types.note_addenda_list_v_1_response import NoteAddendaListV1Response
+from .types.note_addendum_create_v_1_request_data import NoteAddendumCreateV1RequestData
+from .types.note_addendum_create_v_1_request_signature import NoteAddendumCreateV1RequestSignature
+from .types.note_addendum_create_v_1_response import NoteAddendumCreateV1Response
+from .types.note_create_v_1_request_data import NoteCreateV1RequestData
+from .types.note_create_v_1_request_signature import NoteCreateV1RequestSignature
+from .types.note_create_v_1_response import NoteCreateV1Response
+from .types.note_get_v_1_response import NoteGetV1Response
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class NotesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawNotesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawNotesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawNotesClient
+        """
+        return self._raw_client
+
+    def create_note(
+        self,
+        *,
+        service_id: str,
+        data: NoteCreateV1RequestData,
+        signature: NoteCreateV1RequestSignature,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NoteCreateV1Response:
+        """
+        Parameters
+        ----------
+        service_id : str
+
+        data : NoteCreateV1RequestData
+
+        signature : NoteCreateV1RequestSignature
+
+        external_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteCreateV1Response
+
+        Examples
+        --------
+        import datetime
+
+        from rtaylor_205 import BridgeApiClient
+        from rtaylor_205.notes import (
+            NoteCreateV1RequestData,
+            NoteCreateV1RequestSignature,
+        )
+
+        client = BridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+        client.notes.create_note(
+            service_id="serviceId",
+            data=NoteCreateV1RequestData(),
+            signature=NoteCreateV1RequestSignature(
+                timestamp=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                provider_id="providerId",
+            ),
+        )
+        """
+        _response = self._raw_client.create_note(
+            service_id=service_id,
+            data=data,
+            signature=signature,
+            external_id=external_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_note(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> NoteGetV1Response:
+        """
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteGetV1Response
+
+        Examples
+        --------
+        from rtaylor_205 import BridgeApiClient
+
+        client = BridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+        client.notes.get_note(
+            id="id",
+        )
+        """
+        _response = self._raw_client.get_note(id, request_options=request_options)
+        return _response.data
+
+    def list_note_addenda(
+        self,
+        id: str,
+        *,
+        filter_note_id: typing.Optional[str] = None,
+        order_created_at: typing.Optional[NoteAddendaListV1OrderCreatedAt] = None,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NoteAddendaListV1Response:
+        """
+        Parameters
+        ----------
+        id : str
+
+        filter_note_id : typing.Optional[str]
+            should be JSON-encoded, for example filter.noteId="note_xxx"
+
+        order_created_at : typing.Optional[NoteAddendaListV1OrderCreatedAt]
+
+        page : typing.Optional[int]
+
+        limit : typing.Optional[int]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteAddendaListV1Response
+
+        Examples
+        --------
+        from rtaylor_205 import BridgeApiClient
+
+        client = BridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+        client.notes.list_note_addenda(
+            id="id",
+        )
+        """
+        _response = self._raw_client.list_note_addenda(
+            id,
+            filter_note_id=filter_note_id,
+            order_created_at=order_created_at,
+            page=page,
+            limit=limit,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_note_addendum(
+        self,
+        id: str,
+        *,
+        data: NoteAddendumCreateV1RequestData,
+        signature: NoteAddendumCreateV1RequestSignature,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NoteAddendumCreateV1Response:
+        """
+        Parameters
+        ----------
+        id : str
+
+        data : NoteAddendumCreateV1RequestData
+
+        signature : NoteAddendumCreateV1RequestSignature
+
+        external_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteAddendumCreateV1Response
+
+        Examples
+        --------
+        import datetime
+
+        from rtaylor_205 import BridgeApiClient
+        from rtaylor_205.notes import (
+            NoteAddendumCreateV1RequestData,
+            NoteAddendumCreateV1RequestSignature,
+        )
+
+        client = BridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+        client.notes.create_note_addendum(
+            id="id",
+            data=NoteAddendumCreateV1RequestData(),
+            signature=NoteAddendumCreateV1RequestSignature(
+                timestamp=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                provider_id="providerId",
+            ),
+        )
+        """
+        _response = self._raw_client.create_note_addendum(
+            id, data=data, signature=signature, external_id=external_id, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncNotesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawNotesClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawNotesClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawNotesClient
+        """
+        return self._raw_client
+
+    async def create_note(
+        self,
+        *,
+        service_id: str,
+        data: NoteCreateV1RequestData,
+        signature: NoteCreateV1RequestSignature,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NoteCreateV1Response:
+        """
+        Parameters
+        ----------
+        service_id : str
+
+        data : NoteCreateV1RequestData
+
+        signature : NoteCreateV1RequestSignature
+
+        external_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteCreateV1Response
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from rtaylor_205 import AsyncBridgeApiClient
+        from rtaylor_205.notes import (
+            NoteCreateV1RequestData,
+            NoteCreateV1RequestSignature,
+        )
+
+        client = AsyncBridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.notes.create_note(
+                service_id="serviceId",
+                data=NoteCreateV1RequestData(),
+                signature=NoteCreateV1RequestSignature(
+                    timestamp=datetime.datetime.fromisoformat(
+                        "2024-01-15 09:30:00+00:00",
+                    ),
+                    provider_id="providerId",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_note(
+            service_id=service_id,
+            data=data,
+            signature=signature,
+            external_id=external_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_note(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> NoteGetV1Response:
+        """
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteGetV1Response
+
+        Examples
+        --------
+        import asyncio
+
+        from rtaylor_205 import AsyncBridgeApiClient
+
+        client = AsyncBridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.notes.get_note(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_note(id, request_options=request_options)
+        return _response.data
+
+    async def list_note_addenda(
+        self,
+        id: str,
+        *,
+        filter_note_id: typing.Optional[str] = None,
+        order_created_at: typing.Optional[NoteAddendaListV1OrderCreatedAt] = None,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NoteAddendaListV1Response:
+        """
+        Parameters
+        ----------
+        id : str
+
+        filter_note_id : typing.Optional[str]
+            should be JSON-encoded, for example filter.noteId="note_xxx"
+
+        order_created_at : typing.Optional[NoteAddendaListV1OrderCreatedAt]
+
+        page : typing.Optional[int]
+
+        limit : typing.Optional[int]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteAddendaListV1Response
+
+        Examples
+        --------
+        import asyncio
+
+        from rtaylor_205 import AsyncBridgeApiClient
+
+        client = AsyncBridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.notes.list_note_addenda(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_note_addenda(
+            id,
+            filter_note_id=filter_note_id,
+            order_created_at=order_created_at,
+            page=page,
+            limit=limit,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_note_addendum(
+        self,
+        id: str,
+        *,
+        data: NoteAddendumCreateV1RequestData,
+        signature: NoteAddendumCreateV1RequestSignature,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> NoteAddendumCreateV1Response:
+        """
+        Parameters
+        ----------
+        id : str
+
+        data : NoteAddendumCreateV1RequestData
+
+        signature : NoteAddendumCreateV1RequestSignature
+
+        external_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        NoteAddendumCreateV1Response
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from rtaylor_205 import AsyncBridgeApiClient
+        from rtaylor_205.notes import (
+            NoteAddendumCreateV1RequestData,
+            NoteAddendumCreateV1RequestSignature,
+        )
+
+        client = AsyncBridgeApiClient(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.notes.create_note_addendum(
+                id="id",
+                data=NoteAddendumCreateV1RequestData(),
+                signature=NoteAddendumCreateV1RequestSignature(
+                    timestamp=datetime.datetime.fromisoformat(
+                        "2024-01-15 09:30:00+00:00",
+                    ),
+                    provider_id="providerId",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_note_addendum(
+            id, data=data, signature=signature, external_id=external_id, request_options=request_options
+        )
+        return _response.data