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

package/src/models/operations/createidentity.ts

@@ -0,0 +1,237 @@
+/*
+ * 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 profile information
+ */
+export type CreateIdentityRequestBody = {
+  /**
+   * 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;
+};
+
+/**
+ * Created Identity
+ */
+export type CreateIdentityResponseBody = {
+  /**
+   * 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;
+  /**
+   * Unique identifier for the workspace to which the contact belongs
+   */
+  workspaceId: 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 CreateIdentityRequestBody$inboundSchema: z.ZodType<
+  CreateIdentityRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+/** @internal */
+export type CreateIdentityRequestBody$Outbound = {
+  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;
+};
+
+/** @internal */
+export const CreateIdentityRequestBody$outboundSchema: z.ZodType<
+  CreateIdentityRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateIdentityRequestBody
+> = z.object({
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function createIdentityRequestBodyToJSON(
+  createIdentityRequestBody: CreateIdentityRequestBody,
+): string {
+  return JSON.stringify(
+    CreateIdentityRequestBody$outboundSchema.parse(createIdentityRequestBody),
+  );
+}
+export function createIdentityRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateIdentityRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateIdentityRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateIdentityRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateIdentityResponseBody$inboundSchema: z.ZodType<
+  CreateIdentityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  external_id: z.string(),
+  workspace_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:39:55.544Z",
+  ).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "external_id": "externalId",
+    "workspace_id": "workspaceId",
+    "display_name": "displayName",
+    "avatar_url": "avatarUrl",
+  });
+});
+/** @internal */
+export type CreateIdentityResponseBody$Outbound = {
+  _id: string;
+  external_id: string;
+  workspace_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 CreateIdentityResponseBody$outboundSchema: z.ZodType<
+  CreateIdentityResponseBody$Outbound,
+  z.ZodTypeDef,
+  CreateIdentityResponseBody
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  workspaceId: 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:39:55.544Z"))
+    .transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    externalId: "external_id",
+    workspaceId: "workspace_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function createIdentityResponseBodyToJSON(
+  createIdentityResponseBody: CreateIdentityResponseBody,
+): string {
+  return JSON.stringify(
+    CreateIdentityResponseBody$outboundSchema.parse(createIdentityResponseBody),
+  );
+}
+export function createIdentityResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateIdentityResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateIdentityResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateIdentityResponseBody' from JSON`,
+  );
+}

package/src/models/operations/createimage.ts

@@ -111,6 +111,38 @@ export type CreateImageFallbacks = {
   model: string;
 };
 
+/**
+ * @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 CreateImageContact = {
+  /**
+   * 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;
+};
+
 export const CreateImageType = {
   ExactMatch: "exact_match",
 } as const;
@@ -172,9 +204,10 @@ export type CreateImageOrq = {
    */
   fallbacks?: Array<CreateImageFallbacks> | undefined;
   /**
-   * Information about the contact making the request. If the contact does not exist, it will be created automatically.
+   * Information about the identity making the request. If the identity does not exist, it will be created automatically.
    */
-  contact?: components.PublicContact | undefined;
+  identity?: components.PublicContact | undefined;
+  contact?: CreateImageContact | undefined;
   /**
    * Cache configuration for the request.
    */
@@ -416,6 +449,70 @@ export function createImageFallbacksFromJSON(
   );
 }
 
+/** @internal */
+export const CreateImageContact$inboundSchema: z.ZodType<
+  CreateImageContact,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  display_name: z.string().optional(),
+  email: z.string().optional(),
+  metadata: z.array(z.record(z.any())).optional(),
+  logo_url: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "logo_url": "logoUrl",
+  });
+});
+/** @internal */
+export type CreateImageContact$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 CreateImageContact$outboundSchema: z.ZodType<
+  CreateImageContact$Outbound,
+  z.ZodTypeDef,
+  CreateImageContact
+> = 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 createImageContactToJSON(
+  createImageContact: CreateImageContact,
+): string {
+  return JSON.stringify(
+    CreateImageContact$outboundSchema.parse(createImageContact),
+  );
+}
+export function createImageContactFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateImageContact, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateImageContact$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateImageContact' from JSON`,
+  );
+}
+
 /** @internal */
 export const CreateImageType$inboundSchema: z.ZodNativeEnum<
   typeof CreateImageType
@@ -612,7 +709,8 @@ export const CreateImageOrq$inboundSchema: z.ZodType<
   retry: z.lazy(() => CreateImageRetry$inboundSchema).optional(),
   fallbacks: z.array(z.lazy(() => CreateImageFallbacks$inboundSchema))
     .optional(),
-  contact: components.PublicContact$inboundSchema.optional(),
+  identity: components.PublicContact$inboundSchema.optional(),
+  contact: z.lazy(() => CreateImageContact$inboundSchema).optional(),
   cache: z.lazy(() => CreateImageCache$inboundSchema).optional(),
   load_balancer: z.array(z.lazy(() => CreateImageLoadBalancer1$inboundSchema))
     .optional(),
