@distilled.cloud/axiom 0.0.0 → 0.12.7

package/src/operations/v2/createAnnotation.ts

@@ -0,0 +1,41 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { BadRequest, UnprocessableEntity } from "../../errors";
+
+// Input Schema
+export const CreateAnnotationInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  datasets: Schema.Array(Schema.String),
+  description: Schema.optional(Schema.String),
+  endTime: Schema.optional(Schema.String),
+  time: Schema.optional(Schema.String),
+  title: Schema.optional(Schema.String),
+  type: Schema.String,
+  url: Schema.optional(Schema.String),
+}).pipe(T.Http({ method: "POST", path: "/v2/annotations" }));
+export type CreateAnnotationInput = typeof CreateAnnotationInput.Type;
+
+// Output Schema
+export const CreateAnnotationOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    datasets: Schema.Array(Schema.String),
+    description: Schema.optional(Schema.String),
+    endTime: Schema.optional(Schema.NullOr(Schema.String)),
+    id: Schema.String,
+    time: Schema.String,
+    title: Schema.optional(Schema.String),
+    type: Schema.String,
+    url: Schema.optional(Schema.String),
+  },
+);
+export type CreateAnnotationOutput = typeof CreateAnnotationOutput.Type;
+
+// The operation
+/**
+ * Create annotation
+ */
+export const createAnnotation = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateAnnotationInput,
+  outputSchema: CreateAnnotationOutput,
+  errors: [BadRequest, UnprocessableEntity] as const,
+}));

package/src/operations/v2/createDashboard.ts

@@ -0,0 +1,127 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { BadRequest, Conflict } from "../../errors";
+
+// Input Schema
+export const CreateDashboardInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  dashboard: Schema.Struct({
+    name: Schema.String,
+    owner: Schema.String,
+    description: Schema.optional(Schema.String),
+    charts: Schema.Array(Schema.Unknown),
+    layout: Schema.Array(
+      Schema.Struct({
+        i: Schema.String,
+        x: Schema.Number,
+        y: Schema.NullOr(Schema.Number),
+        w: Schema.Number,
+        h: Schema.Number,
+        minW: Schema.optional(Schema.Number),
+        minH: Schema.optional(Schema.Number),
+        maxW: Schema.optional(Schema.Number),
+        maxH: Schema.optional(Schema.Number),
+        static: Schema.optional(Schema.Boolean),
+      }),
+    ),
+    refreshTime: Schema.Literals([15, 60, 300]),
+    schemaVersion: Schema.Literals([2]),
+    against: Schema.optional(
+      Schema.Literals([
+        "-1h",
+        "-3h",
+        "-6h",
+        "-12h",
+        "-1d",
+        "-3d",
+        "-7d",
+        "-1w",
+        "-2w",
+        "-3w",
+        "-30d",
+        "-60d",
+        "-90d",
+      ]),
+    ),
+    againstTimestamp: Schema.optional(Schema.String),
+    timeWindowStart: Schema.String,
+    timeWindowEnd: Schema.String,
+    uid: Schema.optional(Schema.String),
+  }),
+  message: Schema.optional(Schema.String),
+  overwrite: Schema.optional(Schema.Boolean),
+  uid: Schema.optional(Schema.String),
+  version: Schema.optional(Schema.Unknown),
+}).pipe(T.Http({ method: "POST", path: "/v2/dashboards" }));
+export type CreateDashboardInput = typeof CreateDashboardInput.Type;
+
+// Output Schema
+export const CreateDashboardOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  dashboard: Schema.Struct({
+    createdAt: Schema.String,
+    createdBy: Schema.String,
+    dashboard: Schema.Struct({
+      name: Schema.String,
+      owner: Schema.String,
+      description: Schema.optional(Schema.String),
+      charts: Schema.Array(Schema.Unknown),
+      layout: Schema.Array(
+        Schema.Struct({
+          i: Schema.String,
+          x: Schema.Number,
+          y: Schema.NullOr(Schema.Number),
+          w: Schema.Number,
+          h: Schema.Number,
+          minW: Schema.optional(Schema.Number),
+          minH: Schema.optional(Schema.Number),
+          maxW: Schema.optional(Schema.Number),
+          maxH: Schema.optional(Schema.Number),
+          static: Schema.optional(Schema.Boolean),
+        }),
+      ),
+      refreshTime: Schema.Literals([15, 60, 300]),
+      schemaVersion: Schema.Literals([2]),
+      against: Schema.optional(
+        Schema.Literals([
+          "-1h",
+          "-3h",
+          "-6h",
+          "-12h",
+          "-1d",
+          "-3d",
+          "-7d",
+          "-1w",
+          "-2w",
+          "-3w",
+          "-30d",
+          "-60d",
+          "-90d",
+        ]),
+      ),
+      againstTimestamp: Schema.optional(Schema.String),
+      timeWindowStart: Schema.String,
+      timeWindowEnd: Schema.String,
+      uid: Schema.optional(Schema.String),
+    }),
+    id: Schema.String,
+    uid: Schema.String,
+    updatedAt: Schema.String,
+    updatedBy: Schema.String,
+    version: Schema.Unknown,
+  }),
+  overwritten: Schema.optional(Schema.Boolean),
+  status: Schema.Literals(["created", "updated"]),
+});
+export type CreateDashboardOutput = typeof CreateDashboardOutput.Type;
+
+// The operation
+/**
+ * Create dashboard
+ *
+ * Create a dashboard from a dashboard document payload.
+ */
+export const createDashboard = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateDashboardInput,
+  outputSchema: CreateDashboardOutput,
+  errors: [BadRequest, Conflict] as const,
+}));

