@orq-ai/node 4.11.0-rc.9 → 4.12.0-rc.1

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

@@ -0,0 +1,69 @@
+/*
+ * 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 {
+  ManagementPermissionMode,
+  ManagementPermissionMode$outboundSchema,
+} from "./managementpermissionmode.js";
+
+export type CreateManagementKeyRequest = {
+  /**
+   * Human-readable name. Required.
+   */
+  name: string;
+  permissionMode?: ManagementPermissionMode | undefined;
+  /**
+   * Per-domain access map. Required when `permission_mode` =
+   *
+   * @remarks
+   *  `MANAGEMENT_PERMISSION_MODE_RESTRICTED`. See `ManagementKey.access`
+   *  for the catalog of valid keys (Domain.id) and AccessLevel string
+   *  values, or fetch the live catalog via the capability catalog
+   *  endpoint.
+   */
+  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 CreateManagementKeyRequest$Outbound = {
+  name: string;
+  permission_mode?: string | undefined;
+  access?: { [k: string]: number } | undefined;
+  expires_at?: string | undefined;
+};
+
+/** @internal */
+export const CreateManagementKeyRequest$outboundSchema: z.ZodType<
+  CreateManagementKeyRequest$Outbound,
+  z.ZodTypeDef,
+  CreateManagementKeyRequest
+> = z.object({
+  name: z.string(),
+  permissionMode: ManagementPermissionMode$outboundSchema.optional(),
+  access: z.record(z.number().int()).optional(),
+  expiresAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    permissionMode: "permission_mode",
+    expiresAt: "expires_at",
+  });
+});
+
+export function createManagementKeyRequestToJSON(
+  createManagementKeyRequest: CreateManagementKeyRequest,
+): string {
+  return JSON.stringify(
+    CreateManagementKeyRequest$outboundSchema.parse(createManagementKeyRequest),
+  );
+}

package/src/models/components/createmanagementkeyresponse.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 { ManagementKey, ManagementKey$inboundSchema } from "./managementkey.js";
+
+export type CreateManagementKeyResponse = {
+  /**
+   * Newly minted management-key record.
+   */
+  managementKey: ManagementKey;
+  /**
+   * Raw bearer token in the form `sk-orq-<management_key_id>-<secret>`.
+   *
+   * @remarks
+   *  Returned ONCE; the API never exposes this value again.
+   */
+  token: string;
+};
+
+/** @internal */
+export const CreateManagementKeyResponse$inboundSchema: z.ZodType<
+  CreateManagementKeyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  management_key: ManagementKey$inboundSchema,
+  token: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "management_key": "managementKey",
+  });
+});
+
+export function createManagementKeyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateManagementKeyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateManagementKeyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateManagementKeyResponse' from JSON`,
+  );
+}