@orq-ai/node 4.14.0-rc.44 → 4.14.0-rc.46

package/src/models/components/mcpserver.ts

@@ -0,0 +1,114 @@
+/*
+ * 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 {
+  McpAuthConfigOutput,
+  McpAuthConfigOutput$inboundSchema,
+} from "./mcpauthconfigoutput.js";
+import { McpConnection, McpConnection$inboundSchema } from "./mcpconnection.js";
+import { McpSyncState, McpSyncState$inboundSchema } from "./mcpsyncstate.js";
+import { McpTool, McpTool$inboundSchema } from "./mcptool.js";
+import {
+  McpToolExposure,
+  McpToolExposure$inboundSchema,
+} from "./mcptoolexposure.js";
+import { Sharing, Sharing$inboundSchema } from "./sharing.js";
+
+export type McpServer = {
+  /**
+   * Unique identifier of the MCP server.
+   */
+  id?: string | undefined;
+  /**
+   * Lowercase slug of letters, digits, hyphens and underscores, max 64 characters, unique per workspace; prefixes this server's tool names in gateways.
+   */
+  key?: string | undefined;
+  /**
+   * Human readable name shown in the workspace.
+   */
+  displayName?: string | undefined;
+  /**
+   * Free-form note about what this server is for.
+   */
+  description?: string | undefined;
+  /**
+   * How the gateway dials the upstream server.
+   */
+  connection?: McpConnection | undefined;
+  /**
+   * Credentials the gateway sends upstream; send `type: NONE` explicitly for public servers.
+   */
+  auth?: McpAuthConfigOutput | undefined;
+  /**
+   * Fallback exposure used by any gateway link that does not set its own.
+   */
+  defaultToolExposure?: McpToolExposure | undefined;
+  /**
+   * Result of the last `:sync`; a new server has no tools until synced.
+   */
+  syncState?: McpSyncState | undefined;
+  /**
+   * Tool catalog discovered by the last successful `:sync`.
+   */
+  tools?: Array<McpTool> | undefined;
+  /**
+   * ISO 8601 timestamp of when the server was created.
+   */
+  created?: string | undefined;
+  /**
+   * ISO 8601 timestamp of the most recent change to the server.
+   */
+  updated?: string | undefined;
+  /**
+   * Which projects in the workspace may use this server.
+   */
+  sharing?: Sharing | undefined;
+  /**
+   * Account that created the server.
+   */
+  createdById?: string | undefined;
+};
+
+/** @internal */
+export const McpServer$inboundSchema: z.ZodType<
+  McpServer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  key: z.string().optional(),
+  display_name: z.string().optional(),
+  description: z.string().optional(),
+  connection: McpConnection$inboundSchema.optional(),
+  auth: McpAuthConfigOutput$inboundSchema.optional(),
+  default_tool_exposure: McpToolExposure$inboundSchema.optional(),
+  sync_state: McpSyncState$inboundSchema.optional(),
+  tools: z.array(McpTool$inboundSchema).optional(),
+  created: z.string().optional(),
+  updated: z.string().optional(),
+  sharing: Sharing$inboundSchema.optional(),
+  created_by_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "default_tool_exposure": "defaultToolExposure",
+    "sync_state": "syncState",
+    "created_by_id": "createdById",
+  });
+});
+
+export function mcpServerFromJSON(
+  jsonString: string,
+): SafeParseResult<McpServer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => McpServer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'McpServer' from JSON`,
+  );
+}

package/src/models/components/mcpsyncstate.ts

@@ -0,0 +1,65 @@
+/*
+ * 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 { SyncStatus, SyncStatus$inboundSchema } from "./syncstatus.js";
+
+export type McpSyncState = {
+  status?: SyncStatus | undefined;
+  /**
+   * Tools in the catalog after the last sync.
+   */
+  toolsTotal?: number | undefined;
+  /**
+   * Tools the last sync discovered for the first time.
+   */
+  toolsAdded?: number | undefined;
+  /**
+   * Tools the last sync no longer found upstream and marked MISSING.
+   */
+  toolsRemoved?: number | undefined;
+  /**
+   * ISO 8601 timestamp of the last sync attempt.
+   */
+  lastSyncedAt?: string | undefined;
+  /**
+   * Failures reported by the last sync.
+   */
+  errors?: Array<string> | undefined;
+};
+
+/** @internal */
+export const McpSyncState$inboundSchema: z.ZodType<
+  McpSyncState,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: SyncStatus$inboundSchema.optional(),
+  tools_total: z.number().int().optional(),
+  tools_added: z.number().int().optional(),
+  tools_removed: z.number().int().optional(),
+  last_synced_at: z.string().optional(),
+  errors: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tools_total": "toolsTotal",
+    "tools_added": "toolsAdded",
+    "tools_removed": "toolsRemoved",
+    "last_synced_at": "lastSyncedAt",
+  });
+});
+
+export function mcpSyncStateFromJSON(
+  jsonString: string,
+): SafeParseResult<McpSyncState, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => McpSyncState$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'McpSyncState' from JSON`,
+  );
+}

