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

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/guardrailrule.ts

@@ -9,6 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Expression, Expression$inboundSchema } from "./expression.js";
 import { GuardrailRef, GuardrailRef$inboundSchema } from "./guardrailref.js";
+import { Plugin, Plugin$inboundSchema } from "./plugin.js";
 
 export type GuardrailRule = {
   id: string;
@@ -19,6 +20,7 @@ export type GuardrailRule = {
   enabled: boolean;
   expression?: Expression | undefined;
   guardrails?: Array<GuardrailRef> | null | undefined;
+  plugins?: Array<Plugin> | null | undefined;
   projectId: string;
   timeout: number;
   updatedAt: Date;
@@ -39,6 +41,7 @@ export const GuardrailRule$inboundSchema: z.ZodType<
   enabled: z.boolean(),
   expression: Expression$inboundSchema.optional(),
   guardrails: z.nullable(z.array(GuardrailRef$inboundSchema)).optional(),
+  plugins: z.nullable(z.array(Plugin$inboundSchema)).optional(),
   project_id: z.string(),
   timeout: z.number().int(),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),

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";
@@ -123,6 +132,10 @@ export * from "./partdelta.js";
 export * from "./partdeltaevent.js";
 export * from "./partdoneevent.js";
 export * from "./permissionmode.js";
+export * from "./piiredactionplugin.js";
+export * from "./piiredactionpluginen.js";
+export * from "./piiredactionpluginnl.js";
+export * from "./plugin.js";
 export * from "./policy.js";
 export * from "./policyretryconfig.js";
 export * from "./price.js";
@@ -137,6 +150,7 @@ export * from "./publicembeddingdata.js";
 export * from "./publicembeddingusage.js";
 export * from "./publicidentity.js";
 export * from "./publicmodelentry.js";
+export * from "./publicpiiredactionplugin.js";
 export * from "./publicresponseresource.js";
 export * from "./publicschedule.js";
 export * from "./publicscheduleerrordetail.js";
@@ -250,6 +264,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`,
+  );
+}

package/src/models/components/listmanagementkeysresponse.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 ListManagementKeysResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
+  object: string;
+  /**
+   * Page of management-keys, ordered newest first. `token_hash` and
+   *
+   * @remarks
+   *  `api_key` are always elided in list responses.
+   */
+  data: Array<ManagementKey>;
+  /**
+   * Whether more management-keys are available in the selected pagination
+   *
+   * @remarks
+   *  direction.
+   */
+  hasMore: boolean;
+};
+
+/** @internal */
+export const ListManagementKeysResponse$inboundSchema: z.ZodType<
+  ListManagementKeysResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  data: z.array(ManagementKey$inboundSchema),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listManagementKeysResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListManagementKeysResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListManagementKeysResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListManagementKeysResponse' from JSON`,
+  );
+}

package/src/models/components/managementkey.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 {
+  ManagementKeyStatus,
+  ManagementKeyStatus$inboundSchema,
+} from "./managementkeystatus.js";
+import {
+  ManagementPermissionMode,
+  ManagementPermissionMode$inboundSchema,
+} from "./managementpermissionmode.js";
+
+/**
+ * ManagementKey is the canonical record stored in MongoDB
+ *
+ * @remarks
+ *  `auth.managementKeys`. It is the source of truth for permissions,
+ *  expiration, and revocation. Management keys are always
+ *  workspace-scoped — there is no project_scope field, and they have no
+ *  per-user owner (every management key is workspace-owned;
+ *  `created_by_id` records who created it).
+ */
+export type ManagementKey = {
+  /**
+   * Canonical key identifier (ULID). Embedded in opaque tokens as
+   *
+   * @remarks
+   *  `sk-orq-<id>-<secret>`.
+   */
+  managementKeyId: string;
+  /**
+   * Human-readable name shown in the dashboard.
+   */
+  name: string;
+  permissionMode: ManagementPermissionMode;
+  /**
+   * Per-domain access map. Only populated when `permission_mode` is
+   *
+   * @remarks
+   *  `MANAGEMENT_PERMISSION_MODE_RESTRICTED`. Valid keys are the Domain.id
+   *  values in the management capability catalog — see
+   *  libs/catalog/orq/managementkeys/v1/catalog.textpb for the canonical
+   *  list.
+   */
+  access?: { [k: string]: number } | undefined;
+  /**
+   * Displayable prefix for UI listings (e.g. "sk-orq-01HXY..."). Safe
+   *
+   * @remarks
+   *  to expose.
+   */
+  tokenPrefix: string;
+  status: ManagementKeyStatus;
+  /**
+   * Audit: user who created the key.
+   */
+  createdById?: string | undefined;
+  /**
+   * Audit: user who last updated the key.
+   */
+  updatedById?: string | undefined;
+  /**
+   * Time the key was created.
+   */
+  createdAt: Date;
+  /**
+   * Time the key was last updated.
+   */
+  updatedAt: Date;
+  /**
+   * Last authenticated use.
+   */
+  lastUsedAt?: Date | undefined;
+  /**
+   * Optional expiration. The authenticate hot-path rejects keys whose
+   *
+   * @remarks
+   *  `expires_at` is in the past. Unset means the key never expires.
+   */
+  expiresAt?: Date | undefined;
+};
+
+/** @internal */
+export const ManagementKey$inboundSchema: z.ZodType<
+  ManagementKey,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  management_key_id: z.string(),
+  name: z.string(),
+  permission_mode: ManagementPermissionMode$inboundSchema,
+  access: z.record(z.number().int()).optional(),
+  token_prefix: z.string(),
+  status: ManagementKeyStatus$inboundSchema,
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  last_used_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "management_key_id": "managementKeyId",
+    "permission_mode": "permissionMode",
+    "token_prefix": "tokenPrefix",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+    "last_used_at": "lastUsedAt",
+    "expires_at": "expiresAt",
+  });
+});
+
+export function managementKeyFromJSON(
+  jsonString: string,
+): SafeParseResult<ManagementKey, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ManagementKey$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ManagementKey' from JSON`,
+  );
+}

package/src/models/components/managementkeystatus.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ManagementKeyStatus = {
+  ManagementKeyStatusUnspecified: "MANAGEMENT_KEY_STATUS_UNSPECIFIED",
+  ManagementKeyStatusActive: "MANAGEMENT_KEY_STATUS_ACTIVE",
+  ManagementKeyStatusDisabled: "MANAGEMENT_KEY_STATUS_DISABLED",
+  ManagementKeyStatusRevoked: "MANAGEMENT_KEY_STATUS_REVOKED",
+} as const;
+export type ManagementKeyStatus = ClosedEnum<typeof ManagementKeyStatus>;
+
+/** @internal */
+export const ManagementKeyStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ManagementKeyStatus
+> = z.nativeEnum(ManagementKeyStatus);
+/** @internal */
+export const ManagementKeyStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ManagementKeyStatus
+> = ManagementKeyStatus$inboundSchema;

package/src/models/components/managementpermissionmode.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ManagementPermissionMode = {
+  ManagementPermissionModeUnspecified: "MANAGEMENT_PERMISSION_MODE_UNSPECIFIED",
+  ManagementPermissionModeAll: "MANAGEMENT_PERMISSION_MODE_ALL",
+  ManagementPermissionModeRestricted: "MANAGEMENT_PERMISSION_MODE_RESTRICTED",
+  ManagementPermissionModeReadOnly: "MANAGEMENT_PERMISSION_MODE_READ_ONLY",
+} as const;
+export type ManagementPermissionMode = ClosedEnum<
+  typeof ManagementPermissionMode
+>;
+
+/** @internal */
+export const ManagementPermissionMode$inboundSchema: z.ZodNativeEnum<
+  typeof ManagementPermissionMode
+> = z.nativeEnum(ManagementPermissionMode);
+/** @internal */
+export const ManagementPermissionMode$outboundSchema: z.ZodNativeEnum<
+  typeof ManagementPermissionMode
+> = ManagementPermissionMode$inboundSchema;

package/src/models/components/piiredactionplugin.ts

@@ -0,0 +1,44 @@
+/*
+ * 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";
+
+export type PIIRedactionPlugin = {
+  entities?: Array<string> | null | undefined;
+  id: string;
+  language?: string | undefined;
+  onFailure?: string | undefined;
+  threshold?: number | undefined;
+};
+
+/** @internal */
+export const PIIRedactionPlugin$inboundSchema: z.ZodType<
+  PIIRedactionPlugin,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entities: z.nullable(z.array(z.string())).optional(),
+  id: z.string(),
+  language: z.string().optional(),
+  on_failure: z.string().optional(),
+  threshold: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "on_failure": "onFailure",
+  });
+});
+
+export function piiRedactionPluginFromJSON(
+  jsonString: string,
+): SafeParseResult<PIIRedactionPlugin, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PIIRedactionPlugin$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PIIRedactionPlugin' from JSON`,
+  );
+}