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

package/src/models/components/alertcondition.ts

@@ -0,0 +1,207 @@
+/*
+ * 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";
+
+/**
+ * Comparison applied as `value <comparator> threshold`.
+ */
+export const Comparator = {
+  Gt: "gt",
+  Gte: "gte",
+  Lt: "lt",
+  Lte: "lte",
+  Eq: "eq",
+} as const;
+/**
+ * Comparison applied as `value <comparator> threshold`.
+ */
+export type Comparator = ClosedEnum<typeof Comparator>;
+
+/**
+ * Look-back window aggregated on each evaluation tick.
+ */
+export const Window = {
+  Fivem: "5m",
+  Fifteenm: "15m",
+  Thirtym: "30m",
+  Oneh: "1h",
+  Fourh: "4h",
+  Oned: "1d",
+} as const;
+/**
+ * Look-back window aggregated on each evaluation tick.
+ */
+export type Window = ClosedEnum<typeof Window>;
+
+/**
+ * How often the alert is evaluated. `30s` is a testing cadence.
+ */
+export const Interval = {
+  Thirtys: "30s",
+  Fivem: "5m",
+  Fifteenm: "15m",
+  Oneh: "1h",
+  Oned: "1d",
+} as const;
+/**
+ * How often the alert is evaluated. `30s` is a testing cadence.
+ */
+export type Interval = ClosedEnum<typeof Interval>;
+
+/**
+ * Ingestion delay subtracted from the evaluation window. Defaults to `120s`.
+ */
+export const Delay = {
+  Thirtys: "30s",
+  Sixtys: "60s",
+  OneHundredAndTwentys: "120s",
+  ThreeHundreds: "300s",
+  SixHundreds: "600s",
+} as const;
+/**
+ * Ingestion delay subtracted from the evaluation window. Defaults to `120s`.
+ */
+export type Delay = ClosedEnum<typeof Delay>;
+
+export type AlertCondition = {
+  /**
+   * Comparison applied as `value <comparator> threshold`.
+   */
+  comparator: Comparator;
+  /**
+   * Critical-tier threshold. Breaching it opens (or escalates) a
+   *
+   * @remarks
+   *  trigger at critical severity.
+   */
+  threshold: number;
+  /**
+   * Optional degraded-tier threshold. Values past it but short of
+   *
+   * @remarks
+   *  `threshold` open a trigger at degraded severity. Must sit on the
+   *  recovery side of `threshold` for the chosen comparator and is not
+   *  supported with `eq`.
+   */
+  degradedThreshold?: number | undefined;
+  /**
+   * Optional custom resolve bound (hysteresis). An open trigger
+   *
+   * @remarks
+   *  resolves only once the value recovers past this bound; defaults to
+   *  the lowest configured tier. Must sit at or past that tier on the
+   *  recovery side. Not supported with `eq`.
+   */
+  resolveThreshold?: number | undefined;
+  /**
+   * Look-back window aggregated on each evaluation tick.
+   */
+  window: Window;
+  /**
+   * How often the alert is evaluated. `30s` is a testing cadence.
+   */
+  interval: Interval;
+  /**
+   * Ingestion delay subtracted from the evaluation window. Defaults to `120s`.
+   */
+  delay?: Delay | undefined;
+};
+
+/** @internal */
+export const Comparator$inboundSchema: z.ZodNativeEnum<typeof Comparator> = z
+  .nativeEnum(Comparator);
+/** @internal */
+export const Comparator$outboundSchema: z.ZodNativeEnum<typeof Comparator> =
+  Comparator$inboundSchema;
+
+/** @internal */
+export const Window$inboundSchema: z.ZodNativeEnum<typeof Window> = z
+  .nativeEnum(Window);
+/** @internal */
+export const Window$outboundSchema: z.ZodNativeEnum<typeof Window> =
+  Window$inboundSchema;
+
+/** @internal */
+export const Interval$inboundSchema: z.ZodNativeEnum<typeof Interval> = z
+  .nativeEnum(Interval);
+/** @internal */
+export const Interval$outboundSchema: z.ZodNativeEnum<typeof Interval> =
+  Interval$inboundSchema;
+
+/** @internal */
+export const Delay$inboundSchema: z.ZodNativeEnum<typeof Delay> = z.nativeEnum(
+  Delay,
+);
+/** @internal */
+export const Delay$outboundSchema: z.ZodNativeEnum<typeof Delay> =
+  Delay$inboundSchema;
+
+/** @internal */
+export const AlertCondition$inboundSchema: z.ZodType<
+  AlertCondition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  comparator: Comparator$inboundSchema,
+  threshold: z.number(),
+  degraded_threshold: z.number().optional(),
+  resolve_threshold: z.number().optional(),
+  window: Window$inboundSchema,
+  interval: Interval$inboundSchema,
+  delay: Delay$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "degraded_threshold": "degradedThreshold",
+    "resolve_threshold": "resolveThreshold",
+  });
+});
+/** @internal */
+export type AlertCondition$Outbound = {
+  comparator: string;
+  threshold: number;
+  degraded_threshold?: number | undefined;
+  resolve_threshold?: number | undefined;
+  window: string;
+  interval: string;
+  delay?: string | undefined;
+};
+
+/** @internal */
+export const AlertCondition$outboundSchema: z.ZodType<
+  AlertCondition$Outbound,
+  z.ZodTypeDef,
+  AlertCondition
+> = z.object({
+  comparator: Comparator$outboundSchema,
+  threshold: z.number(),
+  degradedThreshold: z.number().optional(),
+  resolveThreshold: z.number().optional(),
+  window: Window$outboundSchema,
+  interval: Interval$outboundSchema,
+  delay: Delay$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    degradedThreshold: "degraded_threshold",
+    resolveThreshold: "resolve_threshold",
+  });
+});
+
+export function alertConditionToJSON(alertCondition: AlertCondition): string {
+  return JSON.stringify(AlertCondition$outboundSchema.parse(alertCondition));
+}
+export function alertConditionFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertCondition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertCondition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertCondition' from JSON`,
+  );
+}

