@unkey/api 2.0.0-alpha.7 → 2.0.0

package/dist/esm/sdk/keys.js

@@ -0,0 +1,313 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { keysAddPermissions } from "../funcs/keysAddPermissions.js";
+import { keysAddRoles } from "../funcs/keysAddRoles.js";
+import { keysCreateKey } from "../funcs/keysCreateKey.js";
+import { keysDeleteKey } from "../funcs/keysDeleteKey.js";
+import { keysGetKey } from "../funcs/keysGetKey.js";
+import { keysRemovePermissions } from "../funcs/keysRemovePermissions.js";
+import { keysRemoveRoles } from "../funcs/keysRemoveRoles.js";
+import { keysSetPermissions } from "../funcs/keysSetPermissions.js";
+import { keysSetRoles } from "../funcs/keysSetRoles.js";
+import { keysUpdateCredits } from "../funcs/keysUpdateCredits.js";
+import { keysUpdateKey } from "../funcs/keysUpdateKey.js";
+import { keysVerifyKey } from "../funcs/keysVerifyKey.js";
+import { keysWhoami } from "../funcs/keysWhoami.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+export class Keys extends ClientSDK {
+    /**
+     * Add key permissions
+     *
+     * @remarks
+     * Add permissions to a key without affecting existing permissions.
+     *
+     * Use this for privilege upgrades, enabling new features, or plan changes that grant additional capabilities. Permissions granted through roles remain unchanged.
+     *
+     * **Important**: Changes take effect immediately with up to 30-second edge propagation.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * Invalidates the key cache for immediate effect, and makes permissions available for verification within 30 seconds across all regions.
+     */
+    async addPermissions(request, options) {
+        return unwrapAsync(keysAddPermissions(this, request, options));
+    }
+    /**
+     * Add key roles
+     *
+     * @remarks
+     * Add roles to a key without affecting existing roles or permissions.
+     *
+     * Use this for privilege upgrades, enabling new feature sets, or subscription changes that grant additional role-based capabilities. Direct permissions remain unchanged.
+     *
+     * **Important**: Changes take effect immediately with up to 30-second edge propagation.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * Invalidates the key cache for immediate effect, and makes role assignments available for verification within 30 seconds across all regions.
+     */
+    async addRoles(request, options) {
+        return unwrapAsync(keysAddRoles(this, request, options));
+    }
+    /**
+     * Create API key
+     *
+     * @remarks
+     * Create a new API key for user authentication and authorization.
+     *
+     * Use this endpoint when users sign up, upgrade subscription tiers, or need additional keys. Keys are cryptographically secure and unique to the specified API namespace.
+     *
+     * **Important**: The key is returned only once. Store it immediately and provide it to your user, as it cannot be retrieved later.
+     *
+     * **Common use cases:**
+     * - Generate keys for new user registrations
+     * - Create additional keys for different applications
+     * - Issue keys with specific permissions or limits
+     *
+     * **Required Permissions**
+     *
+     * Your root key needs one of:
+     * - `api.*.create_key` (create keys in any API)
+     * - `api.<api_id>.create_key` (create keys in specific API)
+     */
+    async createKey(request, options) {
+        return unwrapAsync(keysCreateKey(this, request, options));
+    }
+    /**
+     * Delete API keys
+     *
+     * @remarks
+     * Delete API keys permanently from user accounts or for cleanup purposes.
+     *
+     * Use this for user-requested key deletion, account deletion workflows, or cleaning up unused keys. Keys are immediately invalidated. Two modes: soft delete (default, preserves audit records) and permanent delete.
+     *
+     * **Important**: For temporary access control, use `updateKey` with `enabled: false` instead of deletion.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.delete_key` (to delete keys in any API)
+     * - `api.<api_id>.delete_key` (to delete keys in a specific API)
+     */
+    async deleteKey(request, options) {
+        return unwrapAsync(keysDeleteKey(this, request, options));
+    }
+    /**
+     * Get API key
+     *
+     * @remarks
+     * Retrieve detailed key information for dashboard interfaces and administrative purposes.
+     *
+     * Use this to build key management dashboards showing users their key details, status, permissions, and usage data. You can identify keys by `keyId` or the actual key string.
+     *
+     * **Important**: Set `decrypt: true` only in secure contexts to retrieve plaintext key values from recoverable keys.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions for basic key information:
+     * - `api.*.read_key` (to read keys from any API)
+     * - `api.<api_id>.read_key` (to read keys from a specific API)
+     *
+     * Additional permission required for decrypt functionality:
+     * - `api.*.decrypt_key` or `api.<api_id>.decrypt_key`
+     */
+    async getKey(request, options) {
+        return unwrapAsync(keysGetKey(this, request, options));
+    }
+    /**
+     * Remove key permissions
+     *
+     * @remarks
+     * Remove permissions from a key without affecting existing roles or other permissions.
+     *
+     * Use this for privilege downgrades, removing temporary access, or plan changes that revoke specific capabilities. Permissions granted through roles remain unchanged.
+     *
+     * **Important**: Changes take effect immediately with up to 30-second edge propagation.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * Invalidates the key cache for immediate effect, and makes permission changes available for verification within 30 seconds across all regions.
+     */
+    async removePermissions(request, options) {
+        return unwrapAsync(keysRemovePermissions(this, request, options));
+    }
+    /**
+     * Remove key roles
+     *
+     * @remarks
+     * Remove roles from a key without affecting direct permissions or other roles.
+     *
+     * Use this for privilege downgrades, removing temporary access, or subscription changes that revoke specific role-based capabilities. Direct permissions remain unchanged.
+     *
+     * **Important**: Changes take effect immediately with up to 30-second edge propagation.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * Invalidates the key cache for immediate effect, and makes role changes available for verification within 30 seconds across all regions.
+     */
+    async removeRoles(request, options) {
+        return unwrapAsync(keysRemoveRoles(this, request, options));
+    }
+    /**
+     * Set key permissions
+     *
+     * @remarks
+     * Replace all permissions on a key with the specified set in a single atomic operation.
+     *
+     * Use this to synchronize with external systems, reset permissions to a known state, or apply standardized permission templates. Permissions granted through roles remain unchanged.
+     *
+     * **Important**: Changes take effect immediately with up to 30-second edge propagation.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * Invalidates the key cache for immediate effect, and makes permission changes available for verification within 30 seconds across all regions.
+     */
+    async setPermissions(request, options) {
+        return unwrapAsync(keysSetPermissions(this, request, options));
+    }
+    /**
+     * Set key roles
+     *
+     * @remarks
+     * Replace all roles on a key with the specified set in a single atomic operation.
+     *
+     * Use this to synchronize with external systems, reset roles to a known state, or apply standardized role templates. Direct permissions are never affected.
+     *
+     * **Important**: Changes take effect immediately with up to 30-second edge propagation.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * Invalidates the key cache for immediate effect, and makes role changes available for verification within 30 seconds across all regions.
+     */
+    async setRoles(request, options) {
+        return unwrapAsync(keysSetRoles(this, request, options));
+    }
+    /**
+     * Update key credits
+     *
+     * @remarks
+     * Update credit quotas in response to plan changes, billing cycles, or usage purchases.
+     *
+     * Use this for user upgrades/downgrades, monthly quota resets, credit purchases, or promotional bonuses. Supports three operations: set, increment, or decrement credits. Set to null for unlimited usage.
+     *
+     * **Important**: Setting unlimited credits automatically clears existing refill configurations.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * Credit updates remove the key from cache immediately. Setting credits to unlimited automatically clears any existing refill settings. Changes take effect instantly but may take up to 30 seconds to propagate to all edge regions.
+     */
+    async updateCredits(request, options) {
+        return unwrapAsync(keysUpdateCredits(this, request, options));
+    }
+    /**
+     * Update key settings
+     *
+     * @remarks
+     * Update key properties in response to plan changes, subscription updates, or account status changes.
+     *
+     * Use this for user upgrades/downgrades, role modifications, or administrative changes. Supports partial updates - only specify fields you want to change. Set fields to null to clear them.
+     *
+     * **Important**: Permissions and roles are replaced entirely. Use dedicated add/remove endpoints for incremental changes.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `api.*.update_key` (to update keys in any API)
+     * - `api.<api_id>.update_key` (to update keys in a specific API)
+     *
+     * **Side Effects**
+     *
+     * If you specify an `externalId` that doesn't exist, a new identity will be automatically created and linked to the key. Permission updates will auto-create any permissions that don't exist in your workspace. Changes take effect immediately but may take up to 30 seconds to propagate to all edge regions due to cache invalidation.
+     */
+    async updateKey(request, options) {
+        return unwrapAsync(keysUpdateKey(this, request, options));
+    }
+    /**
+     * Verify API key
+     *
+     * @remarks
+     * Verify an API key's validity and permissions for request authentication.
+     *
+     * Use this endpoint on every incoming request to your protected resources. It checks key validity, permissions, rate limits, and usage quotas in a single call.
+     *
+     * **Important**: Always returns HTTP 200. Check the `valid` field in response data to determine if the key is authorized.
+     *
+     * **Common use cases:**
+     * - Authenticate API requests before processing
+     * - Enforce permission-based access control
+     * - Track usage and apply rate limits
+     *
+     * **Required Permissions**
+     *
+     * Your root key needs one of:
+     * - `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.
+     */
+    async verifyKey(request, options) {
+        return unwrapAsync(keysVerifyKey(this, request, options));
+    }
+    /**
+     * Get API key by hash
+     *
+     * @remarks
+     * Find out what key this is.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions for basic key information:
+     * - `api.*.read_key` (to read keys from any API)
+     * - `api.<api_id>.read_key` (to read keys from a specific API)
+     *
+     * If your rootkey lacks permissions but the key exists, we may return a 404 status here to prevent leaking the existance of a key to unauthorized clients. If you believe that a key should exist, but receive a 404, please double check your root key has the correct permissions.
+     */
+    async whoami(request, options) {
+        return unwrapAsync(keysWhoami(this, request, options));
+    }
+}
+//# sourceMappingURL=keys.js.map

package/dist/esm/sdk/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../src/sdk/keys.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,IAAK,SAAQ,SAAS;IACjC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,cAAc,CAClB,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,QAAQ,CACZ,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,SAAS,CACb,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,SAAS,CACb,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAsD,EACtD,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,WAAW,CACf,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,cAAc,CAClB,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,QAAQ,CACZ,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,aAAa,CACjB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,SAAS,CACb,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,SAAS,CACb,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACV,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,UAAU,CAC3B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -0,0 +1,111 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+export declare class Permissions extends ClientSDK {
+    /**
+     * Create permission
+     *
+     * @remarks
+     * Create a new permission to define specific actions or capabilities in your RBAC system. Permissions can be assigned directly to API keys or included in roles.
+     *
+     * Use hierarchical naming patterns like `documents.read`, `admin.users.delete`, or `billing.invoices.create` for clear organization.
+     *
+     * **Important:** Permission names must be unique within the workspace. Once created, permissions are immediately available for assignment.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.create_permission`
+     */
+    createPermission(request: components.V2PermissionsCreatePermissionRequestBody, options?: RequestOptions): Promise<components.V2PermissionsCreatePermissionResponseBody>;
+    /**
+     * Create role
+     *
+     * @remarks
+     * Create a new role to group related permissions for easier management. Roles enable consistent permission assignment across multiple API keys.
+     *
+     * **Important:** Role names must be unique within the workspace. Once created, roles are immediately available for assignment.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.create_role`
+     */
+    createRole(request: components.V2PermissionsCreateRoleRequestBody, options?: RequestOptions): Promise<components.V2PermissionsCreateRoleResponseBody>;
+    /**
+     * Delete permission
+     *
+     * @remarks
+     * Remove a permission from your workspace. This also removes the permission from all API keys and roles.
+     *
+     * **Important:** This operation cannot be undone and immediately affects all API keys and roles that had this permission assigned.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.delete_permission`
+     */
+    deletePermission(request: components.V2PermissionsDeletePermissionRequestBody, options?: RequestOptions): Promise<components.V2PermissionsDeletePermissionResponseBody>;
+    /**
+     * Delete role
+     *
+     * @remarks
+     * Remove a role from your workspace. This also removes the role from all assigned API keys.
+     *
+     * **Important:** This operation cannot be undone and immediately affects all API keys that had this role assigned.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.delete_role`
+     */
+    deleteRole(request: components.V2PermissionsDeleteRoleRequestBody, options?: RequestOptions): Promise<components.V2PermissionsDeleteRoleResponseBody>;
+    /**
+     * Get permission
+     *
+     * @remarks
+     * Retrieve details about a specific permission including its name, description, and metadata.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_permission`
+     */
+    getPermission(request: components.V2PermissionsGetPermissionRequestBody, options?: RequestOptions): Promise<components.V2PermissionsGetPermissionResponseBody>;
+    /**
+     * Get role
+     *
+     * @remarks
+     * Retrieve details about a specific role including its assigned permissions.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_role`
+     */
+    getRole(request: components.V2PermissionsGetRoleRequestBody, options?: RequestOptions): Promise<components.V2PermissionsGetRoleResponseBody>;
+    /**
+     * List permissions
+     *
+     * @remarks
+     * Retrieve all permissions in your workspace. Results are paginated and sorted alphabetically by permission name.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_permission`
+     */
+    listPermissions(request: components.V2PermissionsListPermissionsRequestBody, options?: RequestOptions): Promise<components.V2PermissionsListPermissionsResponseBody>;
+    /**
+     * List roles
+     *
+     * @remarks
+     * Retrieve all roles in your workspace including their assigned permissions. Results are paginated and sorted alphabetically by role name.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_role`
+     */
+    listRoles(request: components.V2PermissionsListRolesRequestBody, options?: RequestOptions): Promise<components.V2PermissionsListRolesResponseBody>;
+}
+//# sourceMappingURL=permissions.d.ts.map

package/dist/esm/sdk/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../src/sdk/permissions.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,WAAY,SAAQ,SAAS;IACxC;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAQ1D;;;;;;;;;;;;OAYG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAQ1D;;;;;;;;;;OAUG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAQ7D;;;;;;;;;;OAUG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;;;;;;OAUG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,uCAAuC,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wCAAwC,CAAC;IAQ/D;;;;;;;;;;OAUG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;CAO1D"}

package/dist/esm/sdk/permissions.js

@@ -0,0 +1,138 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { permissionsCreatePermission } from "../funcs/permissionsCreatePermission.js";
+import { permissionsCreateRole } from "../funcs/permissionsCreateRole.js";
+import { permissionsDeletePermission } from "../funcs/permissionsDeletePermission.js";
+import { permissionsDeleteRole } from "../funcs/permissionsDeleteRole.js";
+import { permissionsGetPermission } from "../funcs/permissionsGetPermission.js";
+import { permissionsGetRole } from "../funcs/permissionsGetRole.js";
+import { permissionsListPermissions } from "../funcs/permissionsListPermissions.js";
+import { permissionsListRoles } from "../funcs/permissionsListRoles.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+export class Permissions extends ClientSDK {
+    /**
+     * Create permission
+     *
+     * @remarks
+     * Create a new permission to define specific actions or capabilities in your RBAC system. Permissions can be assigned directly to API keys or included in roles.
+     *
+     * Use hierarchical naming patterns like `documents.read`, `admin.users.delete`, or `billing.invoices.create` for clear organization.
+     *
+     * **Important:** Permission names must be unique within the workspace. Once created, permissions are immediately available for assignment.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.create_permission`
+     */
+    async createPermission(request, options) {
+        return unwrapAsync(permissionsCreatePermission(this, request, options));
+    }
+    /**
+     * Create role
+     *
+     * @remarks
+     * Create a new role to group related permissions for easier management. Roles enable consistent permission assignment across multiple API keys.
+     *
+     * **Important:** Role names must be unique within the workspace. Once created, roles are immediately available for assignment.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.create_role`
+     */
+    async createRole(request, options) {
+        return unwrapAsync(permissionsCreateRole(this, request, options));
+    }
+    /**
+     * Delete permission
+     *
+     * @remarks
+     * Remove a permission from your workspace. This also removes the permission from all API keys and roles.
+     *
+     * **Important:** This operation cannot be undone and immediately affects all API keys and roles that had this permission assigned.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.delete_permission`
+     */
+    async deletePermission(request, options) {
+        return unwrapAsync(permissionsDeletePermission(this, request, options));
+    }
+    /**
+     * Delete role
+     *
+     * @remarks
+     * Remove a role from your workspace. This also removes the role from all assigned API keys.
+     *
+     * **Important:** This operation cannot be undone and immediately affects all API keys that had this role assigned.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.delete_role`
+     */
+    async deleteRole(request, options) {
+        return unwrapAsync(permissionsDeleteRole(this, request, options));
+    }
+    /**
+     * Get permission
+     *
+     * @remarks
+     * Retrieve details about a specific permission including its name, description, and metadata.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_permission`
+     */
+    async getPermission(request, options) {
+        return unwrapAsync(permissionsGetPermission(this, request, options));
+    }
+    /**
+     * Get role
+     *
+     * @remarks
+     * Retrieve details about a specific role including its assigned permissions.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_role`
+     */
+    async getRole(request, options) {
+        return unwrapAsync(permissionsGetRole(this, request, options));
+    }
+    /**
+     * List permissions
+     *
+     * @remarks
+     * Retrieve all permissions in your workspace. Results are paginated and sorted alphabetically by permission name.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_permission`
+     */
+    async listPermissions(request, options) {
+        return unwrapAsync(permissionsListPermissions(this, request, options));
+    }
+    /**
+     * List roles
+     *
+     * @remarks
+     * Retrieve all roles in your workspace including their assigned permissions. Results are paginated and sorted alphabetically by role name.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have the following permission:
+     * - `rbac.*.read_role`
+     */
+    async listRoles(request, options) {
+        return unwrapAsync(permissionsListRoles(this, request, options));
+    }
+}
+//# sourceMappingURL=permissions.js.map

