@distilled.cloud/axiom 0.30.2 → 1.0.0-rc.1

package/src/services/edge_query.ts

@@ -0,0 +1,197 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/docs restapi/versions). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  AxiomProtocol,
+  type AxiomOpError,
+  type AxiomOpContext,
+} from "../protocol.ts";
+import { UnknownAxiomError } from "../errors.ts";
+import * as Retry from "../retry.ts";
+
+export type { AxiomOpError, AxiomOpContext };
+
+export type QueryAplRequestFormat = "legacy" | "tabular" | "tabular-rows";
+export const QueryAplRequestFormat = /*@__PURE__*/ S.String;
+
+export interface QueryAplRequestDefaultOrderItem {
+  desc?: boolean;
+  field?: string;
+}
+export const QueryAplRequestDefaultOrderItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    desc: S.optional(S.Boolean),
+    field: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "QueryAplRequestDefaultOrderItem",
+}) as any as S.Schema<QueryAplRequestDefaultOrderItem>;
+
+/** The default order to use when no order is specified in the query. */
+export type QueryAplRequestDefaultOrderList =
+  Array<QueryAplRequestDefaultOrderItem>;
+export const QueryAplRequestDefaultOrderList = /*@__PURE__*/ S.Array(
+  QueryAplRequestDefaultOrderItem,
+) as any as S.Schema<QueryAplRequestDefaultOrderList>;
+
+export type QueryAplRequestLibrariesList = Array<string>;
+export const QueryAplRequestLibrariesList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<QueryAplRequestLibrariesList>;
+
+export interface QueryOptions {
+  against?: string;
+  againstStart?: string;
+  againstTimestamp?: string;
+  aggChartOpts?: string;
+  caseSensitive?: string;
+  containsTimeFilter?: string;
+  datasets?: string;
+  displayNull?: string;
+  editorContent?: string;
+  endColumn?: string;
+  endLineNumber?: string;
+  endTime?: string;
+  integrationsFilter?: string;
+  nanosecondPrecision?: string;
+  openIntervals?: string;
+  overlayCharts?: string;
+  queryObject?: string;
+  quickRange?: string;
+  resolution?: string;
+  resultsHistogram?: string;
+  selection?: string;
+  shownColumns?: string;
+  startColumn?: string;
+  startLineNumber?: string;
+  startTime?: string;
+  timeSeriesVariant?: string;
+  timeSeriesView?: string;
+}
+export const QueryOptions = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    against: S.optional(S.String),
+    againstStart: S.optional(S.String),
+    againstTimestamp: S.optional(S.String),
+    aggChartOpts: S.optional(S.String),
+    caseSensitive: S.optional(S.String),
+    containsTimeFilter: S.optional(S.String),
+    datasets: S.optional(S.String),
+    displayNull: S.optional(S.String),
+    editorContent: S.optional(S.String),
+    endColumn: S.optional(S.String),
+    endLineNumber: S.optional(S.String),
+    endTime: S.optional(S.String),
+    integrationsFilter: S.optional(S.String),
+    nanosecondPrecision: S.optional(S.String),
+    openIntervals: S.optional(S.String),
+    overlayCharts: S.optional(S.String),
+    queryObject: S.optional(S.String),
+    quickRange: S.optional(S.String),
+    resolution: S.optional(S.String),
+    resultsHistogram: S.optional(S.String),
+    selection: S.optional(S.String),
+    shownColumns: S.optional(S.String),
+    startColumn: S.optional(S.String),
+    startLineNumber: S.optional(S.String),
+    startTime: S.optional(S.String),
+    timeSeriesVariant: S.optional(S.String),
+    timeSeriesView: S.optional(S.String),
+  }),
+).annotate({ identifier: "QueryOptions" }) as any as S.Schema<QueryOptions>;
+
+/** Variables is an optional set of additional variables that are inserted into the APL */
+export type QueryAplRequestVariablesMap = {
+  [key: string]: unknown | undefined;
+};
+export const QueryAplRequestVariablesMap = /*@__PURE__*/ S.Record(
+  S.String,
+  S.Unknown,
+) as any as S.Schema<QueryAplRequestVariablesMap>;
+
+export interface QueryAplRequest {
+  format: QueryAplRequestFormat | (string & {});
+  nocache?: boolean;
+  saveAsKind?: string;
+  /** when saveAsKind is true, this parameter indicates the id of the associated dataset */
+  id?: string;
+  streaming_duration?: string;
+  /** contains the source of the APL query (for example console, dashboard, etc.) */
+  apl_source?: string;
+  /** contains the id of the source, for example dashboard_id */
+  apl_source_id?: string;
+  /** Include a totals table (only supported in MetricsDB) */
+  totals?: boolean;
+  /** APL query string */
+  apl: string;
+  /** Pagination cursor */
+  cursor?: string;
+  /** The default limit to use when no limit is specified in the query. */
+  defaultLimit?: number;
+  /** The default order to use when no order is specified in the query. */
+  defaultOrder?: QueryAplRequestDefaultOrderList;
+  /** End time for the query range */
+  endTime?: string;
+  /** Include cursor in response */
+  includeCursor?: boolean;
+  /** Defines if the _cursor field should be projected in the result */
+  includeCursorField?: boolean;
+  libraries?: QueryAplRequestLibrariesList;
+  /** Maximum number of groups to automatically bin into */
+  maxBinAutoGroups?: number;
+  queryOptions?: QueryOptions;
+  /** start and end time for the query, these must be specified as RFC3339 strings or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc) */
+  startTime?: string;
+  /** Variables is an optional set of additional variables that are inserted into the APL */
+  variables?: QueryAplRequestVariablesMap;
+}
+export const QueryAplRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    format: QueryAplRequestFormat.pipe(T.Query()),
+    nocache: S.optional(S.Boolean.pipe(T.Query())),
+    saveAsKind: S.optional(S.String.pipe(T.Query())),
+    id: S.optional(S.String.pipe(T.Query())),
+    streaming_duration: S.optional(
+      S.String.pipe(T.Query("streaming-duration")),
+    ),
+    apl_source: S.optional(S.String.pipe(T.Query("apl-source"))),
+    apl_source_id: S.optional(S.String.pipe(T.Query("apl-source-id"))),
+    totals: S.optional(S.Boolean.pipe(T.Query())),
+    apl: S.String,
+    cursor: S.optional(S.String),
+    defaultLimit: S.optional(S.Number),
+    defaultOrder: S.optional(QueryAplRequestDefaultOrderList),
+    endTime: S.optional(S.String),
+    includeCursor: S.optional(S.Boolean),
+    includeCursorField: S.optional(S.Boolean),
+    libraries: S.optional(QueryAplRequestLibrariesList),
+    maxBinAutoGroups: S.optional(S.Number),
+    queryOptions: S.optional(QueryOptions),
+    startTime: S.optional(S.String),
+    variables: S.optional(QueryAplRequestVariablesMap),
+  }).pipe(T.Http({ method: "POST", uri: "/v1/datasets/_apl", code: 200 })),
+).annotate({
+  identifier: "QueryAplRequest",
+}) as any as S.Schema<QueryAplRequest>;
+
+export type QueryAplResponse = unknown;
+export const QueryAplResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Unknown.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "QueryAplResponse",
+}) as any as S.Schema<QueryAplResponse>;
+
+export type QueryAplError = AxiomOpError;
+export const queryApl: API.OperationMethod<
+  QueryAplRequest,
+  QueryAplResponse,
+  QueryAplError,
+  AxiomOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: QueryAplRequest,
+  output: QueryAplResponse,
+  errors: [UnknownAxiomError],
+  protocol: AxiomProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/index.ts

@@ -0,0 +1,4 @@
+// AUTO-GENERATED by scripts/generate.ts. Do not edit.
+export * as edge_ingest from "./edge_ingest.ts";
+export * as edge_query from "./edge_query.ts";
+export * as v2 from "./v2.ts";