@unkey/api 2.0.0-alpha.7 → 2.0.1

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

@@ -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/commonjs/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"}

package/dist/commonjs/sdk/ratelimit.js

@@ -12,20 +12,88 @@ 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 {
-    async limit(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, ratelimitLimit_js_1.ratelimitLimit)(this, request, options));
-    }
-    async setOverride(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, ratelimitSetOverride_js_1.ratelimitSetOverride)(this, request, options));
+    /**
+     * 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));
     }
-    async deleteOverride(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, ratelimitDeleteOverride_js_1.ratelimitDeleteOverride)(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;

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

@@ -1 +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,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,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,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,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,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;CACF;AAvDD,8BAuDC"}
+{"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

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

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

@@ -1 +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,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,KAAM,SAAQ,SAAS;IAClC,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,IAAI,SAAS,IAAI,SAAS,CAEzB;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;CACF"}
+{"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,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,qBAAa,KAAM,SAAQ,SAAS;IAClC,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,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

@@ -7,20 +7,24 @@ exports.Unkey = void 0;
 const sdks_js_1 = require("../lib/sdks.js");
 const apis_js_1 = require("./apis.js");
 const identities_js_1 = require("./identities.js");
-const liveness_js_1 = require("./liveness.js");
+const keys_js_1 = require("./keys.js");
+const permissions_js_1 = require("./permissions.js");
 const ratelimit_js_1 = require("./ratelimit.js");
 class Unkey extends sdks_js_1.ClientSDK {
-    get ratelimit() {
-        return (this._ratelimit ?? (this._ratelimit = new ratelimit_js_1.Ratelimit(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 apis() {
-        return (this._apis ?? (this._apis = new apis_js_1.Apis(this._options)));
+    get keys() {
+        return (this._keys ?? (this._keys = new keys_js_1.Keys(this._options)));
+    }
+    get permissions() {
+        return (this._permissions ?? (this._permissions = new permissions_js_1.Permissions(this._options)));
     }
-    get liveness() {
-        return (this._liveness ?? (this._liveness = new liveness_js_1.Liveness(this._options)));
+    get ratelimit() {
+        return (this._ratelimit ?? (this._ratelimit = new ratelimit_js_1.Ratelimit(this._options)));
     }
 }
 exports.Unkey = Unkey;

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

@@ -1 +1 @@
-{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,4CAA2C;AAC3C,uCAAiC;AACjC,mDAA6C;AAC7C,+CAAyC;AACzC,iDAA2C;AAE3C,MAAa,KAAM,SAAQ,mBAAS;IAElC,IAAI,SAAS;QACX,OAAO,CAAC,IAAI,CAAC,UAAU,KAAf,IAAI,CAAC,UAAU,GAAK,IAAI,wBAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAC,CAAC;IAC5D,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;CACF;AApBD,sBAoBC"}
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../../src/sdk/sdk.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,4CAA2C;AAC3C,uCAAiC;AACjC,mDAA6C;AAC7C,uCAAiC;AACjC,qDAA+C;AAC/C,iDAA2C;AAE3C,MAAa,KAAM,SAAQ,mBAAS;IAElC,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,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;AAzBD,sBAyBC"}

package/dist/commonjs/types/constdatetime.js

@@ -41,6 +41,6 @@ const z = __importStar(require("zod"));
 function constDateTime(val) {
     return z.custom((v) => {
         return (typeof v === "string" && new Date(v).getTime() === new Date(val).getTime());
-    }, `Value must be equivelant to ${val}`);
+    }, `Value must be equivalent to ${val}`);
 }
 //# sourceMappingURL=constdatetime.js.map

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

@@ -1,11 +1,27 @@
 import { UnkeyCore } from "../core.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
-import { APIError } from "../models/errors/apierror.js";
 import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
 import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { UnkeyError } from "../models/errors/unkeyerror.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
-export declare function apisCreateApi(client: UnkeyCore, request: components.V2ApisCreateApiRequestBody, options?: RequestOptions): APIPromise<Result<components.V2ApisCreateApiResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.InternalServerErrorResponse | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+/**
+ * Create API namespace
+ *
+ * @remarks
+ * Create an API namespace for organizing keys by environment, service, or product.
+ *
+ * Use this to separate production from development keys, isolate different services, or manage multiple products. Each API gets a unique identifier and dedicated infrastructure for secure key operations.
+ *
+ * **Important**: API names must be unique within your workspace and cannot be changed after creation.
+ *
+ * **Required Permissions**
+ *
+ * Your root key must have one of the following permissions:
+ * - `api.*.create_api` (to create APIs in any workspace)
+ */
+export declare function apisCreateApi(client: UnkeyCore, request: components.V2ApisCreateApiRequestBody, options?: RequestOptions): APIPromise<Result<components.V2ApisCreateApiResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=apisCreateApi.d.ts.map

package/dist/esm/funcs/apisCreateApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apisCreateApi.d.ts","sourceRoot":"","sources":["../../../src/funcs/apisCreateApi.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAKvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,2BAA2B,EACpC,MAAM,CAAC,uBAAuB,GAC9B,MAAM,CAAC,yBAAyB,GAChC,MAAM,CAAC,sBAAsB,GAC7B,MAAM,CAAC,2BAA2B,GAClC,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}
+{"version":3,"file":"apisCreateApi.d.ts","sourceRoot":"","sources":["../../../src/funcs/apisCreateApi.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAKvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,2BAA2B,EACpC,MAAM,CAAC,uBAAuB,GAC9B,MAAM,CAAC,yBAAyB,GAChC,MAAM,CAAC,sBAAsB,GAC7B,MAAM,CAAC,2BAA2B,GAClC,UAAU,GACV,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}

package/dist/esm/funcs/apisCreateApi.js

@@ -10,6 +10,21 @@ import { pathToFunc } from "../lib/url.js";
 import * as components from "../models/components/index.js";
 import * as errors from "../models/errors/index.js";
 import { APIPromise } from "../types/async.js";
+/**
+ * Create API namespace
+ *
+ * @remarks
+ * Create an API namespace for organizing keys by environment, service, or product.
+ *
+ * Use this to separate production from development keys, isolate different services, or manage multiple products. Each API gets a unique identifier and dedicated infrastructure for secure key operations.
+ *
+ * **Important**: API names must be unique within your workspace and cannot be changed after creation.
+ *
+ * **Required Permissions**
+ *
+ * Your root key must have one of the following permissions:
+ * - `api.*.create_api` (to create APIs in any workspace)
+ */
 export function apisCreateApi(client, request, options) {
     return new APIPromise($do(client, request, options));
 }
@@ -29,6 +44,7 @@ async function $do(client, request, options) {
     const securityInput = secConfig == null ? {} : { rootKey: secConfig };
     const requestSecurity = resolveGlobalSecurity(securityInput);
     const context = {
+        options: client._options,
         baseURL: options?.serverURL ?? client._baseURL ?? "",
         operationID: "createApi",
         oAuth2Scopes: [],
@@ -56,6 +72,7 @@ async function $do(client, request, options) {
         path: path,
         headers: headers,
         body: body,
+        userAgent: client._options.userAgent,
         timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
     }, options);
     if (!requestRes.ok) {
@@ -75,7 +92,7 @@ async function $do(client, request, options) {
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
-    const [result] = await M.match(M.json(200, components.V2ApisCreateApiResponseBody$inboundSchema), M.jsonErr(400, errors.BadRequestErrorResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedErrorResponse$inboundSchema), M.jsonErr(403, errors.ForbiddenErrorResponse$inboundSchema), M.jsonErr(500, errors.InternalServerErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, { extraFields: responseFields });
+    const [result] = await M.match(M.json(200, components.V2ApisCreateApiResponseBody$inboundSchema), M.jsonErr(400, errors.BadRequestErrorResponse$inboundSchema), M.jsonErr(401, errors.UnauthorizedErrorResponse$inboundSchema), M.jsonErr(403, errors.ForbiddenErrorResponse$inboundSchema), M.jsonErr(500, errors.InternalServerErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
     if (!result.ok) {
         return [result, { status: "complete", request: req, response }];
     }