@orq-ai/node 4.3.1-rc.0 → 4.3.2

package/packages/orq-rc/src/models/components/toolfailedevent.ts

@@ -0,0 +1,77 @@
+/*
+ * 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 ToolFailedEventData = {
+  /**
+   * Unique identifier for the tool in the tool registry
+   */
+  toolId: string;
+  /**
+   * Unique identifier matching the tool call that failed
+   */
+  toolCallId: string;
+  /**
+   * Error message describing why the tool failed
+   */
+  error: string;
+};
+
+/**
+ * Emitted when a tool execution fails. Contains error details.
+ */
+export type ToolFailedEvent = {
+  type: "tool.failed";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: ToolFailedEventData;
+};
+
+/** @internal */
+export const ToolFailedEventData$inboundSchema: z.ZodType<
+  ToolFailedEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  toolId: z.string(),
+  toolCallId: z.string(),
+  error: z.string(),
+});
+
+export function toolFailedEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolFailedEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolFailedEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolFailedEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ToolFailedEvent$inboundSchema: z.ZodType<
+  ToolFailedEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("tool.failed"),
+  timestamp: z.string(),
+  data: z.lazy(() => ToolFailedEventData$inboundSchema),
+});
+
+export function toolFailedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolFailedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolFailedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolFailedEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/toolresultpart.ts

@@ -0,0 +1,71 @@
+/*
+ * 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";
+
+/**
+ * Tool execution result part. Use this ONLY when providing results for a pending tool call from the agent. The tool_call_id must match the ID from the agent's tool call request.
+ */
+export type ToolResultPart = {
+  kind: "tool_result";
+  toolCallId: string;
+  result?: any | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ToolResultPart$inboundSchema: z.ZodType<
+  ToolResultPart,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: z.literal("tool_result"),
+  tool_call_id: z.string(),
+  result: z.any().optional(),
+  metadata: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tool_call_id": "toolCallId",
+  });
+});
+/** @internal */
+export type ToolResultPart$Outbound = {
+  kind: "tool_result";
+  tool_call_id: string;
+  result?: any | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ToolResultPart$outboundSchema: z.ZodType<
+  ToolResultPart$Outbound,
+  z.ZodTypeDef,
+  ToolResultPart
+> = z.object({
+  kind: z.literal("tool_result"),
+  toolCallId: z.string(),
+  result: z.any().optional(),
+  metadata: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    toolCallId: "tool_call_id",
+  });
+});
+
+export function toolResultPartToJSON(toolResultPart: ToolResultPart): string {
+  return JSON.stringify(ToolResultPart$outboundSchema.parse(toolResultPart));
+}
+export function toolResultPartFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolResultPart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolResultPart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolResultPart' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/toolreviewdoneevent.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 { ReviewOutcome, ReviewOutcome$inboundSchema } from "./reviewoutcome.js";
+
+export type ToolReviewDoneEventData = {
+  /**
+   * Unique identifier for the tool in the tool registry
+   */
+  toolId: string;
+  /**
+   * The tool call ID that was reviewed
+   */
+  toolCallId: string;
+  /**
+   * The review decision
+   */
+  review: ReviewOutcome;
+};
+
+/**
+ * Emitted after a tool action has been reviewed. Contains the review decision.
+ */
+export type ToolReviewDoneEvent = {
+  type: "tool.review.done";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: ToolReviewDoneEventData;
+};
+
+/** @internal */
+export const ToolReviewDoneEventData$inboundSchema: z.ZodType<
+  ToolReviewDoneEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  toolId: z.string(),
+  toolCallId: z.string(),
+  review: ReviewOutcome$inboundSchema,
+});
+
+export function toolReviewDoneEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolReviewDoneEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolReviewDoneEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolReviewDoneEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ToolReviewDoneEvent$inboundSchema: z.ZodType<
+  ToolReviewDoneEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("tool.review.done"),
+  timestamp: z.string(),
+  data: z.lazy(() => ToolReviewDoneEventData$inboundSchema),
+});
+
+export function toolReviewDoneEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolReviewDoneEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolReviewDoneEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolReviewDoneEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/toolreviewrequestedevent.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 ToolReviewRequestedEventData = {
+  /**
+   * Unique identifier for the tool in the tool registry
+   */
+  toolId: string;
+  /**
+   * The tool call ID requiring review
+   */
+  toolCallId: string;
+  /**
+   * Name of the tool requiring approval
+   */
+  toolName?: string | undefined;
+  /**
+   * Arguments that will be passed to the tool
+   */
+  arguments: { [k: string]: any };
+  /**
+   * Whether approval is mandatory before execution
+   */
+  requiresApproval: boolean;
+};
+
+/**
+ * Emitted when a tool action requires approval before execution. The execution will pause until reviewed.
+ */
+export type ToolReviewRequestedEvent = {
+  type: "tool.review.requested";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: ToolReviewRequestedEventData;
+};
+
+/** @internal */
+export const ToolReviewRequestedEventData$inboundSchema: z.ZodType<
+  ToolReviewRequestedEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  toolId: z.string(),
+  toolCallId: z.string(),
+  toolName: z.string().optional(),
+  arguments: z.record(z.any()),
+  requiresApproval: z.boolean(),
+});
+
+export function toolReviewRequestedEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolReviewRequestedEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolReviewRequestedEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolReviewRequestedEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ToolReviewRequestedEvent$inboundSchema: z.ZodType<
+  ToolReviewRequestedEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("tool.review.requested"),
+  timestamp: z.string(),
+  data: z.lazy(() => ToolReviewRequestedEventData$inboundSchema),
+});
+
+export function toolReviewRequestedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolReviewRequestedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolReviewRequestedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolReviewRequestedEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/toolstartedevent.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 ToolStartedEventData = {
+  /**
+   * Unique identifier for the tool
+   */
+  toolId: string;
+  /**
+   * Display name of the tool
+   */
+  toolName?: string | undefined;
+  /**
+   * Unique identifier for this specific tool call
+   */
+  toolCallId: string;
+  /**
+   * Arguments passed to the tool
+   */
+  arguments: { [k: string]: any };
+};
+
+/**
+ * Emitted when a tool begins execution. Contains tool details and input arguments.
+ */
+export type ToolStartedEvent = {
+  type: "tool.started";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: ToolStartedEventData;
+};
+
+/** @internal */
+export const ToolStartedEventData$inboundSchema: z.ZodType<
+  ToolStartedEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  toolId: z.string(),
+  toolName: z.string().optional(),
+  toolCallId: z.string(),
+  arguments: z.record(z.any()),
+});
+
+export function toolStartedEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolStartedEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolStartedEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolStartedEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ToolStartedEvent$inboundSchema: z.ZodType<
+  ToolStartedEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("tool.started"),
+  timestamp: z.string(),
+  data: z.lazy(() => ToolStartedEventData$inboundSchema),
+});
+
+export function toolStartedEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolStartedEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolStartedEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolStartedEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/usermessagerequest.ts

