@unkey/api 2.2.0 → 2.2.1

package/README.md

@@ -218,18 +218,18 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [analytics](docs/sdks/analytics/README.md)
+### [Analytics](docs/sdks/analytics/README.md)
 
 * [getVerifications](docs/sdks/analytics/README.md#getverifications) - Query key verification data
 
-### [apis](docs/sdks/apis/README.md)
+### [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
 
-### [identities](docs/sdks/identities/README.md)
+### [Identities](docs/sdks/identities/README.md)
 
 * [createIdentity](docs/sdks/identities/README.md#createidentity) - Create Identity
 * [deleteIdentity](docs/sdks/identities/README.md#deleteidentity) - Delete Identity
@@ -237,7 +237,7 @@ run();
 * [listIdentities](docs/sdks/identities/README.md#listidentities) - List Identities
 * [updateIdentity](docs/sdks/identities/README.md#updateidentity) - Update Identity
 
-### [keys](docs/sdks/keys/README.md)
+### [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
@@ -255,7 +255,7 @@ run();
 * [verifyKey](docs/sdks/keys/README.md#verifykey) - Verify API key
 * [whoami](docs/sdks/keys/README.md#whoami) - Get API key by hash
 
-### [permissions](docs/sdks/permissions/README.md)
+### [Permissions](docs/sdks/permissions/README.md)
 
 * [createPermission](docs/sdks/permissions/README.md#createpermission) - Create permission
 * [createRole](docs/sdks/permissions/README.md#createrole) - Create role
@@ -266,7 +266,7 @@ run();
 * [listPermissions](docs/sdks/permissions/README.md#listpermissions) - List permissions
 * [listRoles](docs/sdks/permissions/README.md#listroles) - List roles
 
-### [ratelimit](docs/sdks/ratelimit/README.md)
+### [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

package/dist/commonjs/funcs/keysVerifyKey.d.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * - `api.*.verify_key` (verify keys in any API)
  * - `api.<api_id>.verify_key` (verify keys in specific API)
  *
- * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+ * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
  */
 export declare function keysVerifyKey(client: UnkeyCore, request: components.V2KeysVerifyKeyRequestBody, options?: RequestOptions): APIPromise<Result<components.V2KeysVerifyKeyResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=keysVerifyKey.d.ts.map

package/dist/commonjs/funcs/keysVerifyKey.js

@@ -67,7 +67,7 @@ const async_js_1 = require("../types/async.js");
  * - `api.*.verify_key` (verify keys in any API)
  * - `api.<api_id>.verify_key` (verify keys in specific API)
  *
- * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+ * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
  */
 function keysVerifyKey(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "2.0.0";
-    readonly sdkVersion: "2.2.0";
-    readonly genVersion: "2.768.1";
-    readonly userAgent: "speakeasy-sdk/typescript 2.2.0 2.768.1 2.0.0 @unkey/api";
+    readonly sdkVersion: "2.2.1";
+    readonly genVersion: "2.779.2";
+    readonly userAgent: "speakeasy-sdk/typescript 2.2.1 2.779.2 2.0.0 @unkey/api";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/commonjs/lib/config.js

@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "2.0.0",
-    sdkVersion: "2.2.0",
-    genVersion: "2.768.1",
-    userAgent: "speakeasy-sdk/typescript 2.2.0 2.768.1 2.0.0 @unkey/api",
+    sdkVersion: "2.2.1",
+    genVersion: "2.779.2",
+    userAgent: "speakeasy-sdk/typescript 2.2.1 2.779.2 2.0.0 @unkey/api",
 };
 //# sourceMappingURL=config.js.map

package/dist/commonjs/sdk/keys.d.ts

@@ -299,7 +299,7 @@ export declare class Keys extends ClientSDK {
      * - `api.*.verify_key` (verify keys in any API)
      * - `api.<api_id>.verify_key` (verify keys in specific API)
      *
-     * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+     * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
      */
     verifyKey(request: components.V2KeysVerifyKeyRequestBody, options?: RequestOptions): Promise<components.V2KeysVerifyKeyResponseBody>;
     /**

package/dist/commonjs/sdk/keys.js

@@ -346,7 +346,7 @@ class Keys extends sdks_js_1.ClientSDK {
      * - `api.*.verify_key` (verify keys in any API)
      * - `api.<api_id>.verify_key` (verify keys in specific API)
      *
-     * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+     * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
      */
     async verifyKey(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, keysVerifyKey_js_1.keysVerifyKey)(this, request, options));

package/dist/esm/funcs/keysVerifyKey.d.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * - `api.*.verify_key` (verify keys in any API)
  * - `api.<api_id>.verify_key` (verify keys in specific API)
  *
- * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+ * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
  */
 export declare function keysVerifyKey(client: UnkeyCore, request: components.V2KeysVerifyKeyRequestBody, options?: RequestOptions): APIPromise<Result<components.V2KeysVerifyKeyResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=keysVerifyKey.d.ts.map

package/dist/esm/funcs/keysVerifyKey.js

@@ -31,7 +31,7 @@ import { APIPromise } from "../types/async.js";
  * - `api.*.verify_key` (verify keys in any API)
  * - `api.<api_id>.verify_key` (verify keys in specific API)
  *
- * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+ * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
  */
 export function keysVerifyKey(client, request, options) {
     return new APIPromise($do(client, request, options));

package/dist/esm/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "2.0.0";
-    readonly sdkVersion: "2.2.0";
-    readonly genVersion: "2.768.1";
-    readonly userAgent: "speakeasy-sdk/typescript 2.2.0 2.768.1 2.0.0 @unkey/api";
+    readonly sdkVersion: "2.2.1";
+    readonly genVersion: "2.779.2";
+    readonly userAgent: "speakeasy-sdk/typescript 2.2.1 2.779.2 2.0.0 @unkey/api";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -24,8 +24,8 @@ export function serverURLFromOptions(options) {
 export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "2.0.0",
-    sdkVersion: "2.2.0",
-    genVersion: "2.768.1",
-    userAgent: "speakeasy-sdk/typescript 2.2.0 2.768.1 2.0.0 @unkey/api",
+    sdkVersion: "2.2.1",
+    genVersion: "2.779.2",
+    userAgent: "speakeasy-sdk/typescript 2.2.1 2.779.2 2.0.0 @unkey/api",
 };
 //# sourceMappingURL=config.js.map

package/dist/esm/sdk/keys.d.ts

@@ -299,7 +299,7 @@ export declare class Keys extends ClientSDK {
      * - `api.*.verify_key` (verify keys in any API)
      * - `api.<api_id>.verify_key` (verify keys in specific API)
      *
-     * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+     * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
      */
     verifyKey(request: components.V2KeysVerifyKeyRequestBody, options?: RequestOptions): Promise<components.V2KeysVerifyKeyResponseBody>;
     /**

package/dist/esm/sdk/keys.js

@@ -343,7 +343,7 @@ export class Keys extends ClientSDK {
      * - `api.*.verify_key` (verify keys in any API)
      * - `api.<api_id>.verify_key` (verify keys in specific API)
      *
-     * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+     * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
      */
     async verifyKey(request, options) {
         return unwrapAsync(keysVerifyKey(this, request, options));

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@unkey/api",
-      "version": "2.2.0",
+      "version": "2.2.1",
       "dependencies": {
         "zod": "^3.25.0 || ^4.0.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@unkey/api",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unkey/api",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/funcs/keysVerifyKey.ts

@@ -46,7 +46,7 @@ import { Result } from "../types/fp.js";
  * - `api.*.verify_key` (verify keys in any API)
  * - `api.<api_id>.verify_key` (verify keys in specific API)
  *
- * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+ * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
  */
 export function keysVerifyKey(
   client: UnkeyCore,

package/src/lib/config.ts

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0.0",
-  sdkVersion: "2.2.0",
-  genVersion: "2.768.1",
-  userAgent: "speakeasy-sdk/typescript 2.2.0 2.768.1 2.0.0 @unkey/api",
+  sdkVersion: "2.2.1",
+  genVersion: "2.779.2",
+  userAgent: "speakeasy-sdk/typescript 2.2.1 2.779.2 2.0.0 @unkey/api",
 } as const;

package/src/sdk/keys.ts

@@ -450,7 +450,7 @@ export class Keys extends ClientSDK {
    * - `api.*.verify_key` (verify keys in any API)
    * - `api.<api_id>.verify_key` (verify keys in specific API)
    *
-   * If you are getting a NOT_FOUND error, ensure your root key has the required verify key permissions.
+   * **Note**: If your root key has no verify permissions at all, you will receive a `403 Forbidden` error. If your root key has verify permissions for a different API than the key you're verifying, you will receive a `200` response with `code: NOT_FOUND` to avoid leaking key existence.
    */
   async verifyKey(
     request: components.V2KeysVerifyKeyRequestBody,