@unkey/api 2.0.0-alpha.1 → 2.0.0-alpha.11

package/README.md

@@ -17,7 +17,82 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
 <!-- 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)
+
+The data object contains the actual response data specific to each endpoint.
+
+### Paginated Response Format:
+```json
+{
+  "meta": {
+    "requestId": "req_123456"
+  },
+  "data": [
+    // Array of results
+  ],
+  "pagination": {
+    "cursor": "next_page_token",
+    "hasMore": true
+  }
+}
+```
+
+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] -->
@@ -30,6 +105,7 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
   * [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)
@@ -44,34 +120,30 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 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 add https://github.com/unkeyed/unkey-ts
+npm add @unkey/api
 ```
 
 ### PNPM
 
 ```bash
-pnpm add https://github.com/unkeyed/unkey-ts
+pnpm add @unkey/api
 ```
 
 ### Bun
 
 ```bash
-bun add https://github.com/unkeyed/unkey-ts
+bun add @unkey/api
 ```
 
 ### Yarn
 
 ```bash
-yarn add https://github.com/unkeyed/unkey-ts zod
+yarn add @unkey/api zod
 
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
@@ -79,6 +151,90 @@ yarn add https://github.com/unkeyed/unkey-ts zod
 
 > [!NOTE]
 > This package is published with CommonJS and ES Modules (ESM) support.
+
+
+### Model Context Protocol (MCP) Server
+
+This SDK is also an installable MCP server where the various SDK methods are
+exposed as tools that can be invoked by AI applications.
+
+> 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", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Cursor installation steps</summary>
+
+Create a `.cursor/mcp.json` file in your project root with the following content:
+
+```json
+{
+  "mcpServers": {
+    "Unkey": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@unkey/api",
+        "--",
+        "mcp", "start",
+        "--root-key", "..."
+      ]
+    }
+  }
+}
+```
+
+</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}"`.
+
+
+```json
+{
+  "mcpServers": {
+    "Todos": {
+      "command": "./DOWNLOAD/PATH/mcp-server",
+      "args": [
+        "start"
+      ]
+    }
+  }
+}
+```
+
+For a full list of server arguments, run:
+
+```sh
+npx -y --package @unkey/api -- mcp start --help
+```
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -95,19 +251,11 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 ```typescript
 import { Unkey } from "@unkey/api";
 
-const unkey = new Unkey({
-  rootKey: "UNKEY_ROOT_KEY",
-});
+const unkey = new Unkey();
 
 async function run() {
-  const result = await unkey.ratelimit.limit({
-    namespace: "sms.sign_up",
-    duration: 455106,
-    identifier: "<value>",
-    limit: 568662,
-  });
+  const result = await unkey.chproxy.chproxyMetrics([]);
 
-  // Handle the result
   console.log(result);
 }
 
@@ -132,18 +280,12 @@ To authenticate with the API the `rootKey` parameter must be set when initializi
 import { Unkey } from "@unkey/api";
 
 const unkey = new Unkey({
-  rootKey: "UNKEY_ROOT_KEY",
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
 });
 
 async function run() {
-  const result = await unkey.ratelimit.limit({
-    namespace: "sms.sign_up",
-    duration: 455106,
-    identifier: "<value>",
-    limit: 568662,
-  });
+  const result = await unkey.chproxy.chproxyMetrics([]);
 
-  // Handle the result
   console.log(result);
 }
 
@@ -158,16 +300,65 @@ run();
 <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)
 
-* [check](docs/sdks/liveness/README.md#check) - Liveness check
+* [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)
 
-* [limit](docs/sdks/ratelimit/README.md#limit) - TODO
-* [setOverride](docs/sdks/ratelimit/README.md#setoverride)
-* [getOverride](docs/sdks/ratelimit/README.md#getoverride)
-* [deleteOverride](docs/sdks/ratelimit/README.md#deleteoverride)
+* [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>
@@ -188,15 +379,83 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`livenessCheck`](docs/sdks/liveness/README.md#check) - Liveness check
-- [`ratelimitDeleteOverride`](docs/sdks/ratelimit/README.md#deleteoverride)
-- [`ratelimitGetOverride`](docs/sdks/ratelimit/README.md#getoverride)
-- [`ratelimitLimit`](docs/sdks/ratelimit/README.md#limit) - TODO
-- [`ratelimitSetOverride`](docs/sdks/ratelimit/README.md#setoverride)
+- [`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";
+
+const unkey = new Unkey({
+  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
+});
+
+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
 
