fix: add RemoveContactResponse type, update tests, rm created_at from audiences class

Author: drish

examples/contacts.py

@@ -50,10 +50,12 @@
     print(c)
 
 # remove by email
-rmed = resend.Contacts.remove(audience_id=audience_id, email=cont_by_email["email"])
+rmed: resend.Contacts.RemoveContactResponse = 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"])
+# rmed: resend.Contacts.RemoveContactResponse = resend.Contacts.remove(audience_id=audience_id, id=cont["id"])
 
-print(f"Removed contact")
+print(f"Removed contact with ID: {rmed['contact']}")
 print(rmed)

resend/audiences/_audiences.py

@@ -27,11 +27,16 @@ class CreateAudienceResponse(TypedDict):
         CreateAudienceResponse is the type that wraps the response of the audience that was created
 
         Attributes:
+            object (str): The object type, "audience"
             id (str): The ID of the created audience
             name (str): The name of the created audience
             created_at (str): When the audience was created
         """
 
+        object: str
+        """
+        The object type, "audience"
+        """
         id: str
         """
         The ID of the created audience
@@ -40,10 +45,6 @@ class CreateAudienceResponse(TypedDict):
         """
         The name of the created audience
         """
-        created_at: str
-        """
-        When the audience was created
-        """
 
     class CreateParams(TypedDict):
         name: str

resend/contacts/_contact.py

@@ -1,4 +1,4 @@
-from typing_extensions import TypedDict
+from typing_extensions import NotRequired, TypedDict
 
 
 class Contact(TypedDict):
@@ -10,11 +10,11 @@ class Contact(TypedDict):
     """
     The email of the contact.
     """
-    first_name: str
+    first_name: NotRequired[str]
     """
     The first name of the contact.
     """
-    last_name: str
+    last_name: NotRequired[str]
     """
     The last name of the contact.
     """
@@ -26,7 +26,3 @@ class Contact(TypedDict):
     """
     The unsubscribed status of the contact.
     """
-    deleted: bool
-    """
-    Wether the contact is deleted or not.
-    """

resend/contacts/_contacts.py

@@ -9,14 +9,42 @@
 
 class Contacts:
 
+    class RemoveContactResponse(TypedDict):
+        """
+        RemoveContactResponse is the type that wraps the response of the contact that was removed
+
+        Attributes:
+            object (str): 'contact'
+            contact (str): The ID of the removed contact
+            deleted (bool): Whether the contact was deleted
+        """
+
+        object: str
+        """
+        The object type: contact
+        """
+        contact: str
+        """
+        The ID of the removed contact.
+        """
+        deleted: bool
+        """
+        Whether the contact was deleted.
+        """
+
     class ListResponse(TypedDict):
         """
         ListResponse type that wraps a list of contact objects
 
         Attributes:
+            object (str): The object type: list
             data (List[Contact]): A list of contact objects
         """
 
+        object: str
+        """
+        The object type: list
+        """
         data: List[Contact]
         """
         A list of contact objects
@@ -195,7 +223,7 @@ def get(
     @classmethod
     def remove(
         cls, audience_id: str, id: Optional[str] = None, email: Optional[str] = None
-    ) -> Contact:
+    ) -> RemoveContactResponse:
         """
         Remove a contact by ID or by Email
         see more: https://resend.com/docs/api-reference/contacts/delete-contact
@@ -206,14 +234,14 @@ def remove(
             email (str): The contact email
 
         Returns:
-            Contact: The removed contact object
+            RemoveContactResponse: The removed contact response object
         """
         contact = email if id is None else id
         if contact is None:
             raise ValueError("id or email must be provided")
         path = f"/audiences/{audience_id}/contacts/{contact}"
 
-        resp = request.Request[Contact](
+        resp = request.Request[Contacts.RemoveContactResponse](
             path=path, params={}, verb="delete"
         ).perform_with_content()
         return resp

tests/contacts_test.py

@@ -93,8 +93,8 @@ def test_contacts_get(self) -> None:
         )
         assert contact["id"] == "e169aa45-1ecf-4183-9955-b1499d5701d3"
         assert contact["email"] == "steve.wozniak@gmail.com"
-        assert contact["first_name"] == "Steve"
-        assert contact["last_name"] == "Wozniak"
+        assert contact.get("first_name") == "Steve"
+        assert contact.get("last_name") == "Wozniak"
         assert contact["created_at"] == "2023-10-06T23:47:56.678Z"
         assert contact["unsubscribed"] is False
 
@@ -144,7 +144,7 @@ def test_contacts_remove_by_id(self) -> None:
         self.set_mock_json(
             {
                 "object": "contact",
-                "id": "520784e2-887d-4c25-b53c-4ad46ad38100",
+                "contact": "520784e2-887d-4c25-b53c-4ad46ad38100",
                 "deleted": True,
             }
         )
@@ -153,7 +153,7 @@ def test_contacts_remove_by_id(self) -> None:
             audience_id="48c269ed-9873-4d60-bdd9-cd7e6fc0b9b8",
             id="78261eea-8f8b-4381-83c6-79fa7120f1cf",
         )
-        assert rmed["id"] == "520784e2-887d-4c25-b53c-4ad46ad38100"
+        assert rmed["contact"] == "520784e2-887d-4c25-b53c-4ad46ad38100"
         assert rmed["deleted"] is True
 
     def test_should_remove_contacts_by_id_raise_exception_when_no_content(self) -> None:
@@ -168,16 +168,16 @@ def test_contacts_remove_by_email(self) -> None:
         self.set_mock_json(
             {
                 "object": "contact",
-                "id": "520784e2-887d-4c25-b53c-4ad46ad38100",
+                "contact": "520784e2-887d-4c25-b53c-4ad46ad38100",
                 "deleted": True,
             }
         )
 
-        rmed: resend.Contact = resend.Contacts.remove(
+        rmed: resend.Contacts.RemoveContactResponse = resend.Contacts.remove(
             audience_id="48c269ed-9873-4d60-bdd9-cd7e6fc0b9b8",
             email="someemail@email.com",
         )
-        assert rmed["id"] == "520784e2-887d-4c25-b53c-4ad46ad38100"
+        assert rmed["contact"] == "520784e2-887d-4c25-b53c-4ad46ad38100"
         assert rmed["deleted"] is True
 
     def test_should_remove_contacts_by_email_raise_exception_when_no_content(
@@ -222,8 +222,8 @@ def test_contacts_list(self) -> None:
         )
         assert contacts["data"][0]["id"] == "e169aa45-1ecf-4183-9955-b1499d5701d3"
         assert contacts["data"][0]["email"] == "steve.wozniak@gmail.com"
-        assert contacts["data"][0]["first_name"] == "Steve"
-        assert contacts["data"][0]["last_name"] == "Wozniak"
+        assert contacts["data"][0].get("first_name") == "Steve"
+        assert contacts["data"][0].get("last_name") == "Wozniak"
         assert contacts["data"][0]["created_at"] == "2023-10-06T23:47:56.678Z"
         assert contacts["data"][0]["unsubscribed"] is False