package/src/models/components/mcptestresult.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 { McpTool, McpTool$inboundSchema } from "./mcptool.js";
+
+export type McpTestResult = {
+  /**
+   * Whether the probe connected and listed tools successfully.
+   */
+  ok?: boolean | undefined;
+  /**
+   * Tools discovered during the probe; not persisted.
+   */
+  tools?: Array<McpTool> | undefined;
+  /**
+   * Round trip time of the probe in milliseconds.
+   */
+  latencyMs?: number | undefined;
+  /**
+   * Human-readable reason the probe failed.
+   */
+  errorMessage?: string | undefined;
+  /**
+   * Additional failure details collected during the probe.
+   */
+  errors?: Array<string> | undefined;
+};
+
+/** @internal */
+export const McpTestResult$inboundSchema: z.ZodType<
+  McpTestResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ok: z.boolean().optional(),
+  tools: z.array(McpTool$inboundSchema).optional(),
+  latency_ms: z.number().int().optional(),
+  error_message: z.string().optional(),
+  errors: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "latency_ms": "latencyMs",
+    "error_message": "errorMessage",
+  });
+});
+
+export function mcpTestResultFromJSON(
+  jsonString: string,
+): SafeParseResult<McpTestResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => McpTestResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'McpTestResult' from JSON`,
+  );
+}

package/src/models/components/mcptool.ts

@@ -0,0 +1,92 @@
+/*
+ * 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 {
+  McpToolAnnotations,
+  McpToolAnnotations$inboundSchema,
+} from "./mcptoolannotations.js";
+
+/**
+ * JSON Schema for the tool arguments, as advertised upstream.
+ */
+export type McpToolInputSchema = {};
+
+export type McpTool = {
+  /**
+   * Bare tool name as advertised by the upstream server.
+   */
+  name?: string | undefined;
+  /**
+   * Tool description advertised upstream, passed through to MCP clients.
+   */
+  description?: string | undefined;
+  /**
+   * JSON Schema for the tool arguments, as advertised upstream.
+   */
+  inputSchema?: McpToolInputSchema | undefined;
+  /**
+   * `ACTIVE`, or `MISSING` when the last sync no longer found the tool upstream.
+   */
+  status?: string | undefined;
+  /**
+   * Assigned once on first discovery and preserved across sync.
+   */
+  id?: string | undefined;
+  /**
+   * Human-readable label advertised upstream, when the server sends one.
+   */
+  title?: string | undefined;
+  /**
+   * Behaviour hints claimed by the upstream server.
+   */
+  annotations?: McpToolAnnotations | undefined;
+};
+
+/** @internal */
+export const McpToolInputSchema$inboundSchema: z.ZodType<
+  McpToolInputSchema,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function mcpToolInputSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<McpToolInputSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => McpToolInputSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'McpToolInputSchema' from JSON`,
+  );
+}
+
+/** @internal */
+export const McpTool$inboundSchema: z.ZodType<McpTool, z.ZodTypeDef, unknown> =
+  z.object({
+    name: z.string().optional(),
+    description: z.string().optional(),
+    input_schema: z.lazy(() => McpToolInputSchema$inboundSchema).optional(),
+    status: z.string().optional(),
+    id: z.string().optional(),
+    title: z.string().optional(),
+    annotations: McpToolAnnotations$inboundSchema.optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "input_schema": "inputSchema",
+    });
+  });
+
+export function mcpToolFromJSON(
+  jsonString: string,
+): SafeParseResult<McpTool, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => McpTool$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'McpTool' from JSON`,
+  );
+}

package/src/models/components/mcptoolannotations.ts

@@ -0,0 +1,58 @@
+/*
+ * 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";
+
+/**
+ * Hints claimed by the upstream server; the gateway does not enforce them.
+ */
+export type McpToolAnnotations = {
+  /**
+   * Upstream claims the tool does not modify state.
+   */
+  readOnly?: boolean | undefined;
+  /**
+   * Upstream claims the tool can perform destructive updates.
+   */
+  destructive?: boolean | undefined;
+  /**
+   * Upstream claims repeated calls with the same arguments have no extra effect.
+   */
+  idempotent?: boolean | undefined;
+  /**
+   * Upstream claims the tool reaches systems outside its own domain.
+   */
+  openWorld?: boolean | undefined;
+};
+
+/** @internal */
+export const McpToolAnnotations$inboundSchema: z.ZodType<
+  McpToolAnnotations,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  read_only: z.boolean().optional(),
+  destructive: z.boolean().optional(),
+  idempotent: z.boolean().optional(),
+  open_world: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "read_only": "readOnly",
+    "open_world": "openWorld",
+  });
+});
+
+export function mcpToolAnnotationsFromJSON(
+  jsonString: string,
+): SafeParseResult<McpToolAnnotations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => McpToolAnnotations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'McpToolAnnotations' from JSON`,
+  );
+}

