@orq-ai/node 4.13.0-rc.2 → 4.13.0-rc.21

package/src/models/components/monitorfilter.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+ */
+export const Op = {
+  Eq: "eq",
+  Neq: "neq",
+  In: "in",
+  NotIn: "not_in",
+} as const;
+/**
+ * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+ */
+export type Op = ClosedEnum<typeof Op>;
+
+export type MonitorFilter = {
+  /**
+   * Reporting dimension to filter on. Valid fields depend on the
+   *
+   * @remarks
+   *  metric; validated when the monitor is saved.
+   */
+  field: string;
+  /**
+   * Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values.
+   */
+  op: Op;
+  /**
+   * Values compared against the selected field.
+   */
+  values: Array<string>;
+};
+
+/** @internal */
+export const Op$inboundSchema: z.ZodNativeEnum<typeof Op> = z.nativeEnum(Op);
+/** @internal */
+export const Op$outboundSchema: z.ZodNativeEnum<typeof Op> = Op$inboundSchema;
+
+/** @internal */
+export const MonitorFilter$inboundSchema: z.ZodType<
+  MonitorFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  field: z.string(),
+  op: Op$inboundSchema,
+  values: z.array(z.string()),
+});
+/** @internal */
+export type MonitorFilter$Outbound = {
+  field: string;
+  op: string;
+  values: Array<string>;
+};
+
+/** @internal */
+export const MonitorFilter$outboundSchema: z.ZodType<
+  MonitorFilter$Outbound,
+  z.ZodTypeDef,
+  MonitorFilter
+> = z.object({
+  field: z.string(),
+  op: Op$outboundSchema,
+  values: z.array(z.string()),
+});
+
+export function monitorFilterToJSON(monitorFilter: MonitorFilter): string {
+  return JSON.stringify(MonitorFilter$outboundSchema.parse(monitorFilter));
+}
+export function monitorFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<MonitorFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonitorFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonitorFilter' from JSON`,
+  );
+}

package/src/models/components/monitorpreset.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { MonitorWidget, MonitorWidget$inboundSchema } from "./monitorwidget.js";
+
+/**
+ * Preset kind.
+ */
+export const MonitorPresetKind = {
+  Dashboard: "dashboard",
+  Widget: "widget",
+} as const;
+/**
+ * Preset kind.
+ */
+export type MonitorPresetKind = ClosedEnum<typeof MonitorPresetKind>;
+
+export type MonitorPreset = {
+  /**
+   * Stable identifier for the preset, e.g. `genai-overview` or
+   *
+   * @remarks
+   *  `widget-cost-by-model`.
+   */
+  presetKey: string;
+  /**
+   * Human-readable preset name shown in galleries.
+   */
+  displayName: string;
+  /**
+   * What the preset shows and when to use it.
+   */
+  description: string;
+  /**
+   * Preset kind.
+   */
+  kind: MonitorPresetKind;
+  /**
+   * Widgets the preset materializes into a create request. Widget
+   *
+   * @remarks
+   *  presets carry exactly one entry.
+   */
+  widgets: Array<MonitorWidget>;
+  /**
+   * Default relative time range suggested by the preset.
+   */
+  defaultRange?: string | undefined;
+};
+
+/** @internal */
+export const MonitorPresetKind$inboundSchema: z.ZodNativeEnum<
+  typeof MonitorPresetKind
+> = z.nativeEnum(MonitorPresetKind);
+
+/** @internal */
+export const MonitorPreset$inboundSchema: z.ZodType<
+  MonitorPreset,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  preset_key: z.string(),
+  display_name: z.string(),
+  description: z.string(),
+  kind: MonitorPresetKind$inboundSchema,
+  widgets: z.array(MonitorWidget$inboundSchema),
+  default_range: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "preset_key": "presetKey",
+    "display_name": "displayName",
+    "default_range": "defaultRange",
+  });
+});
+
+export function monitorPresetFromJSON(
+  jsonString: string,
+): SafeParseResult<MonitorPreset, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonitorPreset$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonitorPreset' from JSON`,
+  );
+}

package/src/models/components/monitorwidget.ts

