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

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

@@ -0,0 +1,127 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ErrorPart, ErrorPart$inboundSchema } from "./errorpart.js";
+import { FilePart, FilePart$inboundSchema } from "./filepart.js";
+import { TextPart, TextPart$inboundSchema } from "./textpart.js";
+import {
+  ToolResultPart,
+  ToolResultPart$inboundSchema,
+} from "./toolresultpart.js";
+
+/**
+ * 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 PublicMessagePart =
+  | TextPart
+  | FilePart
+  | ToolResultPart
+  | ErrorPart;
+
+/**
+ * Message author role. `user` for end-user messages, `assistant` for AI-generated responses.
+ */
+export const MessageResponseRole = {
+  User: "user",
+  Assistant: "assistant",
+} as const;
+/**
+ * Message author role. `user` for end-user messages, `assistant` for AI-generated responses.
+ */
+export type MessageResponseRole = ClosedEnum<typeof MessageResponseRole>;
+
+export type MessageResponse = {
+  /**
+   * Unique message identifier with `msg_` prefix.
+   */
+  id: string;
+  /**
+   * Conversation identifier this message belongs to.
+   */
+  conversationId: string;
+  /**
+   * Unix timestamp in milliseconds when the message was created.
+   */
+  createdAt: number;
+  /**
+   * Identifier of the message author. User ID for user messages, "system" for assistant messages.
+   */
+  createdById: string;
+  /**
+   * Content parts composing the message. Supports multiple content types (text, images, files, tool results).
+   */
+  parts: Array<TextPart | FilePart | ToolResultPart | ErrorPart>;
+  /**
+   * Message author role. `user` for end-user messages, `assistant` for AI-generated responses.
+   */
+  role: MessageResponseRole;
+};
+
+/** @internal */
+export const PublicMessagePart$inboundSchema: z.ZodType<
+  PublicMessagePart,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  TextPart$inboundSchema,
+  FilePart$inboundSchema,
+  ToolResultPart$inboundSchema,
+  ErrorPart$inboundSchema,
+]);
+
+export function publicMessagePartFromJSON(
+  jsonString: string,
+): SafeParseResult<PublicMessagePart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PublicMessagePart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublicMessagePart' from JSON`,
+  );
+}
+
+/** @internal */
+export const MessageResponseRole$inboundSchema: z.ZodNativeEnum<
+  typeof MessageResponseRole
+> = z.nativeEnum(MessageResponseRole);
+
+/** @internal */
+export const MessageResponse$inboundSchema: z.ZodType<
+  MessageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  conversationId: z.string(),
+  createdAt: z.number(),
+  createdById: z.string(),
+  parts: z.array(
+    z.union([
+      TextPart$inboundSchema,
+      FilePart$inboundSchema,
+      ToolResultPart$inboundSchema,
+      ErrorPart$inboundSchema,
+    ]),
+  ),
+  role: MessageResponseRole$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function messageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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 { DataPart, DataPart$inboundSchema } from "./datapart.js";
+import { FilePart, FilePart$inboundSchema } from "./filepart.js";
+import { ReasoningPart, ReasoningPart$inboundSchema } from "./reasoningpart.js";
+import { TextPart, TextPart$inboundSchema } from "./textpart.js";
+
+/**
+ * The content chunk being streamed. Discriminated by kind field (text or reasoning).
+ */
+export type PartDelta = TextPart | ReasoningPart | FilePart | DataPart;
+
+/** @internal */
+export const PartDelta$inboundSchema: z.ZodType<
+  PartDelta,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  TextPart$inboundSchema,
+  ReasoningPart$inboundSchema,
+  FilePart$inboundSchema,
+  DataPart$inboundSchema,
+]);
+
+export function partDeltaFromJSON(
+  jsonString: string,
+): SafeParseResult<PartDelta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartDelta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartDelta' from JSON`,
+  );
+}

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

@@ -0,0 +1,73 @@
+/*
+ * 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 { PartDelta, PartDelta$inboundSchema } from "./partdelta.js";
+
+export type PartDeltaEventData = {
+  /**
+   * Unique identifier for this part. Format: {kind}_{ulid}. Use to correlate with part.done event.
+   */
+  partId: string;
+  /**
+   * The content chunk being streamed. Discriminated by kind field (text or reasoning).
+   */
+  delta: PartDelta;
+};
+
+/**
+ * Emitted for each content chunk streamed from the LLM. The delta field contains a discriminated union based on the kind field.
+ */
+export type PartDeltaEvent = {
+  type: "part.delta";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: PartDeltaEventData;
+};
+
+/** @internal */
+export const PartDeltaEventData$inboundSchema: z.ZodType<
+  PartDeltaEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  partId: z.string(),
+  delta: PartDelta$inboundSchema,
+});
+
+export function partDeltaEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PartDeltaEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartDeltaEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartDeltaEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const PartDeltaEvent$inboundSchema: z.ZodType<
+  PartDeltaEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("part.delta"),
+  timestamp: z.string(),
+  data: z.lazy(() => PartDeltaEventData$inboundSchema),
+});
+
+export function partDeltaEventFromJSON(
+  jsonString: string,
+): SafeParseResult<PartDeltaEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartDeltaEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartDeltaEvent' from JSON`,
+  );
+}

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