package/src/models/components/alertevidence.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";
+
+export type AlertEvidence = {
+  /**
+   * Trace the exemplar span belongs to.
+   */
+  traceId: string;
+  /**
+   * Exemplar span ID.
+   */
+  spanId: string;
+  /**
+   * Start time of the exemplar span.
+   */
+  startTime: Date;
+  /**
+   * Metric contribution of the exemplar (e.g. cost or duration).
+   */
+  value: number;
+};
+
+/** @internal */
+export const AlertEvidence$inboundSchema: z.ZodType<
+  AlertEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trace_id: z.string(),
+  span_id: z.string(),
+  start_time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  value: z.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "trace_id": "traceId",
+    "span_id": "spanId",
+    "start_time": "startTime",
+  });
+});
+
+export function alertEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertEvidence' from JSON`,
+  );
+}

package/src/models/components/alertquery.ts

@@ -0,0 +1,67 @@
+/*
+ * 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 {
+  MonitorFilter,
+  MonitorFilter$inboundSchema,
+  MonitorFilter$Outbound,
+  MonitorFilter$outboundSchema,
+} from "./monitorfilter.js";
+
+export type AlertQuery = {
+  /**
+   * Reporting API catalogue metric, e.g. `genai.cost` or
+   *
+   * @remarks
+   *  `genai.latency.avg`. Validated against the catalogue when the alert
+   *  is saved.
+   */
+  metric: string;
+  /**
+   * Reporting filters combined with AND.
+   */
+  filters?: Array<MonitorFilter> | undefined;
+};
+
+/** @internal */
+export const AlertQuery$inboundSchema: z.ZodType<
+  AlertQuery,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metric: z.string(),
+  filters: z.array(MonitorFilter$inboundSchema).optional(),
+});
+/** @internal */
+export type AlertQuery$Outbound = {
+  metric: string;
+  filters?: Array<MonitorFilter$Outbound> | undefined;
+};
+
+/** @internal */
+export const AlertQuery$outboundSchema: z.ZodType<
+  AlertQuery$Outbound,
+  z.ZodTypeDef,
+  AlertQuery
+> = z.object({
+  metric: z.string(),
+  filters: z.array(MonitorFilter$outboundSchema).optional(),
+});
+
+export function alertQueryToJSON(alertQuery: AlertQuery): string {
+  return JSON.stringify(AlertQuery$outboundSchema.parse(alertQuery));
+}
+export function alertQueryFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertQuery, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertQuery$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertQuery' from JSON`,
+  );
+}

