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

paid/contacts/client.py

@@ -5,7 +5,9 @@ import typing
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.contact import Contact
-from ..types.salutation import Salutation
+from ..types.contact_billing_address import ContactBillingAddress
+from ..types.contact_list_response import ContactListResponse
+from ..types.empty_response import EmptyResponse
 from .raw_client import AsyncRawContactsClient, RawContactsClient
 
 # this is used as the default value for optional parameters
@@ -27,17 +29,29 @@ class ContactsClient:
         """
         return self._raw_client
 
-    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Contact]:
+    def list_contacts(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ContactListResponse:
         """
+        Get a list of contacts for the organization
+
         Parameters
         ----------
+        limit : typing.Optional[int]
+
+        offset : typing.Optional[int]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[Contact]
-            Success response
+        ContactListResponse
+            200
 
         Examples
         --------
@@ -46,33 +60,29 @@ class ContactsClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.contacts.list()
+        client.contacts.list_contacts()
         """
-        _response = self._raw_client.list(request_options=request_options)
+        _response = self._raw_client.list_contacts(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    def create(
+    def create_a_new_contact(
         self,
         *,
-        salutation: Salutation,
+        customer_id: str,
         first_name: str,
         last_name: str,
         email: str,
-        external_id: typing.Optional[str] = OMIT,
-        customer_id: typing.Optional[str] = OMIT,
-        customer_external_id: typing.Optional[str] = OMIT,
         phone: typing.Optional[str] = OMIT,
-        billing_street: typing.Optional[str] = OMIT,
-        billing_city: typing.Optional[str] = OMIT,
-        billing_state_province: typing.Optional[str] = OMIT,
-        billing_country: typing.Optional[str] = OMIT,
-        billing_postal_code: typing.Optional[str] = OMIT,
+        billing_address: typing.Optional[ContactBillingAddress] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Contact:
         """
+        Creates a new contact for the organization
+
         Parameters
         ----------
-        salutation : Salutation
+        customer_id : str
 
         first_name : str
 
@@ -80,23 +90,109 @@ class ContactsClient:
 
         email : str
 
+        phone : typing.Optional[str]
+
+        billing_address : typing.Optional[ContactBillingAddress]
+
         external_id : typing.Optional[str]
 
-        customer_id : typing.Optional[str]
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-        customer_external_id : typing.Optional[str]
+        Returns
+        -------
+        Contact
+            201
 
-        phone : typing.Optional[str]
+        Examples
+        --------
+        from paid import Paid
+
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.contacts.create_a_new_contact(
+            customer_id="customerId",
+            first_name="firstName",
+            last_name="lastName",
+            email="email",
+        )
+        """
+        _response = self._raw_client.create_a_new_contact(
+            customer_id=customer_id,
+            first_name=first_name,
+            last_name=last_name,
+            email=email,
+            phone=phone,
+            billing_address=billing_address,
+            external_id=external_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_contact(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Contact:
+        """
+        Get a contact by its ID
 
-        billing_street : typing.Optional[str]
+        Parameters
+        ----------
+        id : str
 
-        billing_city : typing.Optional[str]
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-        billing_state_province : typing.Optional[str]
+        Returns
+        -------
+        Contact
+            200
 
-        billing_country : typing.Optional[str]
+        Examples
+        --------
+        from paid import Paid
 
-        billing_postal_code : typing.Optional[str]
+        client = Paid(
+            token="YOUR_TOKEN",
+        )
+        client.contacts.get_contact(
+            id="id",
+        )
+        """
+        _response = self._raw_client.get_contact(id, request_options=request_options)
+        return _response.data
+
+    def update_contact(
+        self,
+        id: str,
+        *,
+        customer_id: typing.Optional[str] = OMIT,
+        first_name: typing.Optional[str] = OMIT,
+        last_name: typing.Optional[str] = OMIT,
+        email: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        billing_address: typing.Optional[ContactBillingAddress] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Contact:
+        """
+        Update a contact by its ID
+
+        Parameters
+        ----------
+        id : str
+
+        customer_id : typing.Optional[str]
+
+        first_name : typing.Optional[str]
+
+        last_name : typing.Optional[str]
+
+        email : typing.Optional[str]
+
+        phone : typing.Optional[str]
+
+        billing_address : typing.Optional[ContactBillingAddress]
+
+        external_id : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -104,7 +200,7 @@ class ContactsClient:
         Returns
         -------
         Contact
