feat: api keys async module

Author: drish

examples/api_keys_async.py

@@ -0,0 +1,35 @@
+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.ApiKeys.CreateParams = {
+        "name": "example.com",
+    }
+
+    key: resend.ApiKey = await resend.ApiKeys.create_async(params=create_params)
+    print("Created new api key")
+    print(f"Key id: {key['id']} and token: {key['token']}")
+
+    keys: resend.ApiKeys.ListResponse = await resend.ApiKeys.list_async()
+    for key in keys["data"]:
+        print(key["id"])
+        print(key["name"])
+        print(key["created_at"])
+
+    if len(keys["data"]) > 0:
+        await resend.ApiKeys.remove_async(api_key_id=keys["data"][0]["id"])
+        print(f"Removed api key: {keys['data'][0]['id']}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

resend/api_keys/_api_keys.py

@@ -5,6 +5,12 @@
 from resend import request
 from resend.api_keys._api_key import ApiKey
 
+# 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[ApiKey]
@@ -90,3 +96,54 @@ def remove(cls, api_key_id: str) -> None:
         # This would raise if failed
         request.Request[None](path=path, params={}, verb="delete").perform()
         return None
+
+    @classmethod
+    async def create_async(cls, params: CreateParams) -> ApiKey:
+        """
+        Add a new API key to authenticate communications with Resend (async).
+        see more: https://resend.com/docs/api-reference/api-keys/create-api-key
+
+        Args:
+            params (CreateParams): The API key creation parameters
+
+        Returns:
+            ApiKey: The new API key object
+        """
+        path = "/api-keys"
+        resp = await AsyncRequest[ApiKey](
+            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 API keys for the authenticated user (async).
+        see more: https://resend.com/docs/api-reference/api-keys/list-api-keys
+
+        Returns:
+            ListResponse: A list of API key objects
+        """
+        path = "/api-keys"
+        resp = await AsyncRequest[_ListResponse](
+            path=path, params={}, verb="get"
+        ).perform_with_content()
+        return resp
+
+    @classmethod
+    async def remove_async(cls, api_key_id: str) -> None:
+        """
+        Remove an existing API key (async).
+        see more: https://resend.com/docs/api-reference/api-keys/delete-api-key
+
+        Args:
+            api_key_id (str): The ID of the API key to remove
+
+        Returns:
+            None
+        """
+        path = f"/api-keys/{api_key_id}"
+
+        # This would raise if failed
+        await AsyncRequest[None](path=path, params={}, verb="delete").perform()
+        return None

tests/api_keys_async_test.py

@@ -0,0 +1,69 @@
+import pytest
+import resend
+from resend.exceptions import NoContentError
+from tests.conftest import ResendBaseTest
+
+# flake8: noqa
+
+
+class TestResendApiKeysAsync(ResendBaseTest):
+    @pytest.mark.asyncio
+    async def test_api_keys_create_async(self) -> None:
+        self.set_mock_json(
+            {
+                "id": "dacf4072-4119-4d88-932f-6202748ac7c8",
+                "token": "re_c1tpEyD8_NKFusih9vKVQknRAQfmFcWCv",
+            }
+        )
+
+        params: resend.ApiKeys.CreateParams = {
+            "name": "prod",
+        }
+        key: resend.ApiKey = await resend.ApiKeys.create_async(params)
+        assert key["id"] == "dacf4072-4119-4d88-932f-6202748ac7c8"
+
+    @pytest.mark.asyncio
+    async def test_should_create_api_key_async_raise_exception_when_no_content(self) -> None:
+        self.set_mock_json(None)
+        params: resend.ApiKeys.CreateParams = {
+            "name": "prod",
+        }
+        with self.assertRaises(NoContentError):
+            _ = await resend.ApiKeys.create_async(params)
+
+    @pytest.mark.asyncio
+    async def test_api_keys_list_async(self) -> None:
+        self.set_mock_json(
+            {
+                "data": [
+                    {
+                        "id": "91f3200a-df72-4654-b0cd-f202395f5354",
+                        "name": "Production",
+                        "created_at": "2023-04-08T00:11:13.110779+00:00",
+                    }
+                ]
+            }
+        )
+
+        keys: resend.ApiKeys.ListResponse = await resend.ApiKeys.list_async()
+        for key in keys["data"]:
+            assert key["id"] == "91f3200a-df72-4654-b0cd-f202395f5354"
+            assert key["name"] == "Production"
+            assert key["created_at"] == "2023-04-08T00:11:13.110779+00:00"
+
+    @pytest.mark.asyncio
+    async def test_should_list_api_key_async_raise_exception_when_no_content(self) -> None:
+        self.set_mock_json(None)
+        with self.assertRaises(NoContentError):
+            _ = await resend.ApiKeys.list_async()
+
+    @pytest.mark.asyncio
+    async def test_api_keys_remove_async(self) -> None:
+        self.set_mock_text("")
+
+        assert (
+            await resend.ApiKeys.remove_async(
+                api_key_id="4ef9a417-02e9-4d39-ad75-9611e0fcc33c",
+            )
+            is None
+        )