@orq-ai/node 4.10.0-rc.4 → 4.10.0-rc.46

package/src/models/components/apikey.ts

@@ -0,0 +1,178 @@
+/*
+ * 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 { ApiKeyOwner, ApiKeyOwner$inboundSchema } from "./apikeyowner.js";
+import { ApiKeyStatus, ApiKeyStatus$inboundSchema } from "./apikeystatus.js";
+import {
+  LegacyTokenFamily,
+  LegacyTokenFamily$inboundSchema,
+} from "./legacytokenfamily.js";
+import {
+  PermissionMode,
+  PermissionMode$inboundSchema,
+} from "./permissionmode.js";
+import { ProjectScope, ProjectScope$inboundSchema } from "./projectscope.js";
+
+/**
+ * ApiKey is the canonical record stored in MongoDB `auth.apiKeys`.
+ *
+ * @remarks
+ *  It is the source of truth for scope, permissions, owner, budget,
+ *  expiration, and revocation (see ADR 0001).
+ */
+export type ApiKey = {
+  /**
+   * Canonical key identifier (ULID). Embedded in opaque tokens as
+   *
+   * @remarks
+   *  `sk-orq-<id>-<secret>`.
+   */
+  apiKeyId?: string | undefined;
+  /**
+   * Human-readable name shown in the dashboard.
+   */
+  name?: string | undefined;
+  /**
+   * Owner attribution (drives lifecycle).
+   */
+  owner?: ApiKeyOwner | undefined;
+  /**
+   * Project authorization scope.
+   */
+  projectScope?: ProjectScope | undefined;
+  permissionMode?: PermissionMode | undefined;
+  /**
+   * Per-domain access map. Only populated when `permission_mode` is
+   *
+   * @remarks
+   *  `PERMISSION_MODE_RESTRICTED`. The authoritative list of valid
+   *  keys and the per-domain read / write semantics are exposed at
+   *  runtime via the `ListCapabilities` RPC.
+   *
+   *  Valid keys (Domain.id) currently in the catalog:
+   *    Workspace-admin: "api-key", "member", "billing", "sso", "group",
+   *                     "audit-log", "workspace"
+   *    Platform:        "agent", "agent-schedule", "annotation",
+   *                     "chunking", "dataset", "deployment", "eval",
+   *                     "file", "guardrail-rule", "identity",
+   *                     "knowledge", "memory-store", "policy",
+   *                     "project", "prompt", "routing-rule", "skill",
+   *                     "tool"
+   *    Gateway:         "chat_completions", "embeddings", "responses",
+   *                     "moderations", "images", "audio_speech",
+   *                     "audio_transcription", "realtime", "model"
+   *
+   *  Values are AccessLevel enum names on the JSON wire:
+   *    "ACCESS_LEVEL_NONE"  — capability not granted
+   *    "ACCESS_LEVEL_READ"  — list / view verbs
+   *    "ACCESS_LEVEL_WRITE" — list / view + mutating / execute verbs
+   */
+  access?: { [k: string]: number } | undefined;
+  /**
+   * Displayable prefix for UI listings (e.g. "sk-orq-01HXY..."). Safe
+   *
+   * @remarks
+   *  to expose.
+   */
+  tokenPrefix?: string | undefined;
+  status?: ApiKeyStatus | undefined;
+  /**
+   * Audit: user who created the key. Optional. Distinct from
+   *
+   * @remarks
+   *  `owner.user_id` — created_by is provenance only, while owner
+   *  determines lifecycle binding.
+   */
+  createdById?: string | undefined;
+  /**
+   * Audit: user who last updated the key.
+   */
+  updatedById?: string | undefined;
+  /**
+   * Time the key was created.
+   */
+  createdAt?: Date | undefined;
+  /**
+   * Time the key was last updated.
+   */
+  updatedAt?: Date | undefined;
+  /**
+   * Last authenticated use. Updated via NATS debounce + 1% sampler.
+   */
+  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;
+  legacyTokenFamily?: LegacyTokenFamily | undefined;
+  /**
+   * Legacy MongoDB `_id` from before the canonical ULID was assigned.
+   *
+   * @remarks
+   *  Used by the adapter to resolve a JWT back to this canonical record.
+   */
+  legacyKeyId?: string | undefined;
+};
+
+/** @internal */
+export const ApiKey$inboundSchema: z.ZodType<ApiKey, z.ZodTypeDef, unknown> = z
+  .object({
+    api_key_id: z.string().optional(),
+    name: z.string().optional(),
+    owner: ApiKeyOwner$inboundSchema.optional(),
+    project_scope: ProjectScope$inboundSchema.optional(),
+    permission_mode: PermissionMode$inboundSchema.optional(),
+    access: z.record(z.number().int()).optional(),
+    token_prefix: z.string().optional(),
+    status: ApiKeyStatus$inboundSchema.optional(),
+    created_by_id: z.string().optional(),
+    updated_by_id: z.string().optional(),
+    created_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+    updated_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+    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(),
+    legacy_token_family: LegacyTokenFamily$inboundSchema.optional(),
+    legacy_key_id: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "api_key_id": "apiKeyId",
+      "project_scope": "projectScope",
+      "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",
+      "legacy_token_family": "legacyTokenFamily",
+      "legacy_key_id": "legacyKeyId",
+    });
+  });
+
+export function apiKeyFromJSON(
+  jsonString: string,
+): SafeParseResult<ApiKey, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApiKey$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApiKey' from JSON`,
+  );
+}