package/src/models/components/alertrun.ts

@@ -0,0 +1,76 @@
+/*
+ * 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";
+
+/**
+ * Tier the value landed in when breached. Empty when not breached.
+ */
+export const Severity = {
+  Critical: "critical",
+  Degraded: "degraded",
+} as const;
+/**
+ * Tier the value landed in when breached. Empty when not breached.
+ */
+export type Severity = ClosedEnum<typeof Severity>;
+
+export type AlertRun = {
+  /**
+   * Time of the evaluation tick.
+   */
+  at: Date;
+  /**
+   * Observed metric value. Zero when `has_data` is false.
+   */
+  value: number;
+  /**
+   * Whether the value breached the alert condition.
+   */
+  breached: boolean;
+  /**
+   * Whether the evaluation window contained any data.
+   */
+  hasData: boolean;
+  /**
+   * Tier the value landed in when breached. Empty when not breached.
+   */
+  severity?: Severity | undefined;
+};
+
+/** @internal */
+export const Severity$inboundSchema: z.ZodNativeEnum<typeof Severity> = z
+  .nativeEnum(Severity);
+
+/** @internal */
+export const AlertRun$inboundSchema: z.ZodType<
+  AlertRun,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  value: z.number(),
+  breached: z.boolean(),
+  has_data: z.boolean(),
+  severity: Severity$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_data": "hasData",
+  });
+});
+
+export function alertRunFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertRun, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertRun$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertRun' from JSON`,
+  );
+}

package/src/models/components/alerttrigger.ts

@@ -0,0 +1,149 @@
+/*
+ * 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";
+
+/**
+ * Whether the breach is ongoing or recovered.
+ */
+export const AlertTriggerStatus = {
+  Open: "open",
+  Resolved: "resolved",
+} as const;
+/**
+ * Whether the breach is ongoing or recovered.
+ */
+export type AlertTriggerStatus = ClosedEnum<typeof AlertTriggerStatus>;
+
+/**
+ * Current tier of the incident.
+ */
+export const AlertTriggerSeverity = {
+  Critical: "critical",
+  Degraded: "degraded",
+} as const;
+/**
+ * Current tier of the incident.
+ */
+export type AlertTriggerSeverity = ClosedEnum<typeof AlertTriggerSeverity>;
+
+/**
+ * Worst tier reached while the trigger was open.
+ */
+export const PeakSeverity = {
+  Critical: "critical",
+  Degraded: "degraded",
+} as const;
+/**
+ * Worst tier reached while the trigger was open.
+ */
+export type PeakSeverity = ClosedEnum<typeof PeakSeverity>;
+
+export type AlertTrigger = {
+  /**
+   * Unique trigger identifier, for example `trigger_01H...`.
+   */
+  triggerId: string;
+  /**
+   * Alert this trigger belongs to.
+   */
+  alertId: string;
+  /**
+   * Project that owns the alert.
+   */
+  projectId: string;
+  /**
+   * Whether the breach is ongoing or recovered.
+   */
+  status: AlertTriggerStatus;
+  /**
+   * Current tier of the incident.
+   */
+  severity?: AlertTriggerSeverity | undefined;
+  /**
+   * Worst tier reached while the trigger was open.
+   */
+  peakSeverity?: PeakSeverity | undefined;
+  /**
+   * Time when the threshold was first crossed.
+   */
+  openedAt: Date;
+  /**
+   * Time when the value recovered. Unset while the trigger is open.
+   */
+  resolvedAt?: Date | undefined;
+  /**
+   * Worst observed value while the trigger was open.
+   */
+  peakValue: number;
+  /**
+   * Most recent observed value.
+   */
+  lastValue: number;
+  /**
+   * Number of evaluation events recorded on this trigger.
+   */
+  eventCount: number;
+};
+
+/** @internal */
+export const AlertTriggerStatus$inboundSchema: z.ZodNativeEnum<
+  typeof AlertTriggerStatus
+> = z.nativeEnum(AlertTriggerStatus);
+
+/** @internal */
+export const AlertTriggerSeverity$inboundSchema: z.ZodNativeEnum<
+  typeof AlertTriggerSeverity
+> = z.nativeEnum(AlertTriggerSeverity);
+
+/** @internal */
+export const PeakSeverity$inboundSchema: z.ZodNativeEnum<typeof PeakSeverity> =
+  z.nativeEnum(PeakSeverity);
+
+/** @internal */
+export const AlertTrigger$inboundSchema: z.ZodType<
+  AlertTrigger,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trigger_id: z.string(),
+  alert_id: z.string(),
+  project_id: z.string(),
+  status: AlertTriggerStatus$inboundSchema,
+  severity: AlertTriggerSeverity$inboundSchema.optional(),
+  peak_severity: PeakSeverity$inboundSchema.optional(),
+  opened_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  resolved_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  peak_value: z.number(),
+  last_value: z.number(),
+  event_count: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "trigger_id": "triggerId",
+    "alert_id": "alertId",
+    "project_id": "projectId",
+    "peak_severity": "peakSeverity",
+    "opened_at": "openedAt",
+    "resolved_at": "resolvedAt",
+    "peak_value": "peakValue",
+    "last_value": "lastValue",
+    "event_count": "eventCount",
+  });
+});
+
+export function alertTriggerFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertTrigger, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertTrigger$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertTrigger' from JSON`,
+  );
+}

package/src/models/components/alerttriggerevent.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";
+import { AlertEvidence, AlertEvidence$inboundSchema } from "./alertevidence.js";
+
+export type AlertTriggerEvent = {
+  /**
+   * Unique event identifier, for example `alertevent_01H...`.
+   */
+  eventId: string;
+  /**
+   * Trigger the event was recorded on.
+   */
+  triggerId: string;
+  /**
+   * Alert the event belongs to.
+   */
+  alertId: string;
+  /**
+   * Time of the evaluation tick.
+   */
+  at: Date;
+  /**
+   * Observed metric value at the tick.
+   */
+  value: number;
+  /**
+   * Exemplar traces that contributed to the breach, worst first.
+   */
+  evidence?: Array<AlertEvidence> | undefined;
+};
+
+/** @internal */
+export const AlertTriggerEvent$inboundSchema: z.ZodType<
+  AlertTriggerEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  event_id: z.string(),
+  trigger_id: z.string(),
+  alert_id: z.string(),
+  at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  value: z.number(),
+  evidence: z.array(AlertEvidence$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "event_id": "eventId",
+    "trigger_id": "triggerId",
+    "alert_id": "alertId",
+  });
+});
+
+export function alertTriggerEventFromJSON(
+  jsonString: string,
+): SafeParseResult<AlertTriggerEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlertTriggerEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlertTriggerEvent' from JSON`,
+  );
+}

package/src/models/components/checkalertnowrequest.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type CheckAlertNowRequest = {};
+
+/** @internal */
+export type CheckAlertNowRequest$Outbound = {};
+
+/** @internal */
+export const CheckAlertNowRequest$outboundSchema: z.ZodType<
+  CheckAlertNowRequest$Outbound,
+  z.ZodTypeDef,
+  CheckAlertNowRequest
+> = z.object({});
+
+export function checkAlertNowRequestToJSON(
+  checkAlertNowRequest: CheckAlertNowRequest,
+): string {
+  return JSON.stringify(
+    CheckAlertNowRequest$outboundSchema.parse(checkAlertNowRequest),
+  );
+}

package/src/models/components/checkalertnowresponse.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 CheckAlertNowResponse = {};
+
+/** @internal */
+export const CheckAlertNowResponse$inboundSchema: z.ZodType<
+  CheckAlertNowResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function checkAlertNowResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckAlertNowResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CheckAlertNowResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckAlertNowResponse' from JSON`,
+  );
+}