@orq-ai/node 4.2.0-rc.29 → 4.2.0-rc.30

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-15T04:13:15.987Z",
+  ).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-15T04:13:15.987Z"))
+    .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/updatetool.ts

@@ -1528,7 +1528,7 @@ export const RequestBodyTools$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().default("01KEYB6FHF5AV3H5TVBQY1WNGF"),
+  id: z.string().default("01KEZXQGN5ZB4E7JF3VDGCPZC4"),
   name: z.string(),
   description: z.string().optional(),
   schema: z.lazy(() => UpdateToolRequestBodyToolsSchema$inboundSchema),
@@ -1547,7 +1547,7 @@ export const RequestBodyTools$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RequestBodyTools
 > = z.object({
-  id: z.string().default("01KEYB6FHF5AV3H5TVBQY1WNGF"),
+  id: z.string().default("01KEZXQGN5ZB4E7JF3VDGCPZC4"),
   name: z.string(),
   description: z.string().optional(),
   schema: z.lazy(() => UpdateToolRequestBodyToolsSchema$outboundSchema),
@@ -2729,7 +2729,7 @@ export const UpdateToolResponseBodyCodeExecutionTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KEYB6FH8S84W6S0K0Q78RYDX"),
+  _id: z.string().default("tool_01KEZXQGMM0WE0X9V2M4J0SJEW"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -2783,7 +2783,7 @@ export const UpdateToolResponseBodyCodeExecutionTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateToolResponseBodyCodeExecutionTool
 > = z.object({
-  id: z.string().default("tool_01KEYB6FH8S84W6S0K0Q78RYDX"),
+  id: z.string().default("tool_01KEZXQGMM0WE0X9V2M4J0SJEW"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),
@@ -2958,7 +2958,7 @@ export const UpdateToolResponseBodyTools$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().default("01KEYB6FH6M9PJR0CM7X1JZZ80"),
+  id: z.string().default("01KEZXQGMJ8VQKB48SB8SKNJES"),
   name: z.string(),
   description: z.string().optional(),
   schema: z.lazy(() => UpdateToolResponseBodyToolsSchema$inboundSchema),
@@ -2977,7 +2977,7 @@ export const UpdateToolResponseBodyTools$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateToolResponseBodyTools
 > = z.object({
-  id: z.string().default("01KEYB6FH6M9PJR0CM7X1JZZ80"),
+  id: z.string().default("01KEZXQGMJ8VQKB48SB8SKNJES"),
   name: z.string(),
   description: z.string().optional(),
   schema: z.lazy(() => UpdateToolResponseBodyToolsSchema$outboundSchema),
@@ -3078,7 +3078,7 @@ export const UpdateToolResponseBodyMCPTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KEYB6FH5F3937BEE89E45KFA"),
+  _id: z.string().default("tool_01KEZXQGMGJME5E5RCS1743AHG"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -3131,7 +3131,7 @@ export const UpdateToolResponseBodyMCPTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateToolResponseBodyMCPTool
 > = z.object({
-  id: z.string().default("tool_01KEYB6FH5F3937BEE89E45KFA"),
+  id: z.string().default("tool_01KEZXQGMGJME5E5RCS1743AHG"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),
@@ -3499,7 +3499,7 @@ export const UpdateToolResponseBodyHTTPTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KEYB6FH206WN3KACR7WYSE1H"),
+  _id: z.string().default("tool_01KEZXQGMDGM3AVKFJV9J5JZSX"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -3552,7 +3552,7 @@ export const UpdateToolResponseBodyHTTPTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateToolResponseBodyHTTPTool
 > = z.object({
-  id: z.string().default("tool_01KEYB6FH206WN3KACR7WYSE1H"),
+  id: z.string().default("tool_01KEZXQGMDGM3AVKFJV9J5JZSX"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),
@@ -3725,7 +3725,7 @@ export const UpdateToolResponseBodyJSONSchemaTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KEYB6FGZWR6G4ATD1WYBNKHK"),
+  _id: z.string().default("tool_01KEZXQGMB1KB3PXTGX8CYCXXF"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -3777,7 +3777,7 @@ export const UpdateToolResponseBodyJSONSchemaTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateToolResponseBodyJSONSchemaTool
 > = z.object({
-  id: z.string().default("tool_01KEYB6FGZWR6G4ATD1WYBNKHK"),
+  id: z.string().default("tool_01KEZXQGMB1KB3PXTGX8CYCXXF"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),
@@ -3965,7 +3965,7 @@ export const UpdateToolResponseBodyFunctionTool$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("tool_01KEYB6FGX6VPS34V45PH4RH9G"),
+  _id: z.string().default("tool_01KEZXQGM9YE7NJR1VMDKPTWS2"),
   path: z.string(),
   key: z.string(),
   display_name: z.string().optional(),
@@ -4016,7 +4016,7 @@ export const UpdateToolResponseBodyFunctionTool$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateToolResponseBodyFunctionTool
 > = z.object({
-  id: z.string().default("tool_01KEYB6FGX6VPS34V45PH4RH9G"),
+  id: z.string().default("tool_01KEZXQGM9YE7NJR1VMDKPTWS2"),
   path: z.string(),
   key: z.string(),
   displayName: z.string().optional(),

package/src/sdk/contacts.ts

@@ -17,6 +17,8 @@ export class Contacts extends ClientSDK {
    *
    * @remarks
    * Creates a new contact with a unique external_id. If a contact with the same external_id already exists, the operation will fail. Use this endpoint to add users from your system to orq.ai for tracking their usage and engagement.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async create(
     request?: operations.CreateContactRequestBody | undefined,
@@ -34,6 +36,8 @@ export class Contacts extends ClientSDK {
    *
    * @remarks
    * Retrieves a paginated list of contacts in your workspace. Use pagination parameters to navigate through large contact lists efficiently.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async list(
     request?: operations.ListContactsRequest | undefined,
@@ -51,6 +55,8 @@ export class Contacts extends ClientSDK {
    *
    * @remarks
    * Retrieves detailed information about a specific contact using their contact ID or external ID from your system.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async retrieve(
     request: operations.RetrieveContactRequest,
@@ -68,6 +74,8 @@ export class Contacts extends ClientSDK {
    *
    * @remarks
    * Updates specific fields of an existing contact. Only the fields provided in the request body will be updated.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async update(
     request: operations.UpdateContactRequest,
@@ -85,6 +93,8 @@ export class Contacts extends ClientSDK {
    *
    * @remarks
    * Permanently deletes a contact from your workspace and cleans up associated budget configurations. This action cannot be undone.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async delete(
     request: operations.DeleteContactRequest,

package/src/sdk/identities.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { identitiesCreate } from "../funcs/identitiesCreate.js";
+import { identitiesDelete } from "../funcs/identitiesDelete.js";
+import { identitiesList } from "../funcs/identitiesList.js";
+import { identitiesRetrieve } from "../funcs/identitiesRetrieve.js";
+import { identitiesUpdate } from "../funcs/identitiesUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Identities extends ClientSDK {
+  /**
+   * List identities
+   *
+   * @remarks
+   * Retrieves a paginated list of identities in your workspace. Use pagination parameters to navigate through large identity lists efficiently.
+   */
+  async list(
+    request?: operations.ListIdentitiesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.ListIdentitiesResponseBody> {
+    return unwrapAsync(identitiesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create an identity
+   *
+   * @remarks
+   * Creates a new identity with a unique external_id. If an identity with the same external_id already exists, the operation will fail. Use this endpoint to add users from your system to orq.ai for tracking their usage and engagement.
+   */
+  async create(
+    request?: operations.CreateIdentityRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateIdentityResponseBody> {
+    return unwrapAsync(identitiesCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve an identity
+   *
+   * @remarks
+   * Retrieves detailed information about a specific identity using their identity ID or external ID from your system.
+   */
+  async retrieve(
+    request: operations.RetrieveIdentityRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RetrieveIdentityResponseBody> {
+    return unwrapAsync(identitiesRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update an identity
+   *
+   * @remarks
+   * Updates specific fields of an existing identity. Only the fields provided in the request body will be updated.
+   */
+  async update(
+    request: operations.UpdateIdentityRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateIdentityResponseBody> {
+    return unwrapAsync(identitiesUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete an identity
+   *
+   * @remarks
+   * Permanently deletes an identity from your workspace and cleans up associated budget configurations. This action cannot be undone.
+   */
+  async delete(
+    request: operations.DeleteIdentityRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(identitiesDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -13,6 +13,7 @@ import { Evals } from "./evals.js";
 import { Evaluators } from "./evaluators.js";
 import { Feedback } from "./feedback.js";
 import { Files } from "./files.js";
+import { Identities } from "./identities.js";
 import { Internal } from "./internal.js";
 import { Knowledge } from "./knowledge.js";
 import { MemoryStores } from "./memorystores.js";
@@ -43,6 +44,11 @@ export class Orq extends ClientSDK {
     return (this._evaluators ??= new Evaluators(this._options));
   }
 
+  private _identities?: Identities;
+  get identities(): Identities {
+    return (this._identities ??= new Identities(this._options));
+  }
+
   private _deployments?: Deployments;
   get deployments(): Deployments {
     return (this._deployments ??= new Deployments(this._options));

package/examples/contactsCreate.example.ts

@@ -1,42 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import dotenv from "dotenv";
-dotenv.config();
-/**
- * Example usage of the @orq-ai/node SDK
- *
- * To run this example from the examples directory:
- * npm run build && npx tsx contactsCreate.example.ts
- */
-
-import { Orq } from "@orq-ai/node";
-
-const orq = new Orq({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function main() {
-  const result = await orq.contacts.create({
-    externalId: "user_12345",
-    displayName: "Jane Smith",
-    email: "jane.smith@example.com",
-    avatarUrl: "https://example.com/avatars/jane-smith.jpg",
-    tags: [
-      "premium",
-      "beta-user",
-      "enterprise",
-    ],
-    metadata: {
-      "department": "Engineering",
-      "role": "Senior Developer",
-      "subscription_tier": "premium",
-      "last_login": "2024-01-15T10:30:00Z",
-    },
-  });
-
-  console.log(result);
-}
-
-main().catch(console.error);