@orq-ai/node 4.13.0-rc.52 → 4.13.0-rc.57

package/src/models/components/apikey.ts

@@ -1,304 +0,0 @@
-/*
- * 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 { ApiKeyOwner, ApiKeyOwner$inboundSchema } from "./apikeyowner.js";
-import { ApiKeyStatus, ApiKeyStatus$inboundSchema } from "./apikeystatus.js";
-import { BudgetAlert, BudgetAlert$inboundSchema } from "./budgetalert.js";
-import { BudgetLimits, BudgetLimits$inboundSchema } from "./budgetlimits.js";
-import { BudgetMatch, BudgetMatch$inboundSchema } from "./budgetmatch.js";
-import { BudgetScope, BudgetScope$inboundSchema } from "./budgetscope.js";
-import { BudgetUsage, BudgetUsage$inboundSchema } from "./budgetusage.js";
-import {
-  LegacyTokenFamily,
-  LegacyTokenFamily$inboundSchema,
-} from "./legacytokenfamily.js";
-import { McpAccess, McpAccess$inboundSchema } from "./mcpaccess.js";
-import {
-  PermissionMode,
-  PermissionMode$inboundSchema,
-} from "./permissionmode.js";
-import { ProjectScope, ProjectScope$inboundSchema } from "./projectscope.js";
-import { RateLimit, RateLimit$inboundSchema } from "./ratelimit.js";
-
-/**
- * The budget scoped to this api-key, if one exists. Read-only here:
- *
- * @remarks
- *  budgets are created and managed through the Budgets API
- *  (scope.api_key). Populated only when the read request sets
- *  `include_budget`. Live consumption (`usage`) is not attached on this
- *  path — call the Budgets API for current spend.
- */
-export type ApiKeyBudget = {
-  budgetId?: string | undefined;
-  /**
-   * Denormalized metadata for UI rendering, list filters, and the
-   *
-   * @remarks
-   *  resolver's prefilter index. Never consulted for matching — the
-   *  `match` expression is the single source of matching semantics.
-   *  Unset for budgets created from a raw CEL expression ("custom").
-   */
-  scope?: BudgetScope | undefined;
-  /**
-   * The matching semantics of the budget. The enforcement resolver
-   *
-   * @remarks
-   *  evaluates `match.cel` against the request context; a budget
-   *  applies to a request if and only if the expression evaluates to
-   *  true. Scoped creates derive a canonical expression (e.g.
-   *  `provider == "openai"`); an empty expression always matches
-   *  (workspace-wide).
-   */
-  match?: BudgetMatch | undefined;
-  /**
-   * BudgetLimits is the per-period spend and token ceiling. At least one
-   *
-   * @remarks
-   *  of `amount`, `token_limit`, or RateLimit.requests_per_minute MUST be
-   *  set on a Budget; that invariant is enforced by the handler.
-   */
-  limits?: BudgetLimits | undefined;
-  /**
-   * RateLimit is the per-minute request ceiling. Enforced via atomic
-   *
-   * @remarks
-   *  increment-first semantics in the enforcement middleware.
-   */
-  rateLimit?: RateLimit | undefined;
-  isActive?: boolean | undefined;
-  expiresAt?: Date | undefined;
-  createdAt?: Date | undefined;
-  updatedAt?: Date | undefined;
-  /**
-   * Live consumption for the current period, read from the Redis
-   *
-   * @remarks
-   *  counters the enforcement gate maintains. Populated by read paths
-   *  (Get / List); omitted on write responses (Create / Update / Reset)
-   *  where it carries no signal. Absent or all-zero for a budget that
-   *  has not been spent against in the current period.
-   */
-  usage?: BudgetUsage | undefined;
-  /**
-   * Threshold notifications. Absent when the budget has none.
-   */
-  alerts?: Array<BudgetAlert> | undefined;
-};
-
-/**
- * ApiKey is the canonical record stored in MongoDB `auth.apiKeys`.
- *
- * @remarks
- *  It is the source of truth for scope, permissions, owner, budget,
- *  expiration, and revocation (see ADR 0001).
- */
-export type ApiKey = {
-  /**
-   * Canonical key identifier (ULID). Embedded in opaque tokens as
-   *
-   * @remarks
-   *  `sk-orq-<id>-<secret>`.
-   */
-  apiKeyId: string;
-  /**
-   * Human-readable name shown in the dashboard.
-   */
-  name: string;
-  /**
-   * Owner attribution (drives lifecycle).
-   */
-  owner: ApiKeyOwner;
-  /**
-   * Project authorization scope.
-   */
-  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 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
-   *  list. The ids are intentionally not duplicated here to avoid drift.
-   *
-   *  Values are AccessLevel enum names on the JSON wire:
-   *    "ACCESS_LEVEL_NONE"  — capability not granted
-   *    "ACCESS_LEVEL_READ"  — list / view verbs
-   *    "ACCESS_LEVEL_WRITE" — list / view + mutating / execute verbs
-   */
-  access?: { [k: string]: number } | undefined;
-  /**
-   * Displayable prefix for UI listings (e.g. "sk-orq-01HXY..."). Safe
-   *
-   * @remarks
-   *  to expose.
-   */
-  tokenPrefix: string;
-  status: ApiKeyStatus;
-  /**
-   * Audit: user who created the key. Optional. Distinct from
-   *
-   * @remarks
-   *  `owner.user_id` — created_by is provenance only, while owner
-   *  determines lifecycle binding.
-   */
-  createdById?: string | undefined;
-  /**
-   * Audit: user who last updated the key.
-   */
-  updatedById?: string | undefined;
-  /**
-   * Time the key was created.
-   */
-  createdAt: Date;
-  /**
-   * Time the key was last updated.
-   */
-  updatedAt: Date;
-  /**
-   * Last authenticated use. Updated via NATS debounce + 1% sampler.
-   */
-  lastUsedAt?: Date | undefined;
-  /**
-   * Optional expiration. The authenticate hot-path rejects keys whose
-   *
-   * @remarks
-   *  `expires_at` is in the past. Unset means the key never expires.
-   */
-  expiresAt?: Date | undefined;
-  legacyTokenFamily?: LegacyTokenFamily | undefined;
-  /**
-   * Legacy MongoDB `_id` from before the canonical ULID was assigned.
-   *
-   * @remarks
-   *  Used by the adapter to resolve a JWT back to this canonical record.
-   */
-  legacyKeyId?: string | undefined;
-  /**
-   * The budget scoped to this api-key, if one exists. Read-only here:
-   *
-   * @remarks
-   *  budgets are created and managed through the Budgets API
-   *  (scope.api_key). Populated only when the read request sets
-   *  `include_budget`. Live consumption (`usage`) is not attached on this
-   *  path — call the Budgets API for current spend.
-   */
-  budget?: ApiKeyBudget | undefined;
-  /**
-   * Optional MCP-gateway access restriction. Unset means the key can
-   *
-   * @remarks
-   *  reach every MCP gateway allowed by its project scope. See
-   *  McpAccess for the deny_all / allow-list semantics.
-   */
-  mcpAccess?: McpAccess | undefined;
-};
-
-/** @internal */
-export const ApiKeyBudget$inboundSchema: z.ZodType<
-  ApiKeyBudget,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  budget_id: z.string().optional(),
-  scope: BudgetScope$inboundSchema.optional(),
-  match: BudgetMatch$inboundSchema.optional(),
-  limits: BudgetLimits$inboundSchema.optional(),
-  rate_limit: RateLimit$inboundSchema.optional(),
-  is_active: z.boolean().optional(),
-  expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .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(),
-  usage: BudgetUsage$inboundSchema.optional(),
-  alerts: z.array(BudgetAlert$inboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "budget_id": "budgetId",
-    "rate_limit": "rateLimit",
-    "is_active": "isActive",
-    "expires_at": "expiresAt",
-    "created_at": "createdAt",
-    "updated_at": "updatedAt",
-  });
-});
-
-export function apiKeyBudgetFromJSON(
-  jsonString: string,
-): SafeParseResult<ApiKeyBudget, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ApiKeyBudget$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ApiKeyBudget' from JSON`,
-  );
-}
-
-/** @internal */
-export const ApiKey$inboundSchema: z.ZodType<ApiKey, z.ZodTypeDef, unknown> = z
-  .object({
-    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(),
-    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)
-    ),
-    updated_at: z.string().datetime({ offset: true }).transform(v =>
-      new Date(v)
-    ),
-    last_used_at: z.string().datetime({ offset: true }).transform(v =>
-      new Date(v)
-    ).optional(),
-    expires_at: z.string().datetime({ offset: true }).transform(v =>
-      new Date(v)
-    ).optional(),
-    legacy_token_family: LegacyTokenFamily$inboundSchema.optional(),
-    legacy_key_id: z.string().optional(),
-    budget: z.lazy(() => ApiKeyBudget$inboundSchema).optional(),
-    mcp_access: McpAccess$inboundSchema.optional(),
-  }).transform((v) => {
-    return remap$(v, {
-      "api_key_id": "apiKeyId",
-      "project_scope": "projectScope",
-      "permission_mode": "permissionMode",
-      "token_prefix": "tokenPrefix",
-      "created_by_id": "createdById",
-      "updated_by_id": "updatedById",
-      "created_at": "createdAt",
-      "updated_at": "updatedAt",
-      "last_used_at": "lastUsedAt",
-      "expires_at": "expiresAt",
-      "legacy_token_family": "legacyTokenFamily",
-      "legacy_key_id": "legacyKeyId",
-      "mcp_access": "mcpAccess",
-    });
-  });
-
-export function apiKeyFromJSON(
-  jsonString: string,
-): SafeParseResult<ApiKey, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ApiKey$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ApiKey' from JSON`,
-  );
-}

