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

package/src/services/lb_ip_lists.ts

@@ -0,0 +1,377 @@
+// 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 class UnprocessableEntity
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<UnprocessableEntity>()("UnprocessableEntity", {
+      code: S.Number,
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 422 }],
+  ) {}
+
+export interface DeleteIPListRequest {
+  projectId: string;
+  region: string;
+  name: string;
+}
+export const DeleteIPListRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    name: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/v1alpha/projects/{projectId}/regions/{region}/ip-lists/{name}",
+      code: 200,
+      baseUrl: "https://lb-ip-lists.api.{region}stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "DeleteIPListRequest",
+}) as any as S.Schema<DeleteIPListRequest>;
+
+export type DeleteIPListResponse2 = unknown;
+export const DeleteIPListResponse2 = /*@__PURE__*/ S.suspend(() =>
+  S.Unknown.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "DeleteIPListResponse2",
+}) as any as S.Schema<DeleteIPListResponse2>;
+
+export interface GetIPListRequest {
+  projectId: string;
+  region: string;
+  name: string;
+}
+export const GetIPListRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    name: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1alpha/projects/{projectId}/regions/{region}/ip-lists/{name}",
+      code: 200,
+      baseUrl: "https://lb-ip-lists.api.{region}stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "GetIPListRequest",
+}) as any as S.Schema<GetIPListRequest>;
+
+/** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per IP list. **Key Formatting Rules:** Length: 1-63 characters. Characters: Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. Keys starting with 'stackit-' are system-reserved; users MUST NOT manage them. **Value Formatting Rules:** Length: 0-63 characters (empty string explicitly allowed). Characters (for non-empty values): Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. */
+export type GetIPListResponseLabelsMap = { [key: string]: string | undefined };
+export const GetIPListResponseLabelsMap = /*@__PURE__*/ S.Record(
+  S.String,
+  S.String,
+) as any as S.Schema<GetIPListResponseLabelsMap>;
+
+/** List of load balancers that reference this IP list. */
+export type IPListUsageItemsList = Array<string>;
+export const IPListUsageItemsList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<IPListUsageItemsList>;
+
+/** IPListUsage describes which NLB/ALB currently reference an IP list. */
+export interface IPListUsage {
+  /** Number of load balancers currently using this IP list. */
+  count?: number;
+  /** List of load balancers that reference this IP list. */
+  items?: IPListUsageItemsList;
+}
+export const IPListUsage = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.optional(S.Number),
+    items: S.optional(IPListUsageItemsList),
+  }),
+).annotate({ identifier: "IPListUsage" }) as any as S.Schema<IPListUsage>;
+
+/** GetIPListResponse returns IP list configuration without CIDR entries. */
+export interface GetIPListResponse {
+  /** Unique SHA-256 hex fingerprint used to verify the stored IP list content. */
+  contentHash?: string;
+  /** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per IP list. **Key Formatting Rules:** Length: 1-63 characters. Characters: Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. Keys starting with 'stackit-' are system-reserved; users MUST NOT manage them. **Value Formatting Rules:** Length: 0-63 characters (empty string explicitly allowed). Characters (for non-empty values): Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. */
+  labels?: GetIPListResponseLabelsMap;
+  /** IP list name. */
+  name: string;
+  /** Number of IPv4 CIDR entries stored in the list. */
+  numberOfIps?: number;
+  /** Current use of this IP list in load balancers. */
+  usage?: IPListUsage;
+}
+export const GetIPListResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    contentHash: S.optional(S.String),
+    labels: S.optional(GetIPListResponseLabelsMap),
+    name: S.String,
+    numberOfIps: S.optional(S.Number),
+    usage: S.optional(IPListUsage),
+  }),
+).annotate({
+  identifier: "GetIPListResponse",
+}) as any as S.Schema<GetIPListResponse>;
+
+export interface GetQuotaRequest {
+  projectId: string;
+  region: string;
+}
+export const GetQuotaRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1alpha/projects/{projectId}/regions/{region}/quotas",
+      code: 200,
+      baseUrl: "https://lb-ip-lists.api.{region}stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "GetQuotaRequest",
+}) as any as S.Schema<GetQuotaRequest>;
+
+/** IPListsQuota holds the limits and current usage for IP list resources. Defaults: limit=3 per project, max_entries_per_list=50000. */
+export interface IPListsQuota {
+  /** The maximum number of IP lists allowed in this project. Defaults to 3. Use -1 to indicate unlimited. */
+  limit?: number;
+  /** The maximum number of IPv4 CIDR entries allowed in a single IP list. Defaults to 50000. */
+  maxEntriesPerList?: number;
+  /** The number of IP lists that currently exist in this project. */
+  usage?: number;
+}
+export const IPListsQuota = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    limit: S.optional(S.Number),
+    maxEntriesPerList: S.optional(S.Number),
+    usage: S.optional(S.Number),
+  }),
+).annotate({ identifier: "IPListsQuota" }) as any as S.Schema<IPListsQuota>;
+
+/** Quotas holds the specific quota elements for resources managed by this API. */
+export interface Quotas {
+  ipLists?: IPListsQuota;
+}
+export const Quotas = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ipLists: S.optional(IPListsQuota),
+  }),
+).annotate({ identifier: "Quotas" }) as any as S.Schema<Quotas>;
+
+/** GetQuotaResponse returns the configured IP list quota for the project and region. */
+export interface GetQuotaResponse {
+  /** Project identifier */
+  projectId?: string;
+  quotas?: Quotas;
+  /** Region */
+  region?: string;
+}
+export const GetQuotaResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.optional(S.String),
+    quotas: S.optional(Quotas),
+    region: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "GetQuotaResponse",
+}) as any as S.Schema<GetQuotaResponse>;
+
+export interface ListIPListsRequest {
+  projectId: string;
+  region: string;
+}
+export const ListIPListsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1alpha/projects/{projectId}/regions/{region}/ip-lists",
+      code: 200,
+      baseUrl: "https://lb-ip-lists.api.{region}stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "ListIPListsRequest",
+}) as any as S.Schema<ListIPListsRequest>;
+
+/** Every IP list in the project and region. Never includes the CIDR entries themselves. */
+export type ListIPListsResponseItemsList = Array<GetIPListResponse>;
+export const ListIPListsResponseItemsList = /*@__PURE__*/ S.Array(
+  GetIPListResponse,
+) as any as S.Schema<ListIPListsResponseItemsList>;
+
+/** ListIPListsResponse returns metadata for all IP lists in a project and region. The CIDR entries themselves are never returned. */
+export interface ListIPListsResponse {
+  /** Every IP list in the project and region. Never includes the CIDR entries themselves. */
+  items?: ListIPListsResponseItemsList;
+}
+export const ListIPListsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    items: S.optional(ListIPListsResponseItemsList),
+  }),
+).annotate({
+  identifier: "ListIPListsResponse",
+}) as any as S.Schema<ListIPListsResponse>;
+
+/** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per IP list. **Key Formatting Rules:** Length: 1-63 characters. Characters: Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. Keys starting with 'stackit-' are system-reserved; users MUST NOT manage them. **Value Formatting Rules:** Length: 0-63 characters (empty string explicitly allowed). Characters (for non-empty values): Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. */
+export type UploadIPListRequestLabelsMap = {
+  [key: string]: string | undefined;
+};
+export const UploadIPListRequestLabelsMap = /*@__PURE__*/ S.Record(
+  S.String,
+  S.String,
+) as any as S.Schema<UploadIPListRequestLabelsMap>;
+
+export interface UploadIPListRequest {
+  projectId: string;
+  region: string;
+  name: string;
+  /** Raw upload payload as a plain UTF-8 string. Newline-separated `.txt` list of IPv4 CIDR entries, or CSV with `cidr,labels` columns (any other columns are ignored). */
+  fileContent: string;
+  /** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per IP list. **Key Formatting Rules:** Length: 1-63 characters. Characters: Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. Keys starting with 'stackit-' are system-reserved; users MUST NOT manage them. **Value Formatting Rules:** Length: 0-63 characters (empty string explicitly allowed). Characters (for non-empty values): Must begin and end with [a-zA-Z0-9]. May contain dashes (-), underscores (_), dots (.), and alphanumerics in between. */
+  labels?: UploadIPListRequestLabelsMap;
+}
+export const UploadIPListRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    name: S.String.pipe(T.Label()),
+    fileContent: S.String,
+    labels: S.optional(UploadIPListRequestLabelsMap),
+  }).pipe(
+    T.Http({
+      method: "PUT",
+      uri: "/v1alpha/projects/{projectId}/regions/{region}/ip-lists/{name}",
+      code: 200,
+      baseUrl: "https://lb-ip-lists.api.{region}stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "UploadIPListRequest",
+}) as any as S.Schema<UploadIPListRequest>;
+
+export type DeleteIPListError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** Delete an IP List configuration Removes the IP list configuration from the project. If the IP list is referenced by load balancers, clear or replace the reference first. */
+export const deleteIPList: API.OperationMethod<
+  DeleteIPListRequest,
+  DeleteIPListResponse2,
+  DeleteIPListError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteIPListRequest,
+  output: DeleteIPListResponse2,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetIPListError = BadRequest | Forbidden | NotFound | StackitOpError;
+/** Retrieve metadata of an existing IP list configuration in a project. GetIPList returns metadata of a single IP list by name, without CIDR entries. */
+export const getIPList: API.OperationMethod<
+  GetIPListRequest,
+  GetIPListResponse,
+  GetIPListError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetIPListRequest,
+  output: GetIPListResponse,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetQuotaError = BadRequest | Forbidden | StackitOpError;
+/** Get the quota for IP lists in a project Retrieves the IP List resource quota for the project. */
+export const getQuota: API.OperationMethod<
+  GetQuotaRequest,
+  GetQuotaResponse,
+  GetQuotaError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetQuotaRequest,
+  output: GetQuotaResponse,
+  errors: [BadRequest, Forbidden, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListIPListsError = BadRequest | Forbidden | StackitOpError;
+/** List metadata of all IP lists in a project ListIPLists returns every IP list in the project without CIDR entries. No pagination while the per-project limit is 3. */
+export const listIPLists: API.OperationMethod<
+  ListIPListsRequest,
+  ListIPListsResponse,
+  ListIPListsError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListIPListsRequest,
+  output: ListIPListsResponse,
+  errors: [BadRequest, Forbidden, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type UploadIPListError =
+  | BadRequest
+  | Forbidden
+  | UnprocessableEntity
+  | StackitOpError;
+/** Create/Replace an IP list UploadIPList creates the IP list or replaces its content. Raw upload is in `file_content`. */
+export const uploadIPList: API.OperationMethod<
+  UploadIPListRequest,
+  GetIPListResponse,
+  UploadIPListError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: UploadIPListRequest,
+  output: GetIPListResponse,
+  errors: [BadRequest, Forbidden, UnprocessableEntity, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));