fix(Audiences): use RemoveAudienceResponse type on Audiences.remove

Author: drish

examples/audiences.py

@@ -22,6 +22,8 @@
 audiences: resend.Audiences.ListResponse = resend.Audiences.list()
 print("List of audiences:", [a["id"] for a in audiences["data"]])
 
-rmed: resend.Audience = resend.Audiences.remove(id=audience["id"])
-print(f"Deleted audience")
+rmed: resend.Audiences.RemoveAudienceResponse = resend.Audiences.remove(
+    id=audience["id"]
+)
+print(f"Deleted audience with ID: {audience['id']}")
 print(rmed)

resend/audiences/_audience.py

@@ -14,7 +14,3 @@ class Audience(TypedDict):
     """
     The date and time the audience was created.
     """
-    deleted: bool
-    """
-    Wether the audience was deleted. Only returned on the "remove" call
-    """

resend/audiences/_audiences.py

@@ -9,6 +9,29 @@
 
 class Audiences:
 
+    class RemoveAudienceResponse(TypedDict):
+        """
+        RemoveAudienceResponse is the type that wraps the response of the audience that was removed
+
+        Attributes:
+            object (str): The object type, "audience"
+            id (str): The ID of the removed audience
+            deleted (bool): Whether the audience was deleted
+        """
+
+        object: str
+        """
+        The object type, "audience"
+        """
+        id: str
+        """
+        The ID of the removed audience
+        """
+        deleted: bool
+        """
+        Whether the audience was deleted
+        """
+
     class ListResponse(TypedDict):
         """
         ListResponse type that wraps a list of audience objects
@@ -105,7 +128,7 @@ def get(cls, id: str) -> Audience:
         return resp
 
     @classmethod
-    def remove(cls, id: str) -> Audience:
+    def remove(cls, id: str) -> RemoveAudienceResponse:
         """
         Delete a single audience.
         see more: https://resend.com/docs/api-reference/audiences/delete-audience
@@ -114,10 +137,10 @@ def remove(cls, id: str) -> Audience:
             id (str): The audience ID
 
         Returns:
-            Audience: The audience object
+            RemoveAudienceResponse: The removed audience response
         """
         path = f"/audiences/{id}"
-        resp = request.Request[Audience](
+        resp = request.Request[Audiences.RemoveAudienceResponse](
             path=path, params={}, verb="delete"
         ).perform_with_content()
         return resp

tests/audiences_test.py

@@ -59,7 +59,10 @@ def test_audiences_remove(self) -> None:
             }
         )
 
-        rmed = resend.Audiences.remove("78261eea-8f8b-4381-83c6-79fa7120f1cf")
+        rmed: resend.Audiences.RemoveAudienceResponse = resend.Audiences.remove(
+            "78261eea-8f8b-4381-83c6-79fa7120f1cf"
+        )
+        assert rmed["object"] == "audience"
         assert rmed["id"] == "78261eea-8f8b-4381-83c6-79fa7120f1cf"
         assert rmed["deleted"] is True