@orq-ai/node 4.11.0-rc.6 → 4.11.0-rc.60

package/src/models/components/identity.ts

@@ -7,15 +7,82 @@ 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 { 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 {
   IdentityMetrics,
   IdentityMetrics$inboundSchema,
 } from "./identitymetrics.js";
+import { RateLimit, RateLimit$inboundSchema } from "./ratelimit.js";
 
 /**
  * Custom JSON metadata stored with the identity.
  */
-export type Metadata = {};
+export type IdentityMetadata = {};
+
+/**
+ * The budget scoped to this identity, if one exists. Read-only here:
+ *
+ * @remarks
+ *  budgets are created and managed through the Budgets API
+ *  (scope.identity). Present only when requested with `include_budget`.
+ *  Live consumption (`usage`) is not attached on this path — call the
+ *  Budgets API for current spend.
+ */
+export type IdentityBudget = {
+  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;
+};
 
 export type Identity = {
   /**
@@ -55,7 +122,7 @@ export type Identity = {
   /**
    * Custom JSON metadata stored with the identity.
    */
-  metadata?: Metadata | undefined;
+  metadata?: IdentityMetadata | undefined;
   /**
    * ISO timestamp for when the identity was created.
    */
@@ -71,22 +138,72 @@ export type Identity = {
    *  `include_metrics`.
    */
   metrics?: IdentityMetrics | undefined;
+  /**
+   * The budget scoped to this identity, if one exists. Read-only here:
+   *
+   * @remarks
+   *  budgets are created and managed through the Budgets API
+   *  (scope.identity). Present only when requested with `include_budget`.
+   *  Live consumption (`usage`) is not attached on this path — call the
+   *  Budgets API for current spend.
+   */
+  budget?: IdentityBudget | undefined;
 };
 
 /** @internal */
-export const Metadata$inboundSchema: z.ZodType<
-  Metadata,
+export const IdentityMetadata$inboundSchema: z.ZodType<
+  IdentityMetadata,
   z.ZodTypeDef,
   unknown
 > = z.object({});
 
-export function metadataFromJSON(
+export function identityMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<IdentityMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IdentityMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdentityMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const IdentityBudget$inboundSchema: z.ZodType<
+  IdentityBudget,
+  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(),
+}).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 identityBudgetFromJSON(
   jsonString: string,
-): SafeParseResult<Metadata, SDKValidationError> {
+): SafeParseResult<IdentityBudget, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Metadata' from JSON`,
+    (x) => IdentityBudget$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdentityBudget' from JSON`,
   );
 }
 
@@ -103,10 +220,11 @@ export const Identity$inboundSchema: z.ZodType<
   email: z.string().optional(),
   avatar_url: z.string().optional(),
   tags: z.array(z.string()).optional(),
-  metadata: z.lazy(() => Metadata$inboundSchema).optional(),
+  metadata: z.lazy(() => IdentityMetadata$inboundSchema).optional(),
   created: z.string(),
   updated: z.string(),
   metrics: IdentityMetrics$inboundSchema.optional(),
+  budget: z.lazy(() => IdentityBudget$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",

package/src/models/components/identitybudgetscope.ts

@@ -0,0 +1,66 @@
+/*
+ * 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";
+
+/**
+ * Per-identity cap. Keyed by the contact's external_id (not the
+ *
+ * @remarks
+ *  internal Mongo `_id`) so the scope is stable across imports.
+ */
+export type IdentityBudgetScope = {
+  identityExternalId?: string | undefined;
+};
+
+/** @internal */
+export const IdentityBudgetScope$inboundSchema: z.ZodType<
+  IdentityBudgetScope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identity_external_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "identity_external_id": "identityExternalId",
+  });
+});
+/** @internal */
+export type IdentityBudgetScope$Outbound = {
+  identity_external_id?: string | undefined;
+};
+
+/** @internal */
+export const IdentityBudgetScope$outboundSchema: z.ZodType<
+  IdentityBudgetScope$Outbound,
+  z.ZodTypeDef,
+  IdentityBudgetScope
+> = z.object({
+  identityExternalId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    identityExternalId: "identity_external_id",
+  });
+});
+
+export function identityBudgetScopeToJSON(
+  identityBudgetScope: IdentityBudgetScope,
+): string {
+  return JSON.stringify(
+    IdentityBudgetScope$outboundSchema.parse(identityBudgetScope),
+  );
+}
+export function identityBudgetScopeFromJSON(
+  jsonString: string,
+): SafeParseResult<IdentityBudgetScope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IdentityBudgetScope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IdentityBudgetScope' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -10,25 +10,42 @@ export * from "./agenthandedoffstreamingevent.js";
 export * from "./agentinactivestreamingevent.js";
 export * from "./agentmessagecreatedstreamingevent.js";
 export * from "./agentresponsemessage.js";
