@orq-ai/node 4.2.0-rc.5 → 4.2.0-rc.51

package/src/models/operations/updateidentity.ts

@@ -0,0 +1,281 @@
+/*
+ * 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";
+
+/**
+ * Identity fields to update
+ */
+export type UpdateIdentityRequestBody = {
+  /**
+   * 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;
+};
+
+export type UpdateIdentityRequest = {
+  /**
+   * Unique identity id or external id
+   */
+  id: string;
+  /**
+   * Identity fields to update
+   */
+  requestBody?: UpdateIdentityRequestBody | undefined;
+};
+
+/**
+ * Updated identity
+ */
+export type UpdateIdentityResponseBody = {
+  /**
+   * 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 UpdateIdentityRequestBody$inboundSchema: z.ZodType<
+  UpdateIdentityRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+/** @internal */
+export type UpdateIdentityRequestBody$Outbound = {
+  display_name?: string | null | undefined;
+  email?: string | null | undefined;
+  avatar_url?: string | null | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityRequestBody$outboundSchema: z.ZodType<
+  UpdateIdentityRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequestBody
+> = z.object({
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function updateIdentityRequestBodyToJSON(
+  updateIdentityRequestBody: UpdateIdentityRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequestBody$outboundSchema.parse(updateIdentityRequestBody),
+  );
+}
+export function updateIdentityRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateIdentityRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateIdentityRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateIdentityRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateIdentityRequest$inboundSchema: z.ZodType<
+  UpdateIdentityRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  RequestBody: z.lazy(() => UpdateIdentityRequestBody$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "RequestBody": "requestBody",
+  });
+});
+/** @internal */
+export type UpdateIdentityRequest$Outbound = {
+  id: string;
+  RequestBody?: UpdateIdentityRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityRequest$outboundSchema: z.ZodType<
+  UpdateIdentityRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateIdentityRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function updateIdentityRequestToJSON(
+  updateIdentityRequest: UpdateIdentityRequest,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequest$outboundSchema.parse(updateIdentityRequest),
+  );
+}
+export function updateIdentityRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateIdentityRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateIdentityRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateIdentityRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateIdentityResponseBody$inboundSchema: z.ZodType<
+  UpdateIdentityResponseBody,
+  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-20T14:50:36.860Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+/** @internal */
+export type UpdateIdentityResponseBody$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 UpdateIdentityResponseBody$outboundSchema: z.ZodType<
+  UpdateIdentityResponseBody$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityResponseBody
+> = 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-20T14:50:36.860Z"))
+    .transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function updateIdentityResponseBodyToJSON(
+  updateIdentityResponseBody: UpdateIdentityResponseBody,
+): string {
+  return JSON.stringify(
+    UpdateIdentityResponseBody$outboundSchema.parse(updateIdentityResponseBody),
+  );
+}
+export function updateIdentityResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateIdentityResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateIdentityResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateIdentityResponseBody' from JSON`,
+  );
+}

package/src/models/operations/updatememory.ts

@@ -9,13 +9,6 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpdateMemoryRequestBody = {
-  /**
-   * Unique identifier for the entity this memory is associated with (e.g., user ID, session ID, conversation ID).
-   */
-  entityId: 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 } | undefined;
 };
 
@@ -27,7 +20,7 @@ export type UpdateMemoryRequest = {
   /**
    * The unique identifier of the memory
    */
-  memoryId: string;
+  memoryEntityId: string;
   requestBody?: UpdateMemoryRequestBody | undefined;
 };
 
