@homeflare/distilled-openbao 0.2.0

package/src/services/read.ts

@@ -0,0 +1,266 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-openbao, generated — see fetch-specs.ts). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  OpenBaoProtocol,
+  type OpenBaoOpError,
+  type OpenBaoOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { OpenBaoOpError, OpenBaoOpContext };
+
+export interface ReadEncryptionKeyConfigRequest {}
+export const ReadEncryptionKeyConfigRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/sys/rotate/config", code: 200 }),
+  ),
+).annotate({
+  identifier: "ReadEncryptionKeyConfigRequest",
+}) as any as S.Schema<ReadEncryptionKeyConfigRequest>;
+
+export interface ReadEncryptionKeyConfigResponse {
+  /** Whether automatic rotation is enabled. */
+  enabled?: boolean;
+  /** How long after installation of an active key term that the key will be automatically rotated. */
+  interval?: number;
+  /** The number of encryption operations performed before the barrier key is automatically rotated. */
+  max_operations?: number;
+}
+export const ReadEncryptionKeyConfigResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    enabled: S.optional(S.Boolean),
+    interval: S.optional(S.Number),
+    max_operations: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "ReadEncryptionKeyConfigResponse",
+}) as any as S.Schema<ReadEncryptionKeyConfigResponse>;
+
+export interface ReadHealthStatusRequest {}
+export const ReadHealthStatusRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "GET", uri: "/sys/health", code: 200 })),
+).annotate({
+  identifier: "ReadHealthStatusRequest",
+}) as any as S.Schema<ReadHealthStatusRequest>;
+
+export interface ReadHealthStatusResponse {}
+export const ReadHealthStatusResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "ReadHealthStatusResponse",
+}) as any as S.Schema<ReadHealthStatusResponse>;
+
+export interface ReadInitializationStatusRequest {}
+export const ReadInitializationStatusRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "GET", uri: "/sys/init", code: 200 })),
+).annotate({
+  identifier: "ReadInitializationStatusRequest",
+}) as any as S.Schema<ReadInitializationStatusRequest>;
+
+export interface ReadInitializationStatusResponse {}
+export const ReadInitializationStatusResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "ReadInitializationStatusResponse",
+}) as any as S.Schema<ReadInitializationStatusResponse>;
+
+export interface ReadRotateKeyringConfigRequest {}
+export const ReadRotateKeyringConfigRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/sys/rotate/keyring/config", code: 200 }),
+  ),
+).annotate({
+  identifier: "ReadRotateKeyringConfigRequest",
+}) as any as S.Schema<ReadRotateKeyringConfigRequest>;
+
+export interface ReadRotateKeyringConfigResponse {
+  /** Whether automatic rotation is enabled. */
+  enabled?: boolean;
+  /** How long after installation of an active key term that the key will be automatically rotated. */
+  interval?: number;
+  /** The number of encryption operations performed before the barrier key is automatically rotated. */
+  max_operations?: number;
+}
+export const ReadRotateKeyringConfigResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    enabled: S.optional(S.Boolean),
+    interval: S.optional(S.Number),
+    max_operations: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "ReadRotateKeyringConfigResponse",
+}) as any as S.Schema<ReadRotateKeyringConfigResponse>;
+
+export interface ReadSanitizedConfigurationStateRequest {}
+export const ReadSanitizedConfigurationStateRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({}).pipe(
+      T.Http({ method: "GET", uri: "/sys/config/state/sanitized", code: 200 }),
+    ),
+).annotate({
+  identifier: "ReadSanitizedConfigurationStateRequest",
+}) as any as S.Schema<ReadSanitizedConfigurationStateRequest>;
+
+export interface ReadSanitizedConfigurationStateResponse {}
+export const ReadSanitizedConfigurationStateResponse = /*@__PURE__*/ S.suspend(
+  () => S.Struct({}),
+).annotate({
+  identifier: "ReadSanitizedConfigurationStateResponse",
+}) as any as S.Schema<ReadSanitizedConfigurationStateResponse>;
+
+export interface ReadWrappingPropertiesRequest {
+  token?: string;
+}
+export const ReadWrappingPropertiesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    token: S.optional(S.String),
+  }).pipe(T.Http({ method: "POST", uri: "/sys/wrapping/lookup", code: 200 })),
+).annotate({
+  identifier: "ReadWrappingPropertiesRequest",
+}) as any as S.Schema<ReadWrappingPropertiesRequest>;
+
+export interface ReadWrappingPropertiesResponse {
+  creation_path?: string;
+  creation_time?: string;
+  creation_ttl?: number;
+}
+export const ReadWrappingPropertiesResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    creation_path: S.optional(S.String),
+    creation_time: S.optional(S.String),
+    creation_ttl: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "ReadWrappingPropertiesResponse",
+}) as any as S.Schema<ReadWrappingPropertiesResponse>;
+
+export interface ReadWrappingProperties2Request {}
+export const ReadWrappingProperties2Request = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/sys/wrapping/lookup", code: 200 }),
+  ),
+).annotate({
+  identifier: "ReadWrappingProperties2Request",
+}) as any as S.Schema<ReadWrappingProperties2Request>;
+
+export interface ReadWrappingProperties2Response {
+  creation_path?: string;
+  creation_time?: string;
+  creation_ttl?: number;
+}
+export const ReadWrappingProperties2Response = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    creation_path: S.optional(S.String),
+    creation_time: S.optional(S.String),
+    creation_ttl: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "ReadWrappingProperties2Response",
+}) as any as S.Schema<ReadWrappingProperties2Response>;
+
+export type ReadEncryptionKeyConfigError = OpenBaoOpError;
+/** Get the automatic key rotation config. */
+export const readEncryptionKeyConfig: API.OperationMethod<
+  ReadEncryptionKeyConfigRequest,
+  ReadEncryptionKeyConfigResponse,
+  ReadEncryptionKeyConfigError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadEncryptionKeyConfigRequest,
+  output: ReadEncryptionKeyConfigResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadHealthStatusError = OpenBaoOpError;
+/** Returns the health status of OpenBao. */
+export const readHealthStatus: API.OperationMethod<
+  ReadHealthStatusRequest,
+  ReadHealthStatusResponse,
+  ReadHealthStatusError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadHealthStatusRequest,
+  output: ReadHealthStatusResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadInitializationStatusError = OpenBaoOpError;
+/** Returns the initialization status of OpenBao. */
+export const readInitializationStatus: API.OperationMethod<
+  ReadInitializationStatusRequest,
+  ReadInitializationStatusResponse,
+  ReadInitializationStatusError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadInitializationStatusRequest,
+  output: ReadInitializationStatusResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadRotateKeyringConfigError = OpenBaoOpError;
+/** Get the automatic key rotation config. */
+export const readRotateKeyringConfig: API.OperationMethod<
+  ReadRotateKeyringConfigRequest,
+  ReadRotateKeyringConfigResponse,
+  ReadRotateKeyringConfigError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadRotateKeyringConfigRequest,
+  output: ReadRotateKeyringConfigResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadSanitizedConfigurationStateError = OpenBaoOpError;
+/** Return a sanitized version of the OpenBao server configuration. The sanitized output strips configuration values in the storage, HA storage, and seals stanzas, which may contain sensitive values such as API tokens. It also removes any token or secret fields in other stanzas, such as the circonus_api_token from telemetry. */
+export const readSanitizedConfigurationState: API.OperationMethod<
+  ReadSanitizedConfigurationStateRequest,
+  ReadSanitizedConfigurationStateResponse,
+  ReadSanitizedConfigurationStateError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadSanitizedConfigurationStateRequest,
+  output: ReadSanitizedConfigurationStateResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadWrappingPropertiesError = OpenBaoOpError;
+/** Look up wrapping properties for the given token. */
+export const readWrappingProperties: API.OperationMethod<
+  ReadWrappingPropertiesRequest,
+  ReadWrappingPropertiesResponse,
+  ReadWrappingPropertiesError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadWrappingPropertiesRequest,
+  output: ReadWrappingPropertiesResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReadWrappingProperties2Error = OpenBaoOpError;
+/** Look up wrapping properties for the requester's token. */
+export const readWrappingProperties2: API.OperationMethod<
+  ReadWrappingProperties2Request,
+  ReadWrappingProperties2Response,
+  ReadWrappingProperties2Error,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReadWrappingProperties2Request,
+  output: ReadWrappingProperties2Response,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));