@orq-ai/node 4.11.0-rc.3 → 4.11.0-rc.31

package/src/models/components/budgetscope.ts

@@ -0,0 +1,150 @@
+/*
+ * 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 {
+  ApiKeyBudgetScope,
+  ApiKeyBudgetScope$inboundSchema,
+  ApiKeyBudgetScope$Outbound,
+  ApiKeyBudgetScope$outboundSchema,
+} from "./apikeybudgetscope.js";
+import {
+  IdentityBudgetScope,
+  IdentityBudgetScope$inboundSchema,
+  IdentityBudgetScope$Outbound,
+  IdentityBudgetScope$outboundSchema,
+} from "./identitybudgetscope.js";
+import {
+  ModelBudgetScope,
+  ModelBudgetScope$inboundSchema,
+  ModelBudgetScope$Outbound,
+  ModelBudgetScope$outboundSchema,
+} from "./modelbudgetscope.js";
+import {
+  ProjectBudgetScope,
+  ProjectBudgetScope$inboundSchema,
+  ProjectBudgetScope$Outbound,
+  ProjectBudgetScope$outboundSchema,
+} from "./projectbudgetscope.js";
+import {
+  ProviderBudgetScope,
+  ProviderBudgetScope$inboundSchema,
+  ProviderBudgetScope$Outbound,
+  ProviderBudgetScope$outboundSchema,
+} from "./providerbudgetscope.js";
+import {
+  WorkspaceBudgetScope,
+  WorkspaceBudgetScope$inboundSchema,
+  WorkspaceBudgetScope$Outbound,
+  WorkspaceBudgetScope$outboundSchema,
+} from "./workspacebudgetscope.js";
+
+/**
+ * BudgetScope is a closed oneof. Exactly one variant must be set. The
+ *
+ * @remarks
+ *  six variants are ordered by enforcement precedence (most specific to
+ *  most general) and mirror the BudgetScopeKind filter enum.
+ */
+export type BudgetScope = {
+  /**
+   * Workspace-wide ceiling. The implicit target is the caller's workspace.
+   */
+  workspace?: WorkspaceBudgetScope | undefined;
+  /**
+   * Per-project cap.
+   */
+  project?: ProjectBudgetScope | undefined;
+  /**
+   * Per-identity cap. Keyed by the contact's external_id (not the
+   *
+   * @remarks
+   *  internal Mongo `_id`) so the scope is stable across imports.
+   */
+  identity?: IdentityBudgetScope | undefined;
+  /**
+   * Per-api-key cap. Replaces the legacy embedded `constraints.budget`
+   *
+   * @remarks
+   *  on auth.apiKeys.
+   */
+  apiKey?: ApiKeyBudgetScope | undefined;
+  /**
+   * Per-provider cap. The value is the provider enum string (e.g.
+   *
+   * @remarks
+   *  "openai", "anthropic") drawn from ModelIntegrationIdentifier.
+   */
+  provider?: ProviderBudgetScope | undefined;
+  /**
+   * Per-model cap. The value is the FULL model reference as callers send
+   *
+   * @remarks
+   *  it ("openai/gpt-4o", or "workspaceKey@openai/gpt-4o" for private
+   *  models) — NOT the Mongo `_id` of the model master-data document.
+   */
+  model?: ModelBudgetScope | undefined;
+};
+
+/** @internal */
+export const BudgetScope$inboundSchema: z.ZodType<
+  BudgetScope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  workspace: WorkspaceBudgetScope$inboundSchema.optional(),
+  project: ProjectBudgetScope$inboundSchema.optional(),
+  identity: IdentityBudgetScope$inboundSchema.optional(),
+  api_key: ApiKeyBudgetScope$inboundSchema.optional(),
+  provider: ProviderBudgetScope$inboundSchema.optional(),
+  model: ModelBudgetScope$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_key": "apiKey",
+  });
+});
+/** @internal */
+export type BudgetScope$Outbound = {
+  workspace?: WorkspaceBudgetScope$Outbound | undefined;
+  project?: ProjectBudgetScope$Outbound | undefined;
+  identity?: IdentityBudgetScope$Outbound | undefined;
+  api_key?: ApiKeyBudgetScope$Outbound | undefined;
+  provider?: ProviderBudgetScope$Outbound | undefined;
+  model?: ModelBudgetScope$Outbound | undefined;
+};
+
+/** @internal */
+export const BudgetScope$outboundSchema: z.ZodType<
+  BudgetScope$Outbound,
+  z.ZodTypeDef,
+  BudgetScope
+> = z.object({
+  workspace: WorkspaceBudgetScope$outboundSchema.optional(),
+  project: ProjectBudgetScope$outboundSchema.optional(),
+  identity: IdentityBudgetScope$outboundSchema.optional(),
+  apiKey: ApiKeyBudgetScope$outboundSchema.optional(),
+  provider: ProviderBudgetScope$outboundSchema.optional(),
+  model: ModelBudgetScope$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKey: "api_key",
+  });
+});
+
+export function budgetScopeToJSON(budgetScope: BudgetScope): string {
+  return JSON.stringify(BudgetScope$outboundSchema.parse(budgetScope));
+}
+export function budgetScopeFromJSON(
+  jsonString: string,
+): SafeParseResult<BudgetScope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BudgetScope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BudgetScope' from JSON`,
+  );
+}