@@ -35,9 +28,14 @@ export type UpdateMemoryRequest = {
  * Memory successfully updated.
  */
 export type UpdateMemoryResponseBody = {
+  /**
+   * Unique identifier for the memory. This is automatically generated by the system.
+   */
   id: string;
   /**
-   * Unique identifier for the entity this memory is associated with (e.g., user ID, session ID, conversation ID).
+   * 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;
@@ -45,10 +43,6 @@ export type UpdateMemoryResponseBody = {
   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
@@ -62,16 +56,10 @@ export const UpdateMemoryRequestBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  entity_id: z.string(),
   metadata: z.record(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "entity_id": "entityId",
-  });
 });
 /** @internal */
 export type UpdateMemoryRequestBody$Outbound = {
-  entity_id: string;
   metadata?: { [k: string]: string } | undefined;
 };
 
@@ -81,12 +69,7 @@ export const UpdateMemoryRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateMemoryRequestBody
 > = z.object({
-  entityId: z.string(),
   metadata: z.record(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    entityId: "entity_id",
-  });
 });
 
 export function updateMemoryRequestBodyToJSON(
@@ -113,19 +96,19 @@ export const UpdateMemoryRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   memory_store_key: z.string(),
-  memory_id: z.string(),
+  memory_entity_id: z.string(),
   RequestBody: z.lazy(() => UpdateMemoryRequestBody$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "memory_store_key": "memoryStoreKey",
-    "memory_id": "memoryId",
+    "memory_entity_id": "memoryEntityId",
     "RequestBody": "requestBody",
   });
 });
 /** @internal */
 export type UpdateMemoryRequest$Outbound = {
   memory_store_key: string;
-  memory_id: string;
+  memory_entity_id: string;
   RequestBody?: UpdateMemoryRequestBody$Outbound | undefined;
 };
 
@@ -136,12 +119,12 @@ export const UpdateMemoryRequest$outboundSchema: z.ZodType<
   UpdateMemoryRequest
 > = z.object({
   memoryStoreKey: z.string(),
-  memoryId: z.string(),
+  memoryEntityId: z.string(),
   requestBody: z.lazy(() => UpdateMemoryRequestBody$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     memoryStoreKey: "memory_store_key",
-    memoryId: "memory_id",
+    memoryEntityId: "memory_entity_id",
     requestBody: "RequestBody",
   });
 });
@@ -176,7 +159,6 @@ export const UpdateMemoryResponseBody$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) => {
@@ -199,7 +181,6 @@ export type UpdateMemoryResponseBody$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;
 };
@@ -217,7 +198,6 @@ export const UpdateMemoryResponseBody$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/updatememorydocument.ts

@@ -27,7 +27,7 @@ export type UpdateMemoryDocumentRequest = {
   /**
    * The unique identifier of the memory
    */
-  memoryId: string;
+  memoryEntityId: string;
   /**
    * The unique identifier of the document
    */
@@ -108,14 +108,14 @@ export const UpdateMemoryDocumentRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   memory_store_key: z.string(),
-  memory_id: z.string(),
+  memory_entity_id: z.string(),
   document_id: z.string(),
   RequestBody: z.lazy(() => UpdateMemoryDocumentRequestBody$inboundSchema)
     .optional(),
 }).transform((v) => {
   return remap$(v, {
     "memory_store_key": "memoryStoreKey",
-    "memory_id": "memoryId",
+    "memory_entity_id": "memoryEntityId",
     "document_id": "documentId",
     "RequestBody": "requestBody",
   });
@@ -123,7 +123,7 @@ export const UpdateMemoryDocumentRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type UpdateMemoryDocumentRequest$Outbound = {
   memory_store_key: string;
-  memory_id: string;
+  memory_entity_id: string;
   document_id: string;
   RequestBody?: UpdateMemoryDocumentRequestBody$Outbound | undefined;
 };
@@ -135,14 +135,14 @@ export const UpdateMemoryDocumentRequest$outboundSchema: z.ZodType<
   UpdateMemoryDocumentRequest
 > = z.object({
   memoryStoreKey: z.string(),
-  memoryId: z.string(),
+  memoryEntityId: z.string(),
   documentId: z.string(),
   requestBody: z.lazy(() => UpdateMemoryDocumentRequestBody$outboundSchema)
     .optional(),
 }).transform((v) => {
   return remap$(v, {
     memoryStoreKey: "memory_store_key",
-    memoryId: "memory_id",
+    memoryEntityId: "memory_entity_id",
     documentId: "document_id",
     requestBody: "RequestBody",
   });