-            Success response
+            200
 
         Examples
         --------
@@ -113,45 +209,38 @@ class ContactsClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.contacts.create(
-            customer_external_id="acme-inc",
-            salutation="Mr.",
-            first_name="John",
-            last_name="Doe",
-            email="john.doe@example.com",
+        client.contacts.update_contact(
+            id="id",
         )
         """
-        _response = self._raw_client.create(
-            salutation=salutation,
+        _response = self._raw_client.update_contact(
+            id,
+            customer_id=customer_id,
             first_name=first_name,
             last_name=last_name,
             email=email,
-            external_id=external_id,
-            customer_id=customer_id,
-            customer_external_id=customer_external_id,
             phone=phone,
-            billing_street=billing_street,
-            billing_city=billing_city,
-            billing_state_province=billing_state_province,
-            billing_country=billing_country,
-            billing_postal_code=billing_postal_code,
+            billing_address=billing_address,
+            external_id=external_id,
             request_options=request_options,
         )
         return _response.data
 
-    def get(self, contact_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Contact:
+    def delete_contact(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EmptyResponse:
         """
+        Delete a contact by its ID
+
         Parameters
         ----------
-        contact_id : str
+        id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        Contact
-            Success response
+        EmptyResponse
+            200
 
         Examples
         --------
@@ -160,25 +249,30 @@ class ContactsClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.contacts.get(
-            contact_id="contactId",
+        client.contacts.delete_contact(
+            id="id",
         )
         """
-        _response = self._raw_client.get(contact_id, request_options=request_options)
+        _response = self._raw_client.delete_contact(id, request_options=request_options)
         return _response.data
 
-    def delete(self, contact_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    def get_contact_by_external_id(
+        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Contact:
         """
+        Get a contact by its externalId
+
         Parameters
         ----------
-        contact_id : str
+        external_id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        Contact
+            200
 
         Examples
         --------
@@ -187,20 +281,46 @@ class ContactsClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.contacts.delete(
-            contact_id="contactId",
+        client.contacts.get_contact_by_external_id(
+            external_id="externalId",
         )
         """
-        _response = self._raw_client.delete(contact_id, request_options=request_options)
+        _response = self._raw_client.get_contact_by_external_id(external_id, request_options=request_options)
         return _response.data
 
-    def get_by_external_id(
-        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    def update_contact_by_external_id(
+        self,
+        external_id_: str,
+        *,
+        customer_id: typing.Optional[str] = OMIT,
+        first_name: typing.Optional[str] = OMIT,
+        last_name: typing.Optional[str] = OMIT,
+        email: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        billing_address: typing.Optional[ContactBillingAddress] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> Contact:
         """
+        Update a contact by its externalId
+
         Parameters
         ----------
-        external_id : str
+        external_id_ : str
+
+        customer_id : typing.Optional[str]
+
+        first_name : typing.Optional[str]
+
+        last_name : typing.Optional[str]
+
+        email : typing.Optional[str]
+
+        phone : typing.Optional[str]
+
+        billing_address : typing.Optional[ContactBillingAddress]
+
+        external_id : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -208,7 +328,7 @@ class ContactsClient:
         Returns
         -------
         Contact
-            Success response
+            200
 
         Examples
         --------
@@ -217,17 +337,29 @@ class ContactsClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.contacts.get_by_external_id(
-            external_id="externalId",
+        client.contacts.update_contact_by_external_id(
+            external_id_="externalId",
         )
         """
-        _response = self._raw_client.get_by_external_id(external_id, request_options=request_options)
+        _response = self._raw_client.update_contact_by_external_id(
+            external_id_,
+            customer_id=customer_id,
+            first_name=first_name,
+            last_name=last_name,
+            email=email,
+            phone=phone,
+            billing_address=billing_address,
+            external_id=external_id,
+            request_options=request_options,
+        )
         return _response.data
 
-    def delete_by_external_id(
+    def delete_contact_by_external_id(
         self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    ) -> EmptyResponse:
         """
+        Delete a contact by its externalId
+
         Parameters
         ----------
         external_id : str
@@ -237,7 +369,8 @@ class ContactsClient:
 
         Returns
         -------
-        None
+        EmptyResponse
+            200
 
         Examples
         --------
@@ -246,11 +379,11 @@ class ContactsClient:
         client = Paid(
             token="YOUR_TOKEN",
         )
-        client.contacts.delete_by_external_id(
+        client.contacts.delete_contact_by_external_id(
             external_id="externalId",
         )
         """
-        _response = self._raw_client.delete_by_external_id(external_id, request_options=request_options)
+        _response = self._raw_client.delete_contact_by_external_id(external_id, request_options=request_options)
         return _response.data
 
 
@@ -269,17 +402,29 @@ class AsyncContactsClient:
         """
         return self._raw_client
 
-    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Contact]:
+    async def list_contacts(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ContactListResponse:
         """
+        Get a list of contacts for the organization
+
         Parameters
         ----------
+        limit : typing.Optional[int]
+
+        offset : typing.Optional[int]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[Contact]
-            Success response
+        ContactListResponse
+            200
 
         Examples
         --------
@@ -293,36 +438,32 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.list()
+            await client.contacts.list_contacts()
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.list(request_options=request_options)
+        _response = await self._raw_client.list_contacts(limit=limit, offset=offset, request_options=request_options)
         return _response.data
 
-    async def create(
+    async def create_a_new_contact(
         self,
         *,
-        salutation: Salutation,
+        customer_id: str,
         first_name: str,
         last_name: str,
         email: str,
-        external_id: typing.Optional[str] = OMIT,
-        customer_id: typing.Optional[str] = OMIT,
-        customer_external_id: typing.Optional[str] = OMIT,
         phone: typing.Optional[str] = OMIT,
-        billing_street: typing.Optional[str] = OMIT,
-        billing_city: typing.Optional[str] = OMIT,
-        billing_state_province: typing.Optional[str] = OMIT,
-        billing_country: typing.Optional[str] = OMIT,
-        billing_postal_code: typing.Optional[str] = OMIT,
+        billing_address: typing.Optional[ContactBillingAddress] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Contact:
         """
+        Creates a new contact for the organization
+
         Parameters
         ----------
-        salutation : Salutation
+        customer_id : str
 
         first_name : str
 
@@ -330,23 +471,61 @@ class AsyncContactsClient:
 
         email : str
 
+        phone : typing.Optional[str]
+
+        billing_address : typing.Optional[ContactBillingAddress]
+
         external_id : typing.Optional[str]
 
-        customer_id : typing.Optional[str]
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-        customer_external_id : typing.Optional[str]
+        Returns
+        -------
+        Contact
+            201
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
 
-        phone : typing.Optional[str]
 
-        billing_street : typing.Optional[str]
+        async def main() -> None:
+            await client.contacts.create_a_new_contact(
+                customer_id="customerId",
+                first_name="firstName",
+                last_name="lastName",
+                email="email",
+            )
 
-        billing_city : typing.Optional[str]
 
-        billing_state_province : typing.Optional[str]
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_a_new_contact(
+            customer_id=customer_id,
+            first_name=first_name,
+            last_name=last_name,
+            email=email,
+            phone=phone,
+            billing_address=billing_address,
+            external_id=external_id,
+            request_options=request_options,
+        )
+        return _response.data
 
-        billing_country : typing.Optional[str]
+    async def get_contact(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Contact:
+        """
+        Get a contact by its ID
 
-        billing_postal_code : typing.Optional[str]
+        Parameters
+        ----------
+        id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -354,7 +533,7 @@ class AsyncContactsClient:
         Returns
         -------
         Contact
-            Success response
+            200
 
         Examples
         --------
@@ -368,48 +547,107 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.create(
-                customer_external_id="acme-inc",
-                salutation="Mr.",
-                first_name="John",
-                last_name="Doe",
-                email="john.doe@example.com",
+            await client.contacts.get_contact(
+                id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.create(
-            salutation=salutation,
+        _response = await self._raw_client.get_contact(id, request_options=request_options)
+        return _response.data
+
+    async def update_contact(
+        self,
+        id: str,
+        *,
+        customer_id: typing.Optional[str] = OMIT,
+        first_name: typing.Optional[str] = OMIT,
+        last_name: typing.Optional[str] = OMIT,
+        email: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        billing_address: typing.Optional[ContactBillingAddress] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Contact:
+        """
+        Update a contact by its ID
+
+        Parameters
+        ----------
+        id : str
+
+        customer_id : typing.Optional[str]
+
+        first_name : typing.Optional[str]
+
+        last_name : typing.Optional[str]
+
+        email : typing.Optional[str]
+
+        phone : typing.Optional[str]
+
+        billing_address : typing.Optional[ContactBillingAddress]
+
+        external_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Contact
+            200
+
+        Examples
+        --------
+        import asyncio
+
+        from paid import AsyncPaid
+
+        client = AsyncPaid(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.contacts.update_contact(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_contact(
+            id,
+            customer_id=customer_id,
             first_name=first_name,
             last_name=last_name,
             email=email,
-            external_id=external_id,
-            customer_id=customer_id,
-            customer_external_id=customer_external_id,
             phone=phone,
-            billing_street=billing_street,
-            billing_city=billing_city,
-            billing_state_province=billing_state_province,
-            billing_country=billing_country,
-            billing_postal_code=billing_postal_code,
+            billing_address=billing_address,
+            external_id=external_id,
             request_options=request_options,
         )
         return _response.data
 
-    async def get(self, contact_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Contact:
+    async def delete_contact(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> EmptyResponse:
         """
+        Delete a contact by its ID
+
         Parameters
         ----------
-        contact_id : str
+        id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        Contact
-            Success response
+        EmptyResponse
+            200
 
         Examples
         --------
@@ -423,28 +661,33 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.get(
-                contact_id="contactId",
+            await client.contacts.delete_contact(
+                id="id",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.get(contact_id, request_options=request_options)
+        _response = await self._raw_client.delete_contact(id, request_options=request_options)
         return _response.data
 
-    async def delete(self, contact_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+    async def get_contact_by_external_id(
+        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Contact:
         """
+        Get a contact by its externalId
+
         Parameters
         ----------
-        contact_id : str
+        external_id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        Contact
+            200
 
         Examples
         --------
@@ -458,23 +701,49 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.delete(
-                contact_id="contactId",
+            await client.contacts.get_contact_by_external_id(
+                external_id="externalId",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.delete(contact_id, request_options=request_options)
+        _response = await self._raw_client.get_contact_by_external_id(external_id, request_options=request_options)
         return _response.data
 
-    async def get_by_external_id(
-        self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    async def update_contact_by_external_id(
+        self,
+        external_id_: str,
+        *,
+        customer_id: typing.Optional[str] = OMIT,
+        first_name: typing.Optional[str] = OMIT,
+        last_name: typing.Optional[str] = OMIT,
+        email: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        billing_address: typing.Optional[ContactBillingAddress] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> Contact:
         """
+        Update a contact by its externalId
+
         Parameters
         ----------
-        external_id : str
+        external_id_ : str
+
+        customer_id : typing.Optional[str]
+
+        first_name : typing.Optional[str]
+
+        last_name : typing.Optional[str]
+
+        email : typing.Optional[str]
+
+        phone : typing.Optional[str]
+
+        billing_address : typing.Optional[ContactBillingAddress]
+
+        external_id : typing.Optional[str]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -482,7 +751,7 @@ class AsyncContactsClient:
         Returns
         -------
         Contact
-            Success response
+            200
 
         Examples
         --------
@@ -496,20 +765,32 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.get_by_external_id(
-                external_id="externalId",
+            await client.contacts.update_contact_by_external_id(
+                external_id_="externalId",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.get_by_external_id(external_id, request_options=request_options)
+        _response = await self._raw_client.update_contact_by_external_id(
+            external_id_,
+            customer_id=customer_id,
+            first_name=first_name,
+            last_name=last_name,
+            email=email,
+            phone=phone,
+            billing_address=billing_address,
+            external_id=external_id,
+            request_options=request_options,
+        )
         return _response.data
 
-    async def delete_by_external_id(
+    async def delete_contact_by_external_id(
         self, external_id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> None:
+    ) -> EmptyResponse:
         """
+        Delete a contact by its externalId
+
         Parameters
         ----------
         external_id : str
@@ -519,7 +800,8 @@ class AsyncContactsClient:
 
         Returns
         -------
-        None
+        EmptyResponse
+            200
 
         Examples
         --------
@@ -533,12 +815,12 @@ class AsyncContactsClient:
 
 
         async def main() -> None:
-            await client.contacts.delete_by_external_id(
+            await client.contacts.delete_contact_by_external_id(
                 external_id="externalId",
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.delete_by_external_id(external_id, request_options=request_options)
+        _response = await self._raw_client.delete_contact_by_external_id(external_id, request_options=request_options)
         return _response.data