@distilled.cloud/axiom 0.0.0 → 0.12.7

package/src/operations/v2/getStarredQueries.ts

@@ -0,0 +1,92 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const GetStarredQueriesInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {
+    limit: Schema.optional(Schema.Number),
+    offset: Schema.optional(Schema.Number),
+    dataset: Schema.optional(Schema.String),
+    who: Schema.optional(Schema.String),
+    qs: Schema.optional(Schema.String),
+  },
+).pipe(T.Http({ method: "GET", path: "/v2/apl-starred-queries" }));
+export type GetStarredQueriesInput = typeof GetStarredQueriesInput.Type;
+
+// Output Schema
+export const GetStarredQueriesOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    dataset: Schema.optional(Schema.String),
+    kind: Schema.Literals(["apl"]),
+    metadata: Schema.Record(Schema.String, Schema.String),
+    name: Schema.String,
+    query: Schema.Struct({
+      apl: Schema.String,
+      cursor: Schema.optional(Schema.String),
+      defaultLimit: Schema.optional(Schema.Number),
+      defaultOrder: Schema.optional(
+        Schema.Array(
+          Schema.Struct({
+            desc: Schema.optional(Schema.Boolean),
+            field: Schema.optional(Schema.String),
+          }),
+        ),
+      ),
+      endTime: Schema.optional(Schema.String),
+      includeCursor: Schema.optional(Schema.Boolean),
+      includeCursorField: Schema.optional(Schema.Boolean),
+      libraries: Schema.optional(Schema.Array(Schema.String)),
+      queryOptions: Schema.optional(
+        Schema.Struct({
+          disableCache: Schema.optional(Schema.Boolean),
+          disableStats: Schema.optional(Schema.Boolean),
+          disableTrace: Schema.optional(Schema.Boolean),
+          maxDataPoints: Schema.optional(Schema.Number),
+          maxSeries: Schema.optional(Schema.Number),
+          noAggregation: Schema.optional(Schema.Boolean),
+          noFill: Schema.optional(Schema.Boolean),
+          noInterpolation: Schema.optional(Schema.Boolean),
+          priority: Schema.optional(Schema.Literals(["low", "medium", "high"])),
+          resolution: Schema.optional(Schema.String),
+          displayNull: Schema.optional(
+            Schema.Literals(["auto", "null", "span", "zero", ""]),
+          ),
+          overlayCharts: Schema.optional(
+            Schema.Literals(["true", "false", ""]),
+          ),
+          shownColumns: Schema.optional(Schema.String),
+          timeSeriesVariant: Schema.optional(
+            Schema.Literals(["area", "bars", "line", "lines", ""]),
+          ),
+          timeSeriesView: Schema.optional(
+            Schema.Literals([
+              "charts",
+              "resultsTable",
+              "charts|resultsTable",
+              "",
+            ]),
+          ),
+        }),
+      ),
+      startTime: Schema.optional(Schema.String),
+      variables: Schema.optional(Schema.Unknown),
+    }),
+    who: Schema.String,
+    id: Schema.String,
+  }),
+);
+export type GetStarredQueriesOutput = typeof GetStarredQueriesOutput.Type;
+
+// The operation
+/**
+ *
+ * @param who - - If the value of `who` is undefined, the request returns queries starred by the authenticated user.
+- If the value of `who` is a user ID, the request returns queries starred by the user with this ID (this request requires elevated privileges). For example, `&who='abc123'`.
+- If the value of `who` is `team`, the request returns queries starred by the team apart from the authenticated user.For example, `&who=team`.
+- If the value of `who` is `all`, the request returns queries starred by all users in the team, including the authenticated user. For example, `&who=all`.
+ */
+export const getStarredQueries = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetStarredQueriesInput,
+  outputSchema: GetStarredQueriesOutput,
+}));

