refactor(Contacts): fix return type for create/udpate and cleanup types definitions

Author: drish

examples/contacts.py

@@ -17,8 +17,8 @@
     "unsubscribed": False,
 }
 
-contact: resend.Contact = resend.Contacts.create(create_params)
-print("Created contact !")
+contact: resend.Contacts.CreateContactResponse = resend.Contacts.create(create_params)
+print("Created contact with ID: {}".format(contact["id"]))
 print(contact)
 
 update_params: resend.Contacts.UpdateParams = {
@@ -28,8 +28,8 @@
     "first_name": "Steve",
 }
 
-updated: resend.Contact = resend.Contacts.update(update_params)
-print("updated contact !")
+updated: resend.Contacts.UpdateContactResponse = resend.Contacts.update(update_params)
+print("updated contact with ID: {}".format(updated["id"]))
 print(updated)
 
 cont_by_id: resend.Contact = resend.Contacts.get(
@@ -46,11 +46,11 @@
 
 contacts: resend.Contacts.ListResponse = resend.Contacts.list(audience_id=audience_id)
 print("List of contacts")
-for contact in contacts["data"]:
-    print(contact)
+for c in contacts["data"]:
+    print(c)
 
 # remove by email
-rmed = resend.Contacts.remove(audience_id=audience_id, email=contact["email"])
+rmed = resend.Contacts.remove(audience_id=audience_id, email=cont_by_email["email"])
 
 # remove by id
 # rmed: resend.Contact = resend.Contacts.remove(audience_id=audience_id, id=cont["id"])

resend/contacts/_contacts.py

@@ -7,23 +7,57 @@
 from ._contact import Contact
 
 
-class _ListResponse(TypedDict):
-    data: List[Contact]
-    """
-    A list of contact objects
-    """
-
-
 class Contacts:
 
-    class ListResponse(_ListResponse):
+    class ListResponse(TypedDict):
         """
         ListResponse type that wraps a list of contact objects
 
         Attributes:
             data (List[Contact]): A list of contact objects
         """
 
+        data: List[Contact]
+        """
+        A list of contact objects
+        """
+
+    class CreateContactResponse(TypedDict):
+        """
+        CreateContactResponse is the type that wraps the response of the contact that was created
+
+        Attributes:
+            object (str): The ID of the created contact
+            id (str): The ID of the created contact
+        """
+
+        object: str
+        """
+        The object type: email
+        """
+        id: str
+        """
+        The ID of the scheduled email that was canceled.
+        """
+
+    class UpdateContactResponse(TypedDict):
+        """
+        UpdateContactResponse is the type that wraps the response of the contact that was updated
+
+        Attributes:
+            object (str): The ID of the updated contact
+            id (str): The ID of the updated contact
+        """
+
+        object: str
+        """
+        The object type: email
+        """
+        id: str
+        """
+        The ID of the updated contact.
+        """
+
     class CreateParams(TypedDict):
         audience_id: str
         """
@@ -73,7 +107,7 @@ class UpdateParams(TypedDict):
         """
 
     @classmethod
-    def create(cls, params: CreateParams) -> Contact:
+    def create(cls, params: CreateParams) -> CreateContactResponse:
         """
         Create a new contact.
         see more: https://resend.com/docs/api-reference/contacts/create-contact
@@ -82,16 +116,17 @@ def create(cls, params: CreateParams) -> Contact:
             params (CreateParams): The contact creation parameters
 
         Returns:
-            Contact: The new contact object
+            CreateContactResponse: The created contact response
         """
+
         path = f"/audiences/{params['audience_id']}/contacts"
-        resp = request.Request[Contact](
+        resp = request.Request[Contacts.CreateContactResponse](
             path=path, params=cast(Dict[Any, Any], params), verb="post"
         ).perform_with_content()
         return resp
 
     @classmethod
-    def update(cls, params: UpdateParams) -> Contact:
+    def update(cls, params: UpdateParams) -> UpdateContactResponse:
         """
         Update an existing contact.
         see more: https://resend.com/docs/api-reference/contacts/update-contact
@@ -100,15 +135,15 @@ def update(cls, params: UpdateParams) -> Contact:
             params (UpdateParams): The contact update parameters
 
         Returns:
-            Contact: The updated contact object
+            UpdateContactResponse: The updated contact response.
         """
         if params.get("id") is None and params.get("email") is None:
             raise ValueError("id or email must be provided")
 
         val = params.get("id") if params.get("id") is not None else params.get("email")
 
         path = f"/audiences/{params['audience_id']}/contacts/{val}"
-        resp = request.Request[Contact](
+        resp = request.Request[Contacts.UpdateContactResponse](
             path=path, params=cast(Dict[Any, Any], params), verb="patch"
         ).perform_with_content()
         return resp
@@ -126,7 +161,7 @@ def list(cls, audience_id: str) -> ListResponse:
             ListResponse: A list of contact objects
         """
         path = f"/audiences/{audience_id}/contacts"
-        resp = request.Request[_ListResponse](
+        resp = request.Request[Contacts.ListResponse](
             path=path, params={}, verb="get"
         ).perform_with_content()
         return resp

tests/contacts_test.py

@@ -18,7 +18,7 @@ def test_contacts_create(self) -> None:
             "last_name": "Wozniak",
             "unsubscribed": True,
         }
-        contact: resend.Contact = resend.Contacts.create(params)
+        contact: resend.Contacts.CreateContactResponse = resend.Contacts.create(params)
         assert contact["id"] == "479e3145-dd38-476b-932c-529ceb705947"
 
     def test_should_create_contacts_raise_exception_when_no_content(self) -> None: