@orq-ai/node 4.11.0-rc.6 → 4.11.0-rc.62

package/src/models/components/listbudgetsresponse.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 { Budget, Budget$inboundSchema } from "./budget.js";
+
+export type ListBudgetsResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
+  object?: string | undefined;
+  /**
+   * Page of budgets, ordered newest first.
+   */
+  data?: Array<Budget> | undefined;
+  /**
+   * Whether more budgets are available in the selected pagination
+   *
+   * @remarks
+   *  direction.
+   */
+  hasMore?: boolean | undefined;
+};
+
+/** @internal */
+export const ListBudgetsResponse$inboundSchema: z.ZodType<
+  ListBudgetsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string().optional(),
+  data: z.array(Budget$inboundSchema).optional(),
+  has_more: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listBudgetsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListBudgetsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListBudgetsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListBudgetsResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+/**
+ * Per-model cap. The value is the FULL model reference as callers send
+ *
+ * @remarks
+ *  it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
+ *  models) — NOT the Mongo `_id` of the model master-data document.
+ */
+export type ModelBudgetScope = {
+  modelId?: string | undefined;
+};
+
+/** @internal */
+export const ModelBudgetScope$inboundSchema: z.ZodType<
+  ModelBudgetScope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "model_id": "modelId",
+  });
+});
+/** @internal */
+export type ModelBudgetScope$Outbound = {
+  model_id?: string | undefined;
+};
+
+/** @internal */
+export const ModelBudgetScope$outboundSchema: z.ZodType<
+  ModelBudgetScope$Outbound,
+  z.ZodTypeDef,
+  ModelBudgetScope
+> = z.object({
+  modelId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    modelId: "model_id",
+  });
+});
+
+export function modelBudgetScopeToJSON(
+  modelBudgetScope: ModelBudgetScope,
+): string {
+  return JSON.stringify(
+    ModelBudgetScope$outboundSchema.parse(modelBudgetScope),
+  );
+}
+export function modelBudgetScopeFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelBudgetScope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelBudgetScope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelBudgetScope' from JSON`,
+  );
+}

package/src/models/components/modelmetadata.ts