package/src/operations/v2/getUser.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { NotFound } from "../../errors";
+
+// Input Schema
+export const GetUserInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/v2/users/{id}" }));
+export type GetUserInput = typeof GetUserInput.Type;
+
+// Output Schema
+export const GetUserOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  email: Schema.String,
+  id: Schema.String,
+  name: Schema.String,
+  role: Schema.optional(
+    Schema.Struct({
+      id: Schema.String,
+      name: Schema.String,
+    }),
+  ),
+});
+export type GetUserOutput = typeof GetUserOutput.Type;
+
+// The operation
+/**
+ * Get user by ID
+ */
+export const getUser = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetUserInput,
+  outputSchema: GetUserOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/v2/getUsers.ts

@@ -0,0 +1,34 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const GetUsersInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+  T.Http({ method: "GET", path: "/v2/users" }),
+);
+export type GetUsersInput = typeof GetUsersInput.Type;
+
+// Output Schema
+export const GetUsersOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    email: Schema.String,
+    id: Schema.String,
+    name: Schema.String,
+    role: Schema.optional(
+      Schema.Struct({
+        id: Schema.String,
+        name: Schema.String,
+      }),
+    ),
+  }),
+);
+export type GetUsersOutput = typeof GetUsersOutput.Type;
+
+// The operation
+/**
+ * Get users
+ */
+export const getUsers = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetUsersInput,
+  outputSchema: GetUsersOutput,
+}));

package/src/operations/v2/getView.ts

@@ -0,0 +1,28 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { NotFound } from "../../errors";
+
+// Input Schema
+export const GetViewInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/v2/views/{id}" }));
+export type GetViewInput = typeof GetViewInput.Type;
+
+// Output Schema
+export const GetViewOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  aplQuery: Schema.String,
+  datasets: Schema.optional(Schema.Array(Schema.String)),
+  description: Schema.optional(Schema.String),
+  name: Schema.String,
+  sharedByOrg: Schema.optional(Schema.String),
+  sharedByOrgName: Schema.optional(Schema.String),
+});
+export type GetViewOutput = typeof GetViewOutput.Type;
+
+// The operation
+export const getView = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetViewInput,
+  outputSchema: GetViewOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/v2/getViews.ts

@@ -0,0 +1,28 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const GetViewsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+  T.Http({ method: "GET", path: "/v2/views" }),
+);
+export type GetViewsInput = typeof GetViewsInput.Type;
+
+// Output Schema
+export const GetViewsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    aplQuery: Schema.String,
+    datasets: Schema.optional(Schema.Array(Schema.String)),
+    description: Schema.optional(Schema.String),
+    name: Schema.String,
+    sharedByOrg: Schema.optional(Schema.String),
+    sharedByOrgName: Schema.optional(Schema.String),
+  }),
+);
+export type GetViewsOutput = typeof GetViewsOutput.Type;
+
+// The operation
+export const getViews = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetViewsInput,
+  outputSchema: GetViewsOutput,
+}));

package/src/operations/v2/getVirtualField.ts

@@ -0,0 +1,29 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { NotFound } from "../../errors";
+
+// Input Schema
+export const GetVirtualFieldInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/v2/vfields/{id}" }));
+export type GetVirtualFieldInput = typeof GetVirtualFieldInput.Type;
+
+// Output Schema
+export const GetVirtualFieldOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  dataset: Schema.String,
+  description: Schema.optional(Schema.String),
+  expression: Schema.String,
+  name: Schema.String,
+  type: Schema.optional(Schema.String),
+  unit: Schema.optional(Schema.String),
+  id: Schema.String,
+});
+export type GetVirtualFieldOutput = typeof GetVirtualFieldOutput.Type;
+
+// The operation
+export const getVirtualField = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetVirtualFieldInput,
+  outputSchema: GetVirtualFieldOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/v2/getVirtualFields.ts