+export * from "./agentresponserequest.js";
 export * from "./agentstartedstreamingevent.js";
 export * from "./agentthoughtstreamingevent.js";
 export * from "./allprojects.js";
 export * from "./apikey.js";
+export * from "./apikeybudgetscope.js";
 export * from "./apikeyowner.js";
 export * from "./apikeystatus.js";
 export * from "./audiocontentpartschema.js";
 export * from "./autorouterconfig.js";
 export * from "./azurefoundrydeployment.js";
 export * from "./azurefoundrydeploymentmasterdata.js";
+export * from "./budget.js";
 export * from "./budgetlimit.js";
+export * from "./budgetlimits.js";
+export * from "./budgetmatch.js";
+export * from "./budgetperiod.js";
+export * from "./budgetrejection.js";
+export * from "./budgetscope.js";
+export * from "./budgetscopekind.js";
+export * from "./budgetsortfield.js";
+export * from "./budgetusage.js";
+export * from "./checkbudgetsrequest.js";
+export * from "./checkbudgetsresponse.js";
 export * from "./conversationparam.js";
 export * from "./createagentresponse.js";
 export * from "./createapikeyrequest.js";
 export * from "./createapikeyresponse.js";
+export * from "./createbudgetrequest.js";
+export * from "./createbudgetresponse.js";
 export * from "./createfilerequest.js";
 export * from "./createfileresponse.js";
 export * from "./createidentityrequest.js";
 export * from "./createidentityresponse.js";
+export * from "./createmanagementkeyrequest.js";
+export * from "./createmanagementkeyresponse.js";
 export * from "./createmodelparameter.js";
 export * from "./createprojectrequest.js";
 export * from "./createprojectresponse.js";
@@ -37,12 +54,15 @@ export * from "./createskillresponse.js";
 export * from "./datapart.js";
 export * from "./datapoint.js";
 export * from "./deleteapikeyresponse.js";
+export * from "./deletebudgetresponse.js";
 export * from "./deletefileresponse.js";
 export * from "./deleteidentityresponse.js";
+export * from "./deletemanagementkeyresponse.js";
 export * from "./deleteprojectresponse.js";
 export * from "./deleteskillresponse.js";
 export * from "./detectrequest.js";
 export * from "./detectresponse.js";
+export * from "./dimensioninfo.js";
 export * from "./domain.js";
 export * from "./embeddingcacheconfig.js";
 export * from "./embeddingcontactparams.js";
@@ -54,6 +74,13 @@ export * from "./embeddingtimeoutconfig.js";
 export * from "./errorpart.js";
 export * from "./errorstreamingevent.js";
 export * from "./evaluatorref.js";
+export * from "./evaluatorresponsefunction.js";
+export * from "./evaluatorresponsehttp.js";
+export * from "./evaluatorresponsejsonschema.js";
+export * from "./evaluatorresponsellm.js";
+export * from "./evaluatorresponsepython.js";
+export * from "./evaluatorresponseragas.js";
+export * from "./evaluatorresponsetypescript.js";
 export * from "./executionnamedstreamingevent.js";
 export * from "./executionreviewedstreamingevent.js";
 export * from "./executionreviewrequiredstreamingevent.js";
@@ -68,32 +95,40 @@ export * from "./filepurpose.js";
 export * from "./filter.js";
 export * from "./getagentresponse.js";
 export * from "./getapikeyresponse.js";
+export * from "./getbudgetconsumptionresponse.js";
+export * from "./getbudgetresponse.js";
 export * from "./getfilecontentresponse.js";
 export * from "./getfileresponse.js";
