@unkey/api 2.0.6 → 2.1.0

package/src/models/errors/unprocessableentityerrorresponse.ts

@@ -0,0 +1,107 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+import { UnkeyError } from "./unkeyerror.js";
+
+/**
+ * Error response when the request is syntactically valid but cannot be processed due to semantic constraints or resource limitations. This occurs when:
+ *
+ * @remarks
+ * - A query exceeds execution time limits
+ * - A query uses more memory than allowed
+ * - A query scans too many rows
+ * - A query result exceeds size limits
+ *
+ * The request syntax is correct, but the operation cannot be completed due to business rules or resource constraints. Review the error details for specific limitations and adjust your request accordingly.
+ */
+export type UnprocessableEntityErrorResponseData = {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: components.Meta;
+  /**
+   * Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
+   */
+  error: components.BaseError;
+};
+
+/**
+ * Error response when the request is syntactically valid but cannot be processed due to semantic constraints or resource limitations. This occurs when:
+ *
+ * @remarks
+ * - A query exceeds execution time limits
+ * - A query uses more memory than allowed
+ * - A query scans too many rows
+ * - A query result exceeds size limits
+ *
+ * The request syntax is correct, but the operation cannot be completed due to business rules or resource constraints. Review the error details for specific limitations and adjust your request accordingly.
+ */
+export class UnprocessableEntityErrorResponse extends UnkeyError {
+  /**
+   * Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
+   */
+  meta: components.Meta;
+  /**
+   * Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.
+   */
+  error: components.BaseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: UnprocessableEntityErrorResponseData;
+
+  constructor(
+    err: UnprocessableEntityErrorResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.meta = err.meta;
+    this.error = err.error;
+
+    this.name = "UnprocessableEntityErrorResponse";
+  }
+}
+
+/** @internal */
+export const UnprocessableEntityErrorResponse$inboundSchema: z.ZodType<
+  UnprocessableEntityErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  meta: components.Meta$inboundSchema,
+  error: components.BaseError$inboundSchema,
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UnprocessableEntityErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type UnprocessableEntityErrorResponse$Outbound = {
+  meta: components.Meta$Outbound;
+  error: components.BaseError$Outbound;
+};
+
+/** @internal */
+export const UnprocessableEntityErrorResponse$outboundSchema: z.ZodType<
+  UnprocessableEntityErrorResponse$Outbound,
+  z.ZodTypeDef,
+  UnprocessableEntityErrorResponse
+> = z.instanceof(UnprocessableEntityErrorResponse)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    meta: components.Meta$outboundSchema,
+    error: components.BaseError$outboundSchema,
+  }));

package/src/models/operations/identitieslistidentities.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -25,7 +25,6 @@ export const IdentitiesListIdentitiesResponse$inboundSchema: z.ZodType<
     "Result": "result",
   });
 });
-
 /** @internal */
 export type IdentitiesListIdentitiesResponse$Outbound = {
   Result: components.V2IdentitiesListIdentitiesResponseBody$Outbound;
@@ -44,19 +43,6 @@ export const IdentitiesListIdentitiesResponse$outboundSchema: z.ZodType<
   });
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace IdentitiesListIdentitiesResponse$ {
-  /** @deprecated use `IdentitiesListIdentitiesResponse$inboundSchema` instead. */
-  export const inboundSchema = IdentitiesListIdentitiesResponse$inboundSchema;
-  /** @deprecated use `IdentitiesListIdentitiesResponse$outboundSchema` instead. */
-  export const outboundSchema = IdentitiesListIdentitiesResponse$outboundSchema;
-  /** @deprecated use `IdentitiesListIdentitiesResponse$Outbound` instead. */
-  export type Outbound = IdentitiesListIdentitiesResponse$Outbound;
-}
-
 export function identitiesListIdentitiesResponseToJSON(
   identitiesListIdentitiesResponse: IdentitiesListIdentitiesResponse,
 ): string {
@@ -66,7 +52,6 @@ export function identitiesListIdentitiesResponseToJSON(
     ),
   );
 }
