refactor(ApiKeys): change return type of send method

Author: drish

examples/api_keys.py

@@ -10,7 +10,7 @@
     "name": "example.com",
 }
 
-key: resend.ApiKey = resend.ApiKeys.create(params=create_params)
+key: resend.ApiKeys.CreateApiKeyResponse = resend.ApiKeys.create(params=create_params)
 print("Created new api key")
 print(f"Key id: {key['id']} and token: {key['token']}")
 

resend/api_keys/_api_keys.py

@@ -6,23 +6,39 @@
 from resend.api_keys._api_key import ApiKey
 
 
-class _ListResponse(TypedDict):
-    data: List[ApiKey]
-    """
-    A list of API key objects
-    """
-
-
 class ApiKeys:
 
-    class ListResponse(_ListResponse):
+    class ListResponse(TypedDict):
         """
         ListResponse type that wraps a list of API key objects
 
         Attributes:
             data (List[Dict[str, Any]]): A list of API key objects
         """
 
+        data: List[ApiKey]
+        """
+        A list of API key objects
+        """
+
+    class CreateApiKeyResponse(TypedDict):
+        """
+        CreateApiKeyResponse is the type that wraps the response of the API key that was created
+
+        Attributes:
+            id (str): The ID of the created API key
+            token (str): The token of the created API key
+        """
+
+        id: str
+        """
+        The ID of the created API key
+        """
+        token: str
+        """
+        The token of the created API key
+        """
+
     class CreateParams(TypedDict):
         name: str
         """
@@ -41,7 +57,7 @@ class CreateParams(TypedDict):
         """
 
     @classmethod
-    def create(cls, params: CreateParams) -> ApiKey:
+    def create(cls, params: CreateParams) -> CreateApiKeyResponse:
         """
         Add a new API key to authenticate communications with Resend.
         see more: https://resend.com/docs/api-reference/api-keys/create-api-key
@@ -50,10 +66,10 @@ def create(cls, params: CreateParams) -> ApiKey:
             params (CreateParams): The API key creation parameters
 
         Returns:
-            ApiKey: The new API key object
+            CreateApiKeyResponse: The created API key response with id and token
         """
         path = "/api-keys"
-        resp = request.Request[ApiKey](
+        resp = request.Request[ApiKeys.CreateApiKeyResponse](
             path=path, params=cast(Dict[Any, Any], params), verb="post"
         ).perform_with_content()
         return resp
@@ -68,7 +84,7 @@ def list(cls) -> ListResponse:
             ListResponse: A list of API key objects
         """
         path = "/api-keys"
-        resp = request.Request[_ListResponse](
+        resp = request.Request[ApiKeys.ListResponse](
             path=path, params={}, verb="get"
         ).perform_with_content()
         return resp

tests/api_keys_test.py

@@ -17,7 +17,7 @@ def test_api_keys_create(self) -> None:
         params: resend.ApiKeys.CreateParams = {
             "name": "prod",
         }
-        key: resend.ApiKey = resend.ApiKeys.create(params)
+        key: resend.ApiKeys.CreateApiKeyResponse = resend.ApiKeys.create(params)
         assert key["id"] == "dacf4072-4119-4d88-932f-6202748ac7c8"
 
     def test_should_create_api_key_raise_exception_when_no_content(self) -> None: