npm - @unkey/api - Versions diffs - 2.0.5 → 2.1.0 - Mend

@unkey/api 2.0.5 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1421) hide show

package/docs/sdks/identities/README.md DELETED Viewed

@@ -1,450 +0,0 @@
-# Identities
-(*identities*)
-## Overview
-Identity management operations
-### Available Operations
-* [createIdentity](#createidentity) - Create Identity
-* [deleteIdentity](#deleteidentity) - Delete Identity
-* [getIdentity](#getidentity) - Get Identity
-* [listIdentities](#listidentities) - List Identities
-* [updateIdentity](#updateidentity) - Update Identity
-## createIdentity
-Create an identity to group multiple API keys under a single entity. Identities enable shared rate limits and metadata across all associated keys.
-Perfect for users with multiple devices, organizations with multiple API keys, or when you need unified rate limiting across different services.
-**Important**
-Requires `identity.*.create_identity` permission
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="identities.createIdentity" method="post" path="/v2/identities.createIdentity" -->
-```typescript
-import { Unkey } from "@unkey/api";
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-async function run() {
-  const result = await unkey.identities.createIdentity({
-    externalId: "user_123",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { identitiesCreateIdentity } from "@unkey/api/funcs/identitiesCreateIdentity.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 identitiesCreateIdentity(unkey, {
-    externalId: "user_123",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("identitiesCreateIdentity failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2IdentitiesCreateIdentityRequestBody](../../models/components/v2identitiescreateidentityrequestbody.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.V2IdentitiesCreateIdentityResponseBody](../../models/components/v2identitiescreateidentityresponsebody.md)\>**
-### Errors
-| Error Type                         | Status Code                        | Content Type                       |
-| ---------------------------------- | ---------------------------------- | ---------------------------------- |
-| errors.BadRequestErrorResponse     | 400                                | application/json                   |
-| errors.UnauthorizedErrorResponse   | 401                                | application/json                   |
-| errors.ForbiddenErrorResponse      | 403                                | application/json                   |
-| errors.ConflictErrorResponse       | 409                                | application/json                   |
-| errors.InternalServerErrorResponse | 500                                | application/json                   |
-| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
-## deleteIdentity
-Permanently delete an identity. This operation cannot be undone.
-Use this for data cleanup, compliance requirements, or when removing entities from your system.
-> **Important**
-> Requires `identity.*.delete_identity` permission
-> Associated API keys remain functional but lose shared resources
-> External ID becomes available for reuse immediately
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="v2.identities.deleteIdentity" method="post" path="/v2/identities.deleteIdentity" -->
-```typescript
-import { Unkey } from "@unkey/api";
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-async function run() {
-  const result = await unkey.identities.deleteIdentity({
-    identity: "user_123",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { identitiesDeleteIdentity } from "@unkey/api/funcs/identitiesDeleteIdentity.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 identitiesDeleteIdentity(unkey, {
-    identity: "user_123",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("identitiesDeleteIdentity failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2IdentitiesDeleteIdentityRequestBody](../../models/components/v2identitiesdeleteidentityrequestbody.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.V2IdentitiesDeleteIdentityResponseBody](../../models/components/v2identitiesdeleteidentityresponsebody.md)\>**
-### Errors
-| Error Type                         | Status Code                        | Content Type                       |
-| ---------------------------------- | ---------------------------------- | ---------------------------------- |
-| errors.BadRequestErrorResponse     | 400                                | application/problem+json           |
-| errors.UnauthorizedErrorResponse   | 401                                | application/problem+json           |
-| errors.ForbiddenErrorResponse      | 403                                | application/problem+json           |
-| errors.NotFoundErrorResponse       | 404                                | application/problem+json           |
-| errors.InternalServerErrorResponse | 500                                | application/problem+json           |
-| errors.APIError                    | 4XX, 5XX                           | \*/\*                              |
-## getIdentity
-Retrieve an identity by external ID. Returns metadata, rate limits, and other associated data.
-Use this to check if an identity exists, view configurations, or build management dashboards.
-> **Important**
-> Requires `identity.*.read_identity` permission
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="identities.getIdentity" method="post" path="/v2/identities.getIdentity" -->
-```typescript
-import { Unkey } from "@unkey/api";
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-async function run() {
-  const result = await unkey.identities.getIdentity({
-    identity: "user_abc123",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { identitiesGetIdentity } from "@unkey/api/funcs/identitiesGetIdentity.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 identitiesGetIdentity(unkey, {
-    identity: "user_abc123",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("identitiesGetIdentity failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2IdentitiesGetIdentityRequestBody](../../models/components/v2identitiesgetidentityrequestbody.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.V2IdentitiesGetIdentityResponseBody](../../models/components/v2identitiesgetidentityresponsebody.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                           | \*/\*                              |
-## listIdentities
-Get a paginated list of all identities in your workspace. Returns metadata and rate limit configurations.
-Perfect for building management dashboards, auditing configurations, or browsing your identities.
-> **Important**
-> Requires `identity.*.read_identity` permission
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="identities.listIdentities" method="post" path="/v2/identities.listIdentities" -->
-```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();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { identitiesListIdentities } from "@unkey/api/funcs/identitiesListIdentities.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 identitiesListIdentities(unkey, {
-    limit: 50,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("identitiesListIdentities failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2IdentitiesListIdentitiesRequestBody](../../models/components/v2identitieslistidentitiesrequestbody.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\<[operations.IdentitiesListIdentitiesResponse](../../models/operations/identitieslistidentitiesresponse.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                           | \*/\*                              |
-## updateIdentity
-Update an identity's metadata and rate limits. Only specified fields are modified - others remain unchanged.
-Perfect for subscription changes, plan upgrades, or updating user information. Changes take effect immediately.
-> **Important**
-> Requires `identity.*.update_identity` permission
-> Rate limit changes propagate within 30 seconds
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="v2.identities.updateIdentity" method="post" path="/v2/identities.updateIdentity" -->
-```typescript
-import { Unkey } from "@unkey/api";
-const unkey = new Unkey({
-  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
-});
-async function run() {
-  const result = await unkey.identities.updateIdentity({
-    identity: "user_123",
-    meta: {
-      "email": "alice@example.com",
-      "name": "Alice Smith",
-      "plan": "premium",
-    },
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { UnkeyCore } from "@unkey/api/core.js";
-import { identitiesUpdateIdentity } from "@unkey/api/funcs/identitiesUpdateIdentity.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 identitiesUpdateIdentity(unkey, {
-    identity: "user_123",
-    meta: {
-      "email": "alice@example.com",
-      "name": "Alice Smith",
-      "plan": "premium",
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("identitiesUpdateIdentity failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V2IdentitiesUpdateIdentityRequestBody](../../models/components/v2identitiesupdateidentityrequestbody.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.V2IdentitiesUpdateIdentityResponseBody](../../models/components/v2identitiesupdateidentityresponsebody.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                           | \*/\*                              |