@unkey/api 0.38.0 → 2.0.0-alpha.11

package/README.md

@@ -1,125 +1,704 @@
-<div align="center">
-    <h1 align="center">@unkey/api</h1>
-    <h5>`@unkey/api` is a TypeScript client for Unkey. If you prefer a typed experience over calling HTTP endpoints directly, this SDK is for you.</h5>
+# @unkey/api
+
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
+
+<div align="left">
+    <a href="https://www.speakeasy.com/?utm_source=@unkey/api&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
+    <a href="https://opensource.org/licenses/MIT">
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+    </a>
 </div>
 
 
+<br /><br />
+> [!IMPORTANT]
+> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/unkey/unkey). Delete this section before > publishing to a package manager.
 
-<div align="center">
-  <a href="https://www.unkey.com/docs/libraries/ts/sdk/overview">Documentation</a>
-</div>
-<br/>
+<!-- Start Summary [summary] -->
+## Summary
+
+Unkey API: Unkey's API provides programmatic access for all resources within our platform.
+
+
+### Authentication
+#
+This API uses HTTP Bearer authentication with root keys. Most endpoints require specific permissions associated with your root key. When making requests, include your root key in the `Authorization` header:
+```
+Authorization: Bearer unkey_xxxxxxxxxxx
+```
+
+All responses follow a consistent envelope structure that separates operational metadata from actual data. This design provides several benefits:
+- Debugging: Every response includes a unique requestId for tracing issues
+- Consistency: Predictable response format across all endpoints
+- Extensibility: Easy to add new metadata without breaking existing integrations
+- Error Handling: Unified error format with actionable information
+
+### Success Response Format:
+```json
+{
+  "meta": {
+    "requestId": "req_123456"
+  },
+  "data": {
+    // Actual response data here
+  }
+}
+```
 
+The meta object contains operational information:
+- `requestId`: Unique identifier for this request (essential for support)
 
-Currently the latest version on npm is v2.0.0-alpha.x, which was released on the main channel by accident. Due to npm’s policy, we can not take it back down.
+The data object contains the actual response data specific to each endpoint.
 
-v2 is coming, but it’s not ready yet and lacks some api methods. Please install @unkey/api@0.35 for now.
+### Paginated Response Format:
+```json
+{
+  "meta": {
+    "requestId": "req_123456"
+  },
+  "data": [
+    // Array of results
+  ],
+  "pagination": {
+    "cursor": "next_page_token",
+    "hasMore": true
+  }
+}
+```
 
-## Installation
+The pagination object appears on list endpoints and contains:
+- `cursor`: Token for requesting the next page
+- `hasMore`: Whether more results are available
+
+### Error Response Format:
+```json
+{
+  "meta": {
+    "requestId": "req_2c9a0jf23l4k567"
+  },
+  "error": {
+    "detail": "The resource you are attempting to modify is protected and cannot be changed",
+    "status": 403,
+    "title": "Forbidden",
+    "type": "https://unkey.com/docs/errors/unkey/application/protected_resource"
+  }
+}
+```
+
+Error responses include comprehensive diagnostic information:
+- `title`: Human-readable error summary
+- `detail`: Specific description of what went wrong
+- `status`: HTTP status code
+- `type`: Link to error documentation
+- `errors`: Array of validation errors (for 400 responses)
+
+This structure ensures you always have the context needed to debug issues and take corrective action.
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [@unkey/api](#unkeyapi)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Pagination](#pagination)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
 
 ```bash
-npm install @unkey/api@0.35
+npm add @unkey/api
 ```
 
-## Quickstart
+### PNPM
 
-1.  Create a new Unkey Root Key in the settings.
-2.  Use the root key to initialize the client:
+```bash
+pnpm add @unkey/api
+```
 
-```ts
-import { Unkey } from "@unkey/api";
+### Bun
 
-const unkey = new Unkey({ rootKey: "<UNKEY_ROOT_KEY>" });
+```bash
+bun add @unkey/api
 ```
 
-**Important:** Always keep your root key safe and reset it if you suspect it has been compromised.
+### Yarn
 
-## Usage
+```bash
+yarn add @unkey/api zod
 
-### Verifying a Key
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
+```
 
-```ts
-import { verifyKey } from "@unkey/api";
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
 
-const { result, error } = await verifyKey("key_123");
 
-if (error) {
-  console.error(error.message);
-  // Handle potential network or bad request error
-  // A link to our docs will be in the `error.docs` field
-  return;
-}
+### Model Context Protocol (MCP) Server
 
-if (!result.valid) {
-  // Do not grant access
-  return;
-}
+This SDK is also an installable MCP server where the various SDK methods are
+exposed as tools that can be invoked by AI applications.
 
-// Process request
-console.log(result);
+> Node.js v20 or greater is required to run the MCP server from npm.
+
+<details>
+<summary>Claude installation steps</summary>
+
+Add the following server definition to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "Unkey": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@unkey/api",
+        "--",
+        "mcp", "start",
+        "--root-key", "..."
+      ]
+    }
+  }
+}
 ```
 
-## Response Format
+</details>
 
-All methods return either an `error` or a `result` field, never both and never none. This approach helps with proper error handling.
+<details>
+<summary>Cursor installation steps</summary>
 
-### Success Response
+Create a `.cursor/mcp.json` file in your project root with the following content:
 
-```ts
+```json
 {
-  result: T; // The result depends on what method you called
+  "mcpServers": {
+    "Unkey": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@unkey/api",
+        "--",
+        "mcp", "start",
+        "--root-key", "..."
+      ]
+    }
+  }
 }
 ```
 
