@orq-ai/node 4.5.0-rc.9 → 4.5.2

package/packages/orq-rc/src/models/operations/retrievedataset.ts

@@ -0,0 +1,150 @@
+/*
+ * 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 RetrieveDatasetRequest = {
+  /**
+   * The unique identifier of the dataset
+   */
+  datasetId: string;
+};
+
+export type RetrieveDatasetMetadata = {
+  totalVersions: number;
+  datapointsCount: number;
+};
+
+/**
+ * Dataset retrieved successfully. Returns the complete dataset object.
+ */
+export type RetrieveDatasetResponseBody = {
+  /**
+   * The unique identifier of the dataset
+   */
+  id: string;
+  /**
+   * The display name of the dataset
+   */
+  displayName: string;
+  /**
+   * The unique identifier of the project it belongs to
+   */
+  projectId: string;
+  /**
+   * The unique identifier of the workspace it belongs to
+   */
+  workspaceId: string;
+  metadata: RetrieveDatasetMetadata;
+  /**
+   * The unique identifier of the user who created the dataset
+   */
+  createdById?: string | undefined;
+  /**
+   * The unique identifier of the user who last updated the dataset
+   */
+  updatedById?: string | undefined;
+  /**
+   * The date and time the resource was created
+   */
+  created?: Date | undefined;
+  /**
+   * The date and time the resource was last updated
+   */
+  updated: Date;
+};
+
+/** @internal */
+export type RetrieveDatasetRequest$Outbound = {
+  dataset_id: string;
+};
+
+/** @internal */
+export const RetrieveDatasetRequest$outboundSchema: z.ZodType<
+  RetrieveDatasetRequest$Outbound,
+  z.ZodTypeDef,
+  RetrieveDatasetRequest
+> = z.object({
+  datasetId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    datasetId: "dataset_id",
+  });
+});
+
+export function retrieveDatasetRequestToJSON(
+  retrieveDatasetRequest: RetrieveDatasetRequest,
+): string {
+  return JSON.stringify(
+    RetrieveDatasetRequest$outboundSchema.parse(retrieveDatasetRequest),
+  );
+}
+
+/** @internal */
+export const RetrieveDatasetMetadata$inboundSchema: z.ZodType<
+  RetrieveDatasetMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total_versions: z.number(),
+  datapoints_count: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_versions": "totalVersions",
+    "datapoints_count": "datapointsCount",
+  });
+});
+
+export function retrieveDatasetMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveDatasetMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveDatasetMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveDatasetMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const RetrieveDatasetResponseBody$inboundSchema: z.ZodType<
+  RetrieveDatasetResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  display_name: z.string(),
+  project_id: z.string(),
+  workspace_id: z.string(),
+  metadata: z.lazy(() => RetrieveDatasetMetadata$inboundSchema),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated: z.string().datetime({ offset: true }).default(
+    "2026-03-10T17:52:40.977Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "display_name": "displayName",
+    "project_id": "projectId",
+    "workspace_id": "workspaceId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+  });
+});
+
+export function retrieveDatasetResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveDatasetResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveDatasetResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveDatasetResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/retrievedatasource.ts