@@ -627,7 +725,8 @@ export type CreateImageOrq$Outbound = {
   name?: string | undefined;
   retry?: CreateImageRetry$Outbound | undefined;
   fallbacks?: Array<CreateImageFallbacks$Outbound> | undefined;
-  contact?: components.PublicContact$Outbound | undefined;
+  identity?: components.PublicContact$Outbound | undefined;
+  contact?: CreateImageContact$Outbound | undefined;
   cache?: CreateImageCache$Outbound | undefined;
   load_balancer?: Array<CreateImageLoadBalancer1$Outbound> | undefined;
   timeout?: CreateImageTimeout$Outbound | undefined;
@@ -643,7 +742,8 @@ export const CreateImageOrq$outboundSchema: z.ZodType<
   retry: z.lazy(() => CreateImageRetry$outboundSchema).optional(),
   fallbacks: z.array(z.lazy(() => CreateImageFallbacks$outboundSchema))
     .optional(),
-  contact: components.PublicContact$outboundSchema.optional(),
+  identity: components.PublicContact$outboundSchema.optional(),
+  contact: z.lazy(() => CreateImageContact$outboundSchema).optional(),
   cache: z.lazy(() => CreateImageCache$outboundSchema).optional(),
   loadBalancer: z.array(z.lazy(() => CreateImageLoadBalancer1$outboundSchema))
     .optional(),

package/src/models/operations/creatememory.ts

@@ -13,10 +13,6 @@ export type CreateMemoryRequestBody = {
    * 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;
 };
 
 export type CreateMemoryRequest = {
@@ -33,7 +29,9 @@ export type CreateMemoryRequest = {
 export type CreateMemoryResponseBody = {
   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;
@@ -41,10 +39,6 @@ export type CreateMemoryResponseBody = {
   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
@@ -59,7 +53,6 @@ export const CreateMemoryRequestBody$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   entity_id: z.string(),
-  metadata: z.record(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "entity_id": "entityId",
@@ -68,7 +61,6 @@ export const CreateMemoryRequestBody$inboundSchema: z.ZodType<
 /** @internal */
 export type CreateMemoryRequestBody$Outbound = {
   entity_id: string;
-  metadata?: { [k: string]: string } | undefined;
 };
 
 /** @internal */
@@ -78,7 +70,6 @@ export const CreateMemoryRequestBody$outboundSchema: z.ZodType<
   CreateMemoryRequestBody
 > = z.object({
   entityId: z.string(),
-  metadata: z.record(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     entityId: "entity_id",
@@ -167,7 +158,6 @@ export const CreateMemoryResponseBody$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) => {
@@ -190,7 +180,6 @@ export type CreateMemoryResponseBody$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;
 };
@@ -208,7 +197,6 @@ export const CreateMemoryResponseBody$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/creatememorydocument.ts

@@ -25,9 +25,9 @@ export type CreateMemoryDocumentRequest = {
    */
   memoryStoreKey: string;
   /**
-   * The unique identifier of the memory
+   * The unique entity_id provided during the memory store creation
    */
-  memoryId: string;
+  memoryEntityId: string;
   requestBody?: CreateMemoryDocumentRequestBody | undefined;
 };
 
@@ -104,20 +104,20 @@ export const CreateMemoryDocumentRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   memory_store_key: z.string(),
-  memory_id: z.string(),
+  memory_entity_id: z.string(),
   RequestBody: z.lazy(() => CreateMemoryDocumentRequestBody$inboundSchema)
     .optional(),
 }).transform((v) => {
   return remap$(v, {
     "memory_store_key": "memoryStoreKey",
-    "memory_id": "memoryId",
+    "memory_entity_id": "memoryEntityId",
     "RequestBody": "requestBody",
   });
 });
 /** @internal */
 export type CreateMemoryDocumentRequest$Outbound = {
   memory_store_key: string;
-  memory_id: string;
+  memory_entity_id: string;
   RequestBody?: CreateMemoryDocumentRequestBody$Outbound | undefined;
 };
 
@@ -128,13 +128,13 @@ export const CreateMemoryDocumentRequest$outboundSchema: z.ZodType<
   CreateMemoryDocumentRequest
 > = z.object({
   memoryStoreKey: z.string(),
-  memoryId: z.string(),
+  memoryEntityId: z.string(),
   requestBody: z.lazy(() => CreateMemoryDocumentRequestBody$outboundSchema)
     .optional(),
 }).transform((v) => {
   return remap$(v, {
     memoryStoreKey: "memory_store_key",
-    memoryId: "memory_id",
+    memoryEntityId: "memory_entity_id",
     requestBody: "RequestBody",
   });
 });