package/src/operations/v2/createDataset.ts

@@ -0,0 +1,57 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { BadRequest, Forbidden, UnprocessableEntity } from "../../errors";
+
+// Input Schema
+export const CreateDatasetInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  referrer: Schema.optional(Schema.String),
+  description: Schema.optional(Schema.String),
+  edgeDeployment: Schema.optional(Schema.String),
+  kind: Schema.optional(
+    Schema.Literals([
+      "otel:metrics:v1",
+      "otel:traces:v1",
+      "otel:logs:v1",
+      "axiom:events:v1",
+    ]),
+  ),
+  name: Schema.String,
+  retentionDays: Schema.optional(Schema.Number),
+  useRetentionPeriod: Schema.optional(Schema.Boolean),
+}).pipe(T.Http({ method: "POST", path: "/v2/datasets" }));
+export type CreateDatasetInput = typeof CreateDatasetInput.Type;
+
+// Output Schema
+export const CreateDatasetOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  canWrite: Schema.optional(Schema.Boolean),
+  created: Schema.String,
+  description: Schema.String,
+  edgeDeployment: Schema.optional(Schema.String),
+  id: Schema.String,
+  kind: Schema.Literals([
+    "otel:metrics:v1",
+    "otel:traces:v1",
+    "otel:logs:v1",
+    "axiom:events:v1",
+  ]),
+  mapFields: Schema.optional(Schema.Array(Schema.String)),
+  name: Schema.String,
+  retentionDays: Schema.optional(Schema.Number),
+  sharedByOrg: Schema.optional(Schema.String),
+  useRetentionPeriod: Schema.optional(Schema.Boolean),
+  who: Schema.String,
+});
+export type CreateDatasetOutput = typeof CreateDatasetOutput.Type;
+
+// The operation
+/**
+ * Create dataset
+ *
+ * @param referrer - Referrer slug
+ */
+export const createDataset = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateDatasetInput,
+  outputSchema: CreateDatasetOutput,
+  errors: [BadRequest, Forbidden, UnprocessableEntity] as const,
+}));

package/src/operations/v2/createGroup.ts

@@ -0,0 +1,37 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { UnprocessableEntity } from "../../errors";
+
+// Input Schema
+export const CreateGroupInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  description: Schema.optional(Schema.String),
+  isManaged: Schema.optional(Schema.Boolean),
+  members: Schema.optional(Schema.Array(Schema.String)),
+  name: Schema.String,
+  roles: Schema.optional(Schema.Array(Schema.String)),
+}).pipe(T.Http({ method: "POST", path: "/v2/rbac/groups" }));
+export type CreateGroupInput = typeof CreateGroupInput.Type;
+
+// Output Schema
+export const CreateGroupOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  description: Schema.optional(Schema.String),
+  isManaged: Schema.optional(Schema.Boolean),
+  members: Schema.optional(Schema.Array(Schema.String)),
+  name: Schema.String,
+  roles: Schema.optional(Schema.Array(Schema.String)),
+  id: Schema.String,
+});
+export type CreateGroupOutput = typeof CreateGroupOutput.Type;
+
+// The operation
+/**
+ * Create group
+ *
+ * Creates a new group in the organization.
+ */
+export const createGroup = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateGroupInput,
+  outputSchema: CreateGroupOutput,
+  errors: [UnprocessableEntity] as const,
+}));