package/src/models/components/createapikeyresponse.ts

@@ -1,49 +0,0 @@
-/*
- * 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;
-  /**
-   * 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;
-};
-
-/** @internal */
-export const CreateApiKeyResponse$inboundSchema: z.ZodType<
-  CreateApiKeyResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  api_key: ApiKey$inboundSchema,
-  token: z.string(),
-}).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/deleteapikeyresponse.ts

@@ -1,27 +0,0 @@
-/*
- * 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/getapikeyresponse.ts

@@ -1,40 +0,0 @@
-/*
- * 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 GetApiKeyResponse = {
-  /**
-   * Requested api-key. Raw token never included.
-   */
-  apiKey: ApiKey;
-};
-
-/** @internal */
-export const GetApiKeyResponse$inboundSchema: z.ZodType<
-  GetApiKeyResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  api_key: ApiKey$inboundSchema,
-}).transform((v) => {
-  return remap$(v, {
-    "api_key": "apiKey",
-  });
-});
-
-export function getApiKeyResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<GetApiKeyResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetApiKeyResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetApiKeyResponse' from JSON`,
-  );
-}

package/src/models/components/legacytokenfamily.ts

@@ -1,19 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const LegacyTokenFamily = {
-  LegacyTokenFamilyUnspecified: "LEGACY_TOKEN_FAMILY_UNSPECIFIED",
-  LegacyTokenFamilyRouterJwt: "LEGACY_TOKEN_FAMILY_ROUTER_JWT",
-  LegacyTokenFamilyProjectJwt: "LEGACY_TOKEN_FAMILY_PROJECT_JWT",
-  LegacyTokenFamilyWorkspaceJwt: "LEGACY_TOKEN_FAMILY_WORKSPACE_JWT",
-} as const;
-export type LegacyTokenFamily = ClosedEnum<typeof LegacyTokenFamily>;
-
-/** @internal */
-export const LegacyTokenFamily$inboundSchema: z.ZodNativeEnum<
-  typeof LegacyTokenFamily
-> = z.nativeEnum(LegacyTokenFamily);

