feat: get contact by email

Author: drish

examples/contacts.py

@@ -7,8 +7,7 @@
     raise EnvironmentError("RESEND_API_KEY is missing")
 
 # replace with some audience id
-audience_id: str = "78b8d3bc-a55a-45a3-aee6-6ec0a5e13d7e"
-contact_id: str = "b5c95127-937b-4872-a765-06636e5f73da"
+audience_id: str = "ca4e37c5-a82a-4199-a3b8-bf912a6472aa"
 
 create_params: resend.Contacts.CreateParams = {
     "audience_id": audience_id,
@@ -24,7 +23,7 @@
 
 update_params: resend.Contacts.UpdateParams = {
     "audience_id": audience_id,
-    "id": contact_id,
+    "id": contact["id"],
     "unsubscribed": False,
     "first_name": "Steve",
 }
@@ -33,17 +32,25 @@
 print("updated contact !")
 print(updated)
 
-cont: resend.Contact = resend.Contacts.get(audience_id=audience_id, id=contact["id"])
-print("Retrieved contact")
-print(cont)
+cont_by_id: resend.Contact = resend.Contacts.get(
+    email=contact["id"], audience_id=audience_id
+)
+print("Retrieved contact by ID")
+print(cont_by_id)
+
+cont_by_email: resend.Contact = resend.Contacts.get(
+    email="sw@exmple.com", audience_id=audience_id
+)
+print("Retrieved contact by Email")
+print(cont_by_email)
 
 contacts: resend.Contacts.ListResponse = resend.Contacts.list(audience_id=audience_id)
 print("List of contacts")
 for contact in contacts["data"]:
     print(contact)
 
 # remove by email
-rmed = resend.Contacts.remove(audience_id=audience_id, email=cont["email"])
+rmed = resend.Contacts.remove(audience_id=audience_id, email=contact["email"])
 
 # remove by id
 # rmed: resend.Contact = resend.Contacts.remove(audience_id=audience_id, id=cont["id"])

resend/contacts/_contacts.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, cast
+from typing import Any, Dict, List, Optional, cast
 
 from typing_extensions import NotRequired, TypedDict
 
@@ -132,26 +132,35 @@ def list(cls, audience_id: str) -> ListResponse:
         return resp
 
     @classmethod
-    def get(cls, id: str, audience_id: str) -> Contact:
+    def get(
+        cls, audience_id: str, id: Optional[str] = None, email: Optional[str] = None
+    ) -> Contact:
         """
         Get a contact.
         see more: https://resend.com/docs/api-reference/contacts/get-contact
 
         Args:
             id (str): The contact ID
             audience_id (str): The audience ID
+            email (Optional[str]): The contact email
 
         Returns:
             Contact: The contact object
         """
-        path = f"/audiences/{audience_id}/contacts/{id}"
+        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](
             path=path, params={}, verb="get"
         ).perform_with_content()
         return resp
 
     @classmethod
-    def remove(cls, audience_id: str, id: str = "", email: str = "") -> Contact:
+    def remove(
+        cls, audience_id: str, id: Optional[str] = None, email: Optional[str] = None
+    ) -> Contact:
         """
         Remove a contact by ID or by Email
         see more: https://resend.com/docs/api-reference/contacts/delete-contact
@@ -164,8 +173,8 @@ def remove(cls, audience_id: str, id: str = "", email: str = "") -> Contact:
         Returns:
             Contact: The removed contact object
         """
-        contact = email if id == "" else id
-        if contact == "":
+        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}"
 

tests/contacts_test.py

@@ -98,6 +98,40 @@ def test_contacts_get(self) -> None:
         assert contact["created_at"] == "2023-10-06T23:47:56.678Z"
         assert contact["unsubscribed"] is False
 
+    def test_contacts_get_by_email(self) -> None:
+        self.set_mock_json(
+            {
+                "object": "contact",
+                "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
+                "email": "steve@woz.com",
+                "first_name": "Steve",
+                "last_name": "Wozniak",
+                "created_at": "2023-10-06T23:47:56.678Z",
+                "unsubscribed": False,
+            }
+        )
+
+        contact: resend.Contact = resend.Contacts.get(
+            email="steve@woz.com",
+            audience_id="48c269ed-9873-4d60-bdd9-cd7e6fc0b9b8",
+        )
+        assert contact["id"] == "e169aa45-1ecf-4183-9955-b1499d5701d3"
+        assert contact["email"] == "steve@woz.com"
+        assert contact["first_name"] == "Steve"
+        assert contact["last_name"] == "Wozniak"
+        assert contact["created_at"] == "2023-10-06T23:47:56.678Z"
+        assert contact["unsubscribed"] is False
+
+    def test_contacts_get_raises(self) -> None:
+        resend.api_key = "re_123"
+
+        with self.assertRaises(ValueError) as context:
+            resend.Contacts.get(
+                audience_id="48c269ed-9873-4d60-bdd9-cd7e6fc0b9b8",
+            )
+
+        self.assertEqual("id or email must be provided", str(context.exception))
+
     def test_should_get_contacts_raise_exception_when_no_content(self) -> None:
         self.set_mock_json(None)
         with self.assertRaises(NoContentError):