@@ -0,0 +1,142 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MonitorWidgetDisplay,
+  MonitorWidgetDisplay$inboundSchema,
+  MonitorWidgetDisplay$Outbound,
+  MonitorWidgetDisplay$outboundSchema,
+} from "./monitorwidgetdisplay.js";
+import {
+  MonitorWidgetLayout,
+  MonitorWidgetLayout$inboundSchema,
+  MonitorWidgetLayout$Outbound,
+  MonitorWidgetLayout$outboundSchema,
+} from "./monitorwidgetlayout.js";
+import {
+  MonitorWidgetQuery,
+  MonitorWidgetQuery$inboundSchema,
+  MonitorWidgetQuery$Outbound,
+  MonitorWidgetQuery$outboundSchema,
+} from "./monitorwidgetquery.js";
+
+/**
+ * Widget rendering type.
+ */
+export const MonitorWidgetType = {
+  Timeseries: "timeseries",
+  Toplist: "toplist",
+  Bignumber: "bignumber",
+} as const;
+/**
+ * Widget rendering type.
+ */
+export type MonitorWidgetType = ClosedEnum<typeof MonitorWidgetType>;
+
+export type MonitorWidget = {
+  /**
+   * Widget identifier, unique within the monitor. Provide your own or
+   *
+   * @remarks
+   *  leave empty to have the server assign one.
+   */
+  widgetId: string;
+  /**
+   * Widget rendering type.
+   */
+  type: MonitorWidgetType;
+  /**
+   * Title shown in the widget header.
+   */
+  title: string;
+  /**
+   * Queries feeding the widget. Each maps 1:1 onto a Reporting API
+   *
+   * @remarks
+   *  request; the viewer's time range, time zone, and the query mode
+   *  derived from the widget type are supplied at render time.
+   */
+  queries: Array<MonitorWidgetQuery>;
+  /**
+   * Display options such as visualization style and unit.
+   */
+  display?: MonitorWidgetDisplay | undefined;
+  /**
+   * Position and size on the monitor grid.
+   */
+  layout: MonitorWidgetLayout;
+};
+
+/** @internal */
+export const MonitorWidgetType$inboundSchema: z.ZodNativeEnum<
+  typeof MonitorWidgetType
+> = z.nativeEnum(MonitorWidgetType);
+/** @internal */
+export const MonitorWidgetType$outboundSchema: z.ZodNativeEnum<
+  typeof MonitorWidgetType
+> = MonitorWidgetType$inboundSchema;
+
+/** @internal */
+export const MonitorWidget$inboundSchema: z.ZodType<
+  MonitorWidget,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  widget_id: z.string(),
+  type: MonitorWidgetType$inboundSchema,
+  title: z.string(),
+  queries: z.array(MonitorWidgetQuery$inboundSchema),
+  display: MonitorWidgetDisplay$inboundSchema.optional(),
+  layout: MonitorWidgetLayout$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "widget_id": "widgetId",
+  });
+});
+/** @internal */
+export type MonitorWidget$Outbound = {
+  widget_id: string;
+  type: string;
+  title: string;
+  queries: Array<MonitorWidgetQuery$Outbound>;
+  display?: MonitorWidgetDisplay$Outbound | undefined;
+  layout: MonitorWidgetLayout$Outbound;
+};
+
+/** @internal */
+export const MonitorWidget$outboundSchema: z.ZodType<
+  MonitorWidget$Outbound,
+  z.ZodTypeDef,
+  MonitorWidget
+> = z.object({
+  widgetId: z.string(),
+  type: MonitorWidgetType$outboundSchema,
+  title: z.string(),
+  queries: z.array(MonitorWidgetQuery$outboundSchema),
+  display: MonitorWidgetDisplay$outboundSchema.optional(),
+  layout: MonitorWidgetLayout$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    widgetId: "widget_id",
+  });
+});
+
+export function monitorWidgetToJSON(monitorWidget: MonitorWidget): string {
+  return JSON.stringify(MonitorWidget$outboundSchema.parse(monitorWidget));
+}
+export function monitorWidgetFromJSON(
+  jsonString: string,
+): SafeParseResult<MonitorWidget, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonitorWidget$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonitorWidget' from JSON`,
+  );
+}

package/src/models/components/monitorwidgetdisplay.ts

