@orq-ai/node 4.11.0-rc.50 → 4.11.0-rc.52

package/src/funcs/managementKeysListCapabilities.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function managementKeysListCapabilities(
+  client: OrqCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ListManagementCapabilitiesResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ListManagementCapabilitiesResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v2/management-keys/capabilities")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "ManagementKeyListCapabilities",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.ListManagementCapabilitiesResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.ListManagementCapabilitiesResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/managementKeysUpdate.ts

@@ -0,0 +1,175 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { OrqError } from "../models/errors/orqerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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.
+ */
+export function managementKeysUpdate(
+  client: OrqCore,
+  request: operations.ManagementKeyUpdateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.UpdateManagementKeyResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OrqCore,
+  request: operations.ManagementKeyUpdateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.UpdateManagementKeyResponse,
+      | OrqError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ManagementKeyUpdateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.UpdateManagementKeyRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    management_key_id: encodeSimple(
+      "management_key_id",
+      payload.management_key_id,
+      { explode: false, charEncoding: "percent" },
+    ),
+  };
+  const path = pathToFunc("/v2/management-keys/{management_key_id}")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "ManagementKeyUpdate",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PATCH",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.UpdateManagementKeyResponse,
+    | OrqError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.UpdateManagementKeyResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "2.0",
-  sdkVersion: "4.11.0-rc.50",
-  genVersion: "2.912.1",
-  userAgent: "speakeasy-sdk/typescript 4.11.0-rc.50 2.912.1 2.0 @orq-ai/node",
+  sdkVersion: "4.11.0-rc.52",
+  genVersion: "2.913.3",
+  userAgent: "speakeasy-sdk/typescript 4.11.0-rc.52 2.913.3 2.0 @orq-ai/node",
 } as const;

package/src/models/components/createmanagementkeyrequest.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ManagementPermissionMode,
+  ManagementPermissionMode$outboundSchema,
+} from "./managementpermissionmode.js";
+
+export type CreateManagementKeyRequest = {
+  /**
+   * Human-readable name. Required.
+   */
+  name: string;
+  permissionMode?: ManagementPermissionMode | undefined;
+  /**
+   * Per-domain access map. Required when `permission_mode` =
+   *
+   * @remarks
+   *  `MANAGEMENT_PERMISSION_MODE_RESTRICTED`. See `ManagementKey.access`
+   *  for the catalog of valid keys (Domain.id) and AccessLevel string
+   *  values, or fetch the live catalog via the capability catalog
+   *  endpoint.
+   */
+  access?: { [k: string]: number } | undefined;
+  /**
+   * Optional expiration. When set, the authenticate hot-path rejects
+   *
+   * @remarks
+   *  the key once `expires_at` is in the past. Unset means the key
+   *  never expires.
+   */
+  expiresAt?: Date | undefined;
+};
+
+/** @internal */
+export type CreateManagementKeyRequest$Outbound = {
+  name: string;
+  permission_mode?: string | undefined;
+  access?: { [k: string]: number } | undefined;
+  expires_at?: string | undefined;
+};
+
+/** @internal */
+export const CreateManagementKeyRequest$outboundSchema: z.ZodType<
+  CreateManagementKeyRequest$Outbound,
+  z.ZodTypeDef,
+  CreateManagementKeyRequest
+> = z.object({
+  name: z.string(),
+  permissionMode: ManagementPermissionMode$outboundSchema.optional(),
+  access: z.record(z.number().int()).optional(),
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    permissionMode: "permission_mode",
+    expiresAt: "expires_at",
+  });
+});
+
+export function createManagementKeyRequestToJSON(
+  createManagementKeyRequest: CreateManagementKeyRequest,
+): string {
+  return JSON.stringify(
+    CreateManagementKeyRequest$outboundSchema.parse(createManagementKeyRequest),
+  );
+}

package/src/models/components/createmanagementkeyresponse.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ManagementKey, ManagementKey$inboundSchema } from "./managementkey.js";
+
+export type CreateManagementKeyResponse = {
+  /**
+   * Newly minted management-key record.
+   */
+  managementKey: ManagementKey;
+  /**
+   * Raw bearer token in the form `sk-orq-<management_key_id>-<secret>`.
+   *
+   * @remarks
+   *  Returned ONCE; the API never exposes this value again.
+   */
+  token: string;
+};
+
+/** @internal */
+export const CreateManagementKeyResponse$inboundSchema: z.ZodType<
+  CreateManagementKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  management_key: ManagementKey$inboundSchema,
+  token: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "management_key": "managementKey",
+  });
+});
+
+export function createManagementKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateManagementKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateManagementKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateManagementKeyResponse' from JSON`,
+  );
+}

package/src/models/components/deletemanagementkeyresponse.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DeleteManagementKeyResponse = {};
+
+/** @internal */
+export const DeleteManagementKeyResponse$inboundSchema: z.ZodType<
+  DeleteManagementKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function deleteManagementKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteManagementKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteManagementKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteManagementKeyResponse' from JSON`,
+  );
+}

package/src/models/components/domain.ts

@@ -9,18 +9,18 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Domain describes a permission domain that can be granted to an
+ * Domain describes a permission domain that can be granted to a
  *
  * @remarks
- *  API key. Verbs are derived from id + group + readable/writable.
+ *  management key. Verbs are derived from id + readable/writable.
  */
 export type Domain = {
   /**
-   * Stable domain identifier (e.g. "agent", "chat_completions"). Used
+   * Stable domain identifier (e.g. "api-key", "budget"). Used as the
    *
    * @remarks
-   *  as the key in ApiKey.access and as the verb prefix in resolved
-   *  permissions (e.g. agent.list, agent.view, agent.create).
+   *  key in ManagementKey.access and as the verb prefix in resolved
+   *  permissions (e.g. budget.list, budget.view, budget.create).
    */
   id?: string | undefined;
   /**
@@ -31,13 +31,6 @@ export type Domain = {
    * Logical group used by the UI to render this entry.
    */
   group?: number | undefined;
-  /**
-   * Project scopes this domain may be granted under. A workspace-
-   *
-   * @remarks
-   *  admin domain like `member` is typically SCOPE_MODE_ALL only.
-   */
-  allowedScopes?: Array<number> | undefined;
   /**
    * Whether this domain can be granted read access.
    */
@@ -54,13 +47,11 @@ export const Domain$inboundSchema: z.ZodType<Domain, z.ZodTypeDef, unknown> = z
     id: z.string().optional(),
     display_name: z.string().optional(),
     group: z.number().int().optional(),
-    allowed_scopes: z.array(z.number().int()).optional(),
     readable: z.boolean().optional(),
     writable: z.boolean().optional(),
   }).transform((v) => {
     return remap$(v, {
       "display_name": "displayName",
-      "allowed_scopes": "allowedScopes",
     });
   });
 

package/src/models/components/getmanagementkeyresponse.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ManagementKey, ManagementKey$inboundSchema } from "./managementkey.js";
+
+export type GetManagementKeyResponse = {
+  /**
+   * Requested management-key. Raw token never included.
+   */
+  managementKey: ManagementKey;
+};
+
+/** @internal */
+export const GetManagementKeyResponse$inboundSchema: z.ZodType<
+  GetManagementKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  management_key: ManagementKey$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "management_key": "managementKey",
+  });
+});
+
+export function getManagementKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetManagementKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetManagementKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetManagementKeyResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -44,6 +44,8 @@ export * from "./createfilerequest.js";
 export * from "./createfileresponse.js";
 export * from "./createidentityrequest.js";
 export * from "./createidentityresponse.js";
+export * from "./createmanagementkeyrequest.js";
+export * from "./createmanagementkeyresponse.js";
 export * from "./createmodelparameter.js";
 export * from "./createprojectrequest.js";
 export * from "./createprojectresponse.js";
@@ -55,6 +57,7 @@ export * from "./deleteapikeyresponse.js";
 export * from "./deletebudgetresponse.js";
 export * from "./deletefileresponse.js";
 export * from "./deleteidentityresponse.js";
+export * from "./deletemanagementkeyresponse.js";
 export * from "./deleteprojectresponse.js";
 export * from "./deleteskillresponse.js";
 export * from "./detectrequest.js";
@@ -89,6 +92,7 @@ export * from "./getbudgetconsumptionresponse.js";
 export * from "./getbudgetresponse.js";
 export * from "./getfilecontentresponse.js";
 export * from "./getfileresponse.js";
+export * from "./getmanagementkeyresponse.js";
 export * from "./getprojectresponse.js";
 export * from "./getskillresponse.js";
 export * from "./guardrailref.js";
@@ -108,8 +112,13 @@ export * from "./listbudgetsresponse.js";
 export * from "./listcapabilitiesresponse.js";
 export * from "./listfilesresponse.js";
 export * from "./listidentitiesresponse.js";
+export * from "./listmanagementcapabilitiesresponse.js";
+export * from "./listmanagementkeysresponse.js";
 export * from "./listprojectsresponse.js";
 export * from "./listskillsresponse.js";
+export * from "./managementkey.js";
+export * from "./managementkeystatus.js";
+export * from "./managementpermissionmode.js";
 export * from "./memoryparam.js";
 export * from "./modelbudgetscope.js";
 export * from "./modelconfigurationresponse.js";
@@ -250,6 +259,8 @@ export * from "./updatefilerequest.js";
 export * from "./updatefileresponse.js";
 export * from "./updateidentityrequest.js";
 export * from "./updateidentityresponse.js";
+export * from "./updatemanagementkeyrequest.js";
+export * from "./updatemanagementkeyresponse.js";
 export * from "./updatemodelparameter.js";
 export * from "./updateprojectrequest.js";
 export * from "./updateprojectresponse.js";

package/src/models/components/listmanagementcapabilitiesresponse.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Domain, Domain$inboundSchema } from "./domain.js";
+
+export type ListManagementCapabilitiesResponse = {
+  /**
+   * Full management capability catalog.
+   */
+  domains: Array<Domain>;
+};
+
+/** @internal */
+export const ListManagementCapabilitiesResponse$inboundSchema: z.ZodType<
+  ListManagementCapabilitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  domains: z.array(Domain$inboundSchema),
+});
+
+export function listManagementCapabilitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListManagementCapabilitiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListManagementCapabilitiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListManagementCapabilitiesResponse' from JSON`,
+  );
+}