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

package/src/models/components/listbudgetsresponse.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 { Budget, Budget$inboundSchema } from "./budget.js";
+
+export type ListBudgetsResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
+  object?: string | undefined;
+  /**
+   * Page of budgets, ordered newest first.
+   */
+  data?: Array<Budget> | undefined;
+  /**
+   * Whether more budgets are available in the selected pagination
+   *
+   * @remarks
+   *  direction.
+   */
+  hasMore?: boolean | undefined;
+};
+
+/** @internal */
+export const ListBudgetsResponse$inboundSchema: z.ZodType<
+  ListBudgetsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string().optional(),
+  data: z.array(Budget$inboundSchema).optional(),
+  has_more: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listBudgetsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListBudgetsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListBudgetsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListBudgetsResponse' from JSON`,
+  );
+}

package/src/models/components/listmanagementcapabilitiesresponse.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 { Domain, Domain$inboundSchema } from "./domain.js";
+
+export type ListManagementCapabilitiesResponse = {
+  /**
+   * Full management capability catalog.
+   */
+  domains: Array<Domain>;
+};
+
+/** @internal */
+export const ListManagementCapabilitiesResponse$inboundSchema: z.ZodType<
+  ListManagementCapabilitiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  domains: z.array(Domain$inboundSchema),
+});
+
+export function listManagementCapabilitiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListManagementCapabilitiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListManagementCapabilitiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListManagementCapabilitiesResponse' from JSON`,
+  );
+}

package/src/models/components/listmanagementkeysresponse.ts

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

package/src/models/components/listnotifiersresponse.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 { Notifier, Notifier$inboundSchema } from "./notifier.js";
+
+export type ListNotifiersResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
+  object: string;
+  /**
+   * Page of notifiers.
+   */
+  data: Array<Notifier>;
+  /**
+   * Whether more notifiers are available in the selected pagination direction.
+   */
+  hasMore: boolean;
+};
+
+/** @internal */
+export const ListNotifiersResponse$inboundSchema: z.ZodType<
+  ListNotifiersResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  data: z.array(Notifier$inboundSchema),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listNotifiersResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListNotifiersResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListNotifiersResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListNotifiersResponse' from JSON`,
+  );
+}

package/src/models/components/listtracefacetsresponse.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 { TraceFacet, TraceFacet$inboundSchema } from "./tracefacet.js";
+
+export type ListTraceFacetsResponse = {
+  data?: Array<TraceFacet> | undefined;
+};
+
+/** @internal */
+export const ListTraceFacetsResponse$inboundSchema: z.ZodType<
+  ListTraceFacetsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(TraceFacet$inboundSchema).optional(),
+});
+
+export function listTraceFacetsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTraceFacetsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTraceFacetsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTraceFacetsResponse' from JSON`,
+  );
+}

package/src/models/components/listtracefacetvaluesresponse.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 {
+  TraceFacetValue,
+  TraceFacetValue$inboundSchema,
+} from "./tracefacetvalue.js";
+
+export type ListTraceFacetValuesResponse = {
+  field?: string | undefined;
+  values?: Array<TraceFacetValue> | undefined;
+  hasMore?: boolean | undefined;
+};
+
+/** @internal */
+export const ListTraceFacetValuesResponse$inboundSchema: z.ZodType<
+  ListTraceFacetValuesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  field: z.string().optional(),
+  values: z.array(TraceFacetValue$inboundSchema).optional(),
+  has_more: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listTraceFacetValuesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTraceFacetValuesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTraceFacetValuesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTraceFacetValuesResponse' from JSON`,
+  );
+}

package/src/models/components/listtracefieldsresponse.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 { TraceField, TraceField$inboundSchema } from "./tracefield.js";
+
+export type ListTraceFieldsResponse = {
+  data?: Array<TraceField> | undefined;
+};
+
+/** @internal */
+export const ListTraceFieldsResponse$inboundSchema: z.ZodType<
+  ListTraceFieldsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(TraceField$inboundSchema).optional(),
+});
+
+export function listTraceFieldsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTraceFieldsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTraceFieldsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTraceFieldsResponse' from JSON`,
+  );
+}

package/src/models/components/listtracespansresponse.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 { SpanSummary, SpanSummary$inboundSchema } from "./spansummary.js";
+
+export type ListTraceSpansResponse = {
+  object?: string | undefined;
+  data?: Array<SpanSummary> | undefined;
+  hasMore?: boolean | undefined;
+  nextPageToken?: string | undefined;
+};
+
+/** @internal */
+export const ListTraceSpansResponse$inboundSchema: z.ZodType<
+  ListTraceSpansResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string().optional(),
+  data: z.array(SpanSummary$inboundSchema).optional(),
+  has_more: z.boolean().optional(),
+  next_page_token: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "next_page_token": "nextPageToken",
+  });
+});
+
+export function listTraceSpansResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTraceSpansResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTraceSpansResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTraceSpansResponse' from JSON`,
+  );
+}