@@ -0,0 +1,152 @@
+/*
+ * 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";
+
+export type RetrieveDatasourceRequest = {
+  /**
+   * The unique identifier of the knowledge base
+   */
+  knowledgeId: string;
+  /**
+   * The unique identifier of the datasource.
+   */
+  datasourceId: string;
+};
+
+export const RetrieveDatasourceStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Failed: "failed",
+  Queued: "queued",
+} as const;
+export type RetrieveDatasourceStatus = ClosedEnum<
+  typeof RetrieveDatasourceStatus
+>;
+
+/**
+ * Datasource successfully retrieved
+ */
+export type RetrieveDatasourceResponseBody = {
+  /**
+   * The unique identifier of the data source
+   */
+  id: string;
+  /**
+   * The display name of the datasource. Normally the name of the uploaded file
+   */
+  displayName: string;
+  /**
+   * The description of the knowledge base
+   */
+  description?: string | undefined;
+  status: RetrieveDatasourceStatus;
+  /**
+   * The unique identifier of the file used to create the datasource.
+   */
+  fileId?: string | null | undefined;
+  /**
+   * The date and time the datasource was created
+   */
+  created: string;
+  /**
+   * The date and time the datasource was updated
+   */
+  updated: string;
+  /**
+   * The user ID of the creator of the knowledge base
+   */
+  createdById?: string | null | undefined;
+  /**
+   * The user ID of the last user who updated the knowledge base
+   */
+  updateById?: string | null | undefined;
+  /**
+   * The unique identifier of the knowledge base
+   */
+  knowledgeId: string;
+  /**
+   * The number of chunks in the datasource
+   */
+  chunksCount: number;
+};
+
+/** @internal */
+export type RetrieveDatasourceRequest$Outbound = {
+  knowledge_id: string;
+  datasource_id: string;
+};
+
+/** @internal */
+export const RetrieveDatasourceRequest$outboundSchema: z.ZodType<
+  RetrieveDatasourceRequest$Outbound,
+  z.ZodTypeDef,
+  RetrieveDatasourceRequest
+> = z.object({
+  knowledgeId: z.string(),
+  datasourceId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    knowledgeId: "knowledge_id",
+    datasourceId: "datasource_id",
+  });
+});
+
+export function retrieveDatasourceRequestToJSON(
+  retrieveDatasourceRequest: RetrieveDatasourceRequest,
+): string {
+  return JSON.stringify(
+    RetrieveDatasourceRequest$outboundSchema.parse(retrieveDatasourceRequest),
+  );
+}
+
+/** @internal */
+export const RetrieveDatasourceStatus$inboundSchema: z.ZodNativeEnum<
+  typeof RetrieveDatasourceStatus
+> = z.nativeEnum(RetrieveDatasourceStatus);
+
+/** @internal */
+export const RetrieveDatasourceResponseBody$inboundSchema: z.ZodType<
+  RetrieveDatasourceResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().default("01KKCE2SS9M1NH5JJFYY38CVN1"),
+  display_name: z.string(),
+  description: z.string().optional(),
+  status: RetrieveDatasourceStatus$inboundSchema,
+  file_id: z.nullable(z.string()).optional(),
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.nullable(z.string()).optional(),
+  update_by_id: z.nullable(z.string()).optional(),
+  knowledge_id: z.string(),
+  chunks_count: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "display_name": "displayName",
+    "file_id": "fileId",
+    "created_by_id": "createdById",
+    "update_by_id": "updateById",
+    "knowledge_id": "knowledgeId",
+    "chunks_count": "chunksCount",
+  });
+});
+
+export function retrieveDatasourceResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveDatasourceResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveDatasourceResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveDatasourceResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/retrieveidentity.ts

@@ -0,0 +1,117 @@
+/*
+ * 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 RetrieveIdentityRequest = {
+  /**
+   * Unique identity id or external id
+   */
+  id: string;
+};
+
+/**
+ * Identity details
+ */
+export type RetrieveIdentityResponseBody = {
+  /**
+   * Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
+   */
+  id: string;
+  /**
+   * Unique string value to identify the contact user in the customer's system. This should be the same ID you use in your system to reference this user.
+   */
+  externalId: string;
+  /**
+   * Display name or nickname of the contact user. This is typically shown in user interfaces.
+   */
+  displayName?: string | null | undefined;
+  /**
+   * Email address of the contact user
+   */
+  email?: string | null | undefined;
+  /**
+   * URL linking to the contact user's avatar image
+   */
+  avatarUrl?: string | null | undefined;
+  /**
+   * Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * The date and time the resource was created
+   */
+  created?: Date | undefined;
+  /**
+   * The date and time the resource was last updated
+   */
+  updated: Date;
+};
+
+/** @internal */
+export type RetrieveIdentityRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const RetrieveIdentityRequest$outboundSchema: z.ZodType<
+  RetrieveIdentityRequest$Outbound,
+  z.ZodTypeDef,
+  RetrieveIdentityRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function retrieveIdentityRequestToJSON(
+  retrieveIdentityRequest: RetrieveIdentityRequest,
+): string {
+  return JSON.stringify(
+    RetrieveIdentityRequest$outboundSchema.parse(retrieveIdentityRequest),
+  );
+}
+
+/** @internal */
+export const RetrieveIdentityResponseBody$inboundSchema: z.ZodType<
+  RetrieveIdentityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  external_id: z.string(),
+  display_name: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  avatar_url: z.nullable(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated: z.string().datetime({ offset: true }).default(
+    "2026-03-10T17:52:40.977Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+export function retrieveIdentityResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveIdentityResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveIdentityResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveIdentityResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/retrievememory.ts

@@ -0,0 +1,112 @@
+/*
+ * 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 RetrieveMemoryRequest = {
+  /**
+   * The unique key identifier of the memory store
+   */
+  memoryStoreKey: string;
+  /**
+   * The unique identifier of the memory
+   */
+  memoryEntityId: string;
+};
+
+/**
+ * Memory successfully retrieved.
+ */
+export type RetrieveMemoryResponseBody = {
+  /**
+   * Unique identifier for the memory. This is automatically generated by the system.
+   */
+  id: string;
+  /**
+   * Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  entityId: string;
+  created: string;
+  updated: string;
+  createdById?: string | null | undefined;
+  updatedById?: string | null | undefined;
+  storeId: string;
+  workspaceId: string;
+  /**
+   * The number of memories in the entity
+   */
+  documentsCount: number;
+};
+
+/** @internal */
+export type RetrieveMemoryRequest$Outbound = {
+  memory_store_key: string;
+  memory_entity_id: string;
+};
+
+/** @internal */
+export const RetrieveMemoryRequest$outboundSchema: z.ZodType<
+  RetrieveMemoryRequest$Outbound,
+  z.ZodTypeDef,
+  RetrieveMemoryRequest
+> = z.object({
+  memoryStoreKey: z.string(),
+  memoryEntityId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    memoryStoreKey: "memory_store_key",
+    memoryEntityId: "memory_entity_id",
+  });
+});
+
+export function retrieveMemoryRequestToJSON(
+  retrieveMemoryRequest: RetrieveMemoryRequest,
+): string {
+  return JSON.stringify(
+    RetrieveMemoryRequest$outboundSchema.parse(retrieveMemoryRequest),
+  );
+}
+
+/** @internal */
+export const RetrieveMemoryResponseBody$inboundSchema: z.ZodType<
+  RetrieveMemoryResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  entity_id: z.string(),
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.nullable(z.string()).optional(),
+  updated_by_id: z.nullable(z.string()).optional(),
+  store_id: z.string(),
+  workspace_id: z.string(),
+  documents_count: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "entity_id": "entityId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "store_id": "storeId",
+    "workspace_id": "workspaceId",
+    "documents_count": "documentsCount",
+  });
+});
+
+export function retrieveMemoryResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveMemoryResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveMemoryResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveMemoryResponseBody' from JSON`,
+  );
+}

