refactor(api): align API key audit surface with browser sibling (KERNEL-1350)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 120
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-1f10598afa01d76d22b0ed63685248f482f74c9353cffe1d3e4a3d38da7716cf.yml
-openapi_spec_hash: 8936f458bfa681b709e459ca1cc76fb5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e8afdbeac9332cf79200c2eb873e532104fd0a7472b08e63cde6c857a87cf0c3.yml
+openapi_spec_hash: 2525caf30dffbdd83c83948201f11a52
 config_hash: 03c7e57f268c750e2415831662e95969

src/kernel/resources/api_keys.py

@@ -192,6 +192,7 @@ def list(
         query: str | Omit = omit,
         sort_by: Literal["created_at", "name", "expires_at"] | Omit = omit,
         sort_direction: Literal["asc", "desc"] | Omit = omit,
+        status: Literal["active", "deleted", "all"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -204,8 +205,8 @@ def list(
         API keys are masked.
 
         Args:
-          include_deleted: When true, include deleted (soft-deleted) API keys in the results for audit
-              purposes. Defaults to false, which returns only live keys.
+          include_deleted: Deprecated: use status=all instead. When true, include deleted (soft-deleted)
+              API keys in the results for audit purposes.
 
           limit: Maximum number of results to return
 
@@ -218,6 +219,10 @@ def list(
 
           sort_direction: Sort direction for API keys.
 
+          status: Filter API keys by status. "active" returns keys that are not deleted (default;
+              expired-but-not-deleted keys are still included), "deleted" returns only
+              soft-deleted keys, "all" returns both.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -242,6 +247,7 @@ def list(
                         "query": query,
                         "sort_by": sort_by,
                         "sort_direction": sort_direction,
+                        "status": status,
                     },
                     api_key_list_params.APIKeyListParams,
                 ),
@@ -495,6 +501,7 @@ def list(
         query: str | Omit = omit,
         sort_by: Literal["created_at", "name", "expires_at"] | Omit = omit,
         sort_direction: Literal["asc", "desc"] | Omit = omit,
+        status: Literal["active", "deleted", "all"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -507,8 +514,8 @@ def list(
         API keys are masked.
 
         Args:
-          include_deleted: When true, include deleted (soft-deleted) API keys in the results for audit
-              purposes. Defaults to false, which returns only live keys.
+          include_deleted: Deprecated: use status=all instead. When true, include deleted (soft-deleted)
+              API keys in the results for audit purposes.
 
           limit: Maximum number of results to return
 
@@ -521,6 +528,10 @@ def list(
 
           sort_direction: Sort direction for API keys.
 
+          status: Filter API keys by status. "active" returns keys that are not deleted (default;
+              expired-but-not-deleted keys are still included), "deleted" returns only
+              soft-deleted keys, "all" returns both.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -545,6 +556,7 @@ def list(
                         "query": query,
                         "sort_by": sort_by,
                         "sort_direction": sort_direction,
+                        "status": status,
                     },
                     api_key_list_params.APIKeyListParams,
                 ),

src/kernel/types/api_key.py

@@ -2,7 +2,6 @@
 
 from typing import Optional
 from datetime import datetime
-from typing_extensions import Literal
 
 from .._models import BaseModel
 
@@ -52,11 +51,3 @@ class APIKey(BaseModel):
 
     Null means the key is org-wide or the project name is unavailable.
     """
-
-    status: Literal["active", "expired", "deleted"]
-    """Derived lifecycle status of the API key.
-
-    `active` means usable. `expired` means past its expires_at. `deleted` means it
-    was deleted (soft-deleted) and can no longer authenticate. Deleted takes
-    precedence over expired.
-    """

src/kernel/types/api_key_list_params.py

@@ -9,9 +9,10 @@
 
 class APIKeyListParams(TypedDict, total=False):
     include_deleted: bool
-    """
+    """Deprecated: use status=all instead.
+
     When true, include deleted (soft-deleted) API keys in the results for audit
-    purposes. Defaults to false, which returns only live keys.
+    purposes.
     """
 
     limit: int
@@ -31,3 +32,11 @@ class APIKeyListParams(TypedDict, total=False):
 
     sort_direction: Literal["asc", "desc"]
     """Sort direction for API keys."""
+
+    status: Literal["active", "deleted", "all"]
+    """Filter API keys by status.
+
+    "active" returns keys that are not deleted (default; expired-but-not-deleted
+    keys are still included), "deleted" returns only soft-deleted keys, "all"
+    returns both.
+    """

tests/api_resources/test_api_keys.py

@@ -178,6 +178,7 @@ def test_method_list_with_all_params(self, client: Kernel) -> None:
             query="query",
             sort_by="created_at",
             sort_direction="asc",
+            status="active",
         )
         assert_matches_type(SyncOffsetPagination[APIKey], api_key, path=["response"])
 
@@ -460,6 +461,7 @@ async def test_method_list_with_all_params(self, async_client: AsyncKernel) -> N
             query="query",
             sort_by="created_at",
             sort_direction="asc",
+            status="active",
         )
         assert_matches_type(AsyncOffsetPagination[APIKey], api_key, path=["response"])