@@ -0,0 +1,29 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const GetVirtualFieldsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  dataset: Schema.String,
+}).pipe(T.Http({ method: "GET", path: "/v2/vfields" }));
+export type GetVirtualFieldsInput = typeof GetVirtualFieldsInput.Type;
+
+// Output Schema
+export const GetVirtualFieldsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    dataset: Schema.String,
+    description: Schema.optional(Schema.String),
+    expression: Schema.String,
+    name: Schema.String,
+    type: Schema.optional(Schema.String),
+    unit: Schema.optional(Schema.String),
+    id: Schema.String,
+  }),
+);
+export type GetVirtualFieldsOutput = typeof GetVirtualFieldsOutput.Type;
+
+// The operation
+export const getVirtualFields = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetVirtualFieldsInput,
+  outputSchema: GetVirtualFieldsOutput,
+}));

package/src/operations/v2/index.ts

@@ -0,0 +1,76 @@
+export * from "./getAnnotations";
+export * from "./createAnnotation";
+export * from "./getAnnotation";
+export * from "./updateAnnotation";
+export * from "./deleteAnnotation";
+export * from "./getDatasets";
+export * from "./createDataset";
+export * from "./getDataset";
+export * from "./updateDataset";
+export * from "./deleteDataset";
+export * from "./trimDataset";
+export * from "./vacuumDataset";
+export * from "./getFieldsForDataset";
+export * from "./getFieldForDataset";
+export * from "./updateFieldForDataset";
+export * from "./getMapFields";
+export * from "./createMapField";
+export * from "./updateMapFields";
+export * from "./deleteMapField";
+export * from "./getMonitors";
+export * from "./createMonitor";
+export * from "./getMonitor";
+export * from "./updateMonitor";
+export * from "./deleteMonitor";
+export * from "./getMonitorHistory";
+export * from "./getNotifiers";
+export * from "./createNotifier";
+export * from "./getNotifier";
+export * from "./updateNotifier";
+export * from "./deleteNotifier";
+export * from "./getOrgs";
+export * from "./createOrg";
+export * from "./getOrg";
+export * from "./updateOrg";
+export * from "./listRoles";
+export * from "./createRole";
+export * from "./getRoleById";
+export * from "./updateRole";
+export * from "./deleteRole";
+export * from "./listGroups";
+export * from "./createGroup";
+export * from "./getGroupById";
+export * from "./updateGroup";
+export * from "./deleteGroup";
+export * from "./getStarredQueries";
+export * from "./createStarred";
+export * from "./getStarred";
+export * from "./updateStarred";
+export * from "./deleteStarred";
+export * from "./getAPITokens";
+export * from "./createAPIToken";
+export * from "./getAPIToken";
+export * from "./deleteAPIToken";
+export * from "./regenerateAPIToken";
+export * from "./getCurrentUser";
+export * from "./updateCurrentUser";
+export * from "./getUsers";
+export * from "./createUser";
+export * from "./getUser";
+export * from "./removeUserFromOrg";
+export * from "./updateUserRole";
+export * from "./getVirtualFields";
+export * from "./createVirtualField";
+export * from "./getVirtualField";
+export * from "./updateVirtualField";
+export * from "./deleteVirtualField";
+export * from "./getViews";
+export * from "./createView";
+export * from "./getView";
+export * from "./updateView";
+export * from "./deleteView";
+export * from "./listDashboards";
+export * from "./createDashboard";
+export * from "./getDashboard";
+export * from "./updateDashboard";
+export * from "./deleteDashboard";

package/src/operations/v2/listDashboards.ts

@@ -0,0 +1,78 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const ListDashboardsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  limit: Schema.optional(Schema.Number),
+  offset: Schema.optional(Schema.Number),
+}).pipe(T.Http({ method: "GET", path: "/v2/dashboards" }));
+export type ListDashboardsInput = typeof ListDashboardsInput.Type;
+
+// Output Schema
+export const ListDashboardsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  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,
+  }),
+);
+export type ListDashboardsOutput = typeof ListDashboardsOutput.Type;
+
+// The operation
+/**
+ * List dashboards
+ *
+ * List dashboards visible to the caller.
+ */
+export const listDashboards = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListDashboardsInput,
+  outputSchema: ListDashboardsOutput,
+}));