package/packages/orq-rc/src/models/operations/retrievememorydocument.ts

@@ -0,0 +1,118 @@
+/*
+ * 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 RetrieveMemoryDocumentRequest = {
+  /**
+   * The unique key identifier of the memory store
+   */
+  memoryStoreKey: string;
+  /**
+   * The unique identifier of the memory
+   */
+  memoryEntityId: string;
+  /**
+   * The unique identifier of the document
+   */
+  documentId: string;
+};
+
+/**
+ * Memory document successfully retrieved.
+ */
+export type RetrieveMemoryDocumentResponseBody = {
+  id: string;
+  memoryId: string;
+  storeId: string;
+  /**
+   * The content of the memory document (whitespace trimmed).
+   */
+  text: string;
+  created: string;
+  updated: string;
+  createdById?: string | undefined;
+  updatedById?: string | undefined;
+  workspaceId: string;
+  /**
+   * Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy).
+   */
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export type RetrieveMemoryDocumentRequest$Outbound = {
+  memory_store_key: string;
+  memory_entity_id: string;
+  document_id: string;
+};
+
+/** @internal */
+export const RetrieveMemoryDocumentRequest$outboundSchema: z.ZodType<
+  RetrieveMemoryDocumentRequest$Outbound,
+  z.ZodTypeDef,
+  RetrieveMemoryDocumentRequest
+> = z.object({
+  memoryStoreKey: z.string(),
+  memoryEntityId: z.string(),
+  documentId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    memoryStoreKey: "memory_store_key",
+    memoryEntityId: "memory_entity_id",
+    documentId: "document_id",
+  });
+});
+
+export function retrieveMemoryDocumentRequestToJSON(
+  retrieveMemoryDocumentRequest: RetrieveMemoryDocumentRequest,
+): string {
+  return JSON.stringify(
+    RetrieveMemoryDocumentRequest$outboundSchema.parse(
+      retrieveMemoryDocumentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const RetrieveMemoryDocumentResponseBody$inboundSchema: z.ZodType<
+  RetrieveMemoryDocumentResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  memory_id: z.string(),
+  store_id: z.string(),
+  text: z.string(),
+  created: z.string(),
+  updated: z.string(),
+  created_by_id: z.string().optional(),
+  updated_by_id: z.string().optional(),
+  workspace_id: z.string(),
+  metadata: z.record(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "memory_id": "memoryId",
+    "store_id": "storeId",
+    "created_by_id": "createdById",
+    "updated_by_id": "updatedById",
+    "workspace_id": "workspaceId",
+  });
+});
+
+export function retrieveMemoryDocumentResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveMemoryDocumentResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      RetrieveMemoryDocumentResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveMemoryDocumentResponseBody' from JSON`,
+  );
+}