@orq-ai/node 4.11.0-rc.51 → 4.11.0-rc.53

package/src/sdk/managementkeys.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { managementKeysCreate } from "../funcs/managementKeysCreate.js";
+import { managementKeysDelete } from "../funcs/managementKeysDelete.js";
+import { managementKeysGet } from "../funcs/managementKeysGet.js";
+import { managementKeysList } from "../funcs/managementKeysList.js";
+import { managementKeysListCapabilities } from "../funcs/managementKeysListCapabilities.js";
+import { managementKeysUpdate } from "../funcs/managementKeysUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ManagementKeys extends ClientSDK {
+  /**
+   * List management keys
+   *
+   * @remarks
+   * Returns management keys in the current workspace, ordered by creation time with the newest key first. The `api_key` and `token_hash` fields are never returned by this endpoint; only `token_prefix` is included.
+   */
+  async list(
+    request?: operations.ManagementKeyListRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ListManagementKeysResponse> {
+    return unwrapAsync(managementKeysList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new management key
+   *
+   * @remarks
+   * Mints a new opaque management key (`sk-orq-<key_id>-<secret>`) in the workspace. The raw secret is returned ONCE in the response and is never retrievable afterwards. The stored record retains only `token_prefix` and a SHA-256 `token_hash`.
+   */
+  async create(
+    request: components.CreateManagementKeyRequest,
+    options?: RequestOptions,
+  ): Promise<components.CreateManagementKeyResponse> {
+    return unwrapAsync(managementKeysCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List management capability catalog
+   *
+   * @remarks
+   * Returns the management capability catalog: the set of workspace-admin permission domains that can be granted to a management key. Each entry includes the domain id, display name, group, and the read / write verb support. Drives the permissions UI in the dashboard.
+   */
+  async listCapabilities(
+    options?: RequestOptions,
+  ): Promise<components.ListManagementCapabilitiesResponse> {
+    return unwrapAsync(managementKeysListCapabilities(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a management key
+   *
+   * @remarks
+   * Retrieves the metadata for an existing management key by its unique identifier. The raw secret is never returned — only `token_prefix`, `permission_mode`, and lifecycle fields.
+   */
+  async get(
+    request: operations.ManagementKeyGetRequest,
+    options?: RequestOptions,
+  ): Promise<components.GetManagementKeyResponse> {
+    return unwrapAsync(managementKeysGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a management key
+   *
+   * @remarks
+   * Permanently deletes a management key. Cache entries are invalidated immediately so an in-flight token cannot ride out the TTL. The response body is empty on success.
+   */
+  async delete(
+    request: operations.ManagementKeyDeleteRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteManagementKeyResponse> {
+    return unwrapAsync(managementKeysDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a management key
+   *
+   * @remarks
+   * Updates mutable fields of a management key: display name, status (active / disabled / revoked), permission mode and access map, and expiry. Omitted fields keep their current values.
+   */
+  async update(
+    request: operations.ManagementKeyUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<components.UpdateManagementKeyResponse> {
+    return unwrapAsync(managementKeysUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -17,6 +17,7 @@ import { GuardrailRules } from "./guardrailrules.js";
 import { HumanReviewSets } from "./humanreviewsets.js";
 import { Identities } from "./identities.js";
 import { Knowledge } from "./knowledge.js";
+import { ManagementKeys } from "./managementkeys.js";
 import { MemoryStores } from "./memorystores.js";
 import { Models } from "./models.js";
 import { Pii } from "./pii.js";
@@ -142,6 +143,11 @@ export class Orq extends ClientSDK {
     return (this._identities ??= new Identities(this._options));
   }
 
+  private _managementKeys?: ManagementKeys;
+  get managementKeys(): ManagementKeys {
+    return (this._managementKeys ??= new ManagementKeys(this._options));
+  }
+
   private _projects?: Projects;
   get projects(): Projects {
     return (this._projects ??= new Projects(this._options));