feat: audiences module async

Author: drish

examples/audiences_async.py

@@ -0,0 +1,34 @@
+import asyncio
+import os
+from typing import List
+
+import resend
+
+if not os.environ["RESEND_API_KEY"]:
+    raise EnvironmentError("RESEND_API_KEY is missing")
+
+# Set up async HTTP client
+resend.default_http_client = resend.HTTPXClient()
+
+
+async def main() -> None:
+    create_params: resend.Audiences.CreateParams = {
+        "name": "New Audience from Python SDK (Async)",
+    }
+    audience: resend.Audience = await resend.Audiences.create_async(create_params)
+    print(f"Created audience: {audience['id']}")
+    print(audience)
+
+    aud: resend.Audience = await resend.Audiences.get_async(audience["id"])
+    print("Retrieved audience: ", aud)
+
+    audiences: resend.Audiences.ListResponse = await resend.Audiences.list_async()
+    print("List of audiences:", [a["id"] for a in audiences["data"]])
+
+    rmed: resend.Audience = await resend.Audiences.remove_async(id=audience["id"])
+    print(f"Deleted audience")
+    print(rmed)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

resend/audiences/_audiences.py

@@ -6,6 +6,12 @@
 
 from ._audience import Audience
 
+# Async imports (optional - only available with pip install resend[async])
+try:
+    from resend.async_request import AsyncRequest
+except ImportError:
+    pass
+
 
 class _ListResponse(TypedDict):
     data: List[Audience]
@@ -98,3 +104,72 @@ def remove(cls, id: str) -> Audience:
             path=path, params={}, verb="delete"
         ).perform_with_content()
         return resp
+
+    @classmethod
+    async def create_async(cls, params: CreateParams) -> Audience:
+        """
+        Create a list of contacts (async).
+        see more: https://resend.com/docs/api-reference/audiences/create-audience
+
+        Args:
+            params (CreateParams): The audience creation parameters
+
+        Returns:
+            Audience: The new audience object
+        """
+        path = "/audiences"
+        resp = await AsyncRequest[Audience](
+            path=path, params=cast(Dict[Any, Any], params), verb="post"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def list_async(cls) -> ListResponse:
+        """
+        Retrieve a list of audiences (async).
+        see more: https://resend.com/docs/api-reference/audiences/list-audiences
+
+        Returns:
+            ListResponse: A list of audience objects
+        """
+        path = "/audiences/"
+        resp = await AsyncRequest[_ListResponse](
+            path=path, params={}, verb="get"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def get_async(cls, id: str) -> Audience:
+        """
+        Retrieve a single audience (async).
+        see more: https://resend.com/docs/api-reference/audiences/get-audience
+
+        Args:
+            id (str): The audience ID
+
+        Returns:
+            Audience: The audience object
+        """
+        path = f"/audiences/{id}"
+        resp = await AsyncRequest[Audience](
+            path=path, params={}, verb="get"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def remove_async(cls, id: str) -> Audience:
+        """
+        Delete a single audience (async).
+        see more: https://resend.com/docs/api-reference/audiences/delete-audience
+
+        Args:
+            id (str): The audience ID
+
+        Returns:
+            Audience: The audience object
+        """
+        path = f"/audiences/{id}"
+        resp = await AsyncRequest[Audience](
+            path=path, params={}, verb="delete"
+        ).perform_with_content()
+        return resp

tests/audiences_async_test.py

@@ -0,0 +1,108 @@
+import resend
+from resend.exceptions import NoContentError
+from tests.conftest import ResendBaseTest
+
+# flake8: noqa
+
+
+class TestResendAudiencesAsync(ResendBaseTest):
+    async def test_audiences_create_async(self) -> None:
+        self.set_mock_json(
+            {
+                "object": "audience",
+                "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
+                "name": "Registered Users",
+            }
+        )
+
+        params: resend.Audiences.CreateParams = {
+            "name": "Python SDK Audience",
+        }
+        audience = await resend.Audiences.create_async(params)
+        assert audience["id"] == "78261eea-8f8b-4381-83c6-79fa7120f1cf"
+        assert audience["name"] == "Registered Users"
+
+    async def test_should_create_audiences_async_raise_exception_when_no_content(
+        self,
+    ) -> None:
+        self.set_mock_json(None)
+        params: resend.Audiences.CreateParams = {
+            "name": "Python SDK Audience",
+        }
+        with self.assertRaises(NoContentError):
+            _ = await resend.Audiences.create_async(params)
+
+    async def test_audiences_get_async(self) -> None:
+        self.set_mock_json(
+            {
+                "object": "audience",
+                "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
+                "name": "Registered Users",
+                "created_at": "2023-10-06T22:59:55.977Z",
+            }
+        )
+
+        audience = await resend.Audiences.get_async(
+            id="78261eea-8f8b-4381-83c6-79fa7120f1cf"
+        )
+        assert audience["id"] == "78261eea-8f8b-4381-83c6-79fa7120f1cf"
+        assert audience["name"] == "Registered Users"
+        assert audience["created_at"] == "2023-10-06T22:59:55.977Z"
+
+    async def test_should_get_audiences_async_raise_exception_when_no_content(
+        self,
+    ) -> None:
+        self.set_mock_json(None)
+        with self.assertRaises(NoContentError):
+            _ = await resend.Audiences.get_async(
+                id="78261eea-8f8b-4381-83c6-79fa7120f1cf"
+            )
+
+    async def test_audiences_remove_async(self) -> None:
+        self.set_mock_json(
+            {
+                "object": "audience",
+                "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
+                "deleted": True,
+            }
+        )
+
+        rmed = await resend.Audiences.remove_async(
+            "78261eea-8f8b-4381-83c6-79fa7120f1cf"
+        )
+        assert rmed["id"] == "78261eea-8f8b-4381-83c6-79fa7120f1cf"
+        assert rmed["deleted"] is True
+
+    async def test_should_remove_audiences_async_raise_exception_when_no_content(
+        self,
+    ) -> None:
+        self.set_mock_json(None)
+        with self.assertRaises(NoContentError):
+            _ = await resend.Audiences.remove_async(
+                id="78261eea-8f8b-4381-83c6-79fa7120f1cf"
+            )
+
+    async def test_audiences_list_async(self) -> None:
+        self.set_mock_json(
+            {
+                "object": "list",
+                "data": [
+                    {
+                        "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
+                        "name": "Registered Users",
+                        "created_at": "2023-10-06T22:59:55.977Z",
+                    }
+                ],
+            }
+        )
+
+        audiences: resend.Audiences.ListResponse = await resend.Audiences.list_async()
+        assert audiences["data"][0]["id"] == "78261eea-8f8b-4381-83c6-79fa7120f1cf"
+        assert audiences["data"][0]["name"] == "Registered Users"
+
+    async def test_should_list_audiences_async_raise_exception_when_no_content(
+        self,
+    ) -> None:
+        self.set_mock_json(None)
+        with self.assertRaises(NoContentError):
+            _ = await resend.Audiences.list_async()