package/src/operations/v2/createMapField.ts

@@ -0,0 +1,26 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { NotFound, UnprocessableEntity } from "../../errors";
+
+// Input Schema
+export const CreateMapFieldInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  dataset_id: Schema.String.pipe(T.PathParam()),
+  name: Schema.String,
+}).pipe(
+  T.Http({ method: "POST", path: "/v2/datasets/{dataset_id}/mapfields" }),
+);
+export type CreateMapFieldInput = typeof CreateMapFieldInput.Type;
+
+// Output Schema
+export const CreateMapFieldOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  name: Schema.String,
+});
+export type CreateMapFieldOutput = typeof CreateMapFieldOutput.Type;
+
+// The operation
+export const createMapField = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateMapFieldInput,
+  outputSchema: CreateMapFieldOutput,
+  errors: [NotFound, UnprocessableEntity] as const,
+}));

package/src/operations/v2/createMonitor.ts

@@ -0,0 +1,91 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { UnprocessableEntity } from "../../errors";
+
+// Input Schema
+export const CreateMonitorInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  alertOnNoData: Schema.optional(Schema.Boolean),
+  aplQuery: Schema.optional(Schema.String),
+  columnName: Schema.optional(Schema.String),
+  compareDays: Schema.optional(Schema.Number),
+  createdAt: Schema.optional(Schema.String),
+  createdBy: Schema.optional(Schema.String),
+  description: Schema.optional(Schema.String),
+  disabled: Schema.optional(Schema.Boolean),
+  disabledUntil: Schema.optional(Schema.NullOr(Schema.String)),
+  intervalMinutes: Schema.optional(Schema.Number),
+  mplQuery: Schema.optional(Schema.String),
+  name: Schema.String,
+  notifierIds: Schema.optional(Schema.Array(Schema.String)),
+  notifyByGroup: Schema.optional(Schema.Boolean),
+  notifyEveryRun: Schema.optional(Schema.Boolean),
+  operator: Schema.optional(
+    Schema.Literals([
+      "Below",
+      "BelowOrEqual",
+      "Above",
+      "AboveOrEqual",
+      "AboveOrBelow",
+    ]),
+  ),
+  rangeMinutes: Schema.optional(Schema.Number),
+  resolvable: Schema.optional(Schema.Boolean),
+  secondDelay: Schema.optional(Schema.Number),
+  skipResolved: Schema.optional(Schema.Boolean),
+  threshold: Schema.optional(Schema.Number),
+  tolerance: Schema.optional(Schema.Number),
+  triggerAfterNPositiveResults: Schema.optional(Schema.Number),
+  triggerFromNRuns: Schema.optional(Schema.Number),
+  type: Schema.Literals(["Threshold", "MatchEvent", "AnomalyDetection"]),
+}).pipe(T.Http({ method: "POST", path: "/v2/monitors" }));
+export type CreateMonitorInput = typeof CreateMonitorInput.Type;
+
+// Output Schema
+export const CreateMonitorOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  alertOnNoData: Schema.optional(Schema.Boolean),
+  aplQuery: Schema.optional(Schema.String),
+  columnName: Schema.optional(Schema.String),
+  compareDays: Schema.optional(Schema.Number),
+  createdAt: Schema.optional(Schema.String),
+  createdBy: Schema.optional(Schema.String),
+  description: Schema.optional(Schema.String),
+  disabled: Schema.optional(Schema.Boolean),
+  disabledUntil: Schema.optional(Schema.NullOr(Schema.String)),
+  intervalMinutes: Schema.optional(Schema.Number),
+  mplQuery: Schema.optional(Schema.String),
+  name: Schema.String,
+  notifierIds: Schema.optional(Schema.Array(Schema.String)),
+  notifyByGroup: Schema.optional(Schema.Boolean),
+  notifyEveryRun: Schema.optional(Schema.Boolean),
+  operator: Schema.optional(
+    Schema.Literals([
+      "Below",
+      "BelowOrEqual",
+      "Above",
+      "AboveOrEqual",
+      "AboveOrBelow",
+    ]),
+  ),
+  rangeMinutes: Schema.optional(Schema.Number),
+  resolvable: Schema.optional(Schema.Boolean),
+  secondDelay: Schema.optional(Schema.Number),
+  skipResolved: Schema.optional(Schema.Boolean),
+  threshold: Schema.optional(Schema.Number),
+  tolerance: Schema.optional(Schema.Number),
+  triggerAfterNPositiveResults: Schema.optional(Schema.Number),
+  triggerFromNRuns: Schema.optional(Schema.Number),
+  type: Schema.Literals(["Threshold", "MatchEvent", "AnomalyDetection"]),
+  id: Schema.String,
+});
+export type CreateMonitorOutput = typeof CreateMonitorOutput.Type;
+
+// The operation
+/**
+ * Create monitor
+ */
+export const createMonitor = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateMonitorInput,
+  outputSchema: CreateMonitorOutput,
+  errors: [UnprocessableEntity] as const,
+}));