@@ -0,0 +1,139 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Type discriminator indicating this is a reasoning part
+ */
+export const PartKind = {
+  Reasoning: "reasoning",
+} as const;
+/**
+ * Type discriminator indicating this is a reasoning part
+ */
+export type PartKind = ClosedEnum<typeof PartKind>;
+
+/**
+ * A message part containing reasoning or chain-of-thought content
+ */
+export type PartReasoningPart = {
+  /**
+   * Unique identifier for the part. Format: reasoning_{ulid} (e.g., reasoning_01hxyz...)
+   */
+  id: string;
+  /**
+   * Optional metadata associated with the message part. Can store arbitrary key-value pairs for custom data. Maximum size of 50KB and maximum of 20 keys.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Type discriminator indicating this is a reasoning part
+   */
+  kind: PartKind;
+  /**
+   * The reasoning or thought process behind the response. Used for chain-of-thought or extended thinking.
+   */
+  reasoning: string;
+  /**
+   * Optional cryptographic signature to verify the authenticity and integrity of the reasoning content
+   */
+  signature?: string | undefined;
+};
+
+export type PartDoneEventData = {
+  /**
+   * Unique identifier for this part. Matches the partId from part.delta events.
+   */
+  partId: string;
+  part?: any | undefined;
+};
+
+/**
+ * Emitted when a part has been fully streamed. Contains the complete part with all content.
+ */
+export type PartDoneEvent = {
+  type: "part.done";
+  /**
+   * ISO timestamp of when the event occurred
+   */
+  timestamp: string;
+  data: PartDoneEventData;
+};
+
+/** @internal */
+export const PartKind$inboundSchema: z.ZodNativeEnum<typeof PartKind> = z
+  .nativeEnum(PartKind);
+
+/** @internal */
+export const PartReasoningPart$inboundSchema: z.ZodType<
+  PartReasoningPart,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().default("reasoning_01khbx70qvacezr67949x9gn4h"),
+  metadata: z.record(z.any()).optional(),
+  kind: PartKind$inboundSchema,
+  reasoning: z.string(),
+  signature: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function partReasoningPartFromJSON(
+  jsonString: string,
+): SafeParseResult<PartReasoningPart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartReasoningPart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartReasoningPart' from JSON`,
+  );
+}
+
+/** @internal */
+export const PartDoneEventData$inboundSchema: z.ZodType<
+  PartDoneEventData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  partId: z.string(),
+  part: z.any().optional(),
+});
+
+export function partDoneEventDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PartDoneEventData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartDoneEventData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartDoneEventData' from JSON`,
+  );
+}
+
+/** @internal */
+export const PartDoneEvent$inboundSchema: z.ZodType<
+  PartDoneEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("part.done"),
+  timestamp: z.string(),
+  data: z.lazy(() => PartDoneEventData$inboundSchema),
+});
+
+export function partDoneEventFromJSON(
+  jsonString: string,
+): SafeParseResult<PartDoneEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PartDoneEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PartDoneEvent' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/components/publiccontact.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";
+
+/**
+ * @deprecated Use identity instead. Information about the contact making the request.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export type PublicContact = {
+  /**
+   * Unique identifier for the contact
+   */
+  id: string;
+  /**
+   * Display name of the contact
+   */
+  displayName?: string | undefined;
+  /**
+   * Email address of the contact
+   */
+  email?: string | undefined;
+  /**
+   * A hash of key/value pairs containing any other data about the contact
+   */
+  metadata?: Array<{ [k: string]: any }> | undefined;
+  /**
+   * URL to the contact's avatar or logo
+   */
+  logoUrl?: string | undefined;
+  /**
+   * A list of tags associated with the contact
+   */
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export type PublicContact$Outbound = {
+  id: string;
+  display_name?: string | undefined;
+  email?: string | undefined;
+  metadata?: Array<{ [k: string]: any }> | undefined;
+  logo_url?: string | undefined;
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PublicContact$outboundSchema: z.ZodType<
+  PublicContact$Outbound,
+  z.ZodTypeDef,
+  PublicContact
+> = z.object({
+  id: z.string(),
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  metadata: z.array(z.record(z.any())).optional(),
+  logoUrl: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    logoUrl: "logo_url",
+  });
+});
+
+export function publicContactToJSON(publicContact: PublicContact): string {
+  return JSON.stringify(PublicContact$outboundSchema.parse(publicContact));
+}

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

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Information about the identity making the request. If the identity does not exist, it will be created automatically.
+ */
+export type PublicIdentity = {
+  /**
+   * Unique identifier for the contact
+   */
+  id: string;
+  /**
+   * Display name of the contact
+   */
+  displayName?: string | undefined;
+  /**
+   * Email address of the contact
+   */
+  email?: string | undefined;
+  /**
+   * A hash of key/value pairs containing any other data about the contact
+   */
+  metadata?: Array<{ [k: string]: any }> | undefined;
+  /**
+   * URL to the contact's avatar or logo
+   */
+  logoUrl?: string | undefined;
+  /**
+   * A list of tags associated with the contact
+   */
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export type PublicIdentity$Outbound = {
+  id: string;
+  display_name?: string | undefined;
+  email?: string | undefined;
+  metadata?: Array<{ [k: string]: any }> | undefined;
+  logo_url?: string | undefined;
+  tags?: Array<string> | undefined;
+};
+
+/** @internal */
+export const PublicIdentity$outboundSchema: z.ZodType<
+  PublicIdentity$Outbound,
+  z.ZodTypeDef,
+  PublicIdentity
+> = z.object({
+  id: z.string(),
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  metadata: z.array(z.record(z.any())).optional(),
+  logoUrl: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    logoUrl: "logo_url",
+  });
+});
+
+export function publicIdentityToJSON(publicIdentity: PublicIdentity): string {
+  return JSON.stringify(PublicIdentity$outboundSchema.parse(publicIdentity));
+}

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