@@ -206,17 +465,10 @@ To change the default retry strategy for a single API call, simply provide a ret
 ```typescript
 import { Unkey } from "@unkey/api";
 
-const unkey = new Unkey({
-  rootKey: "UNKEY_ROOT_KEY",
-});
+const unkey = new Unkey();
 
 async function run() {
-  const result = await unkey.ratelimit.limit({
-    namespace: "sms.sign_up",
-    duration: 455106,
-    identifier: "<value>",
-    limit: 568662,
-  }, {
+  const result = await unkey.chproxy.chproxyMetrics([], {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -229,7 +481,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -252,18 +503,11 @@ const unkey = new Unkey({
     },
     retryConnectionErrors: false,
   },
-  rootKey: "UNKEY_ROOT_KEY",
 });
 
 async function run() {
-  const result = await unkey.ratelimit.limit({
-    namespace: "sms.sign_up",
-    duration: 455106,
-    identifier: "<value>",
-    limit: 568662,
-  });
+  const result = await unkey.chproxy.chproxyMetrics([]);
 
-  // Handle the result
   console.log(result);
 }
 
@@ -275,84 +519,41 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `limit` method may throw the following errors:
-
-| Error Type                 | Status Code | Content Type             |
-| -------------------------- | ----------- | ------------------------ |
-| errors.BadRequestError     | 400         | application/problem+json |
-| errors.UnauthorizedError   | 401         | application/problem+json |
-| errors.ForbiddenError      | 403         | application/problem+json |
-| errors.NotFoundError       | 404         | application/problem+json |
-| errors.InternalServerError | 500         | application/problem+json |
-| errors.APIError            | 4XX, 5XX    | \*/\*                    |
+[`UnkeyError`](./src/models/errors/unkeyerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+| 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 {
-  BadRequestError,
-  ForbiddenError,
-  InternalServerError,
-  NotFoundError,
-  SDKValidationError,
-  UnauthorizedError,
-} from "@unkey/api/models/errors";
+import * as errors from "@unkey/api/models/errors";
 
-const unkey = new Unkey({
-  rootKey: "UNKEY_ROOT_KEY",
-});
+const unkey = new Unkey();
 
 async function run() {
-  let result;
   try {
-    result = await unkey.ratelimit.limit({
-      namespace: "sms.sign_up",
-      duration: 455106,
-      identifier: "<value>",
-      limit: 568662,
-    });
-
-    // Handle the result
+    const result = await unkey.chproxy.chproxyMetrics([]);
+
     console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof BadRequestError): {
-        // Handle err.data$: BadRequestErrorData
-        console.error(err);
-        return;
-      }
-      case (err instanceof UnauthorizedError): {
-        // Handle err.data$: UnauthorizedErrorData
-        console.error(err);
-        return;
-      }
-      case (err instanceof ForbiddenError): {
-        // Handle err.data$: ForbiddenErrorData
-        console.error(err);
-        return;
-      }
-      case (err instanceof NotFoundError): {
-        // Handle err.data$: NotFoundErrorData
-        console.error(err);
-        return;
-      }
-      case (err instanceof InternalServerError): {
-        // Handle err.data$: InternalServerErrorData
-        console.error(err);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
+  } 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
       }
     }
   }
@@ -362,17 +563,35 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+### 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`. *
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+<details><summary>Less common errors (9)</summary>
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+<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] -->
 
 <!-- Start Server Selection [server] -->
@@ -386,18 +605,11 @@ import { Unkey } from "@unkey/api";
 
 const unkey = new Unkey({
   serverURL: "https://api.unkey.com",
-  rootKey: "UNKEY_ROOT_KEY",
 });
 
 async function run() {
-  const result = await unkey.ratelimit.limit({
-    namespace: "sms.sign_up",
-    duration: 455106,
-    identifier: "<value>",
-    limit: 568662,
-  });
+  const result = await unkey.chproxy.chproxyMetrics([]);
 
-  // Handle the result
   console.log(result);
 }