paid-python 0.4.1a0__py3-none-any.whl → 0.5.0__py3-none-any.whl

paid/products/client.py

@@ -0,0 +1,788 @@
+# 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 ..types.agent_attribute import AgentAttribute
+from ..types.product import Product
+from ..types.product_update_type import ProductUpdateType
+from .raw_client import AsyncRawProductsClient, RawProductsClient
+from .types.product_create_type import ProductCreateType
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class ProductsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawProductsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawProductsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawProductsClient
+        """
+        return self._raw_client
+
+    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Product]:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Product]
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.list()
+        """
+        _response = self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    def create(
+        self,
+        *,
+        name: str,
+        description: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        type: typing.Optional[ProductCreateType] = OMIT,
+        active: typing.Optional[bool] = OMIT,
+        product_code: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        name : str
+
+        description : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        type : typing.Optional[ProductCreateType]
+
+        active : typing.Optional[bool]
+
+        product_code : typing.Optional[str]
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.create(
+            name="Acme Product",
+            description="Acme Product does amazing things.",
+            external_id="acme-product",
+            type="product",
+        )
+        """
+        _response = self._raw_client.create(
+            name=name,
+            description=description,
+            external_id=external_id,
+            type=type,
+            active=active,
+            product_code=product_code,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get(self, product_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Product:
+        """
+        Parameters
+        ----------
+        product_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.get(
+            product_id="productId",
+        )
+        """
+        _response = self._raw_client.get(product_id, request_options=request_options)
+        return _response.data
+
+    def update(
+        self,
+        product_id: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        type: typing.Optional[ProductUpdateType] = OMIT,
+        active: typing.Optional[bool] = OMIT,
+        product_code: typing.Optional[str] = OMIT,
+        product_attribute: typing.Optional[typing.Sequence[AgentAttribute]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        product_id : str
+
+        name : typing.Optional[str]
+
+        description : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        type : typing.Optional[ProductUpdateType]
+
+        active : typing.Optional[bool]
+
+        product_code : typing.Optional[str]
+
+        product_attribute : typing.Optional[typing.Sequence[AgentAttribute]]
+            Pricing attributes for this product
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.update(
+            product_id="productId",
+        )
+        """
+        _response = self._raw_client.update(
+            product_id,
+            name=name,
+            description=description,
+            external_id=external_id,
+            type=type,
+            active=active,
+            product_code=product_code,
+            product_attribute=product_attribute,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete(self, product_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Parameters
+        ----------
+        product_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.delete(
+            product_id="productId",
+        )
+        """
+        _response = self._raw_client.delete(product_id, request_options=request_options)
+        return _response.data
+
+    def get_by_external_id(
+        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        external_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.get_by_external_id(
+            external_id="externalId",
+        )
+        """
+        _response = self._raw_client.get_by_external_id(external_id, request_options=request_options)
+        return _response.data
+
+    def update_by_external_id(
+        self,
+        external_id_: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        type: typing.Optional[ProductUpdateType] = OMIT,
+        active: typing.Optional[bool] = OMIT,
+        product_code: typing.Optional[str] = OMIT,
+        product_attribute: typing.Optional[typing.Sequence[AgentAttribute]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        external_id_ : str
+
+        name : typing.Optional[str]
+
+        description : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        type : typing.Optional[ProductUpdateType]
+
+        active : typing.Optional[bool]
+
+        product_code : typing.Optional[str]
+
+        product_attribute : typing.Optional[typing.Sequence[AgentAttribute]]
+            Pricing attributes for this product
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.update_by_external_id(
+            external_id_="externalId",
+        )
+        """
+        _response = self._raw_client.update_by_external_id(
+            external_id_,
+            name=name,
+            description=description,
+            external_id=external_id,
+            type=type,
+            active=active,
+            product_code=product_code,
+            product_attribute=product_attribute,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete_by_external_id(
+        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Parameters
+        ----------
+        external_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.products.delete_by_external_id(
+            external_id="externalId",
+        )
+        """
+        _response = self._raw_client.delete_by_external_id(external_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncProductsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawProductsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawProductsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawProductsClient
+        """
+        return self._raw_client
+
+    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Product]:
+        """
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Product]
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(request_options=request_options)
+        return _response.data
+
+    async def create(
+        self,
+        *,
+        name: str,
+        description: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        type: typing.Optional[ProductCreateType] = OMIT,
+        active: typing.Optional[bool] = OMIT,
+        product_code: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        name : str
+
+        description : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        type : typing.Optional[ProductCreateType]
+
+        active : typing.Optional[bool]
+
+        product_code : typing.Optional[str]
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.create(
+                name="Acme Product",
+                description="Acme Product does amazing things.",
+                external_id="acme-product",
+                type="product",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            name=name,
+            description=description,
+            external_id=external_id,
+            type=type,
+            active=active,
+            product_code=product_code,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get(self, product_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Product:
+        """
+        Parameters
+        ----------
+        product_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.get(
+                product_id="productId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(product_id, request_options=request_options)
+        return _response.data
+
+    async def update(
+        self,
+        product_id: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        type: typing.Optional[ProductUpdateType] = OMIT,
+        active: typing.Optional[bool] = OMIT,
+        product_code: typing.Optional[str] = OMIT,
+        product_attribute: typing.Optional[typing.Sequence[AgentAttribute]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        product_id : str
+
+        name : typing.Optional[str]
+
+        description : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        type : typing.Optional[ProductUpdateType]
+
+        active : typing.Optional[bool]
+
+        product_code : typing.Optional[str]
+
+        product_attribute : typing.Optional[typing.Sequence[AgentAttribute]]
+            Pricing attributes for this product
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.update(
+                product_id="productId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(
+            product_id,
+            name=name,
+            description=description,
+            external_id=external_id,
+            type=type,
+            active=active,
+            product_code=product_code,
+            product_attribute=product_attribute,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete(self, product_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Parameters
+        ----------
+        product_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.delete(
+                product_id="productId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(product_id, request_options=request_options)
+        return _response.data
+
+    async def get_by_external_id(
+        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        external_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.get_by_external_id(
+                external_id="externalId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_by_external_id(external_id, request_options=request_options)
+        return _response.data
+
+    async def update_by_external_id(
+        self,
+        external_id_: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        type: typing.Optional[ProductUpdateType] = OMIT,
+        active: typing.Optional[bool] = OMIT,
+        product_code: typing.Optional[str] = OMIT,
+        product_attribute: typing.Optional[typing.Sequence[AgentAttribute]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Product:
+        """
+        Parameters
+        ----------
+        external_id_ : str
+
+        name : typing.Optional[str]
+
+        description : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        type : typing.Optional[ProductUpdateType]
+
+        active : typing.Optional[bool]
+
+        product_code : typing.Optional[str]
+
+        product_attribute : typing.Optional[typing.Sequence[AgentAttribute]]
+            Pricing attributes for this product
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Product
+            Success response
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.update_by_external_id(
+                external_id_="externalId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_by_external_id(
+            external_id_,
+            name=name,
+            description=description,
+            external_id=external_id,
+            type=type,
+            active=active,
+            product_code=product_code,
+            product_attribute=product_attribute,
+            metadata=metadata,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete_by_external_id(
+        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Parameters
+        ----------
+        external_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.products.delete_by_external_id(
+                external_id="externalId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_by_external_id(external_id, request_options=request_options)
+        return _response.data