@orq-ai/node 4.2.0-rc.4 → 4.2.0-rc.40

package/src/models/operations/retrieveidentity.ts

@@ -0,0 +1,180 @@
+/*
+ * 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 | undefined;
+};
+
+/** @internal */
+export const RetrieveIdentityRequest$inboundSchema: z.ZodType<
+  RetrieveIdentityRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+/** @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),
+  );
+}
+export function retrieveIdentityRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveIdentityRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveIdentityRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveIdentityRequest' from JSON`,
+  );
+}
+
+/** @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-01-19T11:38:09.062Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+/** @internal */
+export type RetrieveIdentityResponseBody$Outbound = {
+  _id: string;
+  external_id: string;
+  display_name?: string | null | undefined;
+  email?: string | null | undefined;
+  avatar_url?: string | null | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  created?: string | undefined;
+  updated: string;
+};
+
+/** @internal */
+export const RetrieveIdentityResponseBody$outboundSchema: z.ZodType<
+  RetrieveIdentityResponseBody$Outbound,
+  z.ZodTypeDef,
+  RetrieveIdentityResponseBody
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  displayName: z.nullable(z.string()).optional(),
+  email: z.nullable(z.string()).optional(),
+  avatarUrl: z.nullable(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  created: z.date().transform(v => v.toISOString()).optional(),
+  updated: z.date().default(() => new Date("2026-01-19T11:38:09.062Z"))
+    .transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function retrieveIdentityResponseBodyToJSON(
+  retrieveIdentityResponseBody: RetrieveIdentityResponseBody,
+): string {
+  return JSON.stringify(
+    RetrieveIdentityResponseBody$outboundSchema.parse(
+      retrieveIdentityResponseBody,
+    ),
+  );
+}
+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/src/models/operations/retrievememory.ts

@@ -16,7 +16,7 @@ export type RetrieveMemoryRequest = {
   /**
    * The unique identifier of the memory
    */
-  memoryId: string;
+  memoryEntityId: string;
 };
 
 /**
@@ -25,7 +25,9 @@ export type RetrieveMemoryRequest = {
 export type RetrieveMemoryResponseBody = {
   id: string;
   /**
-   * Unique identifier for the entity this memory is associated with (e.g., user ID, session ID, conversation ID).
+   * This property have been deprecated and moved to `_id`. Please refer to `_id` for future operations
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   entityId: string;
   created: string;
@@ -33,10 +35,6 @@ export type RetrieveMemoryResponseBody = {
   createdById?: string | null | undefined;
   updatedById?: string | null | undefined;
   storeId: string;
-  /**
-   * Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory access based on their specific needs (e.g., user segments, topics, contexts, or any custom taxonomy).
-   */
-  metadata: { [k: string]: string };
   workspaceId: string;
   /**
    * The number of memories in the entity
@@ -51,17 +49,17 @@ export const RetrieveMemoryRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   memory_store_key: z.string(),
-  memory_id: z.string(),
+  memory_entity_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "memory_store_key": "memoryStoreKey",
-    "memory_id": "memoryId",
+    "memory_entity_id": "memoryEntityId",
   });
 });
 /** @internal */
 export type RetrieveMemoryRequest$Outbound = {
   memory_store_key: string;
-  memory_id: string;
+  memory_entity_id: string;
 };
 
 /** @internal */
@@ -71,11 +69,11 @@ export const RetrieveMemoryRequest$outboundSchema: z.ZodType<
   RetrieveMemoryRequest
 > = z.object({
   memoryStoreKey: z.string(),
-  memoryId: z.string(),
+  memoryEntityId: z.string(),
 }).transform((v) => {
   return remap$(v, {
     memoryStoreKey: "memory_store_key",
-    memoryId: "memory_id",
+    memoryEntityId: "memory_entity_id",
   });
 });
 
@@ -109,7 +107,6 @@ export const RetrieveMemoryResponseBody$inboundSchema: z.ZodType<
   created_by_id: z.nullable(z.string()).optional(),
   updated_by_id: z.nullable(z.string()).optional(),
   store_id: z.string(),
-  metadata: z.record(z.string()),
   workspace_id: z.string(),
   documents_count: z.number(),
 }).transform((v) => {
@@ -132,7 +129,6 @@ export type RetrieveMemoryResponseBody$Outbound = {
   created_by_id?: string | null | undefined;
   updated_by_id?: string | null | undefined;
   store_id: string;
-  metadata: { [k: string]: string };
   workspace_id: string;
   documents_count: number;
 };
@@ -150,7 +146,6 @@ export const RetrieveMemoryResponseBody$outboundSchema: z.ZodType<
   createdById: z.nullable(z.string()).optional(),
   updatedById: z.nullable(z.string()).optional(),
   storeId: z.string(),
-  metadata: z.record(z.string()),
   workspaceId: z.string(),
   documentsCount: z.number(),
 }).transform((v) => {

package/src/models/operations/retrievememorydocument.ts

@@ -16,7 +16,7 @@ export type RetrieveMemoryDocumentRequest = {
   /**
    * The unique identifier of the memory
    */
-  memoryId: string;
+  memoryEntityId: string;
   /**
    * The unique identifier of the document
    */
@@ -52,19 +52,19 @@ export const RetrieveMemoryDocumentRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   memory_store_key: z.string(),
-  memory_id: z.string(),
+  memory_entity_id: z.string(),
   document_id: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "memory_store_key": "memoryStoreKey",
-    "memory_id": "memoryId",
+    "memory_entity_id": "memoryEntityId",
     "document_id": "documentId",
   });
 });
 /** @internal */
 export type RetrieveMemoryDocumentRequest$Outbound = {
   memory_store_key: string;
-  memory_id: string;
+  memory_entity_id: string;
   document_id: string;
 };
 