@@ -85,6 +85,7 @@ export type ModelMetadata = {
   supportsB64JsonResponseFormat?: boolean | undefined;
   supportsBatchApi?: boolean | undefined;
   supportsCacheControl?: boolean | undefined;
+  supportsCitations?: boolean | undefined;
   supportsCodeExecution?: boolean | undefined;
   supportsCommercialUse?: boolean | undefined;
   supportsComputerUse?: boolean | undefined;
@@ -108,6 +109,7 @@ export type ModelMetadata = {
   supportsReasoningEffortDefault?: boolean | undefined;
   supportsReasoningEffortHigh?: boolean | undefined;
   supportsReasoningEffortLow?: boolean | undefined;
+  supportsReasoningEffortMax?: boolean | undefined;
   supportsReasoningEffortMedium?: boolean | undefined;
   supportsReasoningEffortMinimal?: boolean | undefined;
   supportsReasoningEffortNone?: boolean | undefined;
@@ -204,6 +206,7 @@ export const ModelMetadata$inboundSchema: z.ZodType<
   supports_b64_json_response_format: z.boolean().optional(),
   supports_batch_api: z.boolean().optional(),
   supports_cache_control: z.boolean().optional(),
+  supports_citations: z.boolean().optional(),
   supports_code_execution: z.boolean().optional(),
   supports_commercial_use: z.boolean().optional(),
   supports_computer_use: z.boolean().optional(),
@@ -227,6 +230,7 @@ export const ModelMetadata$inboundSchema: z.ZodType<
   supports_reasoning_effort_default: z.boolean().optional(),
   supports_reasoning_effort_high: z.boolean().optional(),
   supports_reasoning_effort_low: z.boolean().optional(),
+  supports_reasoning_effort_max: z.boolean().optional(),
   supports_reasoning_effort_medium: z.boolean().optional(),
   supports_reasoning_effort_minimal: z.boolean().optional(),
   supports_reasoning_effort_none: z.boolean().optional(),
@@ -316,6 +320,7 @@ export const ModelMetadata$inboundSchema: z.ZodType<
     "supports_b64_json_response_format": "supportsB64JsonResponseFormat",
     "supports_batch_api": "supportsBatchApi",
     "supports_cache_control": "supportsCacheControl",
+    "supports_citations": "supportsCitations",
     "supports_code_execution": "supportsCodeExecution",
     "supports_commercial_use": "supportsCommercialUse",
     "supports_computer_use": "supportsComputerUse",
@@ -339,6 +344,7 @@ export const ModelMetadata$inboundSchema: z.ZodType<
     "supports_reasoning_effort_default": "supportsReasoningEffortDefault",
     "supports_reasoning_effort_high": "supportsReasoningEffortHigh",
     "supports_reasoning_effort_low": "supportsReasoningEffortLow",
+    "supports_reasoning_effort_max": "supportsReasoningEffortMax",
     "supports_reasoning_effort_medium": "supportsReasoningEffortMedium",
     "supports_reasoning_effort_minimal": "supportsReasoningEffortMinimal",
     "supports_reasoning_effort_none": "supportsReasoningEffortNone",
@@ -431,6 +437,7 @@ export type ModelMetadata$Outbound = {
   supports_b64_json_response_format?: boolean | undefined;
   supports_batch_api?: boolean | undefined;
   supports_cache_control?: boolean | undefined;
+  supports_citations?: boolean | undefined;
   supports_code_execution?: boolean | undefined;
   supports_commercial_use?: boolean | undefined;
   supports_computer_use?: boolean | undefined;
@@ -454,6 +461,7 @@ export type ModelMetadata$Outbound = {
   supports_reasoning_effort_default?: boolean | undefined;
   supports_reasoning_effort_high?: boolean | undefined;
   supports_reasoning_effort_low?: boolean | undefined;
+  supports_reasoning_effort_max?: boolean | undefined;
   supports_reasoning_effort_medium?: boolean | undefined;
   supports_reasoning_effort_minimal?: boolean | undefined;
   supports_reasoning_effort_none?: boolean | undefined;
@@ -550,6 +558,7 @@ export const ModelMetadata$outboundSchema: z.ZodType<
   supportsB64JsonResponseFormat: z.boolean().optional(),
   supportsBatchApi: z.boolean().optional(),
   supportsCacheControl: z.boolean().optional(),
+  supportsCitations: z.boolean().optional(),
   supportsCodeExecution: z.boolean().optional(),
   supportsCommercialUse: z.boolean().optional(),
   supportsComputerUse: z.boolean().optional(),
@@ -573,6 +582,7 @@ export const ModelMetadata$outboundSchema: z.ZodType<
   supportsReasoningEffortDefault: z.boolean().optional(),
   supportsReasoningEffortHigh: z.boolean().optional(),
   supportsReasoningEffortLow: z.boolean().optional(),
+  supportsReasoningEffortMax: z.boolean().optional(),
   supportsReasoningEffortMedium: z.boolean().optional(),
   supportsReasoningEffortMinimal: z.boolean().optional(),
   supportsReasoningEffortNone: z.boolean().optional(),
@@ -662,6 +672,7 @@ export const ModelMetadata$outboundSchema: z.ZodType<
     supportsB64JsonResponseFormat: "supports_b64_json_response_format",
     supportsBatchApi: "supports_batch_api",
     supportsCacheControl: "supports_cache_control",
+    supportsCitations: "supports_citations",
     supportsCodeExecution: "supports_code_execution",
     supportsCommercialUse: "supports_commercial_use",
     supportsComputerUse: "supports_computer_use",
@@ -685,6 +696,7 @@ export const ModelMetadata$outboundSchema: z.ZodType<
     supportsReasoningEffortDefault: "supports_reasoning_effort_default",
     supportsReasoningEffortHigh: "supports_reasoning_effort_high",
     supportsReasoningEffortLow: "supports_reasoning_effort_low",
+    supportsReasoningEffortMax: "supports_reasoning_effort_max",
     supportsReasoningEffortMedium: "supports_reasoning_effort_medium",
     supportsReasoningEffortMinimal: "supports_reasoning_effort_minimal",
     supportsReasoningEffortNone: "supports_reasoning_effort_none",

package/src/models/components/modelsconfig.ts

@@ -14,25 +14,26 @@ import {
   ModelRef$outboundSchema,
 } from "./modelref.js";
 
-export const Mode = {
+export const ModelsConfigMode = {
   Fallback: "fallback",
   Weighted: "weighted",
   RoundRobin: "round_robin",
 } as const;
-export type Mode = ClosedEnum<typeof Mode>;
+export type ModelsConfigMode = ClosedEnum<typeof ModelsConfigMode>;
 
 export type ModelsConfig = {
-  mode: Mode;
+  mode: ModelsConfigMode;
   models: Array<ModelRef> | null;
 };
 
 /** @internal */
-export const Mode$inboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
-  Mode,
-);
+export const ModelsConfigMode$inboundSchema: z.ZodNativeEnum<
+  typeof ModelsConfigMode
+> = z.nativeEnum(ModelsConfigMode);
 /** @internal */
-export const Mode$outboundSchema: z.ZodNativeEnum<typeof Mode> =
-  Mode$inboundSchema;
+export const ModelsConfigMode$outboundSchema: z.ZodNativeEnum<
+  typeof ModelsConfigMode
+> = ModelsConfigMode$inboundSchema;
 
 /** @internal */
 export const ModelsConfig$inboundSchema: z.ZodType<
@@ -40,7 +41,7 @@ export const ModelsConfig$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  mode: Mode$inboundSchema,
+  mode: ModelsConfigMode$inboundSchema,
   models: z.nullable(z.array(ModelRef$inboundSchema)),
 });
 /** @internal */
@@ -55,7 +56,7 @@ export const ModelsConfig$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ModelsConfig
 > = z.object({
-  mode: Mode$outboundSchema,
+  mode: ModelsConfigMode$outboundSchema,
   models: z.nullable(z.array(ModelRef$outboundSchema)),
 });
 

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`,
+  );
+}