+export * from "./getmanagementkeyresponse.js";
 export * from "./getprojectresponse.js";
 export * from "./getskillresponse.js";
 export * from "./guardrailref.js";
 export * from "./guardrailrule.js";
 export * from "./identity.js";
+export * from "./identitybudgetscope.js";
 export * from "./identitymetrics.js";
 export * from "./identitysortfield.js";
 export * from "./imagecontentpartschema.js";
 export * from "./incompletedetails.js";
 export * from "./inputtokensdetails.js";
+export * from "./invokedeploymentrequest.js";
 export * from "./legacytokenfamily.js";
 export * from "./limits.js";
 export * from "./listapikeysresponse.js";
+export * from "./listbudgetsresponse.js";
 export * from "./listcapabilitiesresponse.js";
 export * from "./listfilesresponse.js";
 export * from "./listidentitiesresponse.js";
+export * from "./listmanagementcapabilitiesresponse.js";
+export * from "./listmanagementkeysresponse.js";
 export * from "./listprojectsresponse.js";
 export * from "./listskillsresponse.js";
-export * from "./litellmmodel.js";
-export * from "./litellmmodelinfo.js";
-export * from "./litellmparams.js";
+export * from "./managementkey.js";
+export * from "./managementkeystatus.js";
+export * from "./managementpermissionmode.js";
 export * from "./memoryparam.js";
+export * from "./modelbudgetscope.js";
 export * from "./modelconfigurationresponse.js";
-export * from "./modeldocument.js";
 export * from "./modelmetadata.js";
 export * from "./modelparameterdocument.js";
 export * from "./modelref.js";
@@ -104,18 +139,26 @@ export * from "./partdelta.js";
 export * from "./partdeltaevent.js";
 export * from "./partdoneevent.js";
 export * from "./permissionmode.js";
+export * from "./piiredactionplugin.js";
+export * from "./piiredactionpluginauto.js";
+export * from "./piiredactionpluginen.js";
+export * from "./piiredactionpluginnl.js";
+export * from "./plugin.js";
 export * from "./policy.js";
 export * from "./policyretryconfig.js";
 export * from "./price.js";
 export * from "./pricing.js";
 export * from "./pricingvariant.js";
 export * from "./project.js";
+export * from "./projectbudgetscope.js";
 export * from "./projectscope.js";
+export * from "./providerbudgetscope.js";
 export * from "./publiccontact.js";
 export * from "./publicembeddingdata.js";
 export * from "./publicembeddingusage.js";
 export * from "./publicidentity.js";
 export * from "./publicmodelentry.js";
+export * from "./publicpiiredactionplugin.js";
 export * from "./publicresponseresource.js";
 export * from "./publicschedule.js";
 export * from "./publicscheduleerrordetail.js";
@@ -123,6 +166,7 @@ export * from "./publicschedulepayload.js";
 export * from "./publicusage.js";
 export * from "./queryreportrequest.js";
 export * from "./queryreportresponse.js";
+export * from "./ratelimit.js";
 export * from "./reasoning.js";
 export * from "./reasoningparam.js";
 export * from "./reasoningpart.js";
@@ -132,38 +176,65 @@ export * from "./redactrequest.js";
 export * from "./redactresponse.js";
 export * from "./refusalpartschema.js";
 export * from "./requestlimit.js";
-export * from "./responsecodeinterpretercodedeltastreamevent.js";
-export * from "./responsecodeinterpretercodedonestreamevent.js";
-export * from "./responsecontentpartstreamevent.js";
+export * from "./resetbudgetconsumptionrequest.js";
+export * from "./resetbudgetconsumptionresponse.js";
+export * from "./responsecodeinterpretercallcodedeltastreamevent.js";
+export * from "./responsecodeinterpretercallcodedonestreamevent.js";
+export * from "./responsecodeinterpretercallcompletedstreamevent.js";
+export * from "./responsecodeinterpretercallinprogressstreamevent.js";
+export * from "./responsecodeinterpretercallinterpretingstreamevent.js";
+export * from "./responsecompletedstreamevent.js";
+export * from "./responsecontentpartaddedstreamevent.js";
+export * from "./responsecontentpartdonestreamevent.js";
+export * from "./responsecreatedstreamevent.js";
 export * from "./responsedoneevent.js";
 export * from "./responseerror.js";
 export * from "./responseerrorstreamevent.js";
 export * from "./responseexecutionlimits.js";
 export * from "./responsefailedevent.js";
