paid-python 0.6.0__py3-none-any.whl → 1.0.0a1__py3-none-any.whl

paid/orders/client.py

@@ -1,12 +1,15 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import datetime as dt
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
+from ..types.empty_response import EmptyResponse
 from ..types.order import Order
-from ..types.order_line_create import OrderLineCreate
-from .lines.client import AsyncLinesClient, LinesClient
+from ..types.order_creation_state import OrderCreationState
+from ..types.order_lines_response import OrderLinesResponse
+from ..types.order_list_response import OrderListResponse
 from .raw_client import AsyncRawOrdersClient, RawOrdersClient
 
 # this is used as the default value for optional parameters
@@ -16,7 +19,6 @@ OMIT = typing.cast(typing.Any, ...)
 class OrdersClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._raw_client = RawOrdersClient(client_wrapper=client_wrapper)
-        self.lines = LinesClient(client_wrapper=client_wrapper)
 
     @property
     def with_raw_response(self) -> RawOrdersClient:
@@ -29,17 +31,29 @@ class OrdersClient:
         """
         return self._raw_client
 
-    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Order]:
+    def list_orders(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderListResponse:
         """
+        Get a list of orders for the organization
+
         Parameters
         ----------
+        limit : typing.Optional[int]
+
+        offset : typing.Optional[int]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[Order]
-            Success response
+        OrderListResponse
+            200
 
         Examples
         --------
@@ -48,49 +62,56 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.list()
+        client.orders.list_orders()
         """
-        _response = self._raw_client.list(request_options=request_options)
+        _response = self._raw_client.list_orders(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    def create(
+    def create_a_new_order(
         self,
         *,
-        name: str,
-        start_date: str,
-        currency: str,
-        customer_id: typing.Optional[str] = OMIT,
-        customer_external_id: typing.Optional[str] = OMIT,
-        billing_contact_id: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
-        end_date: typing.Optional[str] = OMIT,
-        plan_id: typing.Optional[str] = OMIT,
-        order_lines: typing.Optional[typing.Sequence[OrderLineCreate]] = OMIT,
+        customer_id: str,
+        billing_customer_id: typing.Optional[str] = OMIT,
+        billing_contact_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        start_date: typing.Optional[dt.datetime] = OMIT,
+        end_date: typing.Optional[dt.datetime] = OMIT,
+        subscription_terms: typing.Optional[int] = OMIT,
+        creation_state: typing.Optional[OrderCreationState] = OMIT,
+        billing_anchor: typing.Optional[float] = OMIT,
+        payment_terms: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Order:
         """
+        Creates a new order for the organization
+
         Parameters
         ----------
-        name : str
+        customer_id : str
+
+        billing_customer_id : typing.Optional[str]
+
+        billing_contact_ids : typing.Optional[typing.Sequence[str]]
 
-        start_date : str
+        name : typing.Optional[str]
 
-        currency : str
+        start_date : typing.Optional[dt.datetime]
 
-        customer_id : typing.Optional[str]
+        end_date : typing.Optional[dt.datetime]
 
-        customer_external_id : typing.Optional[str]
+        subscription_terms : typing.Optional[int]
 
-        billing_contact_id : typing.Optional[str]
+        creation_state : typing.Optional[OrderCreationState]
 
-        description : typing.Optional[str]
+        billing_anchor : typing.Optional[float]
 
-        end_date : typing.Optional[str]
+        payment_terms : typing.Optional[str]
 
-        plan_id : typing.Optional[str]
-            Optional plan ID to associate with this order
+        external_id : typing.Optional[str]
 
-        order_lines : typing.Optional[typing.Sequence[OrderLineCreate]]
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -98,7 +119,7 @@ class OrdersClient:
         Returns
         -------
         Order
-            Success response
+            201
 
         Examples
         --------
