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

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

package/src/models/components/createalertrequest.ts

@@ -0,0 +1,96 @@
+/*
+ * 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 {
+  AlertCondition,
+  AlertCondition$Outbound,
+  AlertCondition$outboundSchema,
+} from "./alertcondition.js";
+import {
+  AlertQuery,
+  AlertQuery$Outbound,
+  AlertQuery$outboundSchema,
+} from "./alertquery.js";
+
+export type CreateAlertRequest = {
+  /**
+   * Workspace-unique display name.
+   */
+  displayName: string;
+  /**
+   * Short human-readable summary of what the alert watches.
+   */
+  description?: string | undefined;
+  /**
+   * Project that owns the alert. Required.
+   */
+  projectId: string;
+  /**
+   * UI signal preset the alert is created from. Defaults to `custom`.
+   */
+  signal?: string | undefined;
+  /**
+   * Metric query evaluated on each tick.
+   */
+  query: AlertQuery;
+  /**
+   * Threshold condition applied to the query result.
+   */
+  condition: AlertCondition;
+  /**
+   * Notifiers that receive trigger-open and trigger-resolve
+   *
+   * @remarks
+   *  notifications.
+   */
+  notifierIds?: Array<string> | undefined;
+  /**
+   * Whether the alert starts evaluating immediately. Defaults to true.
+   */
+  enabled?: boolean | undefined;
+};
+
+/** @internal */
+export type CreateAlertRequest$Outbound = {
+  display_name: string;
+  description?: string | undefined;
+  project_id: string;
+  signal?: string | undefined;
+  query: AlertQuery$Outbound;
+  condition: AlertCondition$Outbound;
+  notifier_ids?: Array<string> | undefined;
+  enabled?: boolean | undefined;
+};
+
+/** @internal */
+export const CreateAlertRequest$outboundSchema: z.ZodType<
+  CreateAlertRequest$Outbound,
+  z.ZodTypeDef,
+  CreateAlertRequest
+> = z.object({
+  displayName: z.string(),
+  description: z.string().optional(),
+  projectId: z.string(),
+  signal: z.string().optional(),
+  query: AlertQuery$outboundSchema,
+  condition: AlertCondition$outboundSchema,
+  notifierIds: z.array(z.string()).optional(),
+  enabled: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    projectId: "project_id",
+    notifierIds: "notifier_ids",
+  });
+});
+
+export function createAlertRequestToJSON(
+  createAlertRequest: CreateAlertRequest,
+): string {
+  return JSON.stringify(
+    CreateAlertRequest$outboundSchema.parse(createAlertRequest),
+  );
+}

package/src/models/components/createalertresponse.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { Alert, Alert$inboundSchema } from "./alert.js";
+
+export type CreateAlertResponse = {
+  /**
+   * Newly created alert.
+   */
+  alert: Alert;
+};
+
+/** @internal */
+export const CreateAlertResponse$inboundSchema: z.ZodType<
+  CreateAlertResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  alert: Alert$inboundSchema,
+});
+
+export function createAlertResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateAlertResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateAlertResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateAlertResponse' from JSON`,
+  );
+}

