@distilled.cloud/stackit 0.0.0-stage → 1.0.0-rc.13

package/src/services/service_enablement.ts

@@ -0,0 +1,359 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-stackit). 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 {
+  StackitProtocol,
+  type StackitOpError,
+  type StackitOpContext,
+} from "../protocol.ts";
+import { UnknownStackitError } from "../errors.ts";
+import * as Retry from "../retry.ts";
+
+export type { StackitOpError, StackitOpContext };
+
+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 interface DisableServiceRegionalRequest {
+  projectId: string;
+  region: string;
+  serviceId: string;
+}
+export const DisableServiceRegionalRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    serviceId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/v2/projects/{projectId}/regions/{region}/services/{serviceId}",
+      code: 200,
+      baseUrl: "https://service-enablement.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "DisableServiceRegionalRequest",
+}) as any as S.Schema<DisableServiceRegionalRequest>;
+
+export interface DisableServiceRegionalResponse {}
+export const DisableServiceRegionalResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "DisableServiceRegionalResponse",
+}) as any as S.Schema<DisableServiceRegionalResponse>;
+
+export interface EnableServiceRegionalRequest {
+  projectId: string;
+  region: string;
+  serviceId: string;
+}
+export const EnableServiceRegionalRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    serviceId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/v2/projects/{projectId}/regions/{region}/services/{serviceId}",
+      code: 200,
+      baseUrl: "https://service-enablement.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "EnableServiceRegionalRequest",
+}) as any as S.Schema<EnableServiceRegionalRequest>;
+
+export interface EnableServiceRegionalResponse {}
+export const EnableServiceRegionalResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "EnableServiceRegionalResponse",
+}) as any as S.Schema<EnableServiceRegionalResponse>;
+
+export interface GetServiceStatusRegionalRequest {
+  projectId: string;
+  region: string;
+  serviceId: string;
+}
+export const GetServiceStatusRegionalRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    serviceId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v2/projects/{projectId}/regions/{region}/services/{serviceId}",
+      code: 200,
+      baseUrl: "https://service-enablement.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "GetServiceStatusRegionalRequest",
+}) as any as S.Schema<GetServiceStatusRegionalRequest>;
+
+/** a list of service IDs which this service depend on. If the service is enabled, those service are enabled as well automatically. */
+export type DependenciesHardList = Array<string>;
+export const DependenciesHardList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<DependenciesHardList>;
+
+/** a list of service IDs which this service depend on. When they are disabled a notification is sent. */
+export type DependenciesSoftList = Array<string>;
+export const DependenciesSoftList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<DependenciesSoftList>;
+
+export interface Dependencies {
+  /** a list of service IDs which this service depend on. If the service is enabled, those service are enabled as well automatically. */
+  hard?: DependenciesHardList;
+  /** a list of service IDs which this service depend on. When they are disabled a notification is sent. */
+  soft?: DependenciesSoftList;
+}
+export const Dependencies = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    hard: S.optional(DependenciesHardList),
+    soft: S.optional(DependenciesSoftList),
+  }),
+).annotate({ identifier: "Dependencies" }) as any as S.Schema<Dependencies>;
+
+export type ServiceStatusEnablement = "REQUEST" | "AUTO";
+export const ServiceStatusEnablement = /*@__PURE__*/ S.String;
+
+/** the last action which was triggered on this service */
+export type ActionErrorAction = "DISABLE" | "ENABLE";
+export const ActionErrorAction = /*@__PURE__*/ S.String;
+
+/** the last error for this service. */
+export interface ActionError {
+  /** the last action which was triggered on this service */
+  action?: ActionErrorAction;
+  /** the error code if provided by the service */
+  code?: string;
+  /** the error reason provided by the service */
+  reason?: string;
+}
+export const ActionError = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    action: S.optional(ActionErrorAction),
+    code: S.optional(S.String),
+    reason: S.optional(S.String),
+  }),
+).annotate({ identifier: "ActionError" }) as any as S.Schema<ActionError>;
+
+export type ServiceStatusLabelsMap = { [key: string]: string | undefined };
+export const ServiceStatusLabelsMap = /*@__PURE__*/ S.Record(
+  S.String,
+  S.String,
+) as any as S.Schema<ServiceStatusLabelsMap>;
+
+export type ServiceStatusLifecycle = "FLEX" | "PROJECT";
+export const ServiceStatusLifecycle = /*@__PURE__*/ S.String;
+
+export type ParametersGeneralProjectScope = "SCHWARZ" | "PUBLIC";
+export const ParametersGeneralProjectScope = /*@__PURE__*/ S.String;
+
+export interface ParametersGeneral {
+  organizationId?: string;
+  projectName?: string;
+  projectScope?: ParametersGeneralProjectScope;
+}
+export const ParametersGeneral = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    organizationId: S.optional(S.String),
+    projectName: S.optional(S.String),
+    projectScope: S.optional(ParametersGeneralProjectScope),
+  }),
+).annotate({
+  identifier: "ParametersGeneral",
+}) as any as S.Schema<ParametersGeneral>;
+
+/** service parameters */
+export interface Parameters {
+  general?: ParametersGeneral;
+}
+export const Parameters = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    general: S.optional(ParametersGeneral),
+  }),
+).annotate({ identifier: "Parameters" }) as any as S.Schema<Parameters>;
+
+export type ServiceStatusScope = "PRIVATE" | "PUBLIC";
+export const ServiceStatusScope = /*@__PURE__*/ S.String;
+
+/** the state of a service within a project */
+export type ServiceStatusState =
+  | "ENABLED"
+  | "ENABLING"
+  | "DISABLED"
+  | "DISABLING";
+export const ServiceStatusState = /*@__PURE__*/ S.String;
+
+export interface ServiceStatus {
+  dependencies?: Dependencies;
+  enablement?: ServiceStatusEnablement;
+  error?: ActionError;
+  labels?: ServiceStatusLabelsMap;
+  lifecycle?: ServiceStatusLifecycle;
+  parameters?: Parameters;
+  scope?: ServiceStatusScope;
+  serviceId?: string;
+  /** the state of a service within a project */
+  state?: ServiceStatusState;
+}
+export const ServiceStatus = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    dependencies: S.optional(Dependencies),
+    enablement: S.optional(ServiceStatusEnablement),
+    error: S.optional(ActionError),
+    labels: S.optional(ServiceStatusLabelsMap),
+    lifecycle: S.optional(ServiceStatusLifecycle),
+    parameters: S.optional(Parameters),
+    scope: S.optional(ServiceStatusScope),
+    serviceId: S.optional(S.String),
+    state: S.optional(ServiceStatusState),
+  }),
+).annotate({ identifier: "ServiceStatus" }) as any as S.Schema<ServiceStatus>;
+
+export interface ListServiceStatusRegionalRequest {
+  projectId: string;
+  region: string;
+  cursor?: string;
+}
+export const ListServiceStatusRegionalRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    cursor: S.optional(S.String.pipe(T.Query())),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v2/projects/{projectId}/regions/{region}/services",
+      code: 200,
+      baseUrl: "https://service-enablement.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "ListServiceStatusRegionalRequest",
+}) as any as S.Schema<ListServiceStatusRegionalRequest>;
+
+export type ListServiceStatusRegionalResponseItemsList = Array<ServiceStatus>;
+export const ListServiceStatusRegionalResponseItemsList = /*@__PURE__*/ S.Array(
+  ServiceStatus,
+) as any as S.Schema<ListServiceStatusRegionalResponseItemsList>;
+
+export interface ListServiceStatusRegionalResponse {
+  items?: ListServiceStatusRegionalResponseItemsList;
+  nextCursor?: string;
+}
+export const ListServiceStatusRegionalResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    items: S.optional(ListServiceStatusRegionalResponseItemsList),
+    nextCursor: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "ListServiceStatusRegionalResponse",
+}) as any as S.Schema<ListServiceStatusRegionalResponse>;
+
+export type DisableServiceRegionalError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** disables the service in a project. */
+export const disableServiceRegional: API.OperationMethod<
+  DisableServiceRegionalRequest,
+  DisableServiceRegionalResponse,
+  DisableServiceRegionalError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DisableServiceRegionalRequest,
+  output: DisableServiceRegionalResponse,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type EnableServiceRegionalError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** enables the service in a project. */
+export const enableServiceRegional: API.OperationMethod<
+  EnableServiceRegionalRequest,
+  EnableServiceRegionalResponse,
+  EnableServiceRegionalError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: EnableServiceRegionalRequest,
+  output: EnableServiceRegionalResponse,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetServiceStatusRegionalError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** returns the current status of a service in a project. */
+export const getServiceStatusRegional: API.OperationMethod<
+  GetServiceStatusRegionalRequest,
+  ServiceStatus,
+  GetServiceStatusRegionalError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetServiceStatusRegionalRequest,
+  output: ServiceStatus,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListServiceStatusRegionalError =
+  | BadRequest
+  | Forbidden
+  | StackitOpError;
+/** returns a list of all available services for a project. */
+export const listServiceStatusRegional: API.OperationMethod<
+  ListServiceStatusRegionalRequest,
+  ListServiceStatusRegionalResponse,
+  ListServiceStatusRegionalError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListServiceStatusRegionalRequest,
+  output: ListServiceStatusRegionalResponse,
+  errors: [BadRequest, Forbidden, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));