@@ -107,35 +128,102 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.create(
-            customer_external_id="acme-inc",
-            name="Acme Order",
-            description="Acme Order is an order for Acme, Inc.",
-            start_date="2025-01-01",
-            end_date="2026-01-01",
-            currency="USD",
+        client.orders.create_a_new_order(
+            customer_id="customerId",
         )
         """
-        _response = self._raw_client.create(
+        _response = self._raw_client.create_a_new_order(
+            customer_id=customer_id,
+            billing_customer_id=billing_customer_id,
+            billing_contact_ids=billing_contact_ids,
             name=name,
             start_date=start_date,
-            currency=currency,
-            customer_id=customer_id,
-            customer_external_id=customer_external_id,
-            billing_contact_id=billing_contact_id,
-            description=description,
             end_date=end_date,
-            plan_id=plan_id,
-            order_lines=order_lines,
+            subscription_terms=subscription_terms,
+            creation_state=creation_state,
+            billing_anchor=billing_anchor,
+            payment_terms=payment_terms,
+            external_id=external_id,
+            metadata=metadata,
             request_options=request_options,
         )
         return _response.data
 
-    def get(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
+    def get_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
+        """
+        Get an order by its ID
+
+        Parameters
+        ----------
+        id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Order
+            200
+
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.orders.get_order(
+            id="id",
+        )
+        """
+        _response = self._raw_client.get_order(id, request_options=request_options)
+        return _response.data
+
+    def update_order(
+        self,
+        id: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        start_date: typing.Optional[dt.datetime] = OMIT,
+        end_date: typing.Optional[dt.datetime] = OMIT,
+        subscription_terms: typing.Optional[int] = OMIT,
+        creation_state: typing.Optional[OrderCreationState] = OMIT,
+        billing_anchor: typing.Optional[float] = OMIT,
+        payment_terms: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        billing_customer_id: typing.Optional[str] = OMIT,
+        billing_contact_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Order:
         """
+        Update an order by its ID
+
         Parameters
         ----------
-        order_id : str
+        id : str
+
+        name : typing.Optional[str]
+
+        start_date : typing.Optional[dt.datetime]
+
+        end_date : typing.Optional[dt.datetime]
+
+        subscription_terms : typing.Optional[int]
+
+        creation_state : typing.Optional[OrderCreationState]
+
+        billing_anchor : typing.Optional[float]
+
+        payment_terms : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        billing_customer_id : typing.Optional[str]
+
+        billing_contact_ids : typing.Optional[typing.Sequence[str]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -143,7 +231,7 @@ class OrdersClient:
         Returns
         -------
         Order
-            Success response
+            200
 
         Examples
         --------
@@ -152,25 +240,42 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.get(
-            order_id="orderId",
+        client.orders.update_order(
+            id="id",
         )
         """
-        _response = self._raw_client.get(order_id, request_options=request_options)
+        _response = self._raw_client.update_order(
+            id,
+            name=name,
+            start_date=start_date,
+            end_date=end_date,
+            subscription_terms=subscription_terms,
+            creation_state=creation_state,
+            billing_anchor=billing_anchor,
+            payment_terms=payment_terms,
+            external_id=external_id,
+            metadata=metadata,
+            billing_customer_id=billing_customer_id,
+            billing_contact_ids=billing_contact_ids,
+            request_options=request_options,
+        )
         return _response.data
 
-    def delete(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def delete_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmptyResponse:
         """
+        Delete an order by its ID
+
         Parameters
         ----------
-        order_id : str
+        id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        EmptyResponse
+            200
 
         Examples
         --------
@@ -179,26 +284,39 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.delete(
-            order_id="orderId",
+        client.orders.delete_order(
+            id="id",
         )
         """
-        _response = self._raw_client.delete(order_id, request_options=request_options)
+        _response = self._raw_client.delete_order(id, request_options=request_options)
         return _response.data
 
-    def activate(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
+    def get_order_lines(
+        self,
+        id: str,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderLinesResponse:
         """
+        Get the order lines for an order by its ID
+
         Parameters
         ----------
-        order_id : str
+        id : str
+
+        limit : typing.Optional[int]
+
+        offset : typing.Optional[int]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        Order
-            Success response
+        OrderLinesResponse
+            200
 
         Examples
         --------
@@ -207,18 +325,17 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.activate(
-            order_id="orderId",
+        client.orders.get_order_lines(
+            id="id",
         )
         """
-        _response = self._raw_client.activate(order_id, request_options=request_options)
+        _response = self._raw_client.get_order_lines(id, limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
 
 class AsyncOrdersClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._raw_client = AsyncRawOrdersClient(client_wrapper=client_wrapper)
-        self.lines = AsyncLinesClient(client_wrapper=client_wrapper)
 
     @property
     def with_raw_response(self) -> AsyncRawOrdersClient:
@@ -231,17 +348,29 @@ class AsyncOrdersClient:
         """
         return self._raw_client
 
-    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Order]:
+    async def list_orders(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderListResponse:
         """
+        Get a list of orders for the organization
+
         Parameters
         ----------
+        limit : typing.Optional[int]
+
+        offset : typing.Optional[int]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[Order]
-            Success response
+        OrderListResponse
+            200
 
         Examples
         --------
@@ -255,52 +384,59 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.list()
+            await client.orders.list_orders()
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.list(request_options=request_options)
+        _response = await self._raw_client.list_orders(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    async def create(
+    async def create_a_new_order(
         self,
         *,
-        name: str,
-        start_date: str,
-        currency: str,
-        customer_id: typing.Optional[str] = OMIT,
-        customer_external_id: typing.Optional[str] = OMIT,
-        billing_contact_id: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
-        end_date: typing.Optional[str] = OMIT,
-        plan_id: typing.Optional[str] = OMIT,
-        order_lines: typing.Optional[typing.Sequence[OrderLineCreate]] = OMIT,
+        customer_id: str,
+        billing_customer_id: typing.Optional[str] = OMIT,
+        billing_contact_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        start_date: typing.Optional[dt.datetime] = OMIT,
+        end_date: typing.Optional[dt.datetime] = OMIT,
+        subscription_terms: typing.Optional[int] = OMIT,
+        creation_state: typing.Optional[OrderCreationState] = OMIT,
+        billing_anchor: typing.Optional[float] = OMIT,
+        payment_terms: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Order:
         """
+        Creates a new order for the organization
+
         Parameters
         ----------
-        name : str
+        customer_id : str
+
+        billing_customer_id : typing.Optional[str]
 
-        start_date : str
+        billing_contact_ids : typing.Optional[typing.Sequence[str]]
 
-        currency : str
+        name : typing.Optional[str]
 
-        customer_id : typing.Optional[str]
+        start_date : typing.Optional[dt.datetime]
 
-        customer_external_id : typing.Optional[str]
+        end_date : typing.Optional[dt.datetime]
 
-        billing_contact_id : typing.Optional[str]
+        subscription_terms : typing.Optional[int]
 
-        description : typing.Optional[str]
+        creation_state : typing.Optional[OrderCreationState]
 
-        end_date : typing.Optional[str]
+        billing_anchor : typing.Optional[float]
 
-        plan_id : typing.Optional[str]
-            Optional plan ID to associate with this order
+        payment_terms : typing.Optional[str]
 
-        order_lines : typing.Optional[typing.Sequence[OrderLineCreate]]
+        external_id : typing.Optional[str]
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -308,7 +444,7 @@ class AsyncOrdersClient:
         Returns
         -------
         Order
-            Success response
+            201
 
         Examples
         --------
@@ -322,38 +458,37 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.create(
-                customer_external_id="acme-inc",
-                name="Acme Order",
-                description="Acme Order is an order for Acme, Inc.",
-                start_date="2025-01-01",
-                end_date="2026-01-01",
-                currency="USD",
+            await client.orders.create_a_new_order(
+                customer_id="customerId",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.create(
+        _response = await self._raw_client.create_a_new_order(
+            customer_id=customer_id,
+            billing_customer_id=billing_customer_id,
+            billing_contact_ids=billing_contact_ids,
             name=name,
             start_date=start_date,
-            currency=currency,
-            customer_id=customer_id,
-            customer_external_id=customer_external_id,
-            billing_contact_id=billing_contact_id,
-            description=description,
             end_date=end_date,
-            plan_id=plan_id,
-            order_lines=order_lines,
+            subscription_terms=subscription_terms,
+            creation_state=creation_state,
+            billing_anchor=billing_anchor,
+            payment_terms=payment_terms,
+            external_id=external_id,
+            metadata=metadata,
             request_options=request_options,
         )
         return _response.data
 
-    async def get(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
+    async def get_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
         """
+        Get an order by its ID
+
         Parameters
         ----------
-        order_id : str
+        id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -361,7 +496,7 @@ class AsyncOrdersClient:
         Returns
         -------
         Order
-            Success response
+            200
 
         Examples
         --------
@@ -375,28 +510,69 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.get(
-                order_id="orderId",
+            await client.orders.get_order(
+                id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.get(order_id, request_options=request_options)
+        _response = await self._raw_client.get_order(id, request_options=request_options)
         return _response.data
 
-    async def delete(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def update_order(
+        self,
+        id: str,
+        *,
+        name: typing.Optional[str] = OMIT,
+        start_date: typing.Optional[dt.datetime] = OMIT,
+        end_date: typing.Optional[dt.datetime] = OMIT,
+        subscription_terms: typing.Optional[int] = OMIT,
+        creation_state: typing.Optional[OrderCreationState] = OMIT,
+        billing_anchor: typing.Optional[float] = OMIT,
+        payment_terms: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        billing_customer_id: typing.Optional[str] = OMIT,
+        billing_contact_ids: typing.Optional[typing.Sequence[str]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Order:
         """
+        Update an order by its ID
+
         Parameters
         ----------
-        order_id : str
+        id : str
+
+        name : typing.Optional[str]
+
+        start_date : typing.Optional[dt.datetime]
+
+        end_date : typing.Optional[dt.datetime]
+
+        subscription_terms : typing.Optional[int]
+
+        creation_state : typing.Optional[OrderCreationState]
+
+        billing_anchor : typing.Optional[float]
+
+        payment_terms : typing.Optional[str]
+
+        external_id : typing.Optional[str]
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        billing_customer_id : typing.Optional[str]
+
+        billing_contact_ids : typing.Optional[typing.Sequence[str]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        Order
+            200
 
         Examples
         --------
@@ -410,29 +586,45 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.delete(
-                order_id="orderId",
+            await client.orders.update_order(
+                id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.delete(order_id, request_options=request_options)
+        _response = await self._raw_client.update_order(
+            id,
+            name=name,
+            start_date=start_date,
+            end_date=end_date,
+            subscription_terms=subscription_terms,
+            creation_state=creation_state,
+            billing_anchor=billing_anchor,
+            payment_terms=payment_terms,
+            external_id=external_id,
+            metadata=metadata,
+            billing_customer_id=billing_customer_id,
+            billing_contact_ids=billing_contact_ids,
+            request_options=request_options,
+        )
         return _response.data
 
-    async def activate(self, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
+    async def delete_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmptyResponse:
         """
+        Delete an order by its ID
+
         Parameters
         ----------
-        order_id : str
+        id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        Order
-            Success response
+        EmptyResponse
+            200
 
         Examples
         --------
@@ -446,12 +638,63 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.activate(
-                order_id="orderId",
+            await client.orders.delete_order(
+                id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.activate(order_id, request_options=request_options)
+        _response = await self._raw_client.delete_order(id, request_options=request_options)
+        return _response.data
+
+    async def get_order_lines(
+        self,
+        id: str,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderLinesResponse:
+        """
+        Get the order lines for an order by its ID
+
+        Parameters
+        ----------
+        id : str
+
+        limit : typing.Optional[int]
+
+        offset : typing.Optional[int]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderLinesResponse
+            200
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.orders.get_order_lines(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_order_lines(
+            id, limit=limit, offset=offset, request_options=request_options
+        )
         return _response.data