@orq-ai/node 4.10.0 → 4.10.1

package/src/models/components/apikey.ts

@@ -33,27 +33,27 @@ export type ApiKey = {
    * @remarks
    *  `sk-orq-<id>-<secret>`.
    */
-  apiKeyId?: string | undefined;
+  apiKeyId: string;
   /**
    * Human-readable name shown in the dashboard.
    */
-  name?: string | undefined;
+  name: string;
   /**
    * Owner attribution (drives lifecycle).
    */
-  owner?: ApiKeyOwner | undefined;
+  owner: ApiKeyOwner;
   /**
    * Project authorization scope.
    */
-  projectScope?: ProjectScope | undefined;
-  permissionMode?: PermissionMode | undefined;
+  projectScope: ProjectScope;
+  permissionMode: PermissionMode;
   /**
    * Per-domain access map. Only populated when `permission_mode` is
    *
    * @remarks
    *  `PERMISSION_MODE_RESTRICTED`. The authoritative list of valid
    *  keys and the per-domain read / write semantics are exposed at
-   *  runtime via the `ListCapabilities` RPC.
+   *  runtime via the capability catalog endpoint.
    *
    *  Valid keys are the Domain.id values in the capability catalog —
    *  see libs/catalog/orq/apikeys/v1/catalog.textpb for the canonical
@@ -71,8 +71,8 @@ export type ApiKey = {
    * @remarks
    *  to expose.
    */
-  tokenPrefix?: string | undefined;
-  status?: ApiKeyStatus | undefined;
+  tokenPrefix: string;
+  status: ApiKeyStatus;
   /**
    * Audit: user who created the key. Optional. Distinct from
    *
@@ -88,11 +88,11 @@ export type ApiKey = {
   /**
    * Time the key was created.
    */
-  createdAt?: Date | undefined;
+  createdAt: Date;
   /**
    * Time the key was last updated.
    */
-  updatedAt?: Date | undefined;
+  updatedAt: Date;
   /**
    * Last authenticated use. Updated via NATS debounce + 1% sampler.
    */
@@ -117,22 +117,22 @@ export type ApiKey = {
 /** @internal */
 export const ApiKey$inboundSchema: z.ZodType<ApiKey, z.ZodTypeDef, unknown> = z
   .object({
-    api_key_id: z.string().optional(),
-    name: z.string().optional(),
-    owner: ApiKeyOwner$inboundSchema.optional(),
-    project_scope: ProjectScope$inboundSchema.optional(),
-    permission_mode: PermissionMode$inboundSchema.optional(),
+    api_key_id: z.string(),
+    name: z.string(),
+    owner: ApiKeyOwner$inboundSchema,
+    project_scope: ProjectScope$inboundSchema,
+    permission_mode: PermissionMode$inboundSchema,
     access: z.record(z.number().int()).optional(),
-    token_prefix: z.string().optional(),
-    status: ApiKeyStatus$inboundSchema.optional(),
+    token_prefix: z.string(),
+    status: ApiKeyStatus$inboundSchema,
     created_by_id: z.string().optional(),
     updated_by_id: z.string().optional(),
     created_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
-    ).optional(),
+    ),
     updated_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
-    ).optional(),
+    ),
     last_used_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ).optional(),

package/src/models/components/createapikeyrequest.ts

