paid-python 1.0.0a1__py3-none-any.whl → 1.0.0a2__py3-none-any.whl

paid/customers/raw_client.py

@@ -111,7 +111,7 @@ class RawCustomersClient:
             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_new_customer(
+    def create_customer(
         self,
         *,
         name: str,
@@ -230,11 +230,11 @@ class RawCustomersClient:
             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_customer(
+    def get_customer_by_id(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[Customer]:
         """
-        Get a customer by its ID
+        Get a customer by ID
 
         Parameters
         ----------
@@ -301,7 +301,7 @@ class RawCustomersClient:
             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_customer(
+    def update_customer_by_id(
         self,
         id: str,
         *,
@@ -319,7 +319,7 @@ class RawCustomersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[Customer]:
         """
-        Update a customer by its ID
+        Update a customer by ID
 
         Parameters
         ----------
@@ -438,11 +438,11 @@ class RawCustomersClient:
             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_customer(
+    def delete_customer_by_id(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[EmptyResponse]:
         """
-        Delete a customer by its ID
+        Delete a customer by ID
 
         Parameters
         ----------
@@ -513,7 +513,7 @@ class RawCustomersClient:
         self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[Customer]:
         """
-        Get a customer by its externalId
+        Get a customer by external ID
 
         Parameters
         ----------
@@ -598,7 +598,7 @@ class RawCustomersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[Customer]:
         """
-        Update a customer by its externalId
+        Update a customer by external ID
 
         Parameters
         ----------
@@ -721,7 +721,7 @@ class RawCustomersClient:
         self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[EmptyResponse]:
         """
-        Delete a customer by its externalId
+        Delete a customer by external ID
 
         Parameters
         ----------
@@ -874,7 +874,7 @@ class AsyncRawCustomersClient:
             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_new_customer(
+    async def create_customer(
         self,
         *,
         name: str,
@@ -993,11 +993,11 @@ class AsyncRawCustomersClient:
             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_customer(
+    async def get_customer_by_id(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[Customer]:
         """
-        Get a customer by its ID
+        Get a customer by ID
 
         Parameters
         ----------
@@ -1064,7 +1064,7 @@ class AsyncRawCustomersClient:
             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_customer(
+    async def update_customer_by_id(
         self,
         id: str,
         *,
@@ -1082,7 +1082,7 @@ class AsyncRawCustomersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[Customer]:
         """
-        Update a customer by its ID
+        Update a customer by ID
 
         Parameters
         ----------
@@ -1201,11 +1201,11 @@ class AsyncRawCustomersClient:
             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_customer(
+    async def delete_customer_by_id(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[EmptyResponse]:
         """
-        Delete a customer by its ID
+        Delete a customer by ID
 
         Parameters
         ----------
@@ -1276,7 +1276,7 @@ class AsyncRawCustomersClient:
         self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[Customer]:
         """
-        Get a customer by its externalId
+        Get a customer by external ID
 
         Parameters
         ----------
@@ -1361,7 +1361,7 @@ class AsyncRawCustomersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[Customer]:
         """
-        Update a customer by its externalId
+        Update a customer by external ID
 
         Parameters
         ----------
@@ -1484,7 +1484,7 @@ class AsyncRawCustomersClient:
         self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[EmptyResponse]:
         """
-        Delete a customer by its externalId
+        Delete a customer by external ID
 
         Parameters
         ----------

paid/invoices/client.py

@@ -64,9 +64,9 @@ class InvoicesClient:
         _response = self._raw_client.list_invoices(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    def get_invoice(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Invoice:
+    def get_invoice_by_id(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Invoice:
         """
-        Get an invoice by its ID
+        Get an invoice by ID
 
         Parameters
         ----------
@@ -87,14 +87,14 @@ class InvoicesClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.invoices.get_invoice(
+        client.invoices.get_invoice_by_id(
             id="id",
         )
         """
-        _response = self._raw_client.get_invoice(id, request_options=request_options)
+        _response = self._raw_client.get_invoice_by_id(id, request_options=request_options)
         return _response.data
 
-    def update_invoice(
+    def update_invoice_by_id(
         self,
         id: str,
         *,
@@ -102,7 +102,7 @@ class InvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Invoice:
         """
-        Update an invoice by its ID (limited fields)
+        Update an invoice by ID
 
         Parameters
         ----------
@@ -125,11 +125,11 @@ class InvoicesClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.invoices.update_invoice(
+        client.invoices.update_invoice_by_id(
             id="id",
         )
         """
-        _response = self._raw_client.update_invoice(id, metadata=metadata, request_options=request_options)
+        _response = self._raw_client.update_invoice_by_id(id, metadata=metadata, request_options=request_options)
         return _response.data
 
     def get_invoice_lines(
@@ -141,7 +141,7 @@ class InvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> InvoiceLinesResponse:
         """
-        Get the invoice lines for an invoice by its ID
+        Get the invoice lines for an invoice by ID
 
         Parameters
         ----------
@@ -233,9 +233,9 @@ class AsyncInvoicesClient:
         _response = await self._raw_client.list_invoices(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    async def get_invoice(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Invoice:
+    async def get_invoice_by_id(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Invoice:
         """
-        Get an invoice by its ID
+        Get an invoice by ID
 
         Parameters
         ----------
@@ -261,17 +261,17 @@ class AsyncInvoicesClient:
 
 
         async def main() -> None:
-            await client.invoices.get_invoice(
+            await client.invoices.get_invoice_by_id(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.get_invoice(id, request_options=request_options)
+        _response = await self._raw_client.get_invoice_by_id(id, request_options=request_options)
         return _response.data
 
-    async def update_invoice(
+    async def update_invoice_by_id(
         self,
         id: str,
         *,
@@ -279,7 +279,7 @@ class AsyncInvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Invoice:
         """
-        Update an invoice by its ID (limited fields)
+        Update an invoice by ID
 
         Parameters
         ----------
@@ -307,14 +307,14 @@ class AsyncInvoicesClient:
 
 
         async def main() -> None:
-            await client.invoices.update_invoice(
+            await client.invoices.update_invoice_by_id(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.update_invoice(id, metadata=metadata, request_options=request_options)
+        _response = await self._raw_client.update_invoice_by_id(id, metadata=metadata, request_options=request_options)
         return _response.data
 
     async def get_invoice_lines(
@@ -326,7 +326,7 @@ class AsyncInvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> InvoiceLinesResponse:
         """
-        Get the invoice lines for an invoice by its ID
+        Get the invoice lines for an invoice by ID
 
         Parameters
         ----------

paid/invoices/raw_client.py

@@ -107,9 +107,11 @@ class RawInvoicesClient:
             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_invoice(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Invoice]:
+    def get_invoice_by_id(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[Invoice]:
         """
-        Get an invoice by its ID
+        Get an invoice by ID
 
         Parameters
         ----------
@@ -176,7 +178,7 @@ class RawInvoicesClient:
             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_invoice(
+    def update_invoice_by_id(
         self,
         id: str,
         *,
@@ -184,7 +186,7 @@ class RawInvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[Invoice]:
         """
-        Update an invoice by its ID (limited fields)
+        Update an invoice by ID
 
         Parameters
         ----------
@@ -280,7 +282,7 @@ class RawInvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[InvoiceLinesResponse]:
         """
-        Get the invoice lines for an invoice by its ID
+        Get the invoice lines for an invoice by ID
 
         Parameters
         ----------
@@ -441,11 +443,11 @@ class AsyncRawInvoicesClient:
             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_invoice(
+    async def get_invoice_by_id(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[Invoice]:
         """
-        Get an invoice by its ID
+        Get an invoice by ID
 
         Parameters
         ----------
@@ -512,7 +514,7 @@ class AsyncRawInvoicesClient:
             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_invoice(
+    async def update_invoice_by_id(
         self,
         id: str,
         *,
@@ -520,7 +522,7 @@ class AsyncRawInvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[Invoice]:
         """
-        Update an invoice by its ID (limited fields)
+        Update an invoice by ID
 
         Parameters
         ----------
@@ -616,7 +618,7 @@ class AsyncRawInvoicesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[InvoiceLinesResponse]:
         """
-        Get the invoice lines for an invoice by its ID
+        Get the invoice lines for an invoice by ID
 
         Parameters
         ----------

paid/orders/client.py

@@ -67,7 +67,7 @@ class OrdersClient:
         _response = self._raw_client.list_orders(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    def create_a_new_order(
+    def create_order(
         self,
         *,
         customer_id: str,
@@ -128,11 +128,11 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.create_a_new_order(
+        client.orders.create_order(
             customer_id="customerId",
         )
         """
-        _response = self._raw_client.create_a_new_order(
+        _response = self._raw_client.create_order(
             customer_id=customer_id,
             billing_customer_id=billing_customer_id,
             billing_contact_ids=billing_contact_ids,
@@ -149,9 +149,9 @@ class OrdersClient:
         )
         return _response.data
 
-    def get_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
+    def get_order_by_id(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
         """
-        Get an order by its ID
+        Get an order by ID
 
         Parameters
         ----------
@@ -172,14 +172,14 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.get_order(
+        client.orders.get_order_by_id(
             id="id",
         )
         """
-        _response = self._raw_client.get_order(id, request_options=request_options)
+        _response = self._raw_client.get_order_by_id(id, request_options=request_options)
         return _response.data
 
-    def update_order(
+    def update_order_by_id(
         self,
         id: str,
         *,
@@ -197,7 +197,7 @@ class OrdersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Order:
         """
-        Update an order by its ID
+        Update an order by ID
 
         Parameters
         ----------
@@ -240,11 +240,11 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.update_order(
+        client.orders.update_order_by_id(
             id="id",
         )
         """
-        _response = self._raw_client.update_order(
+        _response = self._raw_client.update_order_by_id(
             id,
             name=name,
             start_date=start_date,
@@ -261,9 +261,9 @@ class OrdersClient:
         )
         return _response.data
 
-    def delete_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmptyResponse:
+    def delete_order_by_id(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmptyResponse:
         """
-        Delete an order by its ID
+        Delete an order by ID
 
         Parameters
         ----------
@@ -284,11 +284,11 @@ class OrdersClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.orders.delete_order(
+        client.orders.delete_order_by_id(
             id="id",
         )
         """
-        _response = self._raw_client.delete_order(id, request_options=request_options)
+        _response = self._raw_client.delete_order_by_id(id, request_options=request_options)
         return _response.data
 
     def get_order_lines(
@@ -300,7 +300,7 @@ class OrdersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> OrderLinesResponse:
         """
-        Get the order lines for an order by its ID
+        Get the order lines for an order by ID
 
         Parameters
         ----------
@@ -392,7 +392,7 @@ class AsyncOrdersClient:
         _response = await self._raw_client.list_orders(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    async def create_a_new_order(
+    async def create_order(
         self,
         *,
         customer_id: str,
@@ -458,14 +458,14 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.create_a_new_order(
+            await client.orders.create_order(
                 customer_id="customerId",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.create_a_new_order(
+        _response = await self._raw_client.create_order(
             customer_id=customer_id,
             billing_customer_id=billing_customer_id,
             billing_contact_ids=billing_contact_ids,
@@ -482,9 +482,9 @@ class AsyncOrdersClient:
         )
         return _response.data
 
-    async def get_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
+    async def get_order_by_id(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order:
         """
-        Get an order by its ID
+        Get an order by ID
 
         Parameters
         ----------
@@ -510,17 +510,17 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.get_order(
+            await client.orders.get_order_by_id(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.get_order(id, request_options=request_options)
+        _response = await self._raw_client.get_order_by_id(id, request_options=request_options)
         return _response.data
 
-    async def update_order(
+    async def update_order_by_id(
         self,
         id: str,
         *,
@@ -538,7 +538,7 @@ class AsyncOrdersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Order:
         """
-        Update an order by its ID
+        Update an order by ID
 
         Parameters
         ----------
@@ -586,14 +586,14 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.update_order(
+            await client.orders.update_order_by_id(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.update_order(
+        _response = await self._raw_client.update_order_by_id(
             id,
             name=name,
             start_date=start_date,
@@ -610,9 +610,11 @@ class AsyncOrdersClient:
         )
         return _response.data
 
-    async def delete_order(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmptyResponse:
+    async def delete_order_by_id(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> EmptyResponse:
         """
-        Delete an order by its ID
+        Delete an order by ID
 
         Parameters
         ----------
@@ -638,14 +640,14 @@ class AsyncOrdersClient:
 
 
         async def main() -> None:
-            await client.orders.delete_order(
+            await client.orders.delete_order_by_id(
                 id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.delete_order(id, request_options=request_options)
+        _response = await self._raw_client.delete_order_by_id(id, request_options=request_options)
         return _response.data
 
     async def get_order_lines(
@@ -657,7 +659,7 @@ class AsyncOrdersClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> OrderLinesResponse:
         """
-        Get the order lines for an order by its ID
+        Get the order lines for an order by ID
 
         Parameters
         ----------