package/src/operations/v2/createNotifier.ts

@@ -0,0 +1,144 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { UnprocessableEntity } from "../../errors";
+import { SensitiveString } from "../../sensitive";
+
+// Input Schema
+export const CreateNotifierInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  createdAt: Schema.optional(Schema.String),
+  createdBy: Schema.optional(Schema.String),
+  disabledUntil: Schema.optional(Schema.String),
+  name: Schema.String,
+  properties: Schema.Struct({
+    customWebhook: Schema.optional(
+      Schema.Struct({
+        body: Schema.String,
+        headers: Schema.optional(Schema.Record(Schema.String, Schema.String)),
+        secretHeaders: Schema.optional(
+          Schema.Record(Schema.String, Schema.String),
+        ),
+        url: Schema.String,
+      }),
+    ),
+    discord: Schema.optional(
+      Schema.Struct({
+        discordChannel: Schema.optional(Schema.String),
+        discordToken: Schema.optional(Schema.String),
+      }),
+    ),
+    discordWebhook: Schema.optional(
+      Schema.Struct({
+        discordWebhookUrl: Schema.optional(Schema.String),
+      }),
+    ),
+    email: Schema.optional(
+      Schema.Struct({
+        emails: Schema.optional(Schema.Array(Schema.String)),
+      }),
+    ),
+    microsoftTeams: Schema.optional(
+      Schema.Struct({
+        microsoftTeamsUrl: Schema.optional(Schema.String),
+      }),
+    ),
+    opsgenie: Schema.optional(
+      Schema.Struct({
+        apiKey: Schema.optional(SensitiveString),
+        isEU: Schema.optional(Schema.Boolean),
+      }),
+    ),
+    pagerduty: Schema.optional(
+      Schema.Struct({
+        routingKey: Schema.optional(Schema.String),
+        token: Schema.optional(Schema.String),
+      }),
+    ),
+    slack: Schema.optional(
+      Schema.Struct({
+        slackUrl: Schema.optional(Schema.String),
+      }),
+    ),
+    webhook: Schema.optional(
+      Schema.Struct({
+        url: Schema.optional(Schema.String),
+      }),
+    ),
+  }),
+}).pipe(T.Http({ method: "POST", path: "/v2/notifiers" }));
+export type CreateNotifierInput = typeof CreateNotifierInput.Type;
+
+// Output Schema
+export const CreateNotifierOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  createdAt: Schema.optional(Schema.String),
+  createdBy: Schema.optional(Schema.String),
+  disabledUntil: Schema.optional(Schema.String),
+  name: Schema.String,
+  properties: Schema.Struct({
+    customWebhook: Schema.optional(
+      Schema.Struct({
+        body: Schema.String,
+        headers: Schema.optional(Schema.Record(Schema.String, Schema.String)),
+        secretHeaders: Schema.optional(
+          Schema.Record(Schema.String, Schema.String),
+        ),
+        url: Schema.String,
+      }),
+    ),
+    discord: Schema.optional(
+      Schema.Struct({
+        discordChannel: Schema.optional(Schema.String),
+        discordToken: Schema.optional(Schema.String),
+      }),
+    ),
+    discordWebhook: Schema.optional(
+      Schema.Struct({
+        discordWebhookUrl: Schema.optional(Schema.String),
+      }),
+    ),
+    email: Schema.optional(
+      Schema.Struct({
+        emails: Schema.optional(Schema.Array(Schema.String)),
+      }),
+    ),
+    microsoftTeams: Schema.optional(
+      Schema.Struct({
+        microsoftTeamsUrl: Schema.optional(Schema.String),
+      }),
+    ),
+    opsgenie: Schema.optional(
+      Schema.Struct({
+        apiKey: Schema.optional(SensitiveString),
+        isEU: Schema.optional(Schema.Boolean),
+      }),
+    ),
+    pagerduty: Schema.optional(
+      Schema.Struct({
+        routingKey: Schema.optional(Schema.String),
+        token: Schema.optional(Schema.String),
+      }),
+    ),
+    slack: Schema.optional(
+      Schema.Struct({
+        slackUrl: Schema.optional(Schema.String),
+      }),
+    ),
+    webhook: Schema.optional(
+      Schema.Struct({
+        url: Schema.optional(Schema.String),
+      }),
+    ),
+  }),
+  id: Schema.optional(Schema.String),
+});
+export type CreateNotifierOutput = typeof CreateNotifierOutput.Type;
+
+// The operation
+/**
+ * Creates a new notifier configuration for sending alerts through various channels (Slack, Email, etc)
+ */
+export const createNotifier = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateNotifierInput,
+  outputSchema: CreateNotifierOutput,
+  errors: [UnprocessableEntity] as const,
+}));

