@orq-ai/node 4.9.18 → 4.9.19

package/src/models/components/apikeyowner.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 {
+  ServiceAccountOwner,
+  ServiceAccountOwner$inboundSchema,
+  ServiceAccountOwner$Outbound,
+  ServiceAccountOwner$outboundSchema,
+} from "./serviceaccountowner.js";
+import {
+  UserOwner,
+  UserOwner$inboundSchema,
+  UserOwner$Outbound,
+  UserOwner$outboundSchema,
+} from "./userowner.js";
+
+/**
+ * Owner attribution drives lifecycle.
+ *
+ * @remarks
+ *
+ *  `service_account` keys are workspace-owned and outlive any individual
+ *  user. `user` keys are bound to `user_id`: when the user is removed,
+ *  disabled, or loses project access, the key is revoked / its scope
+ *  shrinks per the cascade rules in ADR 0001.
+ */
+export type ApiKeyOwner = {
+  user?: UserOwner | undefined;
+  serviceAccount?: ServiceAccountOwner | undefined;
+};
+
+/** @internal */
+export const ApiKeyOwner$inboundSchema: z.ZodType<
+  ApiKeyOwner,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  user: UserOwner$inboundSchema.optional(),
+  service_account: ServiceAccountOwner$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_account": "serviceAccount",
+  });
+});
+/** @internal */
+export type ApiKeyOwner$Outbound = {
+  user?: UserOwner$Outbound | undefined;
+  service_account?: ServiceAccountOwner$Outbound | undefined;
+};
+
+/** @internal */
+export const ApiKeyOwner$outboundSchema: z.ZodType<
+  ApiKeyOwner$Outbound,
+  z.ZodTypeDef,
+  ApiKeyOwner
+> = z.object({
+  user: UserOwner$outboundSchema.optional(),
+  serviceAccount: ServiceAccountOwner$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceAccount: "service_account",
+  });
+});
+
+export function apiKeyOwnerToJSON(apiKeyOwner: ApiKeyOwner): string {
+  return JSON.stringify(ApiKeyOwner$outboundSchema.parse(apiKeyOwner));
+}
+export function apiKeyOwnerFromJSON(
+  jsonString: string,
+): SafeParseResult<ApiKeyOwner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApiKeyOwner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApiKeyOwner' from JSON`,
+  );
+}

package/src/models/components/apikeystatus.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ApiKeyStatus = {
+  ApiKeyStatusUnspecified: "API_KEY_STATUS_UNSPECIFIED",
+  ApiKeyStatusActive: "API_KEY_STATUS_ACTIVE",
+  ApiKeyStatusDisabled: "API_KEY_STATUS_DISABLED",
+  ApiKeyStatusRevoked: "API_KEY_STATUS_REVOKED",
+} as const;
+export type ApiKeyStatus = ClosedEnum<typeof ApiKeyStatus>;
+
+/** @internal */
+export const ApiKeyStatus$inboundSchema: z.ZodNativeEnum<typeof ApiKeyStatus> =
+  z.nativeEnum(ApiKeyStatus);
+/** @internal */
+export const ApiKeyStatus$outboundSchema: z.ZodNativeEnum<typeof ApiKeyStatus> =
+  ApiKeyStatus$inboundSchema;

