@distilled.cloud/vercel 0.0.0 → 1.0.0-rc.10

package/src/services/observability.ts

@@ -0,0 +1,435 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-vercel/specs/openapi.json). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as C from "@distilled.cloud/core/category";
+import * as T from "../traits.ts";
+import {
+  VercelProtocol,
+  type VercelOpError,
+  type VercelOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { VercelOpError, VercelOpContext };
+
+export class BadRequest
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<BadRequest>()("BadRequest", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 400 }],
+  ) {}
+
+export class Forbidden
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<Forbidden>()("Forbidden", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withAuthError),
+    [{ status: 403 }],
+  ) {}
+
+export class NotFound
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<NotFound>()("NotFound", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 404 }],
+  ) {}
+
+export class PaymentRequired
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<PaymentRequired>()("PaymentRequired", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withQuotaError),
+    [{ status: 402 }],
+  ) {}
+
+/** Dimensions to group results by. JSON dimensions support nested refs, for example event_data/checkout_step. Nested keys containing characters that OData cannot parse as an identifier, such as '-', spaces, quotes, or '/', must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/'enable-comments-view' or event_data/'some property''s/value'. */
+export type CreateObservabilityQueryRequestGroupByList = Array<string>;
+export const CreateObservabilityQueryRequestGroupByList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<CreateObservabilityQueryRequestGroupByList>;
+
+/** Direction to order grouped results by. Defaults to desc. */
+export type CreateObservabilityQueryRequestOrderDirection = "asc" | "desc";
+export const CreateObservabilityQueryRequestOrderDirection = S.String;
+
+export interface CreateObservabilityQueryRequest {
+  /** Metric id */
+  metric: string;
+  /** Owner or project scope for the query */
+  scope: unknown;
+  /** Aggregation function to apply. Some aggregations require a dimension: use <agg>/<dimension>, for example unique/visitor_id. */
+  aggregation?: string;
+  /** Dimensions to group results by. JSON dimensions support nested refs, for example event_data/checkout_step. Nested keys containing characters that OData cannot parse as an identifier, such as '-', spaces, quotes, or '/', must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/'enable-comments-view' or event_data/'some property''s/value'. */
+  groupBy?: CreateObservabilityQueryRequestGroupByList;
+  /** Filter to apply to the query. JSON dimensions support nested refs, for example event_data/checkout_step eq 'payment'. Nested keys containing characters that OData cannot parse as an identifier, such as '-', spaces, quotes, or '/', must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/'enable-comments-view' eq true or event_data/'some property''s/value' eq true. */
+  filter?: string;
+  /** Maximum number of results */
+  limit?: number;
+  /** Rollup column to order grouped results by. Use the generated rollup key for the requested metric and aggregation. Defaults to the query engine count rollup. */
+  orderBy?: string;
+  /** Direction to order grouped results by. Defaults to desc. */
+  orderDirection?:
+    | CreateObservabilityQueryRequestOrderDirection
+    | (string & {});
+  /** Time bucket size */
+  granularity?: unknown;
+  /** Start timestamp */
+  startTime?: string;
+  /** End timestamp */
+  endTime?: string;
+  /** IANA timezone (e.g. Europe/Paris) used only to align calendar buckets (1d/1mo) to that zone's day/month boundaries. startTime/endTime and all output timestamps are always UTC. No effect on sub-day granularities. */
+  bucketTimezone?: string;
+}
+export const CreateObservabilityQueryRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    metric: S.String,
+    scope: S.Unknown,
+    aggregation: S.optional(S.String),
+    groupBy: S.optional(CreateObservabilityQueryRequestGroupByList),
+    filter: S.optional(S.String),
+    limit: S.optional(S.Number),
+    orderBy: S.optional(S.String),
+    orderDirection: S.optional(CreateObservabilityQueryRequestOrderDirection),
+    granularity: S.optional(S.Unknown),
+    startTime: S.optional(S.String),
+    endTime: S.optional(S.String),
+    bucketTimezone: S.optional(S.String),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/v2/observability/query", code: 200 }),
+  ),
+).annotate({
+  identifier: "CreateObservabilityQueryRequest",
+}) as any as S.Schema<CreateObservabilityQueryRequest>;
+
+export type CreateObservabilityQueryResponse = unknown;
+export const CreateObservabilityQueryResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Unknown.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "CreateObservabilityQueryResponse",
+}) as any as S.Schema<CreateObservabilityQueryResponse>;
+
+export interface GetObservabilityConfigurationProjectsRequest {
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+}
+export const GetObservabilityConfigurationProjectsRequest =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      teamId: S.optional(S.String.pipe(T.Query())),
+      slug: S.optional(S.String.pipe(T.Query())),
+    }).pipe(
+      T.Http({
+        method: "GET",
+        uri: "/v1/observability/manage/configuration/projects",
+        code: 200,
+      }),
+    ),
+  ).annotate({
+    identifier: "GetObservabilityConfigurationProjectsRequest",
+  }) as any as S.Schema<GetObservabilityConfigurationProjectsRequest>;
+
+export interface GetObservabilityConfigurationProjectsResponseDisabledProjectsItem {
+  id: string;
+  name?: string;
+  disabledAt: number;
+}
+export const GetObservabilityConfigurationProjectsResponseDisabledProjectsItem =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      id: S.String,
+      name: S.optional(S.String),
+      disabledAt: S.Number,
+    }),
+  ).annotate({
+    identifier:
+      "GetObservabilityConfigurationProjectsResponseDisabledProjectsItem",
+  }) as any as S.Schema<GetObservabilityConfigurationProjectsResponseDisabledProjectsItem>;
+
+export type GetObservabilityConfigurationProjectsResponseDisabledProjectsList =
+  Array<GetObservabilityConfigurationProjectsResponseDisabledProjectsItem>;
+export const GetObservabilityConfigurationProjectsResponseDisabledProjectsList =
+  /*@__PURE__*/ S.Array(
+    GetObservabilityConfigurationProjectsResponseDisabledProjectsItem,
+  ) as any as S.Schema<GetObservabilityConfigurationProjectsResponseDisabledProjectsList>;
+
+export interface GetObservabilityConfigurationProjectsResponse {
+  disabledProjects: GetObservabilityConfigurationProjectsResponseDisabledProjectsList;
+}
+export const GetObservabilityConfigurationProjectsResponse =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      disabledProjects:
+        GetObservabilityConfigurationProjectsResponseDisabledProjectsList,
+    }),
+  ).annotate({
+    identifier: "GetObservabilityConfigurationProjectsResponse",
+  }) as any as S.Schema<GetObservabilityConfigurationProjectsResponse>;
+
+export interface GetObservabilitySchemaRequest {}
+export const GetObservabilitySchemaRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/v2/observability/schema", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetObservabilitySchemaRequest",
+}) as any as S.Schema<GetObservabilitySchemaRequest>;
+
+export interface GetObservabilitySchemaResponseMetricsItem {
+  id: string;
+  description: string;
+}
+export const GetObservabilitySchemaResponseMetricsItem =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      id: S.String,
+      description: S.String,
+    }),
+  ).annotate({
+    identifier: "GetObservabilitySchemaResponseMetricsItem",
+  }) as any as S.Schema<GetObservabilitySchemaResponseMetricsItem>;
+
+export type GetObservabilitySchemaResponseMetricsList =
+  Array<GetObservabilitySchemaResponseMetricsItem>;
+export const GetObservabilitySchemaResponseMetricsList = /*@__PURE__*/ S.Array(
+  GetObservabilitySchemaResponseMetricsItem,
+) as any as S.Schema<GetObservabilitySchemaResponseMetricsList>;
+
+export interface GetObservabilitySchemaResponse {
+  metrics: GetObservabilitySchemaResponseMetricsList;
+}
+export const GetObservabilitySchemaResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    metrics: GetObservabilitySchemaResponseMetricsList,
+  }),
+).annotate({
+  identifier: "GetObservabilitySchemaResponse",
+}) as any as S.Schema<GetObservabilitySchemaResponse>;
+
+export interface GetObservabilitySchemaByMetricIdRequest {
+  metricId: string;
+}
+export const GetObservabilitySchemaByMetricIdRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      metricId: S.String.pipe(T.Label()),
+    }).pipe(
+      T.Http({
+        method: "GET",
+        uri: "/v2/observability/schema/{metricId}",
+        code: 200,
+      }),
+    ),
+).annotate({
+  identifier: "GetObservabilitySchemaByMetricIdRequest",
+}) as any as S.Schema<GetObservabilitySchemaByMetricIdRequest>;
+
+export interface GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsItem {
+  name: string;
+  label: string;
+  description?: string;
+}
+export const GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsItem =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      name: S.String,
+      label: S.String,
+      description: S.optional(S.String),
+    }),
+  ).annotate({
+    identifier:
+      "GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsItem",
+  }) as any as S.Schema<GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsItem>;
+
+export type GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsList =
+  Array<GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsItem>;
+export const GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsList =
+  /*@__PURE__*/ S.Array(
+    GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsItem,
+  ) as any as S.Schema<GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsList>;
+
+export type GetObservabilitySchemaByMetricIdResponseBodyItemAggregationsList =
+  Array<string>;
+export const GetObservabilitySchemaByMetricIdResponseBodyItemAggregationsList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<GetObservabilitySchemaByMetricIdResponseBodyItemAggregationsList>;
+
+export interface GetObservabilitySchemaByMetricIdResponseBodyItem {
+  id: string;
+  description: string;
+  dimensions: GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsList;
+  unit: string;
+  aggregations: GetObservabilitySchemaByMetricIdResponseBodyItemAggregationsList;
+  defaultAggregation: string;
+}
+export const GetObservabilitySchemaByMetricIdResponseBodyItem =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      id: S.String,
+      description: S.String,
+      dimensions:
+        GetObservabilitySchemaByMetricIdResponseBodyItemDimensionsList,
+      unit: S.String,
+      aggregations:
+        GetObservabilitySchemaByMetricIdResponseBodyItemAggregationsList,
+      defaultAggregation: S.String,
+    }),
+  ).annotate({
+    identifier: "GetObservabilitySchemaByMetricIdResponseBodyItem",
+  }) as any as S.Schema<GetObservabilitySchemaByMetricIdResponseBodyItem>;
+
+export type GetObservabilitySchemaByMetricIdResponseBodyList =
+  Array<GetObservabilitySchemaByMetricIdResponseBodyItem>;
+export const GetObservabilitySchemaByMetricIdResponseBodyList =
+  /*@__PURE__*/ S.Array(
+    GetObservabilitySchemaByMetricIdResponseBodyItem,
+  ) as any as S.Schema<GetObservabilitySchemaByMetricIdResponseBodyList>;
+
+export type GetObservabilitySchemaByMetricIdResponse =
+  GetObservabilitySchemaByMetricIdResponseBodyList;
+export const GetObservabilitySchemaByMetricIdResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    GetObservabilitySchemaByMetricIdResponseBodyList.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "GetObservabilitySchemaByMetricIdResponse",
+}) as any as S.Schema<GetObservabilitySchemaByMetricIdResponse>;
+
+export interface UpdateObservabilityConfigurationProjectRequest {
+  /** The ID or name of the project to update */
+  projectIdOrName: string;
+  /** The Team identifier to perform the request on behalf of. */
+  teamId?: string;
+  /** The Team slug to perform the request on behalf of. */
+  slug?: string;
+  /** Whether Observability Plus should be disabled for the project */
+  disabled: boolean;
+}
+export const UpdateObservabilityConfigurationProjectRequest =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      projectIdOrName: S.String.pipe(T.Label()),
+      teamId: S.optional(S.String.pipe(T.Query())),
+      slug: S.optional(S.String.pipe(T.Query())),
+      disabled: S.Boolean,
+    }).pipe(
+      T.Http({
+        method: "PUT",
+        uri: "/v1/observability/manage/configuration/projects/{projectIdOrName}",
+        code: 200,
+      }),
+    ),
+  ).annotate({
+    identifier: "UpdateObservabilityConfigurationProjectRequest",
+  }) as any as S.Schema<UpdateObservabilityConfigurationProjectRequest>;
+
+export interface UpdateObservabilityConfigurationProjectResponse {
+  id: string;
+  disabledAt?: number;
+}
+export const UpdateObservabilityConfigurationProjectResponse =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      id: S.String,
+      disabledAt: S.optional(S.Number),
+    }),
+  ).annotate({
+    identifier: "UpdateObservabilityConfigurationProjectResponse",
+  }) as any as S.Schema<UpdateObservabilityConfigurationProjectResponse>;
+
+export type CreateObservabilityQueryError =
+  | BadRequest
+  | PaymentRequired
+  | Forbidden
+  | VercelOpError;
+export const createObservabilityQuery: API.OperationMethod<
+  CreateObservabilityQueryRequest,
+  CreateObservabilityQueryResponse,
+  CreateObservabilityQueryError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateObservabilityQueryRequest,
+  output: CreateObservabilityQueryResponse,
+  errors: [BadRequest, PaymentRequired, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetObservabilityConfigurationProjectsError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Lists disabled Observability Plus projects Lists the projects that are currently configured as disabled for Observability Plus on a team. */
+export const getObservabilityConfigurationProjects: API.OperationMethod<
+  GetObservabilityConfigurationProjectsRequest,
+  GetObservabilityConfigurationProjectsResponse,
+  GetObservabilityConfigurationProjectsError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetObservabilityConfigurationProjectsRequest,
+  output: GetObservabilityConfigurationProjectsResponse,
+  errors: [BadRequest, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetObservabilitySchemaError =
+  | BadRequest
+  | Forbidden
+  | VercelOpError;
+export const getObservabilitySchema: API.OperationMethod<
+  GetObservabilitySchemaRequest,
+  GetObservabilitySchemaResponse,
+  GetObservabilitySchemaError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetObservabilitySchemaRequest,
+  output: GetObservabilitySchemaResponse,
+  errors: [BadRequest, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetObservabilitySchemaByMetricIdError =
+  | BadRequest
+  | Forbidden
+  | VercelOpError;
+export const getObservabilitySchemaByMetricId: API.OperationMethod<
+  GetObservabilitySchemaByMetricIdRequest,
+  GetObservabilitySchemaByMetricIdResponse,
+  GetObservabilitySchemaByMetricIdError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetObservabilitySchemaByMetricIdRequest,
+  output: GetObservabilitySchemaByMetricIdResponse,
+  errors: [BadRequest, Forbidden],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));
+
+export type UpdateObservabilityConfigurationProjectError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | VercelOpError;
+/** Updates a disabled Observability Plus project setting Updates whether Observability Plus is disabled for a single project. */
+export const updateObservabilityConfigurationProject: API.OperationMethod<
+  UpdateObservabilityConfigurationProjectRequest,
+  UpdateObservabilityConfigurationProjectResponse,
+  UpdateObservabilityConfigurationProjectError,
+  VercelOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: UpdateObservabilityConfigurationProjectRequest,
+  output: UpdateObservabilityConfigurationProjectResponse,
+  errors: [BadRequest, Forbidden, NotFound],
+  protocol: VercelProtocol,
+  retry: Retry.Retry,
+}));