package/src/models/components/apikeyowner.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 {
+  ServiceAccountOwner,
+  ServiceAccountOwner$inboundSchema,
+  ServiceAccountOwner$Outbound,
+  ServiceAccountOwner$outboundSchema,
+} from "./serviceaccountowner.js";
+import {
+  UserOwner,
+  UserOwner$inboundSchema,
+  UserOwner$Outbound,
+  UserOwner$outboundSchema,
+} from "./userowner.js";
+
+/**
+ * Owner attribution drives lifecycle.
+ *
+ * @remarks
+ *
+ *  `service_account` keys are workspace-owned and outlive any individual
+ *  user. `user` keys are bound to `user_id`: when the user is removed,
+ *  disabled, or loses project access, the key is revoked / its scope
+ *  shrinks per the cascade rules in ADR 0001.
+ */
+export type ApiKeyOwner = {
+  user?: UserOwner | undefined;
+  serviceAccount?: ServiceAccountOwner | undefined;
+};
+
+/** @internal */
+export const ApiKeyOwner$inboundSchema: z.ZodType<
+  ApiKeyOwner,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  user: UserOwner$inboundSchema.optional(),
+  service_account: ServiceAccountOwner$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_account": "serviceAccount",
+  });
+});
+/** @internal */
+export type ApiKeyOwner$Outbound = {
+  user?: UserOwner$Outbound | undefined;
+  service_account?: ServiceAccountOwner$Outbound | undefined;
+};
+
+/** @internal */
+export const ApiKeyOwner$outboundSchema: z.ZodType<
+  ApiKeyOwner$Outbound,
+  z.ZodTypeDef,
+  ApiKeyOwner
+> = z.object({
+  user: UserOwner$outboundSchema.optional(),
+  serviceAccount: ServiceAccountOwner$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceAccount: "service_account",
+  });
+});
+
+export function apiKeyOwnerToJSON(apiKeyOwner: ApiKeyOwner): string {
+  return JSON.stringify(ApiKeyOwner$outboundSchema.parse(apiKeyOwner));
+}
+export function apiKeyOwnerFromJSON(
+  jsonString: string,
+): SafeParseResult<ApiKeyOwner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApiKeyOwner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApiKeyOwner' from JSON`,
+  );
+}

package/src/models/components/apikeystatus.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ApiKeyStatus = {
+  ApiKeyStatusUnspecified: "API_KEY_STATUS_UNSPECIFIED",
+  ApiKeyStatusActive: "API_KEY_STATUS_ACTIVE",
+  ApiKeyStatusDisabled: "API_KEY_STATUS_DISABLED",
+  ApiKeyStatusRevoked: "API_KEY_STATUS_REVOKED",
+} as const;
+export type ApiKeyStatus = ClosedEnum<typeof ApiKeyStatus>;
+
+/** @internal */
+export const ApiKeyStatus$inboundSchema: z.ZodNativeEnum<typeof ApiKeyStatus> =
+  z.nativeEnum(ApiKeyStatus);
+/** @internal */
+export const ApiKeyStatus$outboundSchema: z.ZodNativeEnum<typeof ApiKeyStatus> =
+  ApiKeyStatus$inboundSchema;

