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

package/src/services/certificates.ts

@@ -0,0 +1,450 @@
+// 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 Redacted from "effect/Redacted";
+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 }],
+  ) {}
+
+/** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per Certificate. **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 CreateCertificateRequestLabelsMap = {
+  [key: string]: string | undefined;
+};
+export const CreateCertificateRequestLabelsMap = /*@__PURE__*/ S.Record(
+  S.String,
+  S.String,
+) as any as S.Schema<CreateCertificateRequestLabelsMap>;
+
+export interface CreateCertificateRequest {
+  projectId: string;
+  region: string;
+  /** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per Certificate. **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?: CreateCertificateRequestLabelsMap;
+  /** TLS certificate name */
+  name?: string;
+  /** The PEM encoded private key part */
+  privateKey?: string | Redacted.Redacted<string>;
+  /** The PEM encoded public key part */
+  publicKey?: string;
+}
+export const CreateCertificateRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    labels: S.optional(CreateCertificateRequestLabelsMap),
+    name: S.optional(S.String),
+    privateKey: S.optional(S.String.pipe(T.SensitiveValue({}))),
+    publicKey: S.optional(S.String),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/v2/projects/{projectId}/regions/{region}/certificates",
+      code: 200,
+      baseUrl: "https://certificates.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "CreateCertificateRequest",
+}) as any as S.Schema<CreateCertificateRequest>;
+
+export interface Data {
+  /** Comma-separated list of all domains and IP addresses the certificate is valid for (Subject Alternative Names). */
+  dnsNames?: string;
+  /** Comma-separated list of purposes the cert is valid for. 'Server Auth' is required for Load Balancer use. */
+  extendedKeyUsage?: string;
+  /** The legacy SHA1 thumbprint. Provided for cross-referencing with older systems and browsers. */
+  fingerprintSha1?: string;
+  /** The unique SHA256 hash of the raw certificate bytes. Use this as the primary unique identifier. */
+  fingerprintSha256?: string;
+  /** Indicates if the certificate is a Certificate Authority, meaning it can sign other certificates. */
+  isCa?: boolean;
+  /** Indicates if the certificate was signed by its own private key rather than a trusted third-party CA. */
+  isSelfSigned?: boolean;
+  /** The Common Name of the Certificate Authority (CA) that signed and issued the certificate. */
+  issuerCn?: string;
+  /** Human-readable summary of the public key's algorithm and bit-length or curve name. */
+  keyStrength?: string;
+  /** The expiration timestamp. After this date, browsers will show security warnings (RFC3339 format). */
+  notAfter?: string;
+  /** The timestamp indicating when the certificate starts being valid (RFC3339 format). */
+  notBefore?: string;
+  /** Organization name associated with the certificate subject. */
+  organization?: string;
+  /** The cryptographic algorithm used to generate the public/private key pair. */
+  publicKeyAlgorithm?: string;
+  /** The unique serial number assigned by the CA, represented in uppercase hexadecimal format. */
+  serialNumber?: string;
+  /** The algorithm used by the CA to sign this certificate. */
+  signatureAlgorithm?: string;
+  /** The primary identity of the certificate. Fallback sequence: Common Name -> First DNS Name -> Full Subject String. */
+  subjectCn?: string;
+}
+export const Data = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    dnsNames: S.optional(S.String),
+    extendedKeyUsage: S.optional(S.String),
+    fingerprintSha1: S.optional(S.String),
+    fingerprintSha256: S.optional(S.String),
+    isCa: S.optional(S.Boolean),
+    isSelfSigned: S.optional(S.Boolean),
+    issuerCn: S.optional(S.String),
+    keyStrength: S.optional(S.String),
+    notAfter: S.optional(S.String),
+    notBefore: S.optional(S.String),
+    organization: S.optional(S.String),
+    publicKeyAlgorithm: S.optional(S.String),
+    serialNumber: S.optional(S.String),
+    signatureAlgorithm: S.optional(S.String),
+    subjectCn: S.optional(S.String),
+  }),
+).annotate({ identifier: "Data" }) as any as S.Schema<Data>;
+
+/** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per Certificate. **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 GetCertificateResponseLabelsMap = {
+  [key: string]: string | undefined;
+};
+export const GetCertificateResponseLabelsMap = /*@__PURE__*/ S.Record(
+  S.String,
+  S.String,
+) as any as S.Schema<GetCertificateResponseLabelsMap>;
+
+/** The list of listener names in this Load Balancer, that are using the certificate. */
+export type UsageItemListenerNamesList = Array<string>;
+export const UsageItemListenerNamesList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<UsageItemListenerNamesList>;
+
+export interface UsageItem {
+  /** The list of listener names in this Load Balancer, that are using the certificate. */
+  listenerNames?: UsageItemListenerNamesList;
+  /** The display name of the Load Balancer. */
+  loadBalancerName?: string;
+}
+export const UsageItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    listenerNames: S.optional(UsageItemListenerNamesList),
+    loadBalancerName: S.optional(S.String),
+  }),
+).annotate({ identifier: "UsageItem" }) as any as S.Schema<UsageItem>;
+
+/** List of Load Balancers with their associated listeners that use this certificate. */
+export type UsageItemsList = Array<UsageItem>;
+export const UsageItemsList = /*@__PURE__*/ S.Array(
+  UsageItem,
+) as any as S.Schema<UsageItemsList>;
+
+export interface Usage {
+  /** Number of listeners using this certificate. */
+  count?: number;
+  /** List of Load Balancers with their associated listeners that use this certificate. */
+  items?: UsageItemsList;
+}
+export const Usage = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.optional(S.Number),
+    items: S.optional(UsageItemsList),
+  }),
+).annotate({ identifier: "Usage" }) as any as S.Schema<Usage>;
+
+/** GetCertificateResponse returns name, id and public key */
+export interface GetCertificateResponse {
+  data?: Data;
+  /** The certificates resource id */
+  id?: string;
+  /** Labels represent user-defined metadata as key-value pairs. Label count should not exceed 64 per Certificate. **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?: GetCertificateResponseLabelsMap;
+  /** Certificate display name */
+  name?: string;
+  /** The PEM encoded public key part */
+  publicKey?: string;
+  /** Region of the LoadBalancer */
+  region?: string;
+  usage?: Usage;
+}
+export const GetCertificateResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    data: S.optional(Data),
+    id: S.optional(S.String),
+    labels: S.optional(GetCertificateResponseLabelsMap),
+    name: S.optional(S.String),
+    publicKey: S.optional(S.String),
+    region: S.optional(S.String),
+    usage: S.optional(Usage),
+  }),
+).annotate({
+  identifier: "GetCertificateResponse",
+}) as any as S.Schema<GetCertificateResponse>;
+
+export interface DeleteCertificateRequest {
+  projectId: string;
+  region: string;
+  id: string;
+}
+export const DeleteCertificateRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    id: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/v2/projects/{projectId}/regions/{region}/certificates/{id}",
+      code: 200,
+      baseUrl: "https://certificates.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "DeleteCertificateRequest",
+}) as any as S.Schema<DeleteCertificateRequest>;
+
+export type DeleteCertificateResponse2 = unknown;
+export const DeleteCertificateResponse2 = /*@__PURE__*/ S.suspend(() =>
+  S.Unknown.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "DeleteCertificateResponse2",
+}) as any as S.Schema<DeleteCertificateResponse2>;
+
+export interface GetCertificateRequest {
+  projectId: string;
+  region: string;
+  id: string;
+}
+export const GetCertificateRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    id: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v2/projects/{projectId}/regions/{region}/certificates/{id}",
+      code: 200,
+      baseUrl: "https://certificates.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "GetCertificateRequest",
+}) as any as S.Schema<GetCertificateRequest>;
+
+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: "/v2/projects/{projectId}/regions/{region}/quotas",
+      code: 200,
+      baseUrl: "https://certificates.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "GetQuotaRequest",
+}) as any as S.Schema<GetQuotaRequest>;
+
+/** Certificates quotas holds the limits and usage for certificates resources */
+export interface CertificatesQuota {
+  /** The maximum number of TLS certificates in this project. */
+  limit?: number;
+  /** The number of certificates that are currently existing in this project. */
+  usage?: number;
+}
+export const CertificatesQuota = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    limit: S.optional(S.Number),
+    usage: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "CertificatesQuota",
+}) as any as S.Schema<CertificatesQuota>;
+
+/** Quotas holds the specific quota elements for different resources */
+export interface Quotas {
+  certificates?: CertificatesQuota;
+}
+export const Quotas = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    certificates: S.optional(CertificatesQuota),
+  }),
+).annotate({ identifier: "Quotas" }) as any as S.Schema<Quotas>;
+
+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 ListCertificatesRequest {
+  projectId: string;
+  region: string;
+  /** page_size specifies how many certificates should be returned on this page. Must be a positive number <= 1000 */
+  pageSize?: string;
+  /** page_id is a page identifier returned by the previous response and is used to request the next page */
+  pageId?: string;
+}
+export const ListCertificatesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    projectId: S.String.pipe(T.Label()),
+    region: S.String.pipe(T.Label()),
+    pageSize: S.optional(S.String.pipe(T.Query())),
+    pageId: S.optional(S.String.pipe(T.Query())),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v2/projects/{projectId}/regions/{region}/certificates",
+      code: 200,
+      baseUrl: "https://certificates.api.stackit.cloud",
+    }),
+  ),
+).annotate({
+  identifier: "ListCertificatesRequest",
+}) as any as S.Schema<ListCertificatesRequest>;
+
+export type ListCertificatesResponseItemsList = Array<GetCertificateResponse>;
+export const ListCertificatesResponseItemsList = /*@__PURE__*/ S.Array(
+  GetCertificateResponse,
+) as any as S.Schema<ListCertificatesResponseItemsList>;
+
+/** ListCertificateResponse returns a list of certificate responses */
+export interface ListCertificatesResponse {
+  items?: ListCertificatesResponseItemsList;
+  /** Continue token from the ListCertificatesResponse with Limit option */
+  nextPageId?: string;
+}
+export const ListCertificatesResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    items: S.optional(ListCertificatesResponseItemsList),
+    nextPageId: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "ListCertificatesResponse",
+}) as any as S.Schema<ListCertificatesResponse>;
+
+export type CreateCertificateError = BadRequest | Forbidden | StackitOpError;
+/** Store a TLS certificate in a project. CreateCertificate will store a TLS certificate in a project. */
+export const createCertificate: API.OperationMethod<
+  CreateCertificateRequest,
+  GetCertificateResponse,
+  CreateCertificateError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateCertificateRequest,
+  output: GetCertificateResponse,
+  errors: [BadRequest, Forbidden, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DeleteCertificateError = BadRequest | Forbidden | StackitOpError;
+/** Delete a stored TLS certificate in a project. DeleteCertificate will delete the stored TLS certificate. */
+export const deleteCertificate: API.OperationMethod<
+  DeleteCertificateRequest,
+  DeleteCertificateResponse2,
+  DeleteCertificateError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteCertificateRequest,
+  output: DeleteCertificateResponse2,
+  errors: [BadRequest, Forbidden, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetCertificateError =
+  | BadRequest
+  | Forbidden
+  | NotFound
+  | StackitOpError;
+/** Retrieve the public parts of a stored TLS certificate. GetCertificate will return the public parts of a stored TLS certificate. */
+export const getCertificate: API.OperationMethod<
+  GetCertificateRequest,
+  GetCertificateResponse,
+  GetCertificateError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetCertificateRequest,
+  output: GetCertificateResponse,
+  errors: [BadRequest, Forbidden, NotFound, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetQuotaError = BadRequest | Forbidden | StackitOpError;
+/** Get the quota for TLS certificates in a project. Retrieves the configured TLS certificate quota for the project. Limit can be changed via service request. */
+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 ListCertificatesError = BadRequest | Forbidden | StackitOpError;
+/** Retrieve the list of TLS certificate stored in a project. ListCertificates will return the list of TLS certificates in a project. */
+export const listCertificates: API.OperationMethod<
+  ListCertificatesRequest,
+  ListCertificatesResponse,
+  ListCertificatesError,
+  StackitOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListCertificatesRequest,
+  output: ListCertificatesResponse,
+  errors: [BadRequest, Forbidden, UnknownStackitError],
+  protocol: StackitProtocol,
+  retry: Retry.Retry,
+}));