@@ -0,0 +1,166 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Chart style for timeseries widgets.
+ */
+export const Visualization = {
+  Lines: "lines",
+  Bars: "bars",
+} as const;
+/**
+ * Chart style for timeseries widgets.
+ */
+export type Visualization = ClosedEnum<typeof Visualization>;
+
+/**
+ * Unit used for axis and value formatting.
+ */
+export const Unit = {
+  Count: "count",
+  Cost: "cost",
+  Duration: "duration",
+  Percent: "percent",
+  Bytes: "bytes",
+} as const;
+/**
+ * Unit used for axis and value formatting.
+ */
+export type Unit = ClosedEnum<typeof Unit>;
+
+/**
+ * Value ordering for toplist widgets.
+ */
+export const Sort = {
+  Desc: "desc",
+  Asc: "asc",
+} as const;
+/**
+ * Value ordering for toplist widgets.
+ */
+export type Sort = ClosedEnum<typeof Sort>;
+
+export type MonitorWidgetDisplay = {
+  /**
+   * Chart style for timeseries widgets.
+   */
+  visualization?: Visualization | undefined;
+  /**
+   * Unit used for axis and value formatting.
+   */
+  unit?: Unit | undefined;
+  /**
+   * Value ordering for toplist widgets.
+   */
+  sort?: Sort | undefined;
+  /**
+   * When true, toplist widgets also show the overall total across all
+   *
+   * @remarks
+   *  groups for the window.
+   */
+  showOverall?: boolean | undefined;
+  /**
+   * Optional threshold line rendered on timeseries widgets.
+   */
+  target?: number | undefined;
+  /**
+   * Decimal places used when formatting values.
+   */
+  decimals?: number | undefined;
+};
+
+/** @internal */
+export const Visualization$inboundSchema: z.ZodNativeEnum<
+  typeof Visualization
+> = z.nativeEnum(Visualization);
+/** @internal */
+export const Visualization$outboundSchema: z.ZodNativeEnum<
+  typeof Visualization
+> = Visualization$inboundSchema;
+
+/** @internal */
+export const Unit$inboundSchema: z.ZodNativeEnum<typeof Unit> = z.nativeEnum(
+  Unit,
+);
+/** @internal */
+export const Unit$outboundSchema: z.ZodNativeEnum<typeof Unit> =
+  Unit$inboundSchema;
+
+/** @internal */
+export const Sort$inboundSchema: z.ZodNativeEnum<typeof Sort> = z.nativeEnum(
+  Sort,
+);
+/** @internal */
+export const Sort$outboundSchema: z.ZodNativeEnum<typeof Sort> =
+  Sort$inboundSchema;
+
+/** @internal */
+export const MonitorWidgetDisplay$inboundSchema: z.ZodType<
+  MonitorWidgetDisplay,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  visualization: Visualization$inboundSchema.optional(),
+  unit: Unit$inboundSchema.optional(),
+  sort: Sort$inboundSchema.optional(),
+  show_overall: z.boolean().optional(),
+  target: z.number().optional(),
+  decimals: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "show_overall": "showOverall",
+  });
+});
+/** @internal */
+export type MonitorWidgetDisplay$Outbound = {
+  visualization?: string | undefined;
+  unit?: string | undefined;
+  sort?: string | undefined;
+  show_overall?: boolean | undefined;
+  target?: number | undefined;
+  decimals?: number | undefined;
+};
+
+/** @internal */
+export const MonitorWidgetDisplay$outboundSchema: z.ZodType<
+  MonitorWidgetDisplay$Outbound,
+  z.ZodTypeDef,
+  MonitorWidgetDisplay
+> = z.object({
+  visualization: Visualization$outboundSchema.optional(),
+  unit: Unit$outboundSchema.optional(),
+  sort: Sort$outboundSchema.optional(),
+  showOverall: z.boolean().optional(),
+  target: z.number().optional(),
+  decimals: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    showOverall: "show_overall",
+  });
+});
+
+export function monitorWidgetDisplayToJSON(
+  monitorWidgetDisplay: MonitorWidgetDisplay,
+): string {
+  return JSON.stringify(
+    MonitorWidgetDisplay$outboundSchema.parse(monitorWidgetDisplay),
+  );
+}
+export function monitorWidgetDisplayFromJSON(
+  jsonString: string,
+): SafeParseResult<MonitorWidgetDisplay, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonitorWidgetDisplay$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonitorWidgetDisplay' from JSON`,
+  );
+}

package/src/models/components/monitorwidgetlayout.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 MonitorWidgetLayout = {
+  /**
+   * Column offset in grid units.
+   */
+  x: number;
+  /**
+   * Row offset in grid units.
+   */
+  y: number;
+  /**
+   * Width in grid units.
+   */
+  w: number;
+  /**
+   * Height in grid units.
+   */
+  h: number;
+};
+
+/** @internal */
+export const MonitorWidgetLayout$inboundSchema: z.ZodType<
+  MonitorWidgetLayout,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  x: z.number().int(),
+  y: z.number().int(),
+  w: z.number().int(),
+  h: z.number().int(),
+});
+/** @internal */
+export type MonitorWidgetLayout$Outbound = {
+  x: number;
+  y: number;
+  w: number;
+  h: number;
+};
+
+/** @internal */
+export const MonitorWidgetLayout$outboundSchema: z.ZodType<
+  MonitorWidgetLayout$Outbound,
+  z.ZodTypeDef,
+  MonitorWidgetLayout
+> = z.object({
+  x: z.number().int(),
+  y: z.number().int(),
+  w: z.number().int(),
+  h: z.number().int(),
+});
+
+export function monitorWidgetLayoutToJSON(
+  monitorWidgetLayout: MonitorWidgetLayout,
+): string {
+  return JSON.stringify(
+    MonitorWidgetLayout$outboundSchema.parse(monitorWidgetLayout),
+  );
+}
+export function monitorWidgetLayoutFromJSON(
+  jsonString: string,
+): SafeParseResult<MonitorWidgetLayout, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonitorWidgetLayout$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonitorWidgetLayout' from JSON`,
+  );
+}

package/src/models/components/monitorwidgetquery.ts

@@ -0,0 +1,127 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MonitorFilter,
+  MonitorFilter$inboundSchema,
+  MonitorFilter$Outbound,
+  MonitorFilter$outboundSchema,
+} from "./monitorfilter.js";
+
+/**
+ * Requested bucket grain for timeseries widgets.
+ */
+export const Grain = {
+  Auto: "auto",
+  Minute: "minute",
+  Hour: "hour",
+  Day: "day",
+} as const;
+/**
+ * Requested bucket grain for timeseries widgets.
+ */
+export type Grain = ClosedEnum<typeof Grain>;
+
+export type MonitorWidgetQuery = {
+  /**
+   * Reporting API catalogue metric, e.g. `genai.cost` or
+   *
+   * @remarks
+   *  `genai.latency.p95`. Validated against the catalogue when the
+   *  monitor is saved.
+   */
+  metric: string;
+  /**
+   * Reporting dimensions to break down by. Valid dimensions depend on
+   *
+   * @remarks
+   *  the metric; validated when the monitor is saved.
+   */
+  groupBy?: Array<string> | undefined;
+  /**
+   * Reporting filters combined with AND.
+   */
+  filters?: Array<MonitorFilter> | undefined;
+  /**
+   * Requested bucket grain for timeseries widgets.
+   */
+  grain?: Grain | undefined;
+  /**
+   * Row cap. For toplist widgets this is the top-N group count.
+   */
+  limit?: number | undefined;
+};
+
+/** @internal */
+export const Grain$inboundSchema: z.ZodNativeEnum<typeof Grain> = z.nativeEnum(
+  Grain,
+);
+/** @internal */
+export const Grain$outboundSchema: z.ZodNativeEnum<typeof Grain> =
+  Grain$inboundSchema;
+
+/** @internal */
+export const MonitorWidgetQuery$inboundSchema: z.ZodType<
+  MonitorWidgetQuery,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metric: z.string(),
+  group_by: z.array(z.string()).optional(),
+  filters: z.array(MonitorFilter$inboundSchema).optional(),
+  grain: Grain$inboundSchema.optional(),
+  limit: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "group_by": "groupBy",
+  });
+});
+/** @internal */
+export type MonitorWidgetQuery$Outbound = {
+  metric: string;
+  group_by?: Array<string> | undefined;
+  filters?: Array<MonitorFilter$Outbound> | undefined;
+  grain?: string | undefined;
+  limit?: number | undefined;
+};
+
+/** @internal */
+export const MonitorWidgetQuery$outboundSchema: z.ZodType<
+  MonitorWidgetQuery$Outbound,
+  z.ZodTypeDef,
+  MonitorWidgetQuery
+> = z.object({
+  metric: z.string(),
+  groupBy: z.array(z.string()).optional(),
+  filters: z.array(MonitorFilter$outboundSchema).optional(),
+  grain: Grain$outboundSchema.optional(),
+  limit: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    groupBy: "group_by",
+  });
+});
+
+export function monitorWidgetQueryToJSON(
+  monitorWidgetQuery: MonitorWidgetQuery,
+): string {
+  return JSON.stringify(
+    MonitorWidgetQuery$outboundSchema.parse(monitorWidgetQuery),
+  );
+}
+export function monitorWidgetQueryFromJSON(
+  jsonString: string,
+): SafeParseResult<MonitorWidgetQuery, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonitorWidgetQuery$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonitorWidgetQuery' from JSON`,
+  );
+}