package/src/models/components/createmonitorrequest.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 {
+  MonitorWidget,
+  MonitorWidget$Outbound,
+  MonitorWidget$outboundSchema,
+} from "./monitorwidget.js";
+
+export type CreateMonitorRequest = {
+  /**
+   * Workspace-unique display name.
+   */
+  displayName: string;
+  /**
+   * Short human-readable summary of what the monitor tracks.
+   */
+  description?: string | undefined;
+  /**
+   * Project that should own the monitor. Omit to create a
+   *
+   * @remarks
+   *  workspace-wide monitor (requires admin access).
+   */
+  projectId?: string | undefined;
+  /**
+   * Widgets to render on the monitor.
+   */
+  widgets: Array<MonitorWidget>;
+  /**
+   * Default relative time range applied when the monitor opens.
+   */
+  defaultRange?: string | undefined;
+  /**
+   * Preset the monitor is created from, stamped for provenance.
+   */
+  presetKey?: string | undefined;
+};
+
+/** @internal */
+export type CreateMonitorRequest$Outbound = {
+  display_name: string;
+  description?: string | undefined;
+  project_id?: string | undefined;
+  widgets: Array<MonitorWidget$Outbound>;
+  default_range?: string | undefined;
+  preset_key?: string | undefined;
+};
+
+/** @internal */
+export const CreateMonitorRequest$outboundSchema: z.ZodType<
+  CreateMonitorRequest$Outbound,
+  z.ZodTypeDef,
+  CreateMonitorRequest
+> = z.object({
+  displayName: z.string(),
+  description: z.string().optional(),
+  projectId: z.string().optional(),
+  widgets: z.array(MonitorWidget$outboundSchema),
+  defaultRange: z.string().optional(),
+  presetKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    projectId: "project_id",
+    defaultRange: "default_range",
+    presetKey: "preset_key",
+  });
+});
+
+export function createMonitorRequestToJSON(
+  createMonitorRequest: CreateMonitorRequest,
+): string {
+  return JSON.stringify(
+    CreateMonitorRequest$outboundSchema.parse(createMonitorRequest),
+  );
+}

package/src/models/components/createmonitorresponse.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { Monitor, Monitor$inboundSchema } from "./monitor.js";
+
+export type CreateMonitorResponse = {
+  /**
+   * Newly created monitor.
+   */
+  monitor: Monitor;
+};
+
+/** @internal */
+export const CreateMonitorResponse$inboundSchema: z.ZodType<
+  CreateMonitorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  monitor: Monitor$inboundSchema,
+});
+
+export function createMonitorResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateMonitorResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateMonitorResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateMonitorResponse' from JSON`,
+  );
+}

package/src/models/components/createpersonrequest.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type CreatePersonRequest = {
+  /**
+   * Email addresses to invite. At least one email is required.
+   */
+  emails: Array<string>;
+  /**
+   * Roles to assign. Defaults to ["member"] when empty.
+   */
+  roles?: Array<string> | undefined;
+  /**
+   * Group IDs to assign.
+   */
+  groups?: Array<string> | undefined;
+};
+
+/** @internal */
+export type CreatePersonRequest$Outbound = {
+  emails: Array<string>;
+  roles?: Array<string> | undefined;
+  groups?: Array<string> | undefined;
+};
+
+/** @internal */
+export const CreatePersonRequest$outboundSchema: z.ZodType<
+  CreatePersonRequest$Outbound,
+  z.ZodTypeDef,
+  CreatePersonRequest
+> = z.object({
+  emails: z.array(z.string()),
+  roles: z.array(z.string()).optional(),
+  groups: z.array(z.string()).optional(),
+});
+
+export function createPersonRequestToJSON(
+  createPersonRequest: CreatePersonRequest,
+): string {
+  return JSON.stringify(
+    CreatePersonRequest$outboundSchema.parse(createPersonRequest),
+  );
+}

package/src/models/components/createpersonresponse.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 { Person, Person$inboundSchema } from "./person.js";
+
+export type CreatePersonResponse = {
+  /**
+   * Newly created people.
+   */
+  people: Array<Person>;
+};
+
+/** @internal */
+export const CreatePersonResponse$inboundSchema: z.ZodType<
+  CreatePersonResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  people: z.array(Person$inboundSchema),
+});
+
+export function createPersonResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreatePersonResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreatePersonResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreatePersonResponse' from JSON`,
+  );
+}

package/src/models/components/datapoint.ts

@@ -14,7 +14,8 @@ export type DataPoint = {
    * @remarks
    *  `Date.parse(timestamp)` or `new Date(timestamp).getTime()` —
    *  returning the int64 in JSON would force a string (protojson rule)
-   *  and force callers to coerce anyway, so we ship ISO only.
+   *  and force callers to coerce anyway, so we ship ISO only. Unset for
+   *  `mode=scalar` rows, which aggregate the whole window.
    */
   timestamp?: Date | undefined;
   /**