package/src/models/components/createapikeyrequest.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 {
+  ApiKeyOwner,
+  ApiKeyOwner$Outbound,
+  ApiKeyOwner$outboundSchema,
+} from "./apikeyowner.js";
+import {
+  PermissionMode,
+  PermissionMode$outboundSchema,
+} from "./permissionmode.js";
+import {
+  ProjectScope,
+  ProjectScope$Outbound,
+  ProjectScope$outboundSchema,
+} from "./projectscope.js";
+
+export type CreateApiKeyRequest = {
+  /**
+   * Human-readable name. Required.
+   */
+  name?: string | undefined;
+  /**
+   * Owner attribution. Defaults to service_account when omitted.
+   */
+  owner?: ApiKeyOwner | undefined;
+  /**
+   * Project authorization scope. Defaults to all-projects when omitted.
+   */
+  projectScope?: ProjectScope | undefined;
+  permissionMode?: PermissionMode | undefined;
+  /**
+   * Per-domain access map. Required when `permission_mode` =
+   *
+   * @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.
+   */
+  access?: { [k: string]: number } | undefined;
+  /**
+   * Optional expiration. When set, the authenticate hot-path rejects
+   *
+   * @remarks
+   *  the key once `expires_at` is in the past. Unset means the key
+   *  never expires.
+   */
+  expiresAt?: Date | undefined;
+};
+
+/** @internal */
+export type CreateApiKeyRequest$Outbound = {
+  name?: string | undefined;
+  owner?: ApiKeyOwner$Outbound | undefined;
+  project_scope?: ProjectScope$Outbound | undefined;
+  permission_mode?: string | undefined;
+  access?: { [k: string]: number } | undefined;
+  expires_at?: string | undefined;
+};
+
+/** @internal */
+export const CreateApiKeyRequest$outboundSchema: z.ZodType<
+  CreateApiKeyRequest$Outbound,
+  z.ZodTypeDef,
+  CreateApiKeyRequest
+> = z.object({
+  name: z.string().optional(),
+  owner: ApiKeyOwner$outboundSchema.optional(),
+  projectScope: ProjectScope$outboundSchema.optional(),
+  permissionMode: PermissionMode$outboundSchema.optional(),
+  access: z.record(z.number().int()).optional(),
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    projectScope: "project_scope",
+    permissionMode: "permission_mode",
+    expiresAt: "expires_at",
+  });
+});
+
+export function createApiKeyRequestToJSON(
+  createApiKeyRequest: CreateApiKeyRequest,
+): string {
+  return JSON.stringify(
+    CreateApiKeyRequest$outboundSchema.parse(createApiKeyRequest),
+  );
+}

package/src/models/components/createapikeyresponse.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 CreateApiKeyResponse = {
+  /**
+   * Newly minted api-key record.
+   */
+  apiKey?: ApiKey | undefined;
+  /**
+   * Raw bearer token in the form `sk-orq-<api_key_id>-<secret>`.
+   *
+   * @remarks
+   *  Returned ONCE; the API never exposes this value again. Clients
+   *  must persist it immediately on receipt.
+   */
+  token?: string | undefined;
+};
+
+/** @internal */
+export const CreateApiKeyResponse$inboundSchema: z.ZodType<
+  CreateApiKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  api_key: ApiKey$inboundSchema.optional(),
+  token: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_key": "apiKey",
+  });
+});
+
+export function createApiKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateApiKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateApiKeyResponse' from JSON`,
+  );
+}

package/src/models/components/createfilerequest.ts

@@ -4,20 +4,26 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
+import { FilePurpose, FilePurpose$outboundSchema } from "./filepurpose.js";
 
 export type CreateFileRequest = {
   filename?: string | undefined;
   content?: string | undefined;
-  purpose?: number | undefined;
+  purpose?: FilePurpose | undefined;
   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.
+   */
+  projectId?: string | undefined;
 };
 
 /** @internal */
 export type CreateFileRequest$Outbound = {
   filename?: string | undefined;
   content?: string | undefined;
-  purpose?: number | undefined;
+  purpose?: string | undefined;
   content_type?: string | undefined;
+  project_id?: string | undefined;
 };
 
 /** @internal */
@@ -28,11 +34,13 @@ export const CreateFileRequest$outboundSchema: z.ZodType<
 > = z.object({
   filename: z.string().optional(),
   content: z.string().optional(),
-  purpose: z.number().int().optional(),
+  purpose: FilePurpose$outboundSchema.optional(),
   contentType: z.string().optional(),
+  projectId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     contentType: "content_type",
+    projectId: "project_id",
   });
 });
 

package/src/models/components/createidentityrequest.ts