package/src/models/components/managementkey.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 {
+  ManagementKeyStatus,
+  ManagementKeyStatus$inboundSchema,
+} from "./managementkeystatus.js";
+import {
+  ManagementPermissionMode,
+  ManagementPermissionMode$inboundSchema,
+} from "./managementpermissionmode.js";
+
+/**
+ * ManagementKey is the canonical record stored in MongoDB
+ *
+ * @remarks
+ *  `auth.managementKeys`. It is the source of truth for permissions,
+ *  expiration, and revocation. Management keys are always
+ *  workspace-scoped — there is no project_scope field, and they have no
+ *  per-user owner (every management key is workspace-owned;
+ *  `created_by_id` records who created it).
+ */
+export type ManagementKey = {
+  /**
+   * Canonical key identifier (ULID). Embedded in opaque tokens as
+   *
+   * @remarks
+   *  `sk-orq-<id>-<secret>`.
+   */
+  managementKeyId: string;
+  /**
+   * Human-readable name shown in the dashboard.
+   */
+  name: string;
+  permissionMode: ManagementPermissionMode;
+  /**
+   * Per-domain access map. Only populated when `permission_mode` is
+   *
+   * @remarks
+   *  `MANAGEMENT_PERMISSION_MODE_RESTRICTED`. Valid keys are the Domain.id
+   *  values in the management capability catalog — see
+   *  libs/catalog/orq/managementkeys/v1/catalog.textpb for the canonical
+   *  list.
+   */
+  access?: { [k: string]: number } | undefined;
+  /**
+   * Displayable prefix for UI listings (e.g. "sk-orq-01HXY..."). Safe
+   *
+   * @remarks
+   *  to expose.
+   */
+  tokenPrefix: string;
+  status: ManagementKeyStatus;
+  /**
+   * Audit: user who created the key.
+   */
+  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.
+   */
+  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;
+};
+
+/** @internal */
+export const ManagementKey$inboundSchema: z.ZodType<
+  ManagementKey,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  management_key_id: z.string(),
+  name: z.string(),
+  permission_mode: ManagementPermissionMode$inboundSchema,
+  access: z.record(z.number().int()).optional(),
+  token_prefix: z.string(),
+  status: ManagementKeyStatus$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(),
+}).transform((v) => {
+  return remap$(v, {
+    "management_key_id": "managementKeyId",
+    "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",
+  });
+});
+
+export function managementKeyFromJSON(
+  jsonString: string,
+): SafeParseResult<ManagementKey, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ManagementKey$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ManagementKey' from JSON`,
+  );
+}

package/src/models/components/managementkeystatus.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ManagementKeyStatus = {
+  ManagementKeyStatusUnspecified: "MANAGEMENT_KEY_STATUS_UNSPECIFIED",
+  ManagementKeyStatusActive: "MANAGEMENT_KEY_STATUS_ACTIVE",
+  ManagementKeyStatusDisabled: "MANAGEMENT_KEY_STATUS_DISABLED",
+  ManagementKeyStatusRevoked: "MANAGEMENT_KEY_STATUS_REVOKED",
+} as const;
+export type ManagementKeyStatus = ClosedEnum<typeof ManagementKeyStatus>;
+
+/** @internal */
+export const ManagementKeyStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ManagementKeyStatus
+> = z.nativeEnum(ManagementKeyStatus);
+/** @internal */
+export const ManagementKeyStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ManagementKeyStatus
+> = ManagementKeyStatus$inboundSchema;

package/src/models/components/managementpermissionmode.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ManagementPermissionMode = {
+  ManagementPermissionModeUnspecified: "MANAGEMENT_PERMISSION_MODE_UNSPECIFIED",
+  ManagementPermissionModeAll: "MANAGEMENT_PERMISSION_MODE_ALL",
+  ManagementPermissionModeRestricted: "MANAGEMENT_PERMISSION_MODE_RESTRICTED",
+  ManagementPermissionModeReadOnly: "MANAGEMENT_PERMISSION_MODE_READ_ONLY",
+} as const;
+export type ManagementPermissionMode = ClosedEnum<
+  typeof ManagementPermissionMode
+>;
+
+/** @internal */
+export const ManagementPermissionMode$inboundSchema: z.ZodNativeEnum<
+  typeof ManagementPermissionMode
+> = z.nativeEnum(ManagementPermissionMode);
+/** @internal */
+export const ManagementPermissionMode$outboundSchema: z.ZodNativeEnum<
+  typeof ManagementPermissionMode
+> = ManagementPermissionMode$inboundSchema;

package/src/models/components/modelbudgetscope.ts

@@ -0,0 +1,67 @@
+/*
+ * 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-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.
+ */
+export type ModelBudgetScope = {
+  modelId?: string | undefined;
+};
+
+/** @internal */
+export const ModelBudgetScope$inboundSchema: z.ZodType<
+  ModelBudgetScope,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "model_id": "modelId",
+  });
+});
+/** @internal */
+export type ModelBudgetScope$Outbound = {
+  model_id?: string | undefined;
+};
+
+/** @internal */
+export const ModelBudgetScope$outboundSchema: z.ZodType<
+  ModelBudgetScope$Outbound,
+  z.ZodTypeDef,
+  ModelBudgetScope
+> = z.object({
+  modelId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    modelId: "model_id",
+  });
+});
+
+export function modelBudgetScopeToJSON(
+  modelBudgetScope: ModelBudgetScope,
+): string {
+  return JSON.stringify(
+    ModelBudgetScope$outboundSchema.parse(modelBudgetScope),
+  );
+}
+export function modelBudgetScopeFromJSON(
+  jsonString: string,
+): SafeParseResult<ModelBudgetScope, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ModelBudgetScope$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ModelBudgetScope' from JSON`,
+  );
+}