package/src/models/components/mcptoolexposure.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 {
+  McpToolExposureMode,
+  McpToolExposureMode$inboundSchema,
+  McpToolExposureMode$outboundSchema,
+} from "./mcptoolexposuremode.js";
+
+export type McpToolExposure = {
+  mode: McpToolExposureMode;
+  /**
+   * Keeps only the tools the upstream annotates as read-only.
+   */
+  readOnly?: boolean | undefined;
+  /**
+   * `McpTool.id` values to expose when mode is SELECTED; a tool renamed upstream gets a new id on the next sync.
+   */
+  toolIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export const McpToolExposure$inboundSchema: z.ZodType<
+  McpToolExposure,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: McpToolExposureMode$inboundSchema,
+  read_only: z.boolean().optional(),
+  tool_ids: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "read_only": "readOnly",
+    "tool_ids": "toolIds",
+  });
+});
+/** @internal */
+export type McpToolExposure$Outbound = {
+  mode: string;
+  read_only?: boolean | undefined;
+  tool_ids?: Array<string> | undefined;
+};
+
+/** @internal */
+export const McpToolExposure$outboundSchema: z.ZodType<
+  McpToolExposure$Outbound,
+  z.ZodTypeDef,
+  McpToolExposure
+> = z.object({
+  mode: McpToolExposureMode$outboundSchema,
+  readOnly: z.boolean().optional(),
+  toolIds: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    readOnly: "read_only",
+    toolIds: "tool_ids",
+  });
+});
+
+export function mcpToolExposureToJSON(
+  mcpToolExposure: McpToolExposure,
+): string {
+  return JSON.stringify(McpToolExposure$outboundSchema.parse(mcpToolExposure));
+}
+export function mcpToolExposureFromJSON(
+  jsonString: string,
+): SafeParseResult<McpToolExposure, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => McpToolExposure$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'McpToolExposure' from JSON`,
+  );
+}

package/src/models/components/mcptoolexposuremode.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 McpToolExposureMode = {
+  McpToolExposureModeUnspecified: "MCP_TOOL_EXPOSURE_MODE_UNSPECIFIED",
+  McpToolExposureModeAll: "MCP_TOOL_EXPOSURE_MODE_ALL",
+  McpToolExposureModeSelected: "MCP_TOOL_EXPOSURE_MODE_SELECTED",
+  McpToolExposureModeNone: "MCP_TOOL_EXPOSURE_MODE_NONE",
+} as const;
+export type McpToolExposureMode = ClosedEnum<typeof McpToolExposureMode>;
+
+/** @internal */
+export const McpToolExposureMode$inboundSchema: z.ZodNativeEnum<
+  typeof McpToolExposureMode
+> = z.nativeEnum(McpToolExposureMode);
+/** @internal */
+export const McpToolExposureMode$outboundSchema: z.ZodNativeEnum<
+  typeof McpToolExposureMode
+> = McpToolExposureMode$inboundSchema;

package/src/models/components/mcptoolnaming.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const McpToolNaming = {
+  McpToolNamingUnspecified: "MCP_TOOL_NAMING_UNSPECIFIED",
+  McpToolNamingPrefixWithServerKey: "MCP_TOOL_NAMING_PREFIX_WITH_SERVER_KEY",
+  McpToolNamingPrefixOnCollision: "MCP_TOOL_NAMING_PREFIX_ON_COLLISION",
+} as const;
+export type McpToolNaming = ClosedEnum<typeof McpToolNaming>;
+
+/** @internal */
+export const McpToolNaming$inboundSchema: z.ZodNativeEnum<
+  typeof McpToolNaming
+> = z.nativeEnum(McpToolNaming);
+/** @internal */
+export const McpToolNaming$outboundSchema: z.ZodNativeEnum<
+  typeof McpToolNaming
+> = McpToolNaming$inboundSchema;

package/src/models/components/modelbudgetscope.ts

@@ -13,7 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  *
  * @remarks
  *  it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
- *  models) — NOT the Mongo `_id` of the model master-data document.
+ *  models), rather than an internal identifier.
  */
 export type ModelBudgetScope = {
   modelId: string;

package/src/models/components/modelbudgetscoperestresponse.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  *
  * @remarks
  *  it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
- *  models) — NOT the Mongo `_id` of the model master-data document.
+ *  models), rather than an internal identifier.
  */
 export type ModelBudgetScopeRestResponse = {
   modelId: string;