package/src/operations/v2/createOrg.ts

@@ -0,0 +1,81 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const CreateOrgInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  edgeDeployment: Schema.optional(Schema.String),
+  name: Schema.String,
+}).pipe(T.Http({ method: "POST", path: "/v2/orgs" }));
+export type CreateOrgInput = typeof CreateOrgInput.Type;
+
+// Output Schema
+export const CreateOrgOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  defaultEdgeDeployment: Schema.optional(Schema.String),
+  defaultRegion: Schema.optional(Schema.String),
+  firstFailedPayment: Schema.optional(Schema.String),
+  id: Schema.String,
+  lastUsageSync: Schema.String,
+  license: Schema.Struct({
+    apiRateLimitPerSecond: Schema.optional(Schema.Number),
+    billingPeriodEnd: Schema.optional(Schema.String),
+    billingPeriodStart: Schema.optional(Schema.String),
+    defaultEdgeDeployment: Schema.optional(Schema.String),
+    defaultRegion: Schema.optional(Schema.String),
+    edgeDeployments: Schema.optional(Schema.Array(Schema.String)),
+    expiresAt: Schema.optional(Schema.NullOr(Schema.String)),
+    features: Schema.optional(Schema.Record(Schema.String, Schema.Boolean)),
+    id: Schema.String,
+    issuedAt: Schema.optional(Schema.String),
+    issuedTo: Schema.optional(Schema.String),
+    issuer: Schema.optional(Schema.String),
+    maxAuditWindowSeconds: Schema.optional(Schema.Number),
+    maxDatasets: Schema.optional(Schema.Number),
+    maxEndpoints: Schema.optional(Schema.Number),
+    maxFields: Schema.optional(Schema.Number),
+    maxMonitors: Schema.optional(Schema.Number),
+    maxQueryWindowSeconds: Schema.optional(Schema.Number),
+    maxUsers: Schema.optional(Schema.Number),
+    monthlyIngestGb: Schema.optional(Schema.Number),
+    monthlyQueryGbHours: Schema.optional(Schema.Number),
+    regions: Schema.optional(Schema.Array(Schema.String)),
+    storageAllowanceGB: Schema.optional(Schema.Number),
+    tier: Schema.Literals([
+      "personal",
+      "basicDirect",
+      "teamMonthlyDirect",
+      "teamMonthlyAws",
+      "axiomCloud",
+      "teamPlus",
+      "enterprise",
+      "comped",
+    ]),
+    validFrom: Schema.optional(Schema.String),
+    withAuths: Schema.optional(Schema.Array(Schema.String)),
+  }),
+  metaCreated: Schema.optional(Schema.String),
+  metaModified: Schema.optional(Schema.String),
+  metaVersion: Schema.optional(Schema.String),
+  name: Schema.String,
+  paymentStatus: Schema.Literals(["na", "failed", "success", "blocked"]),
+  plan: Schema.Literals([
+    "personal",
+    "basicDirect",
+    "teamMonthlyDirect",
+    "teamMonthlyAws",
+    "axiomCloud",
+    "teamPlus",
+    "enterprise",
+    "comped",
+  ]),
+  planCreated: Schema.String,
+  primaryEmail: Schema.String,
+  role: Schema.optional(Schema.String),
+});
+export type CreateOrgOutput = typeof CreateOrgOutput.Type;
+
+// The operation
+export const createOrg = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: CreateOrgInput,
+  outputSchema: CreateOrgOutput,
+}));