package/src/models/components/budgetscopekind.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const BudgetScopeKind = {
+  BudgetScopeKindUnspecified: "BUDGET_SCOPE_KIND_UNSPECIFIED",
+  BudgetScopeKindWorkspace: "BUDGET_SCOPE_KIND_WORKSPACE",
+  BudgetScopeKindProject: "BUDGET_SCOPE_KIND_PROJECT",
+  BudgetScopeKindIdentity: "BUDGET_SCOPE_KIND_IDENTITY",
+  BudgetScopeKindApiKey: "BUDGET_SCOPE_KIND_API_KEY",
+  BudgetScopeKindProvider: "BUDGET_SCOPE_KIND_PROVIDER",
+  BudgetScopeKindModel: "BUDGET_SCOPE_KIND_MODEL",
+} as const;
+export type BudgetScopeKind = ClosedEnum<typeof BudgetScopeKind>;
+
+/** @internal */
+export const BudgetScopeKind$outboundSchema: z.ZodNativeEnum<
+  typeof BudgetScopeKind
+> = z.nativeEnum(BudgetScopeKind);

package/src/models/components/budgetsortfield.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const BudgetSortField = {
+  BudgetSortFieldUnspecified: "BUDGET_SORT_FIELD_UNSPECIFIED",
+  BudgetSortFieldExpiresAt: "BUDGET_SORT_FIELD_EXPIRES_AT",
+  BudgetSortFieldCreatedAt: "BUDGET_SORT_FIELD_CREATED_AT",
+  BudgetSortFieldUpdatedAt: "BUDGET_SORT_FIELD_UPDATED_AT",
+} as const;
+export type BudgetSortField = ClosedEnum<typeof BudgetSortField>;
+
+/** @internal */
+export const BudgetSortField$outboundSchema: z.ZodNativeEnum<
+  typeof BudgetSortField
+> = z.nativeEnum(BudgetSortField);

package/src/models/components/budgetusage.ts

@@ -0,0 +1,54 @@
+/*
+ * 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";
+
+/**
+ * BudgetUsage is the current-period consumption of a budget, sourced
+ *
+ * @remarks
+ *  from the live Redis counters (not the exact ledger). Each dimension is
+ *  the consumed side of the matching limit dimension: `amount` is the
+ *  accumulated cost in USD (vs limits.amount), `tokens` is the accumulated
+ *  token count (vs limits.token_limit), and `requests` is the count in the
+ *  rolling 60-second window (vs rate_limit.requests_per_minute). All three
+ *  are explicit-presence so the triple is always emitted in full, zeros
+ *  included — a never-spent budget serializes {amount:0, tokens:0,
+ *  requests:0} rather than dropping its zero dimensions.
+ */
+export type BudgetUsage = {
+  amount?: number | undefined;
+  /**
+   * Carried as a double (not int64) so it serializes as a JSON number
+   *
+   * @remarks
+   *  rather than a quoted string, matching limits.token_limit.
+   */
+  tokens?: number | undefined;
+  requests?: number | undefined;
+};
+
+/** @internal */
+export const BudgetUsage$inboundSchema: z.ZodType<
+  BudgetUsage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.number().optional(),
+  tokens: z.number().optional(),
+  requests: z.number().int().optional(),
+});
+
+export function budgetUsageFromJSON(
+  jsonString: string,
+): SafeParseResult<BudgetUsage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BudgetUsage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BudgetUsage' from JSON`,
+  );
+}

package/src/models/components/checkbudgetsrequest.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+/**
+ * Request metadata forwarded for dynamic-budget matching
+ *
+ * @remarks
+ *  (`metadata.team == "ml"`). Free-form JSON object from the request
+ *  body's `metadata` field.
+ */
+export type Metadata = {};
+
+export type CheckBudgetsRequest = {
+  /**
+   * API key that issued the request (if any).
+   */
+  apiKeyId?: string | undefined;
+  /**
+   * Project the request targets (if any).
+   */
+  projectId?: string | undefined;
+  /**
+   * Identity external id for contact-scoped budgets (if any).
+   */
+  identityExternalId?: string | undefined;
+  /**
+   * Provider enum value for provider-scoped budgets (if any).
+   */
+  provider?: string | undefined;
+  /**
+   * Full model reference for model-scoped budgets (if any), exactly as
+   *
+   * @remarks
+   *  the caller sent it: "provider/model" or "workspaceKey@provider/model".
+   */
+  modelId?: string | undefined;
+  /**
+   * Request metadata forwarded for dynamic-budget matching
+   *
+   * @remarks
+   *  (`metadata.team == "ml"`). Free-form JSON object from the request
+   *  body's `metadata` field.
+   */
+  metadata?: Metadata | undefined;
+  /**
+   * Request headers (lowercase keys) forwarded for dynamic-budget
+   *
+   * @remarks
+   *  matching (`headers["x-env"] == "prod"`).
+   */
+  headers?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export type Metadata$Outbound = {};
+
+/** @internal */
+export const Metadata$outboundSchema: z.ZodType<
+  Metadata$Outbound,
+  z.ZodTypeDef,
+  Metadata
+> = z.object({});
+
+export function metadataToJSON(metadata: Metadata): string {
+  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
+}
+
+/** @internal */
+export type CheckBudgetsRequest$Outbound = {
+  api_key_id?: string | undefined;
+  project_id?: string | undefined;
+  identity_external_id?: string | undefined;
+  provider?: string | undefined;
+  model_id?: string | undefined;
+  metadata?: Metadata$Outbound | undefined;
+  headers?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const CheckBudgetsRequest$outboundSchema: z.ZodType<
+  CheckBudgetsRequest$Outbound,
+  z.ZodTypeDef,
+  CheckBudgetsRequest
+> = z.object({
+  apiKeyId: z.string().optional(),
+  projectId: z.string().optional(),
+  identityExternalId: z.string().optional(),
+  provider: z.string().optional(),
+  modelId: z.string().optional(),
+  metadata: z.lazy(() => Metadata$outboundSchema).optional(),
+  headers: z.record(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKeyId: "api_key_id",
+    projectId: "project_id",
+    identityExternalId: "identity_external_id",
+    modelId: "model_id",
+  });
+});
+
+export function checkBudgetsRequestToJSON(
+  checkBudgetsRequest: CheckBudgetsRequest,
+): string {
+  return JSON.stringify(
+    CheckBudgetsRequest$outboundSchema.parse(checkBudgetsRequest),
+  );
+}

package/src/models/components/checkbudgetsresponse.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 {
+  BudgetRejection,
+  BudgetRejection$inboundSchema,
+} from "./budgetrejection.js";
+import { DimensionInfo, DimensionInfo$inboundSchema } from "./dimensioninfo.js";
+
+export type CheckBudgetsResponse = {
+  /**
+   * True when no applicable budget exceeds its limit.
+   */
+  allowed?: boolean | undefined;
+  /**
+   * Populated when allowed is false; identifies which budget and
+   *
+   * @remarks
+   *  dimension triggered the rejection.
+   */
+  rejection?: BudgetRejection | undefined;
+  /**
+   * Cost dimension info for rate-limit headers (nil when no cost budget applies).
+   */
+  cost?: DimensionInfo | undefined;
+  /**
+   * Token dimension info for rate-limit headers (nil when no token budget applies).
+   */
+  tokens?: DimensionInfo | undefined;
+  /**
+   * Requests dimension info for rate-limit headers (nil when no RPM budget applies).
+   */
+  requests?: DimensionInfo | undefined;
+};
+
+/** @internal */
+export const CheckBudgetsResponse$inboundSchema: z.ZodType<
+  CheckBudgetsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  allowed: z.boolean().optional(),
+  rejection: BudgetRejection$inboundSchema.optional(),
+  cost: DimensionInfo$inboundSchema.optional(),
+  tokens: DimensionInfo$inboundSchema.optional(),
+  requests: DimensionInfo$inboundSchema.optional(),
+});
+
+export function checkBudgetsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckBudgetsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CheckBudgetsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckBudgetsResponse' from JSON`,
+  );
+}

package/src/models/components/createbudgetrequest.ts