package/src/models/components/autorouterconfig.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 AutoRouterConfig = {
+  economicalModel?: string | undefined;
+  id?: string | undefined;
+  profile?: string | undefined;
+  strongModel?: string | undefined;
+  version?: string | undefined;
+};
+
+/** @internal */
+export const AutoRouterConfig$inboundSchema: z.ZodType<
+  AutoRouterConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  economical_model: z.string().optional(),
+  id: z.string().optional(),
+  profile: z.string().optional(),
+  strong_model: z.string().optional(),
+  version: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "economical_model": "economicalModel",
+    "strong_model": "strongModel",
+  });
+});
+/** @internal */
+export type AutoRouterConfig$Outbound = {
+  economical_model?: string | undefined;
+  id?: string | undefined;
+  profile?: string | undefined;
+  strong_model?: string | undefined;
+  version?: string | undefined;
+};
+
+/** @internal */
+export const AutoRouterConfig$outboundSchema: z.ZodType<
+  AutoRouterConfig$Outbound,
+  z.ZodTypeDef,
+  AutoRouterConfig
+> = z.object({
+  economicalModel: z.string().optional(),
+  id: z.string().optional(),
+  profile: z.string().optional(),
+  strongModel: z.string().optional(),
+  version: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    economicalModel: "economical_model",
+    strongModel: "strong_model",
+  });
+});
+
+export function autoRouterConfigToJSON(
+  autoRouterConfig: AutoRouterConfig,
+): string {
+  return JSON.stringify(
+    AutoRouterConfig$outboundSchema.parse(autoRouterConfig),
+  );
+}
+export function autoRouterConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<AutoRouterConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AutoRouterConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AutoRouterConfig' from JSON`,
+  );
+}

package/src/models/components/azurefoundrydeployment.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";
+import {
+  AzureFoundryDeploymentMasterData,
+  AzureFoundryDeploymentMasterData$inboundSchema,
+} from "./azurefoundrydeploymentmasterdata.js";
+
+export type AzureFoundryDeployment = {
+  id: string;
+  masterData?: AzureFoundryDeploymentMasterData | undefined;
+  model: string;
+};
+
+/** @internal */
+export const AzureFoundryDeployment$inboundSchema: z.ZodType<
+  AzureFoundryDeployment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  master_data: AzureFoundryDeploymentMasterData$inboundSchema.optional(),
+  model: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "master_data": "masterData",
+  });
+});
+
+export function azureFoundryDeploymentFromJSON(
+  jsonString: string,
+): SafeParseResult<AzureFoundryDeployment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AzureFoundryDeployment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AzureFoundryDeployment' from JSON`,
+  );
+}

package/src/models/components/azurefoundrydeploymentmasterdata.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 AzureFoundryDeploymentMasterData = {
+  hasFunctions: boolean;
+  id: string;
+  inputCost: number;
+  metadata?: { [k: string]: any } | undefined;
+  modelDeveloper: string | null;
+  modelFamily: string | null;
+  modelId: string;
+  modelType: string;
+  outputCost: number;
+  parameters: Array<any> | null;
+};
+
+/** @internal */
+export const AzureFoundryDeploymentMasterData$inboundSchema: z.ZodType<
+  AzureFoundryDeploymentMasterData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  has_functions: z.boolean(),
+  id: z.string(),
+  input_cost: z.number(),
+  metadata: z.record(z.any()).optional(),
+  model_developer: z.nullable(z.string()),
+  model_family: z.nullable(z.string()),
+  model_id: z.string(),
+  model_type: z.string(),
+  output_cost: z.number(),
+  parameters: z.nullable(z.array(z.any())),
+}).transform((v) => {
+  return remap$(v, {
+    "has_functions": "hasFunctions",
+    "input_cost": "inputCost",
+    "model_developer": "modelDeveloper",
+    "model_family": "modelFamily",
+    "model_id": "modelId",
+    "model_type": "modelType",
+    "output_cost": "outputCost",
+  });
+});
+
+export function azureFoundryDeploymentMasterDataFromJSON(
+  jsonString: string,
+): SafeParseResult<AzureFoundryDeploymentMasterData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AzureFoundryDeploymentMasterData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AzureFoundryDeploymentMasterData' from JSON`,
+  );
+}

package/src/models/components/createapikeyrequest.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 {
+  ApiKeyOwner,
+  ApiKeyOwner$Outbound,
+  ApiKeyOwner$outboundSchema,
+} from "./apikeyowner.js";
+import {
+  PermissionMode,
+  PermissionMode$outboundSchema,
+} from "./permissionmode.js";
+import {
+  ProjectScope,
+  ProjectScope$Outbound,
+  ProjectScope$outboundSchema,
+} from "./projectscope.js";
+
+export type CreateApiKeyRequest = {
+  /**
+   * Human-readable name. Required.
+   */
+  name?: string | undefined;
+  /**
+   * Owner attribution. Defaults to service_account when omitted.
+   */
+  owner?: ApiKeyOwner | undefined;
+  /**
+   * Project authorization scope. Defaults to all-projects when omitted.
+   */
+  projectScope?: ProjectScope | undefined;
+  permissionMode?: PermissionMode | undefined;
+  /**
+   * Per-domain access map. Required when `permission_mode` =
+   *
+   * @remarks
+   *  `PERMISSION_MODE_RESTRICTED`. See `ApiKey.access` for the full
+   *  catalog of valid keys (Domain.id) and AccessLevel string values,
+   *  or fetch the live catalog via the `ListCapabilities` RPC.
+   */
+  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 CreateApiKeyRequest$Outbound = {
+  name?: string | undefined;
+  owner?: ApiKeyOwner$Outbound | undefined;
+  project_scope?: ProjectScope$Outbound | undefined;
+  permission_mode?: string | undefined;
+  access?: { [k: string]: number } | undefined;
+  expires_at?: string | undefined;
+};
+
+/** @internal */
+export const CreateApiKeyRequest$outboundSchema: z.ZodType<
+  CreateApiKeyRequest$Outbound,
+  z.ZodTypeDef,
+  CreateApiKeyRequest
+> = z.object({
+  name: z.string().optional(),
+  owner: ApiKeyOwner$outboundSchema.optional(),
+  projectScope: ProjectScope$outboundSchema.optional(),
+  permissionMode: PermissionMode$outboundSchema.optional(),
+  access: z.record(z.number().int()).optional(),
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    projectScope: "project_scope",
+    permissionMode: "permission_mode",
+    expiresAt: "expires_at",
+  });
+});
+
+export function createApiKeyRequestToJSON(
+  createApiKeyRequest: CreateApiKeyRequest,
+): string {
+  return JSON.stringify(
+    CreateApiKeyRequest$outboundSchema.parse(createApiKeyRequest),
+  );
+}

package/src/models/components/createapikeyresponse.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 { ApiKey, ApiKey$inboundSchema } from "./apikey.js";
+
+export type CreateApiKeyResponse = {
+  /**
+   * Newly minted api-key record.
+   */
+  apiKey?: ApiKey | undefined;
+  /**
+   * Raw bearer token in the form `sk-orq-<api_key_id>-<secret>`.
+   *
+   * @remarks
+   *  Returned ONCE; the API never exposes this value again. Clients
+   *  must persist it immediately on receipt.
+   */
+  token?: string | undefined;
+};
+
+/** @internal */
+export const CreateApiKeyResponse$inboundSchema: z.ZodType<
+  CreateApiKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  api_key: ApiKey$inboundSchema.optional(),
+  token: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_key": "apiKey",
+  });
+});
+
+export function createApiKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateApiKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateApiKeyResponse' from JSON`,
+  );
+}

package/src/models/components/createfilerequest.ts

@@ -4,20 +4,26 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
+import { FilePurpose, FilePurpose$outboundSchema } from "./filepurpose.js";
 
 export type CreateFileRequest = {
   filename?: string | undefined;
   content?: string | undefined;
-  purpose?: number | undefined;
+  purpose?: FilePurpose | undefined;
   contentType?: string | undefined;
+  /**
+   * Project the file is created in. Optional for project-scoped API keys (defaults to the key's bound project); required for workspace-scoped callers.
+   */
+  projectId?: string | undefined;
 };
 
 /** @internal */
 export type CreateFileRequest$Outbound = {
   filename?: string | undefined;
   content?: string | undefined;
-  purpose?: number | undefined;
+  purpose?: string | undefined;
   content_type?: string | undefined;
+  project_id?: string | undefined;
 };
 
 /** @internal */
@@ -28,11 +34,13 @@ export const CreateFileRequest$outboundSchema: z.ZodType<
 > = z.object({
   filename: z.string().optional(),
   content: z.string().optional(),
-  purpose: z.number().int().optional(),
+  purpose: FilePurpose$outboundSchema.optional(),
   contentType: z.string().optional(),
+  projectId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     contentType: "content_type",
+    projectId: "project_id",
   });
 });