@distilled.cloud/axiom 0.0.0 → 0.13.0

package/src/operations/v2/getOrg.ts

@@ -0,0 +1,82 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { NotFound } from "../../errors";
+
+// Input Schema
+export const GetOrgInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/v2/orgs/{id}" }));
+export type GetOrgInput = typeof GetOrgInput.Type;
+
+// Output Schema
+export const GetOrgOutput = /*@__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 GetOrgOutput = typeof GetOrgOutput.Type;
+
+// The operation
+export const getOrg = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetOrgInput,
+  outputSchema: GetOrgOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/v2/getOrgs.ts

@@ -0,0 +1,82 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+
+// Input Schema
+export const GetOrgsInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({}).pipe(
+  T.Http({ method: "GET", path: "/v2/orgs" }),
+);
+export type GetOrgsInput = typeof GetOrgsInput.Type;
+
+// Output Schema
+export const GetOrgsOutput = /*@__PURE__*/ /*#__PURE__*/ Schema.Array(
+  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 GetOrgsOutput = typeof GetOrgsOutput.Type;
+
+// The operation
+export const getOrgs = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetOrgsInput,
+  outputSchema: GetOrgsOutput,
+}));

package/src/operations/v2/getRoleById.ts

@@ -0,0 +1,112 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { NotFound } from "../../errors";
+
+// Input Schema
+export const GetRoleByIdInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/v2/rbac/roles/{id}" }));
+export type GetRoleByIdInput = typeof GetRoleByIdInput.Type;
+
+// Output Schema
+export const GetRoleByIdOutput = /*@__PURE__*/ /*#__PURE__*/ 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 GetRoleByIdOutput = typeof GetRoleByIdOutput.Type;
+
+// The operation
+/**
+ * Get role by ID
+ *
+ * Retrieves detailed information about a specific role by its unique identifier.
+ *
+ * @param id - Unique identifier of the role to retrieve
+ */
+export const getRoleById = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetRoleByIdInput,
+  outputSchema: GetRoleByIdOutput,
+  errors: [NotFound] as const,
+}));

package/src/operations/v2/getStarred.ts

@@ -0,0 +1,77 @@
+import * as Schema from "effect/Schema";
+import { API } from "../../client";
+import * as T from "../../traits";
+import { NotFound } from "../../errors";
+
+// Input Schema
+export const GetStarredInput = /*@__PURE__*/ /*#__PURE__*/ Schema.Struct({
+  id: Schema.String.pipe(T.PathParam()),
+}).pipe(T.Http({ method: "GET", path: "/v2/apl-starred-queries/{id}" }));
+export type GetStarredInput = typeof GetStarredInput.Type;
+
+// Output Schema
+export const GetStarredOutput = /*@__PURE__*/ /*#__PURE__*/ 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 GetStarredOutput = typeof GetStarredOutput.Type;
+
+// The operation
+export const getStarred = /*@__PURE__*/ /*#__PURE__*/ API.make(() => ({
+  inputSchema: GetStarredInput,
+  outputSchema: GetStarredOutput,
+  errors: [NotFound] as const,
+}));

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