package/src/operations/v2/listGroups.ts

@@ -0,0 +1,33 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const ListGroupsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {},
+).pipe(T.Http({ method: "GET", path: "/v2/rbac/groups" }));
+export type ListGroupsInput = typeof ListGroupsInput.Type;
+
+// Output Schema
+export const ListGroupsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  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 ListGroupsOutput = typeof ListGroupsOutput.Type;
+
+// The operation
+/**
+ * List all groups
+ *
+ * Retrieves all groups in the organization.
+ */
+export const listGroups = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListGroupsInput,
+  outputSchema: ListGroupsOutput,
+}));

package/src/operations/v2/listRoles.ts

@@ -0,0 +1,114 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const ListRolesInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct(
+  {},
+).pipe(T.Http({ method: "GET", path: "/v2/rbac/roles" }));
+export type ListRolesInput = typeof ListRolesInput.Type;
+
+// Output Schema
+export const ListRolesOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  Schema.Struct({
+    datasetCapabilities: Schema.optional(
+      Schema.Record(
+        Schema.String,
+        Schema.Struct({
+          data: Schema.optional(Schema.Array(Schema.Literals(["delete"]))),
+          ingest: Schema.optional(Schema.Array(Schema.Literals(["create"]))),
+          query: Schema.optional(Schema.Array(Schema.Literals(["read"]))),
+          share: Schema.optional(
+            Schema.Array(Schema.Literals(["create", "read", "delete"])),
+          ),
+          starredQueries: Schema.optional(
+            Schema.Array(
+              Schema.Literals(["create", "read", "update", "delete"]),
+            ),
+          ),
+          trim: Schema.optional(Schema.Array(Schema.Literals(["update"]))),
+          vacuum: Schema.optional(Schema.Array(Schema.Literals(["update"]))),
+          virtualFields: Schema.optional(
+            Schema.Array(
+              Schema.Literals(["create", "read", "update", "delete"]),
+            ),
+          ),
+        }),
+      ),
+    ),
+    description: Schema.optional(Schema.String),
+    members: Schema.optional(Schema.Array(Schema.String)),
+    name: Schema.String,
+    orgCapabilities: Schema.optional(
+      Schema.Struct({
+        annotations: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        apiTokens: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        auditLog: Schema.optional(Schema.Array(Schema.Literals(["read"]))),
+        billing: Schema.optional(
+          Schema.Array(Schema.Literals(["read", "update"])),
+        ),
+        dashboards: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        datasets: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        endpoints: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        flows: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        integrations: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        monitors: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        notifiers: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        rbac: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        sharedAccessKeys: Schema.optional(
+          Schema.Array(Schema.Literals(["read", "update"])),
+        ),
+        users: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+        views: Schema.optional(
+          Schema.Array(Schema.Literals(["create", "read", "update", "delete"])),
+        ),
+      }),
+    ),
+    viewCapabilities: Schema.optional(
+      Schema.Record(
+        Schema.String,
+        Schema.Struct({
+          query: Schema.optional(Schema.Array(Schema.Literals(["read"]))),
+          share: Schema.optional(
+            Schema.Array(Schema.Literals(["create", "read", "delete"])),
+          ),
+        }),
+      ),
+    ),
+    id: Schema.String,
+  }),
+);
+export type ListRolesOutput = typeof ListRolesOutput.Type;
+
+// The operation
+/**
+ * List all roles
+ *
+ * Retrieves all roles in the organization with their associated permissions and members.
+ */
+export const listRoles = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: ListRolesInput,
+  outputSchema: ListRolesOutput,
+}));