+export * from "./responsefailedstreamevent.js";
+export * from "./responsefilesearchcallcompletedstreamevent.js";
+export * from "./responsefilesearchcallinprogressstreamevent.js";
+export * from "./responsefilesearchcallsearchingstreamevent.js";
 export * from "./responsefunctioncallargumentsdeltastreamevent.js";
 export * from "./responsefunctioncallargumentsdonestreamevent.js";
-export * from "./responsehostedtoolcallstreamevent.js";
 export * from "./responseidentity.js";
-export * from "./responseimagegenerationpartialimagestreamevent.js";
-export * from "./responselifecyclestreamevent.js";
+export * from "./responseimagegenerationcallcompletedstreamevent.js";
+export * from "./responseimagegenerationcallgeneratingstreamevent.js";
+export * from "./responseimagegenerationcallinprogressstreamevent.js";
+export * from "./responseimagegenerationcallpartialimagestreamevent.js";
+export * from "./responseincompletestreamevent.js";
+export * from "./responseinprogressstreamevent.js";
 export * from "./responsemcpcallargumentsdeltastreamevent.js";
 export * from "./responsemcpcallargumentsdonestreamevent.js";
+export * from "./responsemcpcallcompletedstreamevent.js";
+export * from "./responsemcpcallfailedstreamevent.js";
+export * from "./responsemcpcallinprogressstreamevent.js";
 export * from "./responsemeta.js";
-export * from "./responseoutputitemstreamevent.js";
+export * from "./responseoutputitemaddedstreamevent.js";
+export * from "./responseoutputitemdonestreamevent.js";
 export * from "./responseoutputtextannotationaddedstreamevent.js";
 export * from "./responseoutputtextdeltastreamevent.js";
 export * from "./responseoutputtextdonestreamevent.js";
+export * from "./responsequeuedstreamevent.js";
 export * from "./responsereasoningdeltastreamevent.js";
 export * from "./responsereasoningdonestreamevent.js";
-export * from "./responsereasoningsummarypartstreamevent.js";
+export * from "./responsereasoningsummarypartaddedstreamevent.js";
+export * from "./responsereasoningsummarypartdonestreamevent.js";
 export * from "./responsereasoningsummarytextdeltastreamevent.js";
 export * from "./responsereasoningsummarytextdonestreamevent.js";
+export * from "./responsereasoningtextdeltastreamevent.js";
+export * from "./responsereasoningtextdonestreamevent.js";
 export * from "./responserefusaldeltastreamevent.js";
 export * from "./responserefusaldonestreamevent.js";
 export * from "./responseretryconfig.js";
 export * from "./responsestartedevent.js";
+export * from "./responsestreamevent.js";
 export * from "./responsestreamingevent.js";
 export * from "./responsethread.js";
+export * from "./responsewebsearchcallcompletedstreamevent.js";
+export * from "./responsewebsearchcallinprogressstreamevent.js";
+export * from "./responsewebsearchcallsearchingstreamevent.js";
 export * from "./restorerequest.js";
 export * from "./restoreresponse.js";
 export * from "./retrieveidentityresponse.js";
@@ -195,10 +266,14 @@ export * from "./toolstartedevent.js";
 export * from "./totals.js";
 export * from "./updateapikeyrequest.js";
 export * from "./updateapikeyresponse.js";
+export * from "./updatebudgetrequest.js";
+export * from "./updatebudgetresponse.js";
 export * from "./updatefilerequest.js";
 export * from "./updatefileresponse.js";
 export * from "./updateidentityrequest.js";
 export * from "./updateidentityresponse.js";
+export * from "./updatemanagementkeyrequest.js";
+export * from "./updatemanagementkeyresponse.js";
 export * from "./updatemodelparameter.js";
 export * from "./updateprojectrequest.js";
 export * from "./updateprojectresponse.js";
@@ -211,3 +286,4 @@ export * from "./vertexmodelconfiguration.js";
 export * from "./vertexparameters.js";
 export * from "./vertexparamrange.js";
 export * from "./vertexparamrangeint.js";
+export * from "./workspacebudgetscope.js";