@@ -0,0 +1,109 @@
+/*
+ * 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 {
+  BudgetLimits,
+  BudgetLimits$Outbound,
+  BudgetLimits$outboundSchema,
+} from "./budgetlimits.js";
+import {
+  BudgetMatch,
+  BudgetMatch$Outbound,
+  BudgetMatch$outboundSchema,
+} from "./budgetmatch.js";
+import {
+  BudgetScope,
+  BudgetScope$Outbound,
+  BudgetScope$outboundSchema,
+} from "./budgetscope.js";
+import {
+  RateLimit,
+  RateLimit$Outbound,
+  RateLimit$outboundSchema,
+} from "./ratelimit.js";
+
+export type CreateBudgetRequest = {
+  /**
+   * Structured scope. Mutually exclusive with `match`: provide a scope
+   *
+   * @remarks
+   *  for the six canonical kinds (the server derives the matching CEL),
+   *  or provide `match` for a dynamic budget. Exactly one of the two
+   *  must be set; the handler enforces that invariant.
+   */
+  scope?: BudgetScope | undefined;
+  /**
+   * Raw CEL matching expression for dynamic budgets (e.g.
+   *
+   * @remarks
+   *  `metadata.team == "ml" && provider == "openai"`). Validated via
+   *  CEL parse at write time. Mutually exclusive with `scope`.
+   */
+  match?: BudgetMatch | undefined;
+  /**
+   * At least one of amount / token_limit / rate_limit.requests_per_minute
+   *
+   * @remarks
+   *  must be provided on the budget; the handler enforces that invariant.
+   */
+  limits?: BudgetLimits | undefined;
+  /**
+   * Optional rate limit.
+   */
+  rateLimit?: RateLimit | undefined;
+  /**
+   * Whether the budget should be active immediately. Defaults to true
+   *
+   * @remarks
+   *  when omitted (handler enforces).
+   */
+  isActive?: boolean | undefined;
+  /**
+   * Optional expiration. When set in combination with is_active=true,
+   *
+   * @remarks
+   *  the value MUST be in the future; the handler rejects past values.
+   */
+  expiresAt?: Date | undefined;
+};
+
+/** @internal */
+export type CreateBudgetRequest$Outbound = {
+  scope?: BudgetScope$Outbound | undefined;
+  match?: BudgetMatch$Outbound | undefined;
+  limits?: BudgetLimits$Outbound | undefined;
+  rate_limit?: RateLimit$Outbound | undefined;
+  is_active?: boolean | undefined;
+  expires_at?: string | undefined;
+};
+
+/** @internal */
+export const CreateBudgetRequest$outboundSchema: z.ZodType<
+  CreateBudgetRequest$Outbound,
+  z.ZodTypeDef,
+  CreateBudgetRequest
+> = z.object({
+  scope: BudgetScope$outboundSchema.optional(),
+  match: BudgetMatch$outboundSchema.optional(),
+  limits: BudgetLimits$outboundSchema.optional(),
+  rateLimit: RateLimit$outboundSchema.optional(),
+  isActive: z.boolean().optional(),
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    rateLimit: "rate_limit",
+    isActive: "is_active",
+    expiresAt: "expires_at",
+  });
+});
+
+export function createBudgetRequestToJSON(
+  createBudgetRequest: CreateBudgetRequest,
+): string {
+  return JSON.stringify(
+    CreateBudgetRequest$outboundSchema.parse(createBudgetRequest),
+  );
+}

package/src/models/components/createbudgetresponse.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { Budget, Budget$inboundSchema } from "./budget.js";
+
+export type CreateBudgetResponse = {
+  /**
+   * Newly created budget.
+   */
+  budget?: Budget | undefined;
+};
+
+/** @internal */
+export const CreateBudgetResponse$inboundSchema: z.ZodType<
+  CreateBudgetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  budget: Budget$inboundSchema.optional(),
+});
+
+export function createBudgetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateBudgetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateBudgetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateBudgetResponse' from JSON`,
+  );
+}

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

package/src/models/components/dimensioninfo.ts

@@ -0,0 +1,43 @@
+/*
+ * 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";
+
+/**
+ * DimensionInfo carries limit/remaining/reset for a single dimension.
+ */
+export type DimensionInfo = {
+  limit?: number | undefined;
+  remaining?: number | undefined;
+  resetSeconds?: number | undefined;
+};
+
+/** @internal */
+export const DimensionInfo$inboundSchema: z.ZodType<
+  DimensionInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  limit: z.number().optional(),
+  remaining: z.number().optional(),
+  reset_seconds: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "reset_seconds": "resetSeconds",
+  });
+});
+
+export function dimensionInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<DimensionInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DimensionInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DimensionInfo' from JSON`,
+  );
+}