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

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

package/src/models/components/person.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 { PersonStatus, PersonStatus$inboundSchema } from "./personstatus.js";
+
+export type Person = {
+  /**
+   * Unique workspace user identifier (ULID).
+   */
+  id: string;
+  /**
+   * Linked account ID.
+   */
+  accountId: string;
+  /**
+   * Email address.
+   */
+  email: string;
+  /**
+   * Full display name (firstname + lastname).
+   */
+  displayName: string;
+  /**
+   * Profile image URL.
+   */
+  avatarUrl?: string | undefined;
+  /**
+   * Permission roles assigned to the person.
+   */
+  roles: Array<string>;
+  /**
+   * Group IDs the person belongs to (non-support groups).
+   */
+  groups: Array<string>;
+  status: PersonStatus;
+  /**
+   * Last activity timestamp.
+   */
+  lastActivity?: Date | undefined;
+  /**
+   * When the person was invited or added.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const Person$inboundSchema: z.ZodType<Person, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    account_id: z.string(),
+    email: z.string(),
+    display_name: z.string(),
+    avatar_url: z.string().optional(),
+    roles: z.array(z.string()),
+    groups: z.array(z.string()),
+    status: PersonStatus$inboundSchema,
+    last_activity: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).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)
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "account_id": "accountId",
+      "display_name": "displayName",
+      "avatar_url": "avatarUrl",
+      "last_activity": "lastActivity",
+      "created_at": "createdAt",
+      "updated_at": "updatedAt",
+    });
+  });
+
+export function personFromJSON(
+  jsonString: string,
+): SafeParseResult<Person, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Person$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Person' from JSON`,
+  );
+}

package/src/models/components/personstatus.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const PersonStatus = {
+  PersonStatusUnspecified: "PERSON_STATUS_UNSPECIFIED",
+  PersonStatusPending: "PERSON_STATUS_PENDING",
+  PersonStatusActive: "PERSON_STATUS_ACTIVE",
+} as const;
+export type PersonStatus = ClosedEnum<typeof PersonStatus>;
+
+/** @internal */
+export const PersonStatus$inboundSchema: z.ZodNativeEnum<typeof PersonStatus> =
+  z.nativeEnum(PersonStatus);

package/src/models/components/queryreportrequest.ts

@@ -23,9 +23,13 @@ export const Metric = {
   GenaiTokens: "genai.tokens",
   GenaiCost: "genai.cost",
   GenaiErrors: "genai.errors",
+  GenaiErrorRate: "genai.error_rate",
   GenaiLatencyP50: "genai.latency.p50",
   GenaiLatencyP95: "genai.latency.p95",
   GenaiLatencyP99: "genai.latency.p99",
+  GenaiTtftAvg: "genai.ttft.avg",
+  GenaiTtftP50: "genai.ttft.p50",
+  GenaiTtftP95: "genai.ttft.p95",
   GenaiEvaluatorRuns: "genai.evaluator.runs",
   GenaiEvaluatorPassRate: "genai.evaluator.pass_rate",
   GenaiEvaluatorScoreAvg: "genai.evaluator.score.avg",
@@ -42,7 +46,7 @@ export type Metric = ClosedEnum<typeof Metric>;
 /**
  * Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range.
  */
-export const Grain = {
+export const QueryReportRequestGrain = {
   Auto: "auto",
   Minute: "minute",
   Hour: "hour",
@@ -51,7 +55,9 @@ export const Grain = {
 /**
  * Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range.
  */
-export type Grain = ClosedEnum<typeof Grain>;
+export type QueryReportRequestGrain = ClosedEnum<
+  typeof QueryReportRequestGrain
+>;
 
 export const GroupBy = {
   Project: "project",
@@ -91,6 +97,30 @@ export const GroupBy = {
 } as const;
 export type GroupBy = ClosedEnum<typeof GroupBy>;
 
+/**
+ * Value shaping. `timeseries` (default) buckets by time; `scalar` returns one aggregated row per group over the whole window, ordered by value (top list), or a single row when `group_by` is empty.
+ */
+export const QueryReportRequestMode = {
+  Timeseries: "timeseries",
+  Scalar: "scalar",
+} as const;
+/**
+ * Value shaping. `timeseries` (default) buckets by time; `scalar` returns one aggregated row per group over the whole window, ordered by value (top list), or a single row when `group_by` is empty.
+ */
+export type QueryReportRequestMode = ClosedEnum<typeof QueryReportRequestMode>;
+
+/**
+ * Value ordering for `scalar` rows. Defaults to `desc`. Ignored for `timeseries`.
+ */
+export const QueryReportRequestSort = {
+  Desc: "desc",
+  Asc: "asc",
+} as const;
+/**
+ * Value ordering for `scalar` rows. Defaults to `desc`. Ignored for `timeseries`.
+ */
+export type QueryReportRequestSort = ClosedEnum<typeof QueryReportRequestSort>;
+
 export type QueryReportRequest = {
   /**
    * Catalogue metric to query.
@@ -107,7 +137,7 @@ export type QueryReportRequest = {
   /**
    * Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range.
    */
-  grain?: Grain | undefined;
+  grain?: QueryReportRequestGrain | undefined;
   /**
    * Reporting dimensions to break down by. Valid dimensions depend on the selected metric.
    */
@@ -137,6 +167,14 @@ export type QueryReportRequest = {
    *  report window.
    */
   includeTotals?: boolean | undefined;
+  /**
+   * Value shaping. `timeseries` (default) buckets by time; `scalar` returns one aggregated row per group over the whole window, ordered by value (top list), or a single row when `group_by` is empty.
+   */
+  mode?: QueryReportRequestMode | undefined;
+  /**
+   * Value ordering for `scalar` rows. Defaults to `desc`. Ignored for `timeseries`.
+   */
+  sort?: QueryReportRequestSort | undefined;
 };
 
 /** @internal */
@@ -147,12 +185,13 @@ export const Metric$outboundSchema: z.ZodNativeEnum<typeof Metric> =
   Metric$inboundSchema;
 
 /** @internal */
-export const Grain$inboundSchema: z.ZodNativeEnum<typeof Grain> = z.nativeEnum(
-  Grain,
-);
+export const QueryReportRequestGrain$inboundSchema: z.ZodNativeEnum<
+  typeof QueryReportRequestGrain
+> = z.nativeEnum(QueryReportRequestGrain);
 /** @internal */
-export const Grain$outboundSchema: z.ZodNativeEnum<typeof Grain> =
-  Grain$inboundSchema;
+export const QueryReportRequestGrain$outboundSchema: z.ZodNativeEnum<
+  typeof QueryReportRequestGrain
+> = QueryReportRequestGrain$inboundSchema;
 
 /** @internal */
 export const GroupBy$inboundSchema: z.ZodNativeEnum<typeof GroupBy> = z
@@ -161,6 +200,24 @@ export const GroupBy$inboundSchema: z.ZodNativeEnum<typeof GroupBy> = z
 export const GroupBy$outboundSchema: z.ZodNativeEnum<typeof GroupBy> =
   GroupBy$inboundSchema;
 
+/** @internal */
+export const QueryReportRequestMode$inboundSchema: z.ZodNativeEnum<
+  typeof QueryReportRequestMode
+> = z.nativeEnum(QueryReportRequestMode);
+/** @internal */
+export const QueryReportRequestMode$outboundSchema: z.ZodNativeEnum<
+  typeof QueryReportRequestMode
+> = QueryReportRequestMode$inboundSchema;
+
+/** @internal */
+export const QueryReportRequestSort$inboundSchema: z.ZodNativeEnum<
+  typeof QueryReportRequestSort
+> = z.nativeEnum(QueryReportRequestSort);
+/** @internal */
+export const QueryReportRequestSort$outboundSchema: z.ZodNativeEnum<
+  typeof QueryReportRequestSort
+> = QueryReportRequestSort$inboundSchema;
+
 /** @internal */
 export const QueryReportRequest$inboundSchema: z.ZodType<
   QueryReportRequest,
@@ -170,12 +227,14 @@ export const QueryReportRequest$inboundSchema: z.ZodType<
   metric: Metric$inboundSchema,
   from: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   to: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  grain: Grain$inboundSchema.optional(),
+  grain: QueryReportRequestGrain$inboundSchema.optional(),
   group_by: z.array(GroupBy$inboundSchema).optional(),
   filters: z.array(Filter$inboundSchema).optional(),
   limit: z.number().int().optional(),
   time_zone: z.string().optional(),
   include_totals: z.boolean().optional(),
+  mode: QueryReportRequestMode$inboundSchema.optional(),
+  sort: QueryReportRequestSort$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "group_by": "groupBy",
@@ -194,6 +253,8 @@ export type QueryReportRequest$Outbound = {
   limit?: number | undefined;
   time_zone?: string | undefined;
   include_totals?: boolean | undefined;
+  mode?: string | undefined;
+  sort?: string | undefined;
 };
 
 /** @internal */
@@ -205,12 +266,14 @@ export const QueryReportRequest$outboundSchema: z.ZodType<
   metric: Metric$outboundSchema,
   from: z.date().transform(v => v.toISOString()),
   to: z.date().transform(v => v.toISOString()),
-  grain: Grain$outboundSchema.optional(),
+  grain: QueryReportRequestGrain$outboundSchema.optional(),
   groupBy: z.array(GroupBy$outboundSchema).optional(),
   filters: z.array(Filter$outboundSchema).optional(),
   limit: z.number().int().optional(),
   timeZone: z.string().optional(),
   includeTotals: z.boolean().optional(),
+  mode: QueryReportRequestMode$outboundSchema.optional(),
+  sort: QueryReportRequestSort$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     groupBy: "group_by",

package/src/models/components/reasoningpart.ts

@@ -40,7 +40,7 @@ export const ReasoningPart$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("reasoning_01ky9csmheab0s8ek3h953zag1"),
+  _id: z.string().default("reasoning_01kydmwchahk59zgzt1xzmyksp"),
   metadata: z.record(z.any()).optional(),
   kind: z.literal("reasoning"),
   reasoning: z.string(),

package/src/models/components/resendinvitationrequest.ts

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