@orq-ai/node 4.9.17 → 4.9.19

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/updateapikeyrequest.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 { ApiKeyStatus, ApiKeyStatus$outboundSchema } from "./apikeystatus.js";
+import {
+  PermissionMode,
+  PermissionMode$outboundSchema,
+} from "./permissionmode.js";
+import {
+  ProjectScope,
+  ProjectScope$Outbound,
+  ProjectScope$outboundSchema,
+} from "./projectscope.js";
+
+export type UpdateApiKeyRequest = {
+  /**
+   * API key id to update.
+   */
+  apiKeyId?: string | undefined;
+  /**
+   * New name. Omit to keep current.
+   */
+  name?: string | undefined;
+  status?: ApiKeyStatus | undefined;
+  permissionMode?: PermissionMode | undefined;
+  /**
+   * Replacement access map. Required when changing to
+   *
+   * @remarks
+   *  `PERMISSION_MODE_RESTRICTED`; ignored otherwise. Provide an empty
+   *  map to clear. See `ApiKey.access` for the full catalog of valid
+   *  keys (Domain.id) and AccessLevel string values, or fetch the
+   *  live catalog via the `ListCapabilities` RPC.
+   */
+  access?: { [k: string]: number } | undefined;
+  /**
+   * New project scope. Omit to keep current.
+   */
+  projectScope?: ProjectScope | undefined;
+  /**
+   * New expiration. Omit to keep current. Set `clear_expires_at = true`
+   *
+   * @remarks
+   *  to remove an existing expiration (a zero Timestamp here would still
+   *  mean "no change" because of optional semantics).
+   */
+  expiresAt?: Date | undefined;
+  /**
+   * Force-clear the expiration. Mutually exclusive with `expires_at`.
+   */
+  clearExpiresAt?: boolean | undefined;
+};
+
+/** @internal */
+export type UpdateApiKeyRequest$Outbound = {
+  api_key_id?: string | undefined;
+  name?: string | undefined;
+  status?: string | undefined;
+  permission_mode?: string | undefined;
+  access?: { [k: string]: number } | undefined;
+  project_scope?: ProjectScope$Outbound | undefined;
+  expires_at?: string | undefined;
+  clear_expires_at?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateApiKeyRequest$outboundSchema: z.ZodType<
+  UpdateApiKeyRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateApiKeyRequest
+> = z.object({
+  apiKeyId: z.string().optional(),
+  name: z.string().optional(),
+  status: ApiKeyStatus$outboundSchema.optional(),
+  permissionMode: PermissionMode$outboundSchema.optional(),
+  access: z.record(z.number().int()).optional(),
+  projectScope: ProjectScope$outboundSchema.optional(),
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+  clearExpiresAt: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKeyId: "api_key_id",
+    permissionMode: "permission_mode",
+    projectScope: "project_scope",
+    expiresAt: "expires_at",
+    clearExpiresAt: "clear_expires_at",
+  });
+});
+
+export function updateApiKeyRequestToJSON(
+  updateApiKeyRequest: UpdateApiKeyRequest,
+): string {
+  return JSON.stringify(
+    UpdateApiKeyRequest$outboundSchema.parse(updateApiKeyRequest),
+  );
+}

package/src/models/components/updateapikeyresponse.ts

@@ -0,0 +1,40 @@
+/*
+ * 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";
+import { ApiKey, ApiKey$inboundSchema } from "./apikey.js";
+
+export type UpdateApiKeyResponse = {
+  /**
+   * Updated api-key.
+   */
+  apiKey?: ApiKey | undefined;
+};
+
+/** @internal */
+export const UpdateApiKeyResponse$inboundSchema: z.ZodType<
+  UpdateApiKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  api_key: ApiKey$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_key": "apiKey",
+  });
+});
+
+export function updateApiKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateApiKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateApiKeyResponse' 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,38 @@ 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.
+   *
+   * @remarks
+   *  Must start with a letter and may contain letters, numbers, and
+   *  underscores. Dashes and dots are not allowed because skill names
+   *  are referenced as template variables.
+   */
   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/components/userowner.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 UserOwner = {
+  userId?: string | undefined;
+};
+
+/** @internal */
+export const UserOwner$inboundSchema: z.ZodType<
+  UserOwner,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  user_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "user_id": "userId",
+  });
+});
+/** @internal */
+export type UserOwner$Outbound = {
+  user_id?: string | undefined;
+};
+
+/** @internal */
+export const UserOwner$outboundSchema: z.ZodType<
+  UserOwner$Outbound,
+  z.ZodTypeDef,
+  UserOwner
+> = z.object({
+  userId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    userId: "user_id",
+  });
+});
+
+export function userOwnerToJSON(userOwner: UserOwner): string {
+  return JSON.stringify(UserOwner$outboundSchema.parse(userOwner));
+}
+export function userOwnerFromJSON(
+  jsonString: string,
+): SafeParseResult<UserOwner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserOwner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserOwner' from JSON`,
+  );
+}

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/apikeydelete.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 ApiKeyDeleteRequest = {
+  /**
+   * API key id to delete.
+   */
+  apiKeyId: string;
+};
+
+/** @internal */
+export type ApiKeyDeleteRequest$Outbound = {
+  api_key_id: string;
+};
+
+/** @internal */
+export const ApiKeyDeleteRequest$outboundSchema: z.ZodType<
+  ApiKeyDeleteRequest$Outbound,
+  z.ZodTypeDef,
+  ApiKeyDeleteRequest
+> = z.object({
+  apiKeyId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKeyId: "api_key_id",
+  });
+});
+
+export function apiKeyDeleteRequestToJSON(
+  apiKeyDeleteRequest: ApiKeyDeleteRequest,
+): string {
+  return JSON.stringify(
+    ApiKeyDeleteRequest$outboundSchema.parse(apiKeyDeleteRequest),
+  );
+}

package/src/models/operations/apikeyget.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 ApiKeyGetRequest = {
+  /**
+   * API key id to retrieve (e.g. `01H...`).
+   */
+  apiKeyId: string;
+};
+
+/** @internal */
+export type ApiKeyGetRequest$Outbound = {
+  api_key_id: string;
+};
+
+/** @internal */
+export const ApiKeyGetRequest$outboundSchema: z.ZodType<
+  ApiKeyGetRequest$Outbound,
+  z.ZodTypeDef,
+  ApiKeyGetRequest
+> = z.object({
+  apiKeyId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKeyId: "api_key_id",
+  });
+});
+
+export function apiKeyGetRequestToJSON(
+  apiKeyGetRequest: ApiKeyGetRequest,
+): string {
+  return JSON.stringify(
+    ApiKeyGetRequest$outboundSchema.parse(apiKeyGetRequest),
+  );
+}