@@ -0,0 +1,136 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  ErrorPart,
+  ErrorPart$Outbound,
+  ErrorPart$outboundSchema,
+} from "./errorpart.js";
+import {
+  FilePart,
+  FilePart$Outbound,
+  FilePart$outboundSchema,
+} from "./filepart.js";
+import {
+  TextPart,
+  TextPart$Outbound,
+  TextPart$outboundSchema,
+} from "./textpart.js";
+import {
+  ToolResultPart,
+  ToolResultPart$Outbound,
+  ToolResultPart$outboundSchema,
+} from "./toolresultpart.js";
+
+/**
+ * Role indicating this message is from a user
+ */
+export const UserMessageRequestRole = {
+  User: "user",
+} as const;
+/**
+ * Role indicating this message is from a user
+ */
+export type UserMessageRequestRole = ClosedEnum<typeof UserMessageRequestRole>;
+
+/**
+ * Message part that can be provided by users. Use "text" for regular messages, "file" for attachments, or "tool_result" when responding to tool call requests.
+ */
+export type UserMessageRequestPublicMessagePart =
+  | TextPart
+  | FilePart
+  | ToolResultPart
+  | ErrorPart;
+
+/**
+ * The user message to send to the model
+ */
+export type UserMessageRequest = {
+  /**
+   * Optional message ID in ULID format
+   */
+  messageId?: string | undefined;
+  /**
+   * Role indicating this message is from a user
+   */
+  role: UserMessageRequestRole;
+  /**
+   * Array of message parts. User messages can contain text, file, tool_result, and error parts.
+   */
+  parts: Array<TextPart | FilePart | ToolResultPart | ErrorPart>;
+};
+
+/** @internal */
+export const UserMessageRequestRole$outboundSchema: z.ZodNativeEnum<
+  typeof UserMessageRequestRole
+> = z.nativeEnum(UserMessageRequestRole);
+
+/** @internal */
+export type UserMessageRequestPublicMessagePart$Outbound =
+  | TextPart$Outbound
+  | FilePart$Outbound
+  | ToolResultPart$Outbound
+  | ErrorPart$Outbound;
+
+/** @internal */
+export const UserMessageRequestPublicMessagePart$outboundSchema: z.ZodType<
+  UserMessageRequestPublicMessagePart$Outbound,
+  z.ZodTypeDef,
+  UserMessageRequestPublicMessagePart
+> = z.union([
+  TextPart$outboundSchema,
+  FilePart$outboundSchema,
+  ToolResultPart$outboundSchema,
+  ErrorPart$outboundSchema,
+]);
+
+export function userMessageRequestPublicMessagePartToJSON(
+  userMessageRequestPublicMessagePart: UserMessageRequestPublicMessagePart,
+): string {
+  return JSON.stringify(
+    UserMessageRequestPublicMessagePart$outboundSchema.parse(
+      userMessageRequestPublicMessagePart,
+    ),
+  );
+}
+
+/** @internal */
+export type UserMessageRequest$Outbound = {
+  messageId?: string | undefined;
+  role: string;
+  parts: Array<
+    | TextPart$Outbound
+    | FilePart$Outbound
+    | ToolResultPart$Outbound
+    | ErrorPart$Outbound
+  >;
+};
+
+/** @internal */
+export const UserMessageRequest$outboundSchema: z.ZodType<
+  UserMessageRequest$Outbound,
+  z.ZodTypeDef,
+  UserMessageRequest
+> = z.object({
+  messageId: z.string().optional(),
+  role: UserMessageRequestRole$outboundSchema,
+  parts: z.array(
+    z.union([
+      TextPart$outboundSchema,
+      FilePart$outboundSchema,
+      ToolResultPart$outboundSchema,
+      ErrorPart$outboundSchema,
+    ]),
+  ),
+});
+
+export function userMessageRequestToJSON(
+  userMessageRequest: UserMessageRequest,
+): string {
+  return JSON.stringify(
+    UserMessageRequest$outboundSchema.parse(userMessageRequest),
+  );
+}