-
 export function identitiesListIdentitiesResponseFromJSON(
   jsonString: string,
 ): SafeParseResult<IdentitiesListIdentitiesResponse, SDKValidationError> {

package/src/sdk/analytics.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { analyticsGetVerifications } from "../funcs/analyticsGetVerifications.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Analytics extends ClientSDK {
+  /**
+   * Query key verification data
+   *
+   * @remarks
+   * Execute custom SQL queries against your key verification analytics.
+   * For complete documentation including available tables, columns, data types, query examples, see the schema reference in the API documentation.
+   */
+  async getVerifications(
+    request: components.V2AnalyticsGetVerificationsRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.V2AnalyticsGetVerificationsResponseBody> {
+    return unwrapAsync(analyticsGetVerifications(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Analytics } from "./analytics.js";
 import { Apis } from "./apis.js";
 import { Identities } from "./identities.js";
 import { Keys } from "./keys.js";
@@ -10,6 +11,11 @@ import { Permissions } from "./permissions.js";
 import { Ratelimit } from "./ratelimit.js";
 
 export class Unkey extends ClientSDK {
+  private _analytics?: Analytics;
+  get analytics(): Analytics {
+    return (this._analytics ??= new Analytics(this._options));
+  }
+
   private _apis?: Apis;
   get apis(): Apis {
     return (this._apis ??= new Apis(this._options));

package/src/types/blobs.ts

@@ -2,13 +2,14 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
-export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
-  z.custom<Blob>(isBlobLike, {
-    message: "expected a Blob, File or Blob-like object",
-    fatal: true,
-  });
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> = z.custom<
+  Blob
+>(isBlobLike, {
+  message: "expected a Blob, File or Blob-like object",
+  fatal: true,
+});
 
 export function isBlobLike(val: unknown): val is Blob {
   if (val instanceof Blob) {

package/src/types/constdatetime.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
 export function constDateTime(
   val: string,

package/docs/sdks/apis/README.md

@@ -1,378 +0,0 @@
-# Apis
-(*apis*)
-
-## Overview
-
-API management operations
-
-### Available Operations
-
-* [createApi](#createapi) - Create API namespace
-* [deleteApi](#deleteapi) - Delete API namespace
-* [getApi](#getapi) - Get API namespace
-* [listKeys](#listkeys) - List API keys
-
-## createApi
-
-Create an API namespace for organizing keys by environment, service, or product.
-
-Use this to separate production from development keys, isolate different services, or manage multiple products. Each API gets a unique identifier and dedicated infrastructure for secure key operations.
-
-**Important**: API names must be unique within your workspace and cannot be changed after creation.
-
-**Required Permissions**
-
-Your root key must have one of the following permissions:
-- `api.*.create_api` (to create APIs in any workspace)
-
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="createApi" method="post" path="/v2/apis.createApi" -->
-```typescript
-import { Unkey } from "@unkey/api";
-
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await unkey.apis.createApi({
-    name: "payment-service-production",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { apisCreateApi } from "@unkey/api/funcs/apisCreateApi.js";
-
-// Use `UnkeyCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const unkey = new UnkeyCore({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await apisCreateApi(unkey, {
-    name: "payment-service-production",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("apisCreateApi failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2ApisCreateApiRequestBody](../../models/components/v2apiscreateapirequestbody.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.V2ApisCreateApiResponseBody](../../models/components/v2apiscreateapiresponsebody.md)\>**
-
-### Errors
-
-| Error Type                         | Status Code                        | Content Type                       |
-| ---------------------------------- | ---------------------------------- | ---------------------------------- |
-| errors.BadRequestErrorResponse     | 400                                | application/json                   |
-| errors.UnauthorizedErrorResponse   | 401                                | application/json                   |
-| errors.ForbiddenErrorResponse      | 403                                | application/json                   |
-| errors.InternalServerErrorResponse | 500                                | application/json                   |
-| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
-
-## deleteApi
-
-Permanently delete an API namespace and immediately invalidate all associated keys.
-
-Use this for cleaning up development environments, retiring deprecated services, or removing unused resources.
-All keys in the namespace are immediately marked as deleted and will fail verification with `code=NOT_FOUND`.
-
-**Important**: This operation is immediate and permanent. Verify you have the correct API ID before deletion.
-If delete protection is enabled, disable it first through the dashboard or API configuration.
-
-**Required Permissions**
-
-Your root key must have one of the following permissions:
-- `api.*.delete_api` (to delete any API)
-- `api.<api_id>.delete_api` (to delete a specific API)
-
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="deleteApi" method="post" path="/v2/apis.deleteApi" -->
-```typescript
-import { Unkey } from "@unkey/api";
-
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await unkey.apis.deleteApi({
-    apiId: "api_1234abcd",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { apisDeleteApi } from "@unkey/api/funcs/apisDeleteApi.js";
-
-// Use `UnkeyCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const unkey = new UnkeyCore({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await apisDeleteApi(unkey, {
-    apiId: "api_1234abcd",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("apisDeleteApi failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2ApisDeleteApiRequestBody](../../models/components/v2apisdeleteapirequestbody.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.V2ApisDeleteApiResponseBody](../../models/components/v2apisdeleteapiresponsebody.md)\>**
-
-### Errors
-
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.BadRequestErrorResponse         | 400                                    | application/json                       |
-| errors.UnauthorizedErrorResponse       | 401                                    | application/json                       |
-| errors.ForbiddenErrorResponse          | 403                                    | application/json                       |
-| errors.NotFoundErrorResponse           | 404                                    | application/json                       |
-| errors.PreconditionFailedErrorResponse | 412                                    | application/json                       |
-| errors.InternalServerErrorResponse     | 500                                    | application/json                       |
-| errors.APIError                        | 4XX, 5XX                               | \*/\*                                  |
-
-## getApi
-
-Retrieve basic information about an API namespace including its ID and name.
-
-Use this to verify an API exists before performing operations, get the human-readable name when you only have the API ID, or confirm access to a specific namespace. For detailed key information, use the `listKeys` endpoint instead.
-
-**Required Permissions**
-
-Your root key must have one of the following permissions:
-- `api.*.read_api` (to read any API)
-- `api.<api_id>.read_api` (to read a specific API)
-
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="getApi" method="post" path="/v2/apis.getApi" -->
-```typescript
-import { Unkey } from "@unkey/api";
-
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await unkey.apis.getApi({
-    apiId: "api_1234abcd",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { apisGetApi } from "@unkey/api/funcs/apisGetApi.js";
-
-// Use `UnkeyCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const unkey = new UnkeyCore({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await apisGetApi(unkey, {
-    apiId: "api_1234abcd",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("apisGetApi failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2ApisGetApiRequestBody](../../models/components/v2apisgetapirequestbody.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.V2ApisGetApiResponseBody](../../models/components/v2apisgetapiresponsebody.md)\>**
-
-### Errors
-
-| Error Type                         | Status Code                        | Content Type                       |
-| ---------------------------------- | ---------------------------------- | ---------------------------------- |
-| errors.BadRequestErrorResponse     | 400                                | application/json                   |
-| errors.UnauthorizedErrorResponse   | 401                                | application/json                   |
-| errors.ForbiddenErrorResponse      | 403                                | application/json                   |
-| errors.NotFoundErrorResponse       | 404                                | application/json                   |
-| errors.InternalServerErrorResponse | 500                                | application/json                   |
-| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
-
-## listKeys
-
-Retrieve a paginated list of API keys for dashboard and administrative interfaces.
-
-Use this to build key management dashboards, filter keys by user with `externalId`, or retrieve key details for administrative purposes. Each key includes status, metadata, permissions, and usage limits.
-
-**Important**: Set `decrypt: true` only in secure contexts to retrieve plaintext key values from recoverable keys.
-
-**Required Permissions**
-
-Your root key must have one of the following permissions for basic key listing:
-- `api.*.read_key` (to read keys from any API)
-- `api.<api_id>.read_key` (to read keys from a specific API)
-
-Additionally, you need read access to the API itself:
-- `api.*.read_api` or `api.<api_id>.read_api`
-
-Additional permission required for decrypt functionality:
-- `api.*.decrypt_key` or `api.<api_id>.decrypt_key`
-
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="listKeys" method="post" path="/v2/apis.listKeys" -->
-```typescript
-import { Unkey } from "@unkey/api";
-
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await unkey.apis.listKeys({
-    apiId: "api_1234abcd",
-    cursor: "key_1234abcd",
-    externalId: "user_1234abcd",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { apisListKeys } from "@unkey/api/funcs/apisListKeys.js";
-
-// Use `UnkeyCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const unkey = new UnkeyCore({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await apisListKeys(unkey, {
-    apiId: "api_1234abcd",
-    cursor: "key_1234abcd",
-    externalId: "user_1234abcd",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("apisListKeys failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2ApisListKeysRequestBody](../../models/components/v2apislistkeysrequestbody.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.V2ApisListKeysResponseBody](../../models/components/v2apislistkeysresponsebody.md)\>**
-
-### Errors
-
-| Error Type                         | Status Code                        | Content Type                       |
-| ---------------------------------- | ---------------------------------- | ---------------------------------- |
-| errors.BadRequestErrorResponse     | 400                                | application/json                   |
-| errors.UnauthorizedErrorResponse   | 401                                | application/json                   |
-| errors.ForbiddenErrorResponse      | 403                                | application/json                   |
-| errors.NotFoundErrorResponse       | 404                                | application/json                   |
-| errors.InternalServerErrorResponse | 500                                | application/json                   |
-| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |