@unkey/api 0.38.0 → 2.0.0-alpha.11

package/dist/commonjs/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/commonjs/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/commonjs/sdk/permissions.js

@@ -0,0 +1,142 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Permissions = void 0;
+const permissionsCreatePermission_js_1 = require("../funcs/permissionsCreatePermission.js");
+const permissionsCreateRole_js_1 = require("../funcs/permissionsCreateRole.js");
+const permissionsDeletePermission_js_1 = require("../funcs/permissionsDeletePermission.js");
+const permissionsDeleteRole_js_1 = require("../funcs/permissionsDeleteRole.js");
+const permissionsGetPermission_js_1 = require("../funcs/permissionsGetPermission.js");
+const permissionsGetRole_js_1 = require("../funcs/permissionsGetRole.js");
+const permissionsListPermissions_js_1 = require("../funcs/permissionsListPermissions.js");
+const permissionsListRoles_js_1 = require("../funcs/permissionsListRoles.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("../types/fp.js");
+class Permissions extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsCreatePermission_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsCreateRole_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsDeletePermission_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsDeleteRole_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsGetPermission_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsGetRole_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsListPermissions_js_1.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 (0, fp_js_1.unwrapAsync)((0, permissionsListRoles_js_1.permissionsListRoles)(this, request, options));
+    }
+}
+exports.Permissions = Permissions;
+//# sourceMappingURL=permissions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../../src/sdk/permissions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,4FAAsF;AACtF,gFAA0E;AAC1E,4FAAsF;AACtF,gFAA0E;AAC1E,sFAAgF;AAChF,0EAAoE;AACpE,0FAAoF;AACpF,8EAAwE;AACxE,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,WAAY,SAAQ,mBAAS;IACxC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA4D,EAC5D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4DAA2B,EAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACd,OAAsD,EACtD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA4D,EAC5D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4DAA2B,EAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACd,OAAsD,EACtD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,OAAyD,EACzD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CACX,OAAmD,EACnD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,eAAe,CACnB,OAA2D,EAC3D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS,CACb,OAAqD,EACrD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA1LD,kCA0LC"}

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

@@ -0,0 +1,78 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+export declare class Ratelimit extends ClientSDK {
+    /**
+     * 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>;
+    /**
+     * 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/commonjs/sdk/ratelimit.d.ts.map

@@ -0,0 +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;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"}

package/dist/commonjs/sdk/ratelimit.js

@@ -0,0 +1,100 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ratelimit = void 0;
+const ratelimitDeleteOverride_js_1 = require("../funcs/ratelimitDeleteOverride.js");
+const ratelimitGetOverride_js_1 = require("../funcs/ratelimitGetOverride.js");
+const ratelimitLimit_js_1 = require("../funcs/ratelimitLimit.js");
+const ratelimitListOverrides_js_1 = require("../funcs/ratelimitListOverrides.js");
+const ratelimitSetOverride_js_1 = require("../funcs/ratelimitSetOverride.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("../types/fp.js");
+class Ratelimit extends sdks_js_1.ClientSDK {
+    /**
+     * 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`
+     */
+    async deleteOverride(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, ratelimitDeleteOverride_js_1.ratelimitDeleteOverride)(this, request, options));
+    }
+    /**
+     * 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`
+     */
+    async getOverride(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, ratelimitGetOverride_js_1.ratelimitGetOverride)(this, request, options));
+    }
+    /**
+     * 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.
+     */
+    async limit(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, ratelimitLimit_js_1.ratelimitLimit)(this, request, options));
+    }
+    /**
+     * 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`
+     */
+    async listOverrides(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, ratelimitListOverrides_js_1.ratelimitListOverrides)(this, request, options));
+    }
+    /**
+     * 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`
+     */
+    async setOverride(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, ratelimitSetOverride_js_1.ratelimitSetOverride)(this, request, options));
+    }
+}
+exports.Ratelimit = Ratelimit;
+//# sourceMappingURL=ratelimit.js.map

package/dist/commonjs/sdk/ratelimit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ratelimit.js","sourceRoot":"","sources":["../../../src/sdk/ratelimit.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,oFAA8E;AAC9E,8EAAwE;AACxE,kEAA4D;AAC5D,kFAA4E;AAC5E,8EAAwE;AACxE,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,SAAU,SAAQ,mBAAS;IACtC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CACf,OAAqD,EACrD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,KAAK,CACT,OAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kCAAc,EAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,OAAuD,EACvD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kDAAsB,EACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CACf,OAAqD,EACrD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA3HD,8BA2HC"}

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

@@ -0,0 +1,25 @@
+import { ClientSDK } from "../lib/sdks.js";
+import { Apis } from "./apis.js";
+import { Chproxy } from "./chproxy.js";
+import { Identities } from "./identities.js";
+import { Keys } from "./keys.js";
+import { Liveness } from "./liveness.js";
+import { Permissions } from "./permissions.js";
+import { Ratelimit } from "./ratelimit.js";
+export declare class Unkey extends ClientSDK {
+    private _chproxy?;
+    get chproxy(): Chproxy;
+    private _apis?;
+    get apis(): Apis;
+    private _identities?;
+    get identities(): Identities;
+    private _keys?;
+    get keys(): Keys;
+    private _liveness?;
+    get liveness(): Liveness;
+    private _permissions?;
+    get permissions(): Permissions;
+    private _ratelimit?;
+    get ratelimit(): Ratelimit;
+}
+//# sourceMappingURL=sdk.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,KAAM,SAAQ,SAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,CAAU;IAC3B,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,OAAO,CAAC,SAAS,CAAC,CAAW;IAC7B,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;CACF"}

package/dist/commonjs/sdk/sdk.js

@@ -0,0 +1,39 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Unkey = void 0;
+const sdks_js_1 = require("../lib/sdks.js");
+const apis_js_1 = require("./apis.js");
+const chproxy_js_1 = require("./chproxy.js");
+const identities_js_1 = require("./identities.js");
+const keys_js_1 = require("./keys.js");
+const liveness_js_1 = require("./liveness.js");
+const permissions_js_1 = require("./permissions.js");
+const ratelimit_js_1 = require("./ratelimit.js");
+class Unkey extends sdks_js_1.ClientSDK {
+    get chproxy() {
+        return (this._chproxy ?? (this._chproxy = new chproxy_js_1.Chproxy(this._options)));
+    }
+    get apis() {
+        return (this._apis ?? (this._apis = new apis_js_1.Apis(this._options)));
+    }
+    get identities() {
+        return (this._identities ?? (this._identities = new identities_js_1.Identities(this._options)));
+    }
+    get keys() {
+        return (this._keys ?? (this._keys = new keys_js_1.Keys(this._options)));
+    }
+    get liveness() {
+        return (this._liveness ?? (this._liveness = new liveness_js_1.Liveness(this._options)));
+    }
+    get permissions() {
+        return (this._permissions ?? (this._permissions = new permissions_js_1.Permissions(this._options)));
+    }
+    get ratelimit() {
+        return (this._ratelimit ?? (this._ratelimit = new ratelimit_js_1.Ratelimit(this._options)));
+    }
+}
+exports.Unkey = Unkey;
+//# sourceMappingURL=sdk.js.map

package/dist/commonjs/sdk/sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,4CAA2C;AAC3C,uCAAiC;AACjC,6CAAuC;AACvC,mDAA6C;AAC7C,uCAAiC;AACjC,+CAAyC;AACzC,qDAA+C;AAC/C,iDAA2C;AAE3C,MAAa,KAAM,SAAQ,mBAAS;IAElC,IAAI,OAAO;QACT,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,oBAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IACxD,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,cAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,UAAU;QACZ,OAAO,CAAC,IAAI,CAAC,WAAW,KAAhB,IAAI,CAAC,WAAW,GAAK,IAAI,0BAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC9D,CAAC;IAGD,IAAI,IAAI;QACN,OAAO,CAAC,IAAI,CAAC,KAAK,KAAV,IAAI,CAAC,KAAK,GAAK,IAAI,cAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAClD,CAAC;IAGD,IAAI,QAAQ;QACV,OAAO,CAAC,IAAI,CAAC,SAAS,KAAd,IAAI,CAAC,SAAS,GAAK,IAAI,sBAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC1D,CAAC;IAGD,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAjB,IAAI,CAAC,YAAY,GAAK,IAAI,4BAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAChE,CAAC;IAGD,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,wBAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,CAAC;CACF;AAnCD,sBAmCC"}

package/dist/commonjs/types/async.d.ts

@@ -0,0 +1,23 @@
+export type APICall = {
+    status: "complete";
+    request: Request;
+    response: Response;
+} | {
+    status: "request-error";
+    request: Request;
+    response?: undefined;
+} | {
+    status: "invalid";
+    request?: undefined;
+    response?: undefined;
+};
+export declare class APIPromise<T> implements Promise<T> {
+    #private;
+    readonly [Symbol.toStringTag] = "APIPromise";
+    constructor(p: [T, APICall] | Promise<[T, APICall]>);
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null | undefined): Promise<T | TResult>;
+    finally(onfinally?: (() => void) | null | undefined): Promise<T>;
+    $inspect(): Promise<[T, APICall]>;
+}
+//# sourceMappingURL=async.d.ts.map

package/dist/commonjs/types/async.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"async.d.ts","sourceRoot":"","sources":["../../../src/types/async.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GACf;IACE,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;CACpB,GACD;IACE,MAAM,EAAE,eAAe,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,GACD;IACE,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEN,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;;IAI9C,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB;gBAEjC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAQnD,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EACjC,WAAW,CAAC,EACR,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAChD,IAAI,GACJ,SAAS,EACb,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACnD,IAAI,GACJ,SAAS,GACZ,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAO/B,KAAK,CAAC,OAAO,GAAG,KAAK,EACnB,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,GACjD,IAAI,GACJ,SAAS,GACZ,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC;IAIvB,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC;IAIhE,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;CAGlC"}

package/dist/commonjs/types/async.js

@@ -0,0 +1,44 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _APIPromise_promise, _APIPromise_unwrapped, _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIPromise = void 0;
+class APIPromise {
+    constructor(p) {
+        _APIPromise_promise.set(this, void 0);
+        _APIPromise_unwrapped.set(this, void 0);
+        this[_a] = "APIPromise";
+        __classPrivateFieldSet(this, _APIPromise_promise, p instanceof Promise ? p : Promise.resolve(p), "f");
+        __classPrivateFieldSet(this, _APIPromise_unwrapped, p instanceof Promise
+            ? __classPrivateFieldGet(this, _APIPromise_promise, "f").then(([value]) => value)
+            : Promise.resolve(p[0]), "f");
+    }
+    then(onfulfilled, onrejected) {
+        return __classPrivateFieldGet(this, _APIPromise_promise, "f").then(onfulfilled ? ([value]) => onfulfilled(value) : void 0, onrejected);
+    }
+    catch(onrejected) {
+        return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").catch(onrejected);
+    }
+    finally(onfinally) {
+        return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").finally(onfinally);
+    }
+    $inspect() {
+        return __classPrivateFieldGet(this, _APIPromise_promise, "f");
+    }
+}
+exports.APIPromise = APIPromise;
+_APIPromise_promise = new WeakMap(), _APIPromise_unwrapped = new WeakMap(), _a = Symbol.toStringTag;
+//# sourceMappingURL=async.js.map

package/dist/commonjs/types/async.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async.js","sourceRoot":"","sources":["../../../src/types/async.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;AAmBH,MAAa,UAAU;IAMrB,YAAY,CAAuC;QAL1C,sCAAgC;QAChC,wCAAuB;QAEvB,QAAoB,GAAG,YAAY,CAAC;QAG3C,uBAAA,IAAI,uBAAY,CAAC,YAAY,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAA,CAAC;QAC9D,uBAAA,IAAI,yBACF,CAAC,YAAY,OAAO;YAClB,CAAC,CAAC,uBAAA,IAAI,2BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;YACxC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAA,CAAC;IAC9B,CAAC;IAED,IAAI,CACF,WAGa,EACb,UAGa;QAEb,OAAO,uBAAA,IAAI,2BAAS,CAAC,IAAI,CACvB,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EACtD,UAAU,CACX,CAAC;IACJ,CAAC;IAED,KAAK,CACH,UAGa;QAEb,OAAO,uBAAA,IAAI,6BAAW,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,SAA2C;QACjD,OAAO,uBAAA,IAAI,6BAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,QAAQ;QACN,OAAO,uBAAA,IAAI,2BAAS,CAAC;IACvB,CAAC;CACF;AA9CD,gCA8CC;iFA1CW,MAAM,CAAC,WAAW"}

package/dist/commonjs/types/blobs.d.ts

@@ -0,0 +1,4 @@
+import * as z from "zod";
+export declare const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob>;
+export declare function isBlobLike(val: unknown): val is Blob;
+//# sourceMappingURL=blobs.d.ts.map

package/dist/commonjs/types/blobs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobs.d.ts","sourceRoot":"","sources":["../../../src/types/blobs.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,CAI3D,CAAC;AAEL,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,IAAI,CAkBpD"}