@@ -23,7 +23,7 @@ export type CreateApiKeyRequest = {
   /**
    * Human-readable name. Required.
    */
-  name?: string | undefined;
+  name: string;
   /**
    * Owner attribution. Defaults to service_account when omitted.
    */
@@ -39,7 +39,7 @@ export type CreateApiKeyRequest = {
    * @remarks
    *  `PERMISSION_MODE_RESTRICTED`. 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.
+   *  or fetch the live catalog via the capability catalog endpoint.
    */
   access?: { [k: string]: number } | undefined;
   /**
@@ -54,7 +54,7 @@ export type CreateApiKeyRequest = {
 
 /** @internal */
 export type CreateApiKeyRequest$Outbound = {
-  name?: string | undefined;
+  name: string;
   owner?: ApiKeyOwner$Outbound | undefined;
   project_scope?: ProjectScope$Outbound | undefined;
   permission_mode?: string | undefined;
@@ -68,7 +68,7 @@ export const CreateApiKeyRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateApiKeyRequest
 > = z.object({
-  name: z.string().optional(),
+  name: z.string(),
   owner: ApiKeyOwner$outboundSchema.optional(),
   projectScope: ProjectScope$outboundSchema.optional(),
   permissionMode: PermissionMode$outboundSchema.optional(),

package/src/models/components/createapikeyresponse.ts

@@ -13,7 +13,7 @@ export type CreateApiKeyResponse = {
   /**
    * Newly minted api-key record.
    */
-  apiKey?: ApiKey | undefined;
+  apiKey: ApiKey;
   /**
    * Raw bearer token in the form `sk-orq-<api_key_id>-<secret>`.
    *
@@ -21,7 +21,7 @@ export type CreateApiKeyResponse = {
    *  Returned ONCE; the API never exposes this value again. Clients
    *  must persist it immediately on receipt.
    */
-  token?: string | undefined;
+  token: string;
 };
 
 /** @internal */
@@ -30,8 +30,8 @@ export const CreateApiKeyResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  api_key: ApiKey$inboundSchema.optional(),
-  token: z.string().optional(),
+  api_key: ApiKey$inboundSchema,
+  token: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "api_key": "apiKey",

package/src/models/components/createfilerequest.ts

@@ -7,9 +7,18 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { FilePurpose, FilePurpose$outboundSchema } from "./filepurpose.js";
 
 export type CreateFileRequest = {
-  filename?: string | undefined;
-  content?: string | undefined;
+  /**
+   * Name to store for the uploaded file, including extension when available.
+   */
+  filename: string;
+  /**
+   * Base64-encoded file contents.
+   */
+  content: string;
   purpose?: FilePurpose | undefined;
+  /**
+   * MIME type of the uploaded content, for example `application/pdf`.
+   */
   contentType?: string | undefined;
   /**
    * Project the file is created in. Optional for project-scoped API keys (defaults to the key's bound project); required for workspace-scoped callers.
@@ -19,8 +28,8 @@ export type CreateFileRequest = {
 
 /** @internal */
 export type CreateFileRequest$Outbound = {
-  filename?: string | undefined;
-  content?: string | undefined;
+  filename: string;
+  content: string;
   purpose?: string | undefined;
   content_type?: string | undefined;
   project_id?: string | undefined;
@@ -32,8 +41,8 @@ export const CreateFileRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateFileRequest
 > = z.object({
-  filename: z.string().optional(),
-  content: z.string().optional(),
+  filename: z.string(),
+  content: z.string(),
   purpose: FilePurpose$outboundSchema.optional(),
   contentType: z.string().optional(),
   projectId: z.string().optional(),

package/src/models/components/createfileresponse.ts

@@ -9,7 +9,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { FileT, FileT$inboundSchema } from "./file.js";
 
 export type CreateFileResponse = {
-  file?: FileT | undefined;
+  /**
+   * Newly created file.
+   */
+  file: FileT;
 };
 
 /** @internal */
@@ -18,7 +21,7 @@ export const CreateFileResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  file: FileT$inboundSchema.optional(),
+  file: FileT$inboundSchema,
 });
 
 export function createFileResponseFromJSON(

package/src/models/components/createidentityrequest.ts

@@ -5,14 +5,38 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
+/**
+ * Custom JSON metadata stored with the identity.
+ */
 export type CreateIdentityRequestMetadata = {};
 
 export type CreateIdentityRequest = {
-  externalId?: string | undefined;
+  /**
+   * Customer-provided stable identifier for this identity. Must be unique
+   *
+   * @remarks
+   *  within the workspace.
+   */
+  externalId: string;
+  /**
+   * Human-readable display name for the identity.
+   */
   displayName?: string | undefined;
+  /**
+   * Email address associated with the identity.
+   */
   email?: string | undefined;
+  /**
+   * URL of the identity avatar image.
+   */
   avatarUrl?: string | undefined;
+  /**
+   * Free-form labels used to organize and filter identities.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * Custom JSON metadata stored with the identity.
+   */
   metadata?: CreateIdentityRequestMetadata | undefined;
 };
 
@@ -38,7 +62,7 @@ export function createIdentityRequestMetadataToJSON(
 
 /** @internal */
 export type CreateIdentityRequest$Outbound = {
-  external_id?: string | undefined;
+  external_id: string;
   display_name?: string | undefined;
   email?: string | undefined;
   avatar_url?: string | undefined;
@@ -52,7 +76,7 @@ export const CreateIdentityRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateIdentityRequest
 > = z.object({
-  externalId: z.string().optional(),
+  externalId: z.string(),
   displayName: z.string().optional(),
   email: z.string().optional(),
   avatarUrl: z.string().optional(),

package/src/models/components/createidentityresponse.ts

@@ -9,7 +9,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Identity, Identity$inboundSchema } from "./identity.js";
 
 export type CreateIdentityResponse = {
-  identity?: Identity | undefined;
+  /**
+   * Newly created identity.
+   */
+  identity: Identity;
 };
 
 /** @internal */
@@ -18,7 +21,7 @@ export const CreateIdentityResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  identity: Identity$inboundSchema.optional(),
+  identity: Identity$inboundSchema,
 });
 
 export function createIdentityResponseFromJSON(

package/src/models/components/createprojectrequest.ts

@@ -8,7 +8,7 @@ export type CreateProjectRequest = {
   /**
    * Project name. Names must be non-empty and at most 128 characters.
    */
-  name?: string | undefined;
+  name: string;
   /**
    * Team identifiers to associate with the project.
    */
@@ -21,7 +21,7 @@ export type CreateProjectRequest = {
 
 /** @internal */
 export type CreateProjectRequest$Outbound = {
-  name?: string | undefined;
+  name: string;
   teams?: Array<string> | undefined;
   description?: string | undefined;
 };
@@ -32,7 +32,7 @@ export const CreateProjectRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateProjectRequest
 > = z.object({
-  name: z.string().optional(),
+  name: z.string(),
   teams: z.array(z.string()).optional(),
   description: z.string().optional(),
 });

package/src/models/components/createprojectresponse.ts

@@ -12,7 +12,7 @@ export type CreateProjectResponse = {
   /**
    * Newly created project.
    */
-  project?: Project | undefined;
+  project: Project;
 };
 
 /** @internal */
@@ -21,7 +21,7 @@ export const CreateProjectResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  project: Project$inboundSchema.optional(),
+  project: Project$inboundSchema,
 });
 
 export function createProjectResponseFromJSON(

package/src/models/components/createskillrequest.ts

@@ -9,7 +9,7 @@ export type CreateSkillRequest = {
   /**
    * Workspace-unique display name. Must start with a letter and may contain letters, numbers, and underscores. Dashes and dots are not allowed.
    */
-  displayName?: string | undefined;
+  displayName: string;
   /**
    * Short human-readable summary of what the skill is for.
    */
@@ -34,7 +34,7 @@ export type CreateSkillRequest = {
 
 /** @internal */
 export type CreateSkillRequest$Outbound = {
-  display_name?: string | undefined;
+  display_name: string;
   description?: string | undefined;
   tags?: Array<string> | undefined;
   path?: string | undefined;
@@ -48,7 +48,7 @@ export const CreateSkillRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateSkillRequest
 > = z.object({
-  displayName: z.string().optional(),
+  displayName: z.string(),
   description: z.string().optional(),
   tags: z.array(z.string()).optional(),
   path: z.string().optional(),

package/src/models/components/createskillresponse.ts

@@ -12,7 +12,7 @@ export type CreateSkillResponse = {
   /**
    * Newly created skill.
    */
-  skill?: Skill | undefined;
+  skill: Skill;
 };
 
 /** @internal */
@@ -21,7 +21,7 @@ export const CreateSkillResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  skill: Skill$inboundSchema.optional(),
+  skill: Skill$inboundSchema,
 });
 
 export function createSkillResponseFromJSON(

package/src/models/components/file.ts

@@ -10,28 +10,40 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { FilePurpose, FilePurpose$inboundSchema } from "./filepurpose.js";
 
 export type FileT = {
-  fileId?: string | undefined;
-  purpose?: FilePurpose | undefined;
-  fileName?: string | undefined;
-  bytes?: string | undefined;
-  createdAt?: Date | undefined;
+  /**
+   * Unique file identifier assigned by ORQ.
+   */
+  fileId: string;
+  purpose: FilePurpose;
+  /**
+   * Display file name, including extension when available.
+   */
+  fileName: string;
+  /**
+   * Size of the uploaded file in bytes.
+   */
+  bytes: string;
+  /**
+   * Time when the file was created.
+   */
+  createdAt: Date;
   /**
    * Identifier of the project the file belongs to. Files are project-scoped; an API key may only access files in projects it is authorized for.
    */
-  projectId?: string | undefined;
+  projectId: string;
 };
 
 /** @internal */
 export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
   .object({
-    file_id: z.string().optional(),
-    purpose: FilePurpose$inboundSchema.optional(),
-    file_name: z.string().optional(),
-    bytes: z.string().optional(),
+    file_id: z.string(),
+    purpose: FilePurpose$inboundSchema,
+    file_name: z.string(),
+    bytes: z.string(),
     created_at: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
-    ).optional(),
-    project_id: z.string().optional(),
+    ),
+    project_id: z.string(),
   }).transform((v) => {
     return remap$(v, {
       "file_id": "fileId",

package/src/models/components/getapikeyresponse.ts

@@ -13,7 +13,7 @@ export type GetApiKeyResponse = {
   /**
    * Requested api-key. Raw token never included.
    */
-  apiKey?: ApiKey | undefined;
+  apiKey: ApiKey;
 };
 
 /** @internal */
@@ -22,7 +22,7 @@ export const GetApiKeyResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  api_key: ApiKey$inboundSchema.optional(),
+  api_key: ApiKey$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "api_key": "apiKey",

package/src/models/components/getfilecontentresponse.ts

@@ -9,7 +9,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetFileContentResponse = {
-  downloadUrl?: string | undefined;
+  /**
+   * Presigned URL that can be used to download the file content.
+   */
+  downloadUrl: string;
 };
 
 /** @internal */
@@ -18,7 +21,7 @@ export const GetFileContentResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  download_url: z.string().optional(),
+  download_url: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "download_url": "downloadUrl",

package/src/models/components/getfileresponse.ts

@@ -9,7 +9,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { FileT, FileT$inboundSchema } from "./file.js";
 
 export type GetFileResponse = {
-  file?: FileT | undefined;
+  /**
+   * Requested file metadata.
+   */
+  file: FileT;
 };
 
 /** @internal */
@@ -18,7 +21,7 @@ export const GetFileResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  file: FileT$inboundSchema.optional(),
+  file: FileT$inboundSchema,
 });
 
 export function getFileResponseFromJSON(

package/src/models/components/getprojectresponse.ts

@@ -12,7 +12,7 @@ export type GetProjectResponse = {
   /**
    * Requested project.
    */
-  project?: Project | undefined;
+  project: Project;
 };
 
 /** @internal */
@@ -21,7 +21,7 @@ export const GetProjectResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  project: Project$inboundSchema.optional(),
+  project: Project$inboundSchema,
 });
 
 export function getProjectResponseFromJSON(

package/src/models/components/getskillresponse.ts

@@ -12,7 +12,7 @@ export type GetSkillResponse = {
   /**
    * Requested skill.
    */
-  skill?: Skill | undefined;
+  skill: Skill;
 };
 
 /** @internal */
@@ -21,7 +21,7 @@ export const GetSkillResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  skill: Skill$inboundSchema.optional(),
+  skill: Skill$inboundSchema,
 });
 
 export function getSkillResponseFromJSON(

package/src/models/components/identity.ts

@@ -12,19 +12,64 @@ import {
   IdentityMetrics$inboundSchema,
 } from "./identitymetrics.js";
 
+/**
+ * Custom JSON metadata stored with the identity.
+ */
 export type Metadata = {};
 
 export type Identity = {
-  id?: string | undefined;
-  externalId?: string | undefined;
-  workspaceId?: string | undefined;
+  /**
+   * Unique identity identifier assigned by ORQ. Returned as `_id` for
+   *
+   * @remarks
+   *  compatibility with the v1 identity API.
+   */
+  id: string;
+  /**
+   * Customer-provided stable identifier for this identity. This value is
+   *
+   * @remarks
+   *  required on create and is unique within the workspace.
+   */
+  externalId: string;
+  /**
+   * Workspace that owns the identity.
+   */
+  workspaceId: string;
+  /**
+   * Human-readable display name for the identity.
+   */
   displayName?: string | undefined;
+  /**
+   * Email address associated with the identity.
+   */
   email?: string | undefined;
+  /**
+   * URL of the identity avatar image.
+   */
   avatarUrl?: string | undefined;
+  /**
+   * Free-form labels used to organize and filter identities.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * Custom JSON metadata stored with the identity.
+   */
   metadata?: Metadata | undefined;
-  created?: string | undefined;
-  updated?: string | undefined;
+  /**
+   * ISO timestamp for when the identity was created.
+   */
+  created: string;
+  /**
+   * ISO timestamp for when the identity was last updated.
+   */
+  updated: string;
+  /**
+   * Optional usage and cost metrics. Present only when requested with
+   *
+   * @remarks
+   *  `include_metrics`.
+   */
   metrics?: IdentityMetrics | undefined;
 };
 
@@ -51,16 +96,16 @@ export const Identity$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().optional(),
-  external_id: z.string().optional(),
-  workspace_id: z.string().optional(),
+  _id: z.string(),
+  external_id: z.string(),
+  workspace_id: z.string(),
   display_name: z.string().optional(),
   email: z.string().optional(),
   avatar_url: z.string().optional(),
   tags: z.array(z.string()).optional(),
   metadata: z.lazy(() => Metadata$inboundSchema).optional(),
-  created: z.string().optional(),
-  updated: z.string().optional(),
+  created: z.string(),
+  updated: z.string(),
   metrics: IdentityMetrics$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/identitymetrics.ts

@@ -9,10 +9,22 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type IdentityMetrics = {
-  totalTokens?: number | undefined;
-  totalCost?: number | undefined;
-  totalRequests?: number | undefined;
-  errorRate?: number | undefined;
+  /**
+   * Total token count attributed to the identity.
+   */
+  totalTokens: number;
+  /**
+   * Total cost attributed to the identity.
+   */
+  totalCost: number;
+  /**
+   * Total request count attributed to the identity.
+   */
+  totalRequests: number;
+  /**
+   * Fraction of attributed requests that failed.
+   */
+  errorRate: number;
 };
 
 /** @internal */
@@ -21,10 +33,10 @@ export const IdentityMetrics$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  total_tokens: z.number().optional(),
-  total_cost: z.number().optional(),
-  total_requests: z.number().optional(),
-  error_rate: z.number().optional(),
+  total_tokens: z.number(),
+  total_cost: z.number(),
+  total_requests: z.number(),
+  error_rate: z.number(),
 }).transform((v) => {
   return remap$(v, {
     "total_tokens": "totalTokens",