@orq-ai/node 4.13.0-rc.3 → 4.13.0-rc.5

package/src/models/components/listmonitorpresetsresponse.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 { MonitorPreset, MonitorPreset$inboundSchema } from "./monitorpreset.js";
+
+export type ListMonitorPresetsResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
+  object: string;
+  /**
+   * Built-in presets, dashboards first.
+   */
+  data: Array<MonitorPreset>;
+};
+
+/** @internal */
+export const ListMonitorPresetsResponse$inboundSchema: z.ZodType<
+  ListMonitorPresetsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  data: z.array(MonitorPreset$inboundSchema),
+});
+
+export function listMonitorPresetsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMonitorPresetsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListMonitorPresetsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMonitorPresetsResponse' from JSON`,
+  );
+}

package/src/models/components/listmonitorsresponse.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 { Monitor, Monitor$inboundSchema } from "./monitor.js";
+
+export type ListMonitorsResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
+  object: string;
+  /**
+   * Page of monitors, ordered newest first.
+   */
+  data: Array<Monitor>;
+  /**
+   * Whether more monitors are available in the selected pagination
+   *
+   * @remarks
+   *  direction.
+   */
+  hasMore: boolean;
+};
+
+/** @internal */
+export const ListMonitorsResponse$inboundSchema: z.ZodType<
+  ListMonitorsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  data: z.array(Monitor$inboundSchema),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listMonitorsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListMonitorsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListMonitorsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListMonitorsResponse' from JSON`,
+  );
+}

package/src/models/components/listpeopleresponse.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 { Person, Person$inboundSchema } from "./person.js";
+
+export type ListPeopleResponse = {
+  /**
+   * Object discriminator for list responses; always `list`.
+   */
+  object: string;
+  /**
+   * Page of people, ordered newest first.
+   */
+  data: Array<Person>;
+  /**
+   * Whether more people are available in the selected pagination
+   *
+   * @remarks
+   *  direction.
+   */
+  hasMore: boolean;
+};
+
+/** @internal */
+export const ListPeopleResponse$inboundSchema: z.ZodType<
+  ListPeopleResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  data: z.array(Person$inboundSchema),
+  has_more: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listPeopleResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPeopleResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListPeopleResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPeopleResponse' from JSON`,
+  );
+}

package/src/models/components/monitor.ts

@@ -0,0 +1,130 @@
+/*
+ * 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";
+
+/**
+ * Default relative time range applied when the monitor opens.
+ */
+export const DefaultRange = {
+  Fifteenm: "15m",
+  Oneh: "1h",
+  Fourh: "4h",
+  Oned: "1d",
+  Threed: "3d",
+  Sevend: "7d",
+  Fourteend: "14d",
+  Thirtyd: "30d",
+  Ninetyd: "90d",
+} as const;
+/**
+ * Default relative time range applied when the monitor opens.
+ */
+export type DefaultRange = ClosedEnum<typeof DefaultRange>;
+
+export type Monitor = {
+  /**
+   * Unique monitor identifier assigned by ORQ, for example
+   *
+   * @remarks
+   *  `monitor_01H...`. Use this value in retrieve, update, and delete
+   *  requests.
+   */
+  monitorId: string;
+  /**
+   * Workspace-unique display name.
+   */
+  displayName: string;
+  /**
+   * Short human-readable summary of what the monitor tracks.
+   */
+  description: string;
+  /**
+   * Project that owns the monitor. Empty for workspace-wide monitors (admin-managed). Immutable after creation.
+   */
+  projectId: string;
+  /**
+   * Widgets rendered on the monitor, each carrying its own query and
+   *
+   * @remarks
+   *  layout position.
+   */
+  widgets: Array<MonitorWidget>;
+  /**
+   * Default relative time range applied when the monitor opens.
+   */
+  defaultRange?: DefaultRange | undefined;
+  /**
+   * Preset this monitor was created from. Empty when built from scratch.
+   */
+  presetKey: string;
+  /**
+   * Time when the monitor was created.
+   */
+  createdAt: Date;
+  /**
+   * Time when the monitor was last updated.
+   */
+  updatedAt: Date;
+  /**
+   * User ID that created the monitor.
+   */
+  createdById: string;
+  /**
+   * User ID that last updated the monitor.
+   */
+  updatedById: string;
+};
+
+/** @internal */
+export const DefaultRange$inboundSchema: z.ZodNativeEnum<typeof DefaultRange> =
+  z.nativeEnum(DefaultRange);
+
+/** @internal */
+export const Monitor$inboundSchema: z.ZodType<Monitor, z.ZodTypeDef, unknown> =
+  z.object({
+    monitor_id: z.string(),
+    display_name: z.string(),
+    description: z.string(),
+    project_id: z.string(),
+    widgets: z.array(MonitorWidget$inboundSchema),
+    default_range: DefaultRange$inboundSchema.optional(),
+    preset_key: z.string(),
+    created_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updated_at: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    created_by_id: z.string(),
+    updated_by_id: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "monitor_id": "monitorId",
+      "display_name": "displayName",
+      "project_id": "projectId",
+      "default_range": "defaultRange",
+      "preset_key": "presetKey",
+      "created_at": "createdAt",
+      "updated_at": "updatedAt",
+      "created_by_id": "createdById",
+      "updated_by_id": "updatedById",
+    });
+  });
+
+export function monitorFromJSON(
+  jsonString: string,
+): SafeParseResult<Monitor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Monitor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Monitor' from JSON`,
+  );
+}

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`,
+  );
+}