-### Error Response
+</details>
+
+You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
+
+```bash
+curl -L -o mcp-server \
+    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
+chmod +x mcp-server
+```
+
+If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
 
-```ts
+
+```json
 {
-  error: {
-    message: string;
-    docs: string; // URL to relevant documentation
+  "mcpServers": {
+    "Todos": {
+      "command": "./DOWNLOAD/PATH/mcp-server",
+      "args": [
+        "start"
+      ]
+    }
   }
 }
 ```
 
-## Configuration Options
+For a full list of server arguments, run:
+
+```sh
+npx -y --package @unkey/api -- mcp start --help
+```
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey();
+
+async function run() {
+  const result = await unkey.chproxy.chproxyMetrics([]);
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
 
-### Base URL
+This SDK supports the following security scheme globally:
 
-You can customize the base URL for all requests:
+| Name      | Type | Scheme      | Environment Variable |
+| --------- | ---- | ----------- | -------------------- |
+| `rootKey` | http | HTTP Bearer | `UNKEY_ROOT_KEY`     |
+
+To authenticate with the API the `rootKey` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { Unkey } from "@unkey/api";
 
-```ts
 const unkey = new Unkey({
-  rootKey: "<UNKEY_ROOT_KEY>",
-  baseUrl: "https://my.domain",
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
 });
+
+async function run() {
+  const result = await unkey.chproxy.chproxyMetrics([]);
+
+  console.log(result);
+}
+
+run();
+
 ```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [apis](docs/sdks/apis/README.md)
+
+* [createApi](docs/sdks/apis/README.md#createapi) - Create API namespace
+* [deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete API namespace
+* [getApi](docs/sdks/apis/README.md#getapi) - Get API namespace
+* [listKeys](docs/sdks/apis/README.md#listkeys) - List API keys
+
+### [chproxy](docs/sdks/chproxy/README.md)
+
+* [chproxyMetrics](docs/sdks/chproxy/README.md#chproxymetrics) - Internal ClickHouse proxy for API request metrics
+* [chproxyRatelimits](docs/sdks/chproxy/README.md#chproxyratelimits) - Internal ClickHouse proxy for ratelimit events
+* [chproxyVerifications](docs/sdks/chproxy/README.md#chproxyverifications) - Internal ClickHouse proxy for verification events
+
+### [identities](docs/sdks/identities/README.md)
+
+* [createIdentity](docs/sdks/identities/README.md#createidentity) - Create Identity
+* [deleteIdentity](docs/sdks/identities/README.md#deleteidentity) - Delete Identity
+* [getIdentity](docs/sdks/identities/README.md#getidentity) - Get Identity
+* [listIdentities](docs/sdks/identities/README.md#listidentities) - List Identities
+* [updateIdentity](docs/sdks/identities/README.md#updateidentity) - Update Identity
+
+### [keys](docs/sdks/keys/README.md)
+
+* [addPermissions](docs/sdks/keys/README.md#addpermissions) - Add key permissions
+* [addRoles](docs/sdks/keys/README.md#addroles) - Add key roles
+* [createKey](docs/sdks/keys/README.md#createkey) - Create API key
+* [deleteKey](docs/sdks/keys/README.md#deletekey) - Delete API keys
+* [getKey](docs/sdks/keys/README.md#getkey) - Get API key
+* [removePermissions](docs/sdks/keys/README.md#removepermissions) - Remove key permissions
+* [removeRoles](docs/sdks/keys/README.md#removeroles) - Remove key roles
+* [setPermissions](docs/sdks/keys/README.md#setpermissions) - Set key permissions
+* [setRoles](docs/sdks/keys/README.md#setroles) - Set key roles
+* [updateCredits](docs/sdks/keys/README.md#updatecredits) - Update key credits
+* [updateKey](docs/sdks/keys/README.md#updatekey) - Update key settings
+* [verifyKey](docs/sdks/keys/README.md#verifykey) - Verify API key
+* [whoami](docs/sdks/keys/README.md#whoami) - Get API key by hash
+
+### [liveness](docs/sdks/liveness/README.md)
+
+* [liveness](docs/sdks/liveness/README.md#liveness) - Health check
+
+### [permissions](docs/sdks/permissions/README.md)
+
+* [createPermission](docs/sdks/permissions/README.md#createpermission) - Create permission
+* [createRole](docs/sdks/permissions/README.md#createrole) - Create role
+* [deletePermission](docs/sdks/permissions/README.md#deletepermission) - Delete permission
+* [deleteRole](docs/sdks/permissions/README.md#deleterole) - Delete role
+* [getPermission](docs/sdks/permissions/README.md#getpermission) - Get permission
+* [getRole](docs/sdks/permissions/README.md#getrole) - Get role
+* [listPermissions](docs/sdks/permissions/README.md#listpermissions) - List permissions
+* [listRoles](docs/sdks/permissions/README.md#listroles) - List roles
+
+### [ratelimit](docs/sdks/ratelimit/README.md)
+
+* [deleteOverride](docs/sdks/ratelimit/README.md#deleteoverride) - Delete ratelimit override
+* [getOverride](docs/sdks/ratelimit/README.md#getoverride) - Get ratelimit override
+* [limit](docs/sdks/ratelimit/README.md#limit) - Apply rate limiting
+* [listOverrides](docs/sdks/ratelimit/README.md#listoverrides) - List ratelimit overrides
+* [setOverride](docs/sdks/ratelimit/README.md#setoverride) - Set ratelimit override
+
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`apisCreateApi`](docs/sdks/apis/README.md#createapi) - Create API namespace
+- [`apisDeleteApi`](docs/sdks/apis/README.md#deleteapi) - Delete API namespace
+- [`apisGetApi`](docs/sdks/apis/README.md#getapi) - Get API namespace
+- [`apisListKeys`](docs/sdks/apis/README.md#listkeys) - List API keys
+- [`chproxyChproxyMetrics`](docs/sdks/chproxy/README.md#chproxymetrics) - Internal ClickHouse proxy for API request metrics
+- [`chproxyChproxyRatelimits`](docs/sdks/chproxy/README.md#chproxyratelimits) - Internal ClickHouse proxy for ratelimit events
+- [`chproxyChproxyVerifications`](docs/sdks/chproxy/README.md#chproxyverifications) - Internal ClickHouse proxy for verification events
+- [`identitiesCreateIdentity`](docs/sdks/identities/README.md#createidentity) - Create Identity
+- [`identitiesDeleteIdentity`](docs/sdks/identities/README.md#deleteidentity) - Delete Identity
+- [`identitiesGetIdentity`](docs/sdks/identities/README.md#getidentity) - Get Identity
+- [`identitiesListIdentities`](docs/sdks/identities/README.md#listidentities) - List Identities
+- [`identitiesUpdateIdentity`](docs/sdks/identities/README.md#updateidentity) - Update Identity
+- [`keysAddPermissions`](docs/sdks/keys/README.md#addpermissions) - Add key permissions
+- [`keysAddRoles`](docs/sdks/keys/README.md#addroles) - Add key roles
+- [`keysCreateKey`](docs/sdks/keys/README.md#createkey) - Create API key
+- [`keysDeleteKey`](docs/sdks/keys/README.md#deletekey) - Delete API keys
+- [`keysGetKey`](docs/sdks/keys/README.md#getkey) - Get API key
+- [`keysRemovePermissions`](docs/sdks/keys/README.md#removepermissions) - Remove key permissions
+- [`keysRemoveRoles`](docs/sdks/keys/README.md#removeroles) - Remove key roles
+- [`keysSetPermissions`](docs/sdks/keys/README.md#setpermissions) - Set key permissions
+- [`keysSetRoles`](docs/sdks/keys/README.md#setroles) - Set key roles
+- [`keysUpdateCredits`](docs/sdks/keys/README.md#updatecredits) - Update key credits
+- [`keysUpdateKey`](docs/sdks/keys/README.md#updatekey) - Update key settings
+- [`keysVerifyKey`](docs/sdks/keys/README.md#verifykey) - Verify API key
+- [`keysWhoami`](docs/sdks/keys/README.md#whoami) - Get API key by hash
+- [`livenessLiveness`](docs/sdks/liveness/README.md#liveness) - Health check
+- [`permissionsCreatePermission`](docs/sdks/permissions/README.md#createpermission) - Create permission
+- [`permissionsCreateRole`](docs/sdks/permissions/README.md#createrole) - Create role
+- [`permissionsDeletePermission`](docs/sdks/permissions/README.md#deletepermission) - Delete permission
+- [`permissionsDeleteRole`](docs/sdks/permissions/README.md#deleterole) - Delete role
+- [`permissionsGetPermission`](docs/sdks/permissions/README.md#getpermission) - Get permission
+- [`permissionsGetRole`](docs/sdks/permissions/README.md#getrole) - Get role
+- [`permissionsListPermissions`](docs/sdks/permissions/README.md#listpermissions) - List permissions
+- [`permissionsListRoles`](docs/sdks/permissions/README.md#listroles) - List roles
+- [`ratelimitDeleteOverride`](docs/sdks/ratelimit/README.md#deleteoverride) - Delete ratelimit override
+- [`ratelimitGetOverride`](docs/sdks/ratelimit/README.md#getoverride) - Get ratelimit override
+- [`ratelimitLimit`](docs/sdks/ratelimit/README.md#limit) - Apply rate limiting
+- [`ratelimitListOverrides`](docs/sdks/ratelimit/README.md#listoverrides) - List ratelimit overrides
+- [`ratelimitSetOverride`](docs/sdks/ratelimit/README.md#setoverride) - Set ratelimit override
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start Pagination [pagination] -->
+## Pagination
+
+Some of the endpoints in this SDK support pagination. To use pagination, you
+make your SDK calls as usual, but the returned response object will also be an
+async iterable that can be consumed using the [`for await...of`][for-await-of]
+syntax.
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+
+Here's an example of one such pagination call:
+
+```typescript
+import { Unkey } from "@unkey/api";
 
-### Retries
+const unkey = new Unkey({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
 
-Configure retry behavior for network errors:
+async function run() {
+  const result = await unkey.identities.listIdentities({
+    limit: 50,
+  });
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+run();
+
+```
+<!-- End Pagination [pagination] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey();
+
+async function run() {
+  const result = await unkey.chproxy.chproxyMetrics([], {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { Unkey } from "@unkey/api";
 
-```ts
 const unkey = new Unkey({
-  rootKey: "<UNKEY_ROOT_KEY>",
-  retry: {
-    attempts: 3,
-    backoff: (retryCount) => retryCount * 1000,
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
   },
 });
+
+async function run() {
+  const result = await unkey.chproxy.chproxyMetrics([]);
+
+  console.log(result);
+}
+
+run();
+
 ```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+[`UnkeyError`](./src/models/errors/unkeyerror.ts) is the base class for all HTTP error responses. It has the following properties:
+
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
+
+### Example
+```typescript
+import { Unkey } from "@unkey/api";
+import * as errors from "@unkey/api/models/errors";
+
+const unkey = new Unkey();
+
+async function run() {
+  try {
+    const result = await unkey.chproxy.chproxyMetrics([]);
+
+    console.log(result);
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.UnkeyError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.BadRequestErrorResponse) {
+        console.log(error.data$.meta); // components.Meta
+        console.log(error.data$.error); // components.BadRequestErrorDetails
+      }
+    }
+  }
+}
+
+run();
+
+```
+
+### Error Classes
+**Primary errors:**
+* [`UnkeyError`](./src/models/errors/unkeyerror.ts): The base class for HTTP error responses.
+  * [`InternalServerErrorResponse`](./src/models/errors/internalservererrorresponse.ts): Error response when an unexpected error occurs on the server. This indicates a problem with Unkey's systems rather than your request.  When you encounter this error: - The request ID in the response can help Unkey support investigate the issue - The error is likely temporary and retrying may succeed - If the error persists, contact Unkey support with the request ID.
+  * [`BadRequestErrorResponse`](./src/models/errors/badrequesterrorresponse.ts): Error response for invalid requests that cannot be processed due to client-side errors. This typically occurs when request parameters are missing, malformed, or fail validation rules. The response includes detailed information about the specific errors in the request, including the location of each error and suggestions for fixing it. When receiving this error, check the 'errors' array in the response for specific validation issues that need to be addressed before retrying. Status code `400`. *
+  * [`UnauthorizedErrorResponse`](./src/models/errors/unauthorizederrorresponse.ts): Error response when authentication has failed or credentials are missing. This occurs when: - No authentication token is provided in the request - The provided token is invalid, expired, or malformed - The token format doesn't match expected patterns  To resolve this error, ensure you're including a valid root key in the Authorization header. Status code `401`. *
+  * [`ForbiddenErrorResponse`](./src/models/errors/forbiddenerrorresponse.ts): Error response when the provided credentials are valid but lack sufficient permissions for the requested operation. This occurs when: - The root key doesn't have the required permissions for this endpoint - The operation requires elevated privileges that the current key lacks - Access to the requested resource is restricted based on workspace settings  To resolve this error, ensure your root key has the necessary permissions or contact your workspace administrator. Status code `403`. *
+
+<details><summary>Less common errors (9)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`UnkeyError`](./src/models/errors/unkeyerror.ts)**:
+* [`NotFoundErrorResponse`](./src/models/errors/notfounderrorresponse.ts): Error response when the requested resource cannot be found. This occurs when: - The specified resource ID doesn't exist in your workspace - The resource has been deleted or moved - The resource exists but is not accessible with current permissions  To resolve this error, verify the resource ID is correct and that you have access to it. Status code `404`. Applicable to 28 of 39 methods.*
+* [`ConflictErrorResponse`](./src/models/errors/conflicterrorresponse.ts): Error response when the request conflicts with the current state of the resource. This occurs when: - Attempting to create a resource that already exists - Modifying a resource that has been changed by another operation - Violating unique constraints or business rules  To resolve this error, check the current state of the resource and adjust your request accordingly. Status code `409`. Applicable to 3 of 39 methods.*
+* [`PreconditionFailedErrorResponse`](./src/models/errors/preconditionfailederrorresponse.ts): Error response when one or more conditions specified in the request headers are not met. This typically occurs when: - Using conditional requests with If-Match or If-None-Match headers - The resource version doesn't match the expected value - Optimistic concurrency control detects a conflict  To resolve this error, fetch the latest version of the resource and retry with updated conditions. Status code `412`. Applicable to 1 of 39 methods.*
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
+<!-- End Error Handling [errors] -->
 
-### Disable Telemetry
+<!-- Start Server Selection [server] -->
+## Server Selection
 
-To opt out of anonymous telemetry data collection:
+### Override Server URL Per-Client
+
+The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+```typescript
+import { Unkey } from "@unkey/api";
 
-```ts
 const unkey = new Unkey({
-  rootKey: "<UNKEY_ROOT_KEY>",
-  disableTelemetry: true,
+  serverURL: "https://api.unkey.com",
+});
+
+async function run() {
+  const result = await unkey.chproxy.chproxyMetrics([]);
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { Unkey } from "@unkey/api";
+import { HTTPClient } from "@unkey/api/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
 });
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new Unkey({ httpClient });
 ```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { Unkey } from "@unkey/api";
+
+const sdk = new Unkey({ debugLogger: console });
+```
+
+You can also enable a default debug logger by setting an environment variable `UNKEY_DEBUG` to true.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
 
-### Documentation
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
 
-[Read the full documentation](https://www.unkey.com/docs/libraries/ts/sdk/overview)
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@unkey/api&utm_campaign=typescript)