feat: broadcasts async module

Author: drish

examples/broadcasts_async.py

@@ -0,0 +1,77 @@
+import asyncio
+import os
+from typing import List
+
+import resend
+import resend.broadcasts
+
+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()
+
+# replace with some existing audience id
+audience_id: str = "78b8d3bc-a55a-45a3-aee6-6ec0a5e13d7e"
+
+
+async def main() -> None:
+    create_params: resend.Broadcasts.CreateParams = {
+        "audience_id": audience_id,
+        "from": "onboarding@resend.dev",
+        "subject": "Hello, world! (Async)",
+        "html": "<p>Hello, world!</p>",
+        "text": "Hello, world!",
+        "reply_to": ["foo@resend.dev", "bar@resend.dev"],
+        "name": "Hello, world! (Async)",
+    }
+
+    broadcast: resend.Broadcasts.CreateResponse = await resend.Broadcasts.create_async(
+        create_params
+    )
+    print("Created broadcast !")
+    print(broadcast)
+
+    update_params: resend.Broadcasts.UpdateParams = {
+        "broadcast_id": broadcast["id"],
+        "html": "<p>Hello, world! Updated (Async)</p>",
+        "text": "Hello, world! Updated (Async)",
+        "name": "Hello, world! Updated (Async)",
+    }
+
+    updated_broadcast: resend.Broadcasts.UpdateResponse = (
+        await resend.Broadcasts.update_async(update_params)
+    )
+    print("Updated broadcast!")
+    print(updated_broadcast)
+
+    send_params: resend.Broadcasts.SendParams = {
+        "broadcast_id": broadcast["id"],
+    }
+    sent: resend.Broadcasts.SendResponse = await resend.Broadcasts.send_async(
+        send_params
+    )
+    print("Sent broadcast !\n")
+    print(sent)
+
+    retrieved: resend.Broadcast = await resend.Broadcasts.get_async(id=broadcast["id"])
+    print("retrieved broadcast !\n")
+    print(retrieved)
+
+    if retrieved["status"] == "draft":
+        removed: resend.Broadcasts.RemoveResponse = (
+            await resend.Broadcasts.remove_async(id=broadcast["id"])
+        )
+        print("Removed broadcast !\n")
+        print(removed)
+        print("\n")
+    else:
+        print("Broadcast is not in draft status, cannot remove it.\n")
+
+    list_response: resend.Broadcasts.ListResponse = await resend.Broadcasts.list_async()
+    print("List of broadcasts !\n")
+    print(list_response)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

resend/broadcasts/_broadcasts.py

@@ -6,6 +6,12 @@
 
 from ._broadcast import Broadcast
 
+# Async imports (optional - only available with pip install resend[async])
+try:
+    from resend.async_request import AsyncRequest
+except ImportError:
+    pass
+
 # _CreateParamsFrom is declared with functional TypedDict syntax here because
 # "from" is a reserved keyword in Python, and this is the best way to
 # support type-checking for it.
@@ -323,3 +329,108 @@ def remove(cls, id: str) -> RemoveResponse:
             path=path, params={}, verb="delete"
         ).perform_with_content()
         return resp
+
+    @classmethod
+    async def create_async(cls, params: CreateParams) -> CreateResponse:
+        """
+        Create a broadcast (async).
+        see more: https://resend.com/docs/api-reference/broadcasts/create-broadcast
+
+        Args:
+            params (CreateParams): The broadcast creation parameters
+
+        Returns:
+            CreateResponse: The new broadcast object response
+        """
+        path = "/broadcasts"
+        resp = await AsyncRequest[_CreateResponse](
+            path=path, params=cast(Dict[Any, Any], params), verb="post"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def update_async(cls, params: UpdateParams) -> UpdateResponse:
+        """
+        Update a broadcast (async).
+        see more: https://resend.com/docs/api-reference/broadcasts/update-broadcast
+
+        Args:
+            params (UpdateParams): The broadcast update parameters
+
+        Returns:
+            UpdateResponse: The updated broadcast object response
+        """
+        path = f"/broadcasts/{params['broadcast_id']}"
+        resp = await AsyncRequest[_UpdateResponse](
+            path=path, params=cast(Dict[Any, Any], params), verb="patch"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def send_async(cls, params: SendParams) -> SendResponse:
+        """
+        Sends a broadcast (async).
+        see more: https://resend.com/docs/api-reference/broadcasts/send-broadcast
+
+        Args:
+            params (SendParams): The broadcast send parameters
+
+        Returns:
+            SendResponse: The new broadcast object response
+        """
+        path = f"/broadcasts/{params['broadcast_id']}/send"
+        resp = await AsyncRequest[_SendResponse](
+            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 broadcasts (async).
+        see more: https://resend.com/docs/api-reference/broadcasts/list-broadcasts
+
+        Returns:
+            ListResponse: A list of broadcast objects
+        """
+        path = "/broadcasts/"
+        resp = await AsyncRequest[_ListResponse](
+            path=path, params={}, verb="get"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def get_async(cls, id: str) -> Broadcast:
+        """
+        Retrieve a single broadcast (async).
+        see more: https://resend.com/docs/api-reference/broadcasts/get-broadcast
+
+        Args:
+            id (str): The broadcast ID
+
+        Returns:
+            Broadcast: The broadcast object
+        """
+        path = f"/broadcasts/{id}"
+        resp = await AsyncRequest[Broadcast](
+            path=path, params={}, verb="get"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def remove_async(cls, id: str) -> RemoveResponse:
+        """
+        Delete a single broadcast (async).
+        see more: https://resend.com/docs/api-reference/broadcasts/delete-broadcasts
+
+        Args:
+            id (str): The broadcast ID
+
+        Returns:
+            RemoveResponse: The remove response object
+        """
+        path = f"/broadcasts/{id}"
+        resp = await AsyncRequest[_RemoveResponse](
+            path=path, params={}, verb="delete"
+        ).perform_with_content()
+        return resp