@@ -0,0 +1,76 @@
+/*
+ * 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 CreateIdentityRequestMetadata = {};
+
+export type CreateIdentityRequest = {
+  externalId?: string | undefined;
+  displayName?: string | undefined;
+  email?: string | undefined;
+  avatarUrl?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: CreateIdentityRequestMetadata | undefined;
+};
+
+/** @internal */
+export type CreateIdentityRequestMetadata$Outbound = {};
+
+/** @internal */
+export const CreateIdentityRequestMetadata$outboundSchema: z.ZodType<
+  CreateIdentityRequestMetadata$Outbound,
+  z.ZodTypeDef,
+  CreateIdentityRequestMetadata
+> = z.object({});
+
+export function createIdentityRequestMetadataToJSON(
+  createIdentityRequestMetadata: CreateIdentityRequestMetadata,
+): string {
+  return JSON.stringify(
+    CreateIdentityRequestMetadata$outboundSchema.parse(
+      createIdentityRequestMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateIdentityRequest$Outbound = {
+  external_id?: string | undefined;
+  display_name?: string | undefined;
+  email?: string | undefined;
+  avatar_url?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: CreateIdentityRequestMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateIdentityRequest$outboundSchema: z.ZodType<
+  CreateIdentityRequest$Outbound,
+  z.ZodTypeDef,
+  CreateIdentityRequest
+> = z.object({
+  externalId: z.string().optional(),
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  avatarUrl: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.lazy(() => CreateIdentityRequestMetadata$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function createIdentityRequestToJSON(
+  createIdentityRequest: CreateIdentityRequest,
+): string {
+  return JSON.stringify(
+    CreateIdentityRequest$outboundSchema.parse(createIdentityRequest),
+  );
+}

package/src/models/components/createidentityresponse.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 CreateIdentityResponse = {
+  identity?: Identity | undefined;
+};
+
+/** @internal */
+export const CreateIdentityResponse$inboundSchema: z.ZodType<
+  CreateIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identity: Identity$inboundSchema.optional(),
+});
+
+export function createIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/createprojectrequest.ts

@@ -5,7 +5,13 @@
 import * as z from "zod/v3";
 
 export type CreateProjectRequest = {
+  /**
+   * Project name. Names must be non-empty and at most 128 characters.
+   */
   name?: string | undefined;
+  /**
+   * Team identifiers to associate with the project.
+   */
   teams?: Array<string> | undefined;
 };
 

package/src/models/components/createprojectresponse.ts

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

package/src/models/components/createskillrequest.ts

@@ -6,11 +6,29 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 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;
+  /**
+   * Short human-readable summary of what the skill is for.
+   */
   description?: string | undefined;
+  /**
+   * Free-form labels for organizing the skill.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * Project path where the skill should be stored.
+   */
   path?: string | undefined;
+  /**
+   * Project that should contain the skill.
+   */
   projectId?: string | undefined;
+  /**
+   * Instruction body for the skill. Omit to create metadata first and fill instructions later.
+   */
   instructions?: string | undefined;
 };
 

package/src/models/components/createskillresponse.ts

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

package/src/models/components/datapoint.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 DataPoint = {
+  /**
+   * Bucket start in UTC, RFC 3339. Clients that need epoch ms can call
+   *
+   * @remarks
+   *  `Date.parse(timestamp)` or `new Date(timestamp).getTime()` —
+   *  returning the int64 in JSON would force a string (protojson rule)
+   *  and force callers to coerce anyway, so we ship ISO only.
+   */
+  timestamp?: Date | undefined;
+  /**
+   * Public breakdown labels for this bucket, keyed by group-by column.
+   *
+   * @remarks
+   *  Empty when no group-by was requested. Empty values are omitted so
+   *  the caller never has to special-case `""`.
+   */
+  dimensions?: { [k: string]: string } | undefined;
+  /**
+   * Metric values for this bucket. Single-metric requests carry one
+   *
+   * @remarks
+   *  entry keyed by the requested metric name (e.g. `"genai.cost"` →
+   *  `0.000495`). Bundle metrics carry one entry per field. Numbers are
+   *  pre-rounded to 10 significant digits to avoid IEEE-754 display
+   *  noise like `0.00009900000000000001`.
+   */
+  metrics?: { [k: string]: number } | undefined;
+};
+
+/** @internal */
+export const DataPoint$inboundSchema: z.ZodType<
+  DataPoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  dimensions: z.record(z.string()).optional(),
+  metrics: z.record(z.number()).optional(),
+});
+
+export function dataPointFromJSON(
+  jsonString: string,
+): SafeParseResult<DataPoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataPoint' from JSON`,
+  );
+}