package/dist/esm/sdk/permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../../src/sdk/permissions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACd,OAAsD,EACtD,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACd,OAAsD,EACtD,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,OAAyD,EACzD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CACX,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CACnB,OAA2D,EAC3D,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CACb,OAAqD,EACrD,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -1,10 +1,78 @@
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 export declare class Ratelimit extends ClientSDK {
-    limit(request: components.V2RatelimitLimitRequestBody, options?: RequestOptions): Promise<components.V2RatelimitLimitResponseBody>;
-    setOverride(request: components.V2RatelimitSetOverrideRequestBody, options?: RequestOptions): Promise<components.V2RatelimitSetOverrideResponseBody>;
+    /**
+     * Delete ratelimit override
+     *
+     * @remarks
+     * Permanently remove a rate limit override. Affected identifiers immediately revert to the namespace default.
+     *
+     * Use this to remove temporary overrides, reset identifiers to standard limits, or clean up outdated rules.
+     *
+     * **Important:** Deletion is immediate and permanent. The override cannot be recovered and must be recreated if needed again.
+     *
+     * **Permissions:** Requires `ratelimit.*.delete_override` or `ratelimit.<namespace_id>.delete_override`
+     */
+    deleteOverride(request: components.V2RatelimitDeleteOverrideRequestBody, options?: RequestOptions): Promise<components.V2RatelimitDeleteOverrideResponseBody>;
+    /**
+     * Get ratelimit override
+     *
+     * @remarks
+     * Retrieve the configuration of a specific rate limit override by its identifier.
+     *
+     * Use this to inspect override configurations, audit rate limiting policies, or debug rate limiting behavior.
+     *
+     * **Important:** The identifier must match exactly as specified when creating the override, including wildcard patterns.
+     *
+     * **Permissions:** Requires `ratelimit.*.read_override` or `ratelimit.<namespace_id>.read_override`
+     */
     getOverride(request: components.V2RatelimitGetOverrideRequestBody, options?: RequestOptions): Promise<components.V2RatelimitGetOverrideResponseBody>;
+    /**
+     * Apply rate limiting
+     *
+     * @remarks
+     * Check and enforce rate limits for any identifier (user ID, IP address, API client, etc.).
+     *
+     * Use this for rate limiting beyond API keys - limit users by ID, IPs by address, or any custom identifier. Supports namespace organization, variable costs, and custom overrides.
+     *
+     * **Important**: Always returns HTTP 200. Check the `success` field to determine if the request should proceed.
+     *
+     * **Required Permissions**
+     *
+     * Your root key must have one of the following permissions:
+     * - `ratelimit.*.limit` (to check limits in any namespace)
+     * - `ratelimit.<namespace_id>.limit` (to check limits in a specific namespace)
+     *
+     * **Side Effects**
+     *
+     * Records rate limit metrics for analytics and monitoring, updates rate limit counters with sliding window algorithm, and optionally triggers override matching for custom limits.
+     */
+    limit(request: components.V2RatelimitLimitRequestBody, options?: RequestOptions): Promise<components.V2RatelimitLimitResponseBody>;
+    /**
+     * List ratelimit overrides
+     *
+     * @remarks
+     * Retrieve a paginated list of all rate limit overrides in a namespace.
+     *
+     * Use this to audit rate limiting policies, build admin dashboards, or manage override configurations.
+     *
+     * **Important:** Results are paginated. Use the cursor parameter to retrieve additional pages when more results are available.
+     *
+     * **Permissions:** Requires `ratelimit.*.read_override` or `ratelimit.<namespace_id>.read_override`
+     */
     listOverrides(request: components.V2RatelimitListOverridesRequestBody, options?: RequestOptions): Promise<components.V2RatelimitListOverridesResponseBody>;
-    deleteOverride(request: components.V2RatelimitDeleteOverrideRequestBody, options?: RequestOptions): Promise<components.V2RatelimitDeleteOverrideResponseBody>;
+    /**
+     * Set ratelimit override
+     *
+     * @remarks
+     * Create or update a custom rate limit for specific identifiers, bypassing the namespace default.
+     *
+     * Use this to create premium tiers with higher limits, apply stricter limits to specific users, or implement emergency throttling.
+     *
+     * **Important:** Overrides take effect immediately and completely replace the default limit for matching identifiers. Use wildcard patterns (e.g., `premium_*`) to match multiple identifiers.
+     *
+     * **Permissions:** Requires `ratelimit.*.set_override` or `ratelimit.<namespace_id>.set_override`
+     */
+    setOverride(request: components.V2RatelimitSetOverrideRequestBody, options?: RequestOptions): Promise<components.V2RatelimitSetOverrideResponseBody>;
 }
 //# sourceMappingURL=ratelimit.d.ts.map

package/dist/esm/sdk/ratelimit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ratelimit.d.ts","sourceRoot":"","sources":["../../../src/sdk/ratelimit.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,SAAU,SAAQ,SAAS;IAChC,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQ7C,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQnD,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQnD,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,mCAAmC,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oCAAoC,CAAC;IAQrD,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;CAO7D"}
+{"version":3,"file":"ratelimit.d.ts","sourceRoot":"","sources":["../../../src/sdk/ratelimit.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;;;OAWG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;;;;;;;OAWG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQzD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,KAAK,CACT,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQnD;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,mCAAmC,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oCAAoC,CAAC;IAQ3D;;;;;;;;;;;OAWG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;CAO1D"}