package/src/models/components/listapikeysresponse.ts

@@ -1,56 +0,0 @@
-/*
- * 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 ListApiKeysResponse = {
-  /**
-   * Object discriminator for list responses; always `list`.
-   */
-  object: string;
-  /**
-   * Page of api-keys, ordered newest first. `token_hash` and
-   *
-   * @remarks
-   *  `api_key` are always elided in list responses.
-   */
-  data: Array<ApiKey>;
-  /**
-   * Whether more api-keys are available in the selected pagination
-   *
-   * @remarks
-   *  direction.
-   */
-  hasMore: boolean;
-};
-
-/** @internal */
-export const ListApiKeysResponse$inboundSchema: z.ZodType<
-  ListApiKeysResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  object: z.string(),
-  data: z.array(ApiKey$inboundSchema),
-  has_more: z.boolean(),
-}).transform((v) => {
-  return remap$(v, {
-    "has_more": "hasMore",
-  });
-});
-
-export function listApiKeysResponseFromJSON(
-  jsonString: string,
-): SafeParseResult<ListApiKeysResponse, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ListApiKeysResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ListApiKeysResponse' from JSON`,
-  );
-}

package/src/models/components/smartroutermetrics.ts

@@ -1,44 +0,0 @@
-/*
- * 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 SmartRouterMetrics = {
-  /**
-   * Total gateway requests served by the router over the window.
-   */
-  requests: number;
-  /**
-   * Total cost in USD attributed to the router over the window.
-   */
-  spend: number;
-  /**
-   * Requests per selected model, keyed by the provider/model reference.
-   */
-  traffic: { [k: string]: number };
-};
-
-/** @internal */
-export const SmartRouterMetrics$inboundSchema: z.ZodType<
-  SmartRouterMetrics,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  requests: z.number(),
-  spend: z.number(),
-  traffic: z.record(z.number()),
-});
-
-export function smartRouterMetricsFromJSON(
-  jsonString: string,
-): SafeParseResult<SmartRouterMetrics, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => SmartRouterMetrics$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SmartRouterMetrics' from JSON`,
-  );
-}

package/src/models/components/updateapikeyresponse.ts

@@ -1,40 +0,0 @@
-/*
- * 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;
-};
-
-/** @internal */
-export const UpdateApiKeyResponse$inboundSchema: z.ZodType<
-  UpdateApiKeyResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  api_key: ApiKey$inboundSchema,
-}).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`,
-  );
-}