package/src/models/components/deleteapikeyresponse.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 DeleteApiKeyResponse = {};
+
+/** @internal */
+export const DeleteApiKeyResponse$inboundSchema: z.ZodType<
+  DeleteApiKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function deleteApiKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteApiKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteApiKeyResponse' from JSON`,
+  );
+}

package/src/models/components/deleteidentityresponse.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 DeleteIdentityResponse = {};
+
+/** @internal */
+export const DeleteIdentityResponse$inboundSchema: z.ZodType<
+  DeleteIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function deleteIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/domain.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 { DomainGroup, DomainGroup$inboundSchema } from "./domaingroup.js";
+import { ScopeMode, ScopeMode$inboundSchema } from "./scopemode.js";
+
+/**
+ * Domain describes a permission domain that can be granted to an API
+ *
+ * @remarks
+ *  key. The capability catalog is the registry consulted by
+ *  ResolvePermissions() at authorize() time. Verbs are derived by
+ *  convention from `id` + `group` + `readable` / `writable` flags.
+ */
+export type Domain = {
+  /**
+   * Stable domain identifier (e.g. "agent", "chat_completions"). Used
+   *
+   * @remarks
+   *  as the key in ApiKey.access and as the verb prefix in resolved
+   *  permissions (e.g. agent.list, agent.view, agent.create).
+   */
+  id?: string | undefined;
+  /**
+   * Human-readable label for UI.
+   */
+  displayName?: string | undefined;
+  group?: DomainGroup | undefined;
+  /**
+   * Project scopes this domain may be granted under. A workspace-admin
+   *
+   * @remarks
+   *  domain like `member` is typically SCOPE_MODE_ALL only.
+   */
+  allowedScopes?: Array<ScopeMode> | undefined;
+  /**
+   * Whether this domain can be granted read access. When false the UI
+   *
+   * @remarks
+   *  disables the Read segment (e.g. write-only gateway endpoints).
+   */
+  readable?: boolean | undefined;
+  /**
+   * Whether this domain can be granted write access. When false the UI
+   *
+   * @remarks
+   *  disables the Write segment (e.g. read-only `model` listing).
+   */
+  writable?: boolean | undefined;
+};
+
+/** @internal */
+export const Domain$inboundSchema: z.ZodType<Domain, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    display_name: z.string().optional(),
+    group: DomainGroup$inboundSchema.optional(),
+    allowed_scopes: z.array(ScopeMode$inboundSchema).optional(),
+    readable: z.boolean().optional(),
+    writable: z.boolean().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "display_name": "displayName",
+      "allowed_scopes": "allowedScopes",
+    });
+  });
+
+export function domainFromJSON(
+  jsonString: string,
+): SafeParseResult<Domain, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Domain$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Domain' from JSON`,
+  );
+}

package/src/models/components/domaingroup.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const DomainGroup = {
+  DomainGroupUnspecified: "DOMAIN_GROUP_UNSPECIFIED",
+  DomainGroupWorkspaceAdmin: "DOMAIN_GROUP_WORKSPACE_ADMIN",
+  DomainGroupPlatform: "DOMAIN_GROUP_PLATFORM",
+  DomainGroupGateway: "DOMAIN_GROUP_GATEWAY",
+} as const;
+export type DomainGroup = ClosedEnum<typeof DomainGroup>;
+
+/** @internal */
+export const DomainGroup$inboundSchema: z.ZodNativeEnum<typeof DomainGroup> = z
+  .nativeEnum(DomainGroup);