package/packages/orq-rc/src/models/errors/apierror.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OrqError } from "./orqerror.js";
+
+/** The fallback error class if no more specific error class is matched */
+export class APIError extends OrqError {
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
+    message = message.trim();
+    super(message, httpMeta);
+    this.name = "APIError";
+  }
+}

package/packages/orq-rc/src/models/errors/createeval.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { OrqError } from "./orqerror.js";
+
+/**
+ * Workspace ID is not found on the request
+ */
+export type CreateEvalResponseBodyData = {
+  message: string;
+};
+
+/**
+ * Workspace ID is not found on the request
+ */
+export class CreateEvalResponseBody extends OrqError {
+  /** The original data that was passed to this error instance. */
+  data$: CreateEvalResponseBodyData;
+
+  constructor(
+    err: CreateEvalResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+
+    this.name = "CreateEvalResponseBody";
+  }
+}
+
+/** @internal */
+export const CreateEvalResponseBody$inboundSchema: z.ZodType<
+  CreateEvalResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new CreateEvalResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/packages/orq-rc/src/models/errors/createmoderation.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 { OrqError } from "./orqerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+export type ErrorT = {
+  message: string;
+  type: string;
+  param: string | null;
+  code: string;
+};
+
+/**
+ * Returns validation error
+ */
+export type CreateModerationResponseBodyData = {
+  error: ErrorT;
+};
+
+/**
+ * Returns validation error
+ */
+export class CreateModerationResponseBody extends OrqError {
+  error: ErrorT;
+
+  /** The original data that was passed to this error instance. */
+  data$: CreateModerationResponseBodyData;
+
+  constructor(
+    err: CreateModerationResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "CreateModerationResponseBody";
+  }
+}
+
+/** @internal */
+export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
+  .object({
+    message: z.string(),
+    type: z.string(),
+    param: z.nullable(z.string()),
+    code: z.string(),
+  });
+
+export function errorFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorT, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorT$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorT' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateModerationResponseBody$inboundSchema: z.ZodType<
+  CreateModerationResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ErrorT$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new CreateModerationResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });