@orq-ai/node 4.10.0-rc.2 → 4.10.0-rc.20

package/src/models/components/responsemeta.ts

@@ -0,0 +1,103 @@
+/*
+ * 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";
+
+/**
+ * Bucket grain actually applied by the planner.
+ */
+export const EffectiveGrain = {
+  Minute: "minute",
+  Hour: "hour",
+  Day: "day",
+} as const;
+/**
+ * Bucket grain actually applied by the planner.
+ */
+export type EffectiveGrain = ClosedEnum<typeof EffectiveGrain>;
+
+/**
+ * ISO 4217 currency code for cost fields. Always `USD` today.
+ */
+export const ResponseMetaCurrency = {
+  Usd: "USD",
+} as const;
+/**
+ * ISO 4217 currency code for cost fields. Always `USD` today.
+ */
+export type ResponseMetaCurrency = ClosedEnum<typeof ResponseMetaCurrency>;
+
+export type ResponseMeta = {
+  /**
+   * Bucket grain actually applied by the planner.
+   */
+  effectiveGrain?: EffectiveGrain | undefined;
+  /**
+   * Number of rows in `data`. Cheap hint for clients that paginate
+   *
+   * @remarks
+   *  client-side; mirrors `len(data)`.
+   */
+  rowCount?: number | undefined;
+  /**
+   * Stable identifier for this query. Forward in support tickets so
+   *
+   * @remarks
+   *  server logs can be correlated. Also returned in the
+   *  `X-Request-Id` response header.
+   */
+  requestId?: string | undefined;
+  /**
+   * ISO 4217 currency code for cost fields. Always `USD` today.
+   */
+  currency?: ResponseMetaCurrency | undefined;
+  /**
+   * Non-fatal warnings about the response. May contain `totals_unavailable` when totals were requested but failed.
+   */
+  warnings?: Array<string> | undefined;
+};
+
+/** @internal */
+export const EffectiveGrain$inboundSchema: z.ZodNativeEnum<
+  typeof EffectiveGrain
+> = z.nativeEnum(EffectiveGrain);
+
+/** @internal */
+export const ResponseMetaCurrency$inboundSchema: z.ZodNativeEnum<
+  typeof ResponseMetaCurrency
+> = z.nativeEnum(ResponseMetaCurrency);
+
+/** @internal */
+export const ResponseMeta$inboundSchema: z.ZodType<
+  ResponseMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  effective_grain: EffectiveGrain$inboundSchema.optional(),
+  row_count: z.number().int().optional(),
+  request_id: z.string().optional(),
+  currency: ResponseMetaCurrency$inboundSchema.optional(),
+  warnings: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "effective_grain": "effectiveGrain",
+    "row_count": "rowCount",
+    "request_id": "requestId",
+  });
+});
+
+export function responseMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<ResponseMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResponseMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResponseMeta' from JSON`,
+  );
+}

package/src/models/components/retrieveidentityresponse.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Identity, Identity$inboundSchema } from "./identity.js";
+
+export type RetrieveIdentityResponse = {
+  identity?: Identity | undefined;
+};
+
+/** @internal */
+export const RetrieveIdentityResponse$inboundSchema: z.ZodType<
+  RetrieveIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identity: Identity$inboundSchema.optional(),
+});
+
+export function retrieveIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RetrieveIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetrieveIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetrieveIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/skill.ts

@@ -9,17 +9,53 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Skill = {
+  /**
+   * Unique skill identifier assigned by ORQ, for example
+   *
+   * @remarks
+   *  `skill_01H...`. Use this value in retrieve, update, and delete
+   *  requests.
+   */
   skillId?: string | undefined;
+  /**
+   * Workspace-unique display name. Must start with a letter and may contain letters, numbers, underscores, and hyphens.
+   */
   displayName?: string | undefined;
+  /**
+   * Short human-readable summary of what the skill is for.
+   */
   description?: string | undefined;
+  /**
+   * Free-form labels used for organization and filtering in clients.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * Project that owns or contains the skill.
+   */
   projectId?: string | undefined;
+  /**
+   * Project path where the skill is stored in the workspace.
+   */
   path?: string | undefined;
-  workspaceId?: string | undefined;
+  /**
+   * Time when the skill was created.
+   */
   createdAt?: Date | undefined;
+  /**
+   * Time when the skill was last updated.
+   */
   updatedAt?: Date | undefined;
+  /**
+   * User ID that created the skill.
+   */
   createdById?: string | undefined;
+  /**
+   * User ID that last updated the skill.
+   */
   updatedById?: string | undefined;
+  /**
+   * Instruction body executed or reused by clients that load this skill.
+   */
   instructions?: string | undefined;
   /**
    * Latest semver assigned by the activity log. Stamped on the document
@@ -40,7 +76,6 @@ export const Skill$inboundSchema: z.ZodType<Skill, z.ZodTypeDef, unknown> = z
     tags: z.array(z.string()).optional(),
     project_id: z.string().optional(),
     path: z.string().optional(),
-    workspace_id: z.string().optional(),
     created_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ).optional(),
@@ -56,7 +91,6 @@ export const Skill$inboundSchema: z.ZodType<Skill, z.ZodTypeDef, unknown> = z
       "skill_id": "skillId",
       "display_name": "displayName",
       "project_id": "projectId",
-      "workspace_id": "workspaceId",
       "created_at": "createdAt",
       "updated_at": "updatedAt",
       "created_by_id": "createdById",

package/src/models/components/totals.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Totals = {
+  /**
+   * Same shape and rules as `DataPoint.metrics`, aggregated across the
+   *
+   * @remarks
+   *  whole window.
+   */
+  metrics?: { [k: string]: number } | undefined;
+};
+
+/** @internal */
+export const Totals$inboundSchema: z.ZodType<Totals, z.ZodTypeDef, unknown> = z
+  .object({
+    metrics: z.record(z.number()).optional(),
+  });
+
+export function totalsFromJSON(
+  jsonString: string,
+): SafeParseResult<Totals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Totals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Totals' from JSON`,
+  );
+}

package/src/models/components/updateidentityrequest.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UpdateIdentityRequestMetadata = {};
+
+export type UpdateIdentityRequest = {
+  id?: string | undefined;
+  displayName?: string | undefined;
+  email?: string | undefined;
+  avatarUrl?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: UpdateIdentityRequestMetadata | undefined;
+};
+
+/** @internal */
+export type UpdateIdentityRequestMetadata$Outbound = {};
+
+/** @internal */
+export const UpdateIdentityRequestMetadata$outboundSchema: z.ZodType<
+  UpdateIdentityRequestMetadata$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequestMetadata
+> = z.object({});
+
+export function updateIdentityRequestMetadataToJSON(
+  updateIdentityRequestMetadata: UpdateIdentityRequestMetadata,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequestMetadata$outboundSchema.parse(
+      updateIdentityRequestMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateIdentityRequest$Outbound = {
+  id?: string | undefined;
+  display_name?: string | undefined;
+  email?: string | undefined;
+  avatar_url?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: UpdateIdentityRequestMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityRequest$outboundSchema: z.ZodType<
+  UpdateIdentityRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequest
+> = z.object({
+  id: z.string().optional(),
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  avatarUrl: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.lazy(() => UpdateIdentityRequestMetadata$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function updateIdentityRequestToJSON(
+  updateIdentityRequest: UpdateIdentityRequest,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequest$outboundSchema.parse(updateIdentityRequest),
+  );
+}

package/src/models/components/updateidentityresponse.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Identity, Identity$inboundSchema } from "./identity.js";
+
+export type UpdateIdentityResponse = {
+  identity?: Identity | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityResponse$inboundSchema: z.ZodType<
+  UpdateIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identity: Identity$inboundSchema.optional(),
+});
+
+export function updateIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/updateprojectrequest.ts

@@ -6,8 +6,20 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type UpdateProjectRequest = {
+  /**
+   * Project ID to update.
+   */
   projectId?: string | undefined;
+  /**
+   * New project name. Omit to keep the current name.
+   */
   name?: string | undefined;
+  /**
+   * Replacement list of team identifiers associated with the project.
+   *
+   * @remarks
+   *  Leave empty to remove all team associations.
+   */
   teams?: Array<string> | undefined;
 };
 

package/src/models/components/updateprojectresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Project, Project$inboundSchema } from "./project.js";
 
 export type UpdateProjectResponse = {
+  /**
+   * Updated project.
+   */
   project?: Project | undefined;
 };
 

package/src/models/components/updateskillrequest.ts

@@ -6,12 +6,33 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type UpdateSkillRequest = {
+  /**
+   * Skill ID to update.
+   */
   skillId?: string | undefined;
+  /**
+   * New workspace-unique display name. Omit to keep the current name.
+   */
   displayName?: string | undefined;
+  /**
+   * New description. Omit to keep the current description.
+   */
   description?: string | undefined;
+  /**
+   * Replacement tag list. Leave empty to clear tags.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * New project path. Omit to keep the current path.
+   */
   path?: string | undefined;
+  /**
+   * New instruction body. Omit to keep the current instructions.
+   */
   instructions?: string | undefined;
+  /**
+   * New containing project. Omit to keep the current project.
+   */
   projectId?: string | undefined;
 };
 

package/src/models/components/updateskillresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Skill, Skill$inboundSchema } from "./skill.js";
 
 export type UpdateSkillResponse = {
+  /**
+   * Updated skill.
+   */
   skill?: Skill | undefined;
 };
 

package/src/models/errors/index.ts

@@ -11,7 +11,6 @@ export * from "./createtranslation.js";
 export * from "./deleteagent.js";
 export * from "./deleteagentschedule.js";
 export * from "./deleteeval.js";
-export * from "./deleteidentity.js";
 export * from "./deleteprompt.js";
 export * from "./getevals.js";
 export * from "./getpromptversion.js";
@@ -29,7 +28,6 @@ export * from "./postv2feedbackremove.js";
 export * from "./responsevalidationerror.js";
 export * from "./retrieveagentrequest.js";
 export * from "./retrieveagentschedule.js";
-export * from "./retrieveidentity.js";
 export * from "./sdkvalidationerror.js";
 export * from "./streamagent.js";
 export * from "./streamrunagent.js";
@@ -37,6 +35,5 @@ export * from "./triggeragentschedule.js";
 export * from "./updateagent.js";
 export * from "./updateagentschedule.js";
 export * from "./updateeval.js";
-export * from "./updateidentity.js";
 export * from "./updateprompt.js";
 export * from "./updatetool.js";

package/src/models/operations/createagentrequest.ts

@@ -2577,13 +2577,13 @@ export type CreateAgentRequestResponseBody = {
    */
   version?: string | undefined;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
   /**

package/src/models/operations/createannotation.ts

@@ -8,7 +8,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 /**
  * The feedback value. For single-select, provide a string or single-element array. For multi-select, provide an array of strings. For range evaluations, provide a number. For text/correction, provide a string.
  */
-export type CreateAnnotationValue = string | number | Array<string>;
+export type Value = string | number | Array<string>;
 
 export type Annotations = {
   /**
@@ -43,21 +43,17 @@ export type CreateAnnotationRequest = {
 };
 
 /** @internal */
-export type CreateAnnotationValue$Outbound = string | number | Array<string>;
+export type Value$Outbound = string | number | Array<string>;
 
 /** @internal */
-export const CreateAnnotationValue$outboundSchema: z.ZodType<
-  CreateAnnotationValue$Outbound,
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
   z.ZodTypeDef,
-  CreateAnnotationValue
+  Value
 > = z.union([z.string(), z.number(), z.array(z.string())]);
 
-export function createAnnotationValueToJSON(
-  createAnnotationValue: CreateAnnotationValue,
-): string {
-  return JSON.stringify(
-    CreateAnnotationValue$outboundSchema.parse(createAnnotationValue),
-  );
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
 }
 
 /** @internal */

package/src/models/operations/createdataset.ts

@@ -14,13 +14,13 @@ export type CreateDatasetRequestBody = {
    */
   displayName: string;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
 };
@@ -138,7 +138,7 @@ export const CreateDatasetResponseBody$inboundSchema: z.ZodType<
   created: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   updated: z.string().datetime({ offset: true }).default(
-    "2026-05-13T12:08:27.769Z",
+    "2026-05-20T07:16:35.691Z",
   ).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {

package/src/models/operations/createdatasetitem.ts

@@ -2355,7 +2355,7 @@ export const Evaluations3$inboundSchema: z.ZodType<
   ),
   reviewed_by_id: z.string(),
   reviewed_at: z.string().datetime({ offset: true }).default(
-    "2026-05-13T12:08:42.738Z",
+    "2026-05-20T07:16:49.543Z",
   ).transform(v => new Date(v)),
   type: z.literal("string_array"),
   values: z.array(z.string()),
@@ -2400,7 +2400,7 @@ export const Evaluations2$inboundSchema: z.ZodType<
   source: CreateDatasetItemEvaluationsSource$inboundSchema.default("orq"),
   reviewed_by_id: z.string(),
   reviewed_at: z.string().datetime({ offset: true }).default(
-    "2026-05-13T12:08:42.738Z",
+    "2026-05-20T07:16:49.543Z",
   ).transform(v => new Date(v)),
   type: z.literal("number"),
   value: z.number(),
@@ -2446,7 +2446,7 @@ export const Evaluations1$inboundSchema: z.ZodType<
   source: EvaluationsSource$inboundSchema.default("orq"),
   reviewed_by_id: z.string(),
   reviewed_at: z.string().datetime({ offset: true }).default(
-    "2026-05-13T12:08:42.737Z",
+    "2026-05-20T07:16:49.543Z",
   ).transform(v => new Date(v)),
   type: z.literal("string"),
   value: z.string(),
@@ -2529,7 +2529,7 @@ export const CreateDatasetItemResponseBody$inboundSchema: z.ZodType<
   created: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   updated: z.string().datetime({ offset: true }).default(
-    "2026-05-13T12:08:27.769Z",
+    "2026-05-20T07:16:35.691Z",
   ).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {

package/src/models/operations/createdatasource.ts

@@ -403,7 +403,7 @@ export const CreateDatasourceResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("01KRGKTFXAJC74ZDBSKAZGCKBT"),
+  _id: z.string().default("01KS23X26KN6WM069SMF8SBMP5"),
   display_name: z.string(),
   description: z.string().optional(),
   status: CreateDatasourceStatus$inboundSchema,