@@ -75,12 +75,12 @@ export const RetrieveMemoryDocumentRequest$outboundSchema: z.ZodType<
   RetrieveMemoryDocumentRequest
 > = z.object({
   memoryStoreKey: z.string(),
-  memoryId: z.string(),
+  memoryEntityId: z.string(),
   documentId: z.string(),
 }).transform((v) => {
   return remap$(v, {
     memoryStoreKey: "memory_store_key",
-    memoryId: "memory_id",
+    memoryEntityId: "memory_entity_id",
     documentId: "document_id",
   });
 });

package/src/models/operations/retrievetool.ts

@@ -858,7 +858,7 @@ export const RetrieveToolResponseBodyCodeExecutionTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KDW0P60B6AA7GTM56NGAJJVG"),
+  _id: z.string().default("tool_01KFB0S0Q2T041EM0RTHKYZDPN"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -913,7 +913,7 @@ export const RetrieveToolResponseBodyCodeExecutionTool$outboundSchema:
     z.ZodTypeDef,
     RetrieveToolResponseBodyCodeExecutionTool
   > = z.object({
-    id: z.string().default("tool_01KDW0P60B6AA7GTM56NGAJJVG"),
+    id: z.string().default("tool_01KFB0S0Q2T041EM0RTHKYZDPN"),
     path: z.string(),
     key: z.string(),
     displayName: z.string().optional(),
@@ -1092,7 +1092,7 @@ export const RetrieveToolResponseBodyTools$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().default("01KDW0P60BT32728PN9TWVQY47"),
+  id: z.string().default("01KFB0S0PVCX7EPKNM4CG4R066"),
   name: z.string(),
   description: z.string().optional(),
   schema: z.lazy(() => RetrieveToolResponseBodyToolsSchema$inboundSchema),
@@ -1111,7 +1111,7 @@ export const RetrieveToolResponseBodyTools$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RetrieveToolResponseBodyTools
 > = z.object({
-  id: z.string().default("01KDW0P60BT32728PN9TWVQY47"),
+  id: z.string().default("01KFB0S0PVCX7EPKNM4CG4R066"),
   name: z.string(),
   description: z.string().optional(),
   schema: z.lazy(() => RetrieveToolResponseBodyToolsSchema$outboundSchema),
@@ -1217,7 +1217,7 @@ export const RetrieveToolResponseBodyMCPTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KDW0P609KS4EXVRSZXAMG8NR"),
+  _id: z.string().default("tool_01KFB0S0PHG5YMZVCQ1G75H2EP"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -1270,7 +1270,7 @@ export const RetrieveToolResponseBodyMCPTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RetrieveToolResponseBodyMCPTool
 > = z.object({
-  id: z.string().default("tool_01KDW0P609KS4EXVRSZXAMG8NR"),
+  id: z.string().default("tool_01KFB0S0PHG5YMZVCQ1G75H2EP"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),
@@ -1641,7 +1641,7 @@ export const RetrieveToolResponseBodyHTTPTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KDW0P608HWD9HTS70FH8VWSM"),
+  _id: z.string().default("tool_01KFB0S0P4K6M2S1HGPY2WSAJJ"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -1694,7 +1694,7 @@ export const RetrieveToolResponseBodyHTTPTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RetrieveToolResponseBodyHTTPTool
 > = z.object({
-  id: z.string().default("tool_01KDW0P608HWD9HTS70FH8VWSM"),
+  id: z.string().default("tool_01KFB0S0P4K6M2S1HGPY2WSAJJ"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),
@@ -1868,7 +1868,7 @@ export const RetrieveToolResponseBodyJSONSchemaTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KDW0P606E1W8VZ17EFVTR7ZP"),
+  _id: z.string().default("tool_01KFB0S0NSSEEWSBJFRWWXAFQV"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -1920,7 +1920,7 @@ export const RetrieveToolResponseBodyJSONSchemaTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RetrieveToolResponseBodyJSONSchemaTool
 > = z.object({
-  id: z.string().default("tool_01KDW0P606E1W8VZ17EFVTR7ZP"),
+  id: z.string().default("tool_01KFB0S0NSSEEWSBJFRWWXAFQV"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),
@@ -2113,7 +2113,7 @@ export const RetrieveToolResponseBodyFunctionTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KDW0P6058T1YGCQ148JR6K5M"),
+  _id: z.string().default("tool_01KFB0S0ND2HHJG13H71BA51DA"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -2164,7 +2164,7 @@ export const RetrieveToolResponseBodyFunctionTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RetrieveToolResponseBodyFunctionTool
 > = z.object({
-  id: z.string().default("tool_01KDW0P6058T1YGCQ148JR6K5M"),
+  id: z.string().default("tool_01KFB0S0ND2HHJG13H71BA51DA"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),