@@ -0,0 +1,62 @@
+/*
+ * 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";
+
+/**
+ * A message part containing reasoning or chain-of-thought content
+ */
+export type ReasoningPart = {
+  /**
+   * Unique identifier for the part. Format: reasoning_{ulid} (e.g., reasoning_01hxyz...)
+   */
+  id: string;
+  /**
+   * Optional metadata associated with the message part. Can store arbitrary key-value pairs for custom data. Maximum size of 50KB and maximum of 20 keys.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Type discriminator indicating this is a reasoning part
+   */
+  kind: "reasoning";
+  /**
+   * The reasoning or thought process behind the response. Used for chain-of-thought or extended thinking.
+   */
+  reasoning: string;
+  /**
+   * Optional cryptographic signature to verify the authenticity and integrity of the reasoning content
+   */
+  signature?: string | undefined;
+};
+
+/** @internal */
+export const ReasoningPart$inboundSchema: z.ZodType<
+  ReasoningPart,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().default("reasoning_01khbx70qmkech1r7b0yp5vtrm"),
+  metadata: z.record(z.any()).optional(),
+  kind: z.literal("reasoning"),
+  reasoning: z.string(),
+  signature: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function reasoningPartFromJSON(
+  jsonString: string,
+): SafeParseResult<ReasoningPart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReasoningPart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReasoningPart' from JSON`,
+  );
+}

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

@@ -0,0 +1,71 @@
+/*
+ * 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";
+
+/**
+ * A message part containing reasoning or chain-of-thought content
+ */
+export type ReasoningPartSchema = {
+  /**
+   * The type of the content part. Always `reasoning`.
+   */
+  type: "reasoning";
+  /**
+   * The reasoning or thought process behind the response. Used for chain-of-thought or extended thinking.
+   */
+  reasoning: string;
+  /**
+   * Optional cryptographic signature to verify the authenticity and integrity of the reasoning content
+   */
+  signature: string;
+};
+
+/** @internal */
+export const ReasoningPartSchema$inboundSchema: z.ZodType<
+  ReasoningPartSchema,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("reasoning"),
+  reasoning: z.string(),
+  signature: z.string(),
+});
+/** @internal */
+export type ReasoningPartSchema$Outbound = {
+  type: "reasoning";
+  reasoning: string;
+  signature: string;
+};
+
+/** @internal */
+export const ReasoningPartSchema$outboundSchema: z.ZodType<
+  ReasoningPartSchema$Outbound,
+  z.ZodTypeDef,
+  ReasoningPartSchema
+> = z.object({
+  type: z.literal("reasoning"),
+  reasoning: z.string(),
+  signature: z.string(),
+});
+
+export function reasoningPartSchemaToJSON(
+  reasoningPartSchema: ReasoningPartSchema,
+): string {
+  return JSON.stringify(
+    ReasoningPartSchema$outboundSchema.parse(reasoningPartSchema),
+  );
+}
+export function reasoningPartSchemaFromJSON(
+  jsonString: string,
+): SafeParseResult<ReasoningPartSchema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReasoningPartSchema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReasoningPartSchema' from JSON`,
+  );
+}