@homeflare/distilled-openbao 0.2.0

package/src/services/mounts.ts

@@ -0,0 +1,428 @@
+// 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 MountsDisableSecretsEngineRequest {
+  /** The path to mount to. Example: "aws/east" */
+  path: string;
+}
+export const MountsDisableSecretsEngineRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+  }).pipe(T.Http({ method: "DELETE", uri: "/sys/mounts/{path}", code: 200 })),
+).annotate({
+  identifier: "MountsDisableSecretsEngineRequest",
+}) as any as S.Schema<MountsDisableSecretsEngineRequest>;
+
+export interface MountsDisableSecretsEngineResponse {}
+export const MountsDisableSecretsEngineResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "MountsDisableSecretsEngineResponse",
+}) as any as S.Schema<MountsDisableSecretsEngineResponse>;
+
+export interface MountsEnableSecretsEngineRequest {
+  /** The path to mount to. Example: "aws/east" */
+  path: string;
+  /** Configuration for this mount, such as default_lease_ttl and max_lease_ttl. */
+  config?: unknown;
+  /** User-friendly description for this mount. */
+  description?: string;
+  /** Whether to give the mount access to OpenBao's external entropy. */
+  external_entropy_access?: boolean;
+  /** Mark the mount as a local mount, which is not replicated and is unaffected by replication. */
+  local?: boolean;
+  /** The options to pass into the backend. Should be a json object with string keys and values. */
+  options?: unknown;
+  /** Name of the plugin to mount based from the name registered in the plugin catalog. */
+  plugin_name?: string;
+  /** The semantic version of the plugin to use. */
+  plugin_version?: string;
+  /** Whether to turn on seal wrapping for the mount. */
+  seal_wrap?: boolean;
+  /** The type of the backend. Example: "passthrough" */
+  type?: string;
+}
+export const MountsEnableSecretsEngineRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+    config: S.optional(S.Unknown),
+    description: S.optional(S.String),
+    external_entropy_access: S.optional(S.Boolean),
+    local: S.optional(S.Boolean),
+    options: S.optional(S.Unknown),
+    plugin_name: S.optional(S.String),
+    plugin_version: S.optional(S.String),
+    seal_wrap: S.optional(S.Boolean),
+    type: S.optional(S.String),
+  }).pipe(T.Http({ method: "POST", uri: "/sys/mounts/{path}", code: 200 })),
+).annotate({
+  identifier: "MountsEnableSecretsEngineRequest",
+}) as any as S.Schema<MountsEnableSecretsEngineRequest>;
+
+export interface MountsEnableSecretsEngineResponse {}
+export const MountsEnableSecretsEngineResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "MountsEnableSecretsEngineResponse",
+}) as any as S.Schema<MountsEnableSecretsEngineResponse>;
+
+export interface MountsListSecretsEnginesRequest {}
+export const MountsListSecretsEnginesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "GET", uri: "/sys/mounts", code: 200 })),
+).annotate({
+  identifier: "MountsListSecretsEnginesRequest",
+}) as any as S.Schema<MountsListSecretsEnginesRequest>;
+
+export interface MountsListSecretsEnginesResponse {}
+export const MountsListSecretsEnginesResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "MountsListSecretsEnginesResponse",
+}) as any as S.Schema<MountsListSecretsEnginesResponse>;
+
+export interface MountsReadConfigurationRequest {
+  /** The path to mount to. Example: "aws/east" */
+  path: string;
+}
+export const MountsReadConfigurationRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+  }).pipe(T.Http({ method: "GET", uri: "/sys/mounts/{path}", code: 200 })),
+).annotate({
+  identifier: "MountsReadConfigurationRequest",
+}) as any as S.Schema<MountsReadConfigurationRequest>;
+
+export interface MountsReadConfigurationResponse {
+  accessor?: string;
+  /** Configuration for this mount, such as default_lease_ttl and max_lease_ttl. */
+  config?: unknown;
+  deprecation_status?: string;
+  /** User-friendly description for this mount. */
+  description?: string;
+  external_entropy_access?: boolean;
+  /** Mark the mount as a local mount, which is not replicated and is unaffected by replication. */
+  local?: boolean;
+  /** The options to pass into the backend. Should be a json object with string keys and values. */
+  options?: unknown;
+  /** The semantic version of the plugin to use. */
+  plugin_version?: string;
+  running_plugin_version?: string;
+  running_sha256?: string;
+  /** Whether to turn on seal wrapping for the mount. */
+  seal_wrap?: boolean;
+  /** The type of the backend. Example: "passthrough" */
+  type?: string;
+  uuid?: string;
+}
+export const MountsReadConfigurationResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    accessor: S.optional(S.String),
+    config: S.optional(S.Unknown),
+    deprecation_status: S.optional(S.String),
+    description: S.optional(S.String),
+    external_entropy_access: S.optional(S.Boolean),
+    local: S.optional(S.Boolean),
+    options: S.optional(S.Unknown),
+    plugin_version: S.optional(S.String),
+    running_plugin_version: S.optional(S.String),
+    running_sha256: S.optional(S.String),
+    seal_wrap: S.optional(S.Boolean),
+    type: S.optional(S.String),
+    uuid: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "MountsReadConfigurationResponse",
+}) as any as S.Schema<MountsReadConfigurationResponse>;
+
+export interface MountsReadTuningInformationRequest {
+  /** The path to mount to. Example: "aws/east" */
+  path: string;
+}
+export const MountsReadTuningInformationRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+  }).pipe(T.Http({ method: "GET", uri: "/sys/mounts/{path}/tune", code: 200 })),
+).annotate({
+  identifier: "MountsReadTuningInformationRequest",
+}) as any as S.Schema<MountsReadTuningInformationRequest>;
+
+/** A list of headers to whitelist and allow a plugin to set on responses. */
+export type MountsReadTuningInformationResponseAllowedResponseHeadersList =
+  Array<string>;
+export const MountsReadTuningInformationResponseAllowedResponseHeadersList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsReadTuningInformationResponseAllowedResponseHeadersList>;
+
+export type MountsReadTuningInformationResponseAuditNonHmacRequestKeysList =
+  Array<string>;
+export const MountsReadTuningInformationResponseAuditNonHmacRequestKeysList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsReadTuningInformationResponseAuditNonHmacRequestKeysList>;
+
+export type MountsReadTuningInformationResponseAuditNonHmacResponseKeysList =
+  Array<string>;
+export const MountsReadTuningInformationResponseAuditNonHmacResponseKeysList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsReadTuningInformationResponseAuditNonHmacResponseKeysList>;
+
+export type MountsReadTuningInformationResponsePassthroughRequestHeadersList =
+  Array<string>;
+export const MountsReadTuningInformationResponsePassthroughRequestHeadersList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsReadTuningInformationResponsePassthroughRequestHeadersList>;
+
+export interface MountsReadTuningInformationResponse {
+  /** A list of headers to whitelist and allow a plugin to set on responses. */
+  allowed_response_headers?: MountsReadTuningInformationResponseAllowedResponseHeadersList;
+  audit_non_hmac_request_keys?: MountsReadTuningInformationResponseAuditNonHmacRequestKeysList;
+  audit_non_hmac_response_keys?: MountsReadTuningInformationResponseAuditNonHmacResponseKeysList;
+  /** The default lease TTL for this mount. */
+  default_lease_ttl?: number;
+  /** User-friendly description for this credential backend. */
+  description?: string;
+  external_entropy_access?: boolean;
+  force_no_cache?: boolean;
+  listing_visibility?: string;
+  /** The max lease TTL for this mount. */
+  max_lease_ttl?: number;
+  /** The options to pass into the backend. Should be a json object with string keys and values. */
+  options?: unknown;
+  passthrough_request_headers?: MountsReadTuningInformationResponsePassthroughRequestHeadersList;
+  /** The semantic version of the plugin to use. */
+  plugin_version?: string;
+  /** The type of token to issue (service or batch). */
+  token_type?: string;
+  user_lockout_counter_reset_duration?: number;
+  user_lockout_disable?: boolean;
+  user_lockout_duration?: number;
+  user_lockout_threshold?: number;
+}
+export const MountsReadTuningInformationResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    allowed_response_headers: S.optional(
+      MountsReadTuningInformationResponseAllowedResponseHeadersList,
+    ),
+    audit_non_hmac_request_keys: S.optional(
+      MountsReadTuningInformationResponseAuditNonHmacRequestKeysList,
+    ),
+    audit_non_hmac_response_keys: S.optional(
+      MountsReadTuningInformationResponseAuditNonHmacResponseKeysList,
+    ),
+    default_lease_ttl: S.optional(S.Number),
+    description: S.optional(S.String),
+    external_entropy_access: S.optional(S.Boolean),
+    force_no_cache: S.optional(S.Boolean),
+    listing_visibility: S.optional(S.String),
+    max_lease_ttl: S.optional(S.Number),
+    options: S.optional(S.Unknown),
+    passthrough_request_headers: S.optional(
+      MountsReadTuningInformationResponsePassthroughRequestHeadersList,
+    ),
+    plugin_version: S.optional(S.String),
+    token_type: S.optional(S.String),
+    user_lockout_counter_reset_duration: S.optional(S.Number),
+    user_lockout_disable: S.optional(S.Boolean),
+    user_lockout_duration: S.optional(S.Number),
+    user_lockout_threshold: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "MountsReadTuningInformationResponse",
+}) as any as S.Schema<MountsReadTuningInformationResponse>;
+
+/** A list of headers to whitelist and allow a plugin to set on responses. */
+export type MountsTuneConfigurationParametersRequestAllowedResponseHeadersList =
+  Array<string>;
+export const MountsTuneConfigurationParametersRequestAllowedResponseHeadersList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsTuneConfigurationParametersRequestAllowedResponseHeadersList>;
+
+/** The list of keys in the request data object that will not be HMAC'ed by audit devices. */
+export type MountsTuneConfigurationParametersRequestAuditNonHmacRequestKeysList =
+  Array<string>;
+export const MountsTuneConfigurationParametersRequestAuditNonHmacRequestKeysList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsTuneConfigurationParametersRequestAuditNonHmacRequestKeysList>;
+
+/** The list of keys in the response data object that will not be HMAC'ed by audit devices. */
+export type MountsTuneConfigurationParametersRequestAuditNonHmacResponseKeysList =
+  Array<string>;
+export const MountsTuneConfigurationParametersRequestAuditNonHmacResponseKeysList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsTuneConfigurationParametersRequestAuditNonHmacResponseKeysList>;
+
+/** A list of headers to whitelist and pass from the request to the plugin. */
+export type MountsTuneConfigurationParametersRequestPassthroughRequestHeadersList =
+  Array<string>;
+export const MountsTuneConfigurationParametersRequestPassthroughRequestHeadersList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<MountsTuneConfigurationParametersRequestPassthroughRequestHeadersList>;
+
+export interface MountsTuneConfigurationParametersRequest {
+  /** The path to mount to. Example: "aws/east" */
+  path: string;
+  /** A list of headers to whitelist and allow a plugin to set on responses. */
+  allowed_response_headers?: MountsTuneConfigurationParametersRequestAllowedResponseHeadersList;
+  /** The list of keys in the request data object that will not be HMAC'ed by audit devices. */
+  audit_non_hmac_request_keys?: MountsTuneConfigurationParametersRequestAuditNonHmacRequestKeysList;
+  /** The list of keys in the response data object that will not be HMAC'ed by audit devices. */
+  audit_non_hmac_response_keys?: MountsTuneConfigurationParametersRequestAuditNonHmacResponseKeysList;
+  /** The default lease TTL for this mount. */
+  default_lease_ttl?: string;
+  /** User-friendly description for this credential backend. */
+  description?: string;
+  /** Determines the visibility of the mount in the UI-specific listing endpoint. Accepted value are 'unauth' and 'hidden', with the empty default ('') behaving like 'hidden'. */
+  listing_visibility?: string;
+  /** The max lease TTL for this mount. */
+  max_lease_ttl?: string;
+  /** The options to pass into the backend. Should be a json object with string keys and values. */
+  options?: unknown;
+  /** A list of headers to whitelist and pass from the request to the plugin. */
+  passthrough_request_headers?: MountsTuneConfigurationParametersRequestPassthroughRequestHeadersList;
+  /** The semantic version of the plugin to use. */
+  plugin_version?: string;
+  /** The type of token to issue (service or batch). */
+  token_type?: string;
+  /** The user lockout configuration to pass into the backend. Should be a json object with string keys and values. */
+  user_lockout_config?: unknown;
+}
+export const MountsTuneConfigurationParametersRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      path: S.String.pipe(T.Label()),
+      allowed_response_headers: S.optional(
+        MountsTuneConfigurationParametersRequestAllowedResponseHeadersList,
+      ),
+      audit_non_hmac_request_keys: S.optional(
+        MountsTuneConfigurationParametersRequestAuditNonHmacRequestKeysList,
+      ),
+      audit_non_hmac_response_keys: S.optional(
+        MountsTuneConfigurationParametersRequestAuditNonHmacResponseKeysList,
+      ),
+      default_lease_ttl: S.optional(S.String),
+      description: S.optional(S.String),
+      listing_visibility: S.optional(S.String),
+      max_lease_ttl: S.optional(S.String),
+      options: S.optional(S.Unknown),
+      passthrough_request_headers: S.optional(
+        MountsTuneConfigurationParametersRequestPassthroughRequestHeadersList,
+      ),
+      plugin_version: S.optional(S.String),
+      token_type: S.optional(S.String),
+      user_lockout_config: S.optional(S.Unknown),
+    }).pipe(
+      T.Http({ method: "POST", uri: "/sys/mounts/{path}/tune", code: 200 }),
+    ),
+).annotate({
+  identifier: "MountsTuneConfigurationParametersRequest",
+}) as any as S.Schema<MountsTuneConfigurationParametersRequest>;
+
+export interface MountsTuneConfigurationParametersResponse {}
+export const MountsTuneConfigurationParametersResponse =
+  /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
+    identifier: "MountsTuneConfigurationParametersResponse",
+  }) as any as S.Schema<MountsTuneConfigurationParametersResponse>;
+
+export type MountsDisableSecretsEngineError = OpenBaoOpError;
+/** Disable the mount point specified at the given path. */
+export const mountsDisableSecretsEngine: API.OperationMethod<
+  MountsDisableSecretsEngineRequest,
+  MountsDisableSecretsEngineResponse,
+  MountsDisableSecretsEngineError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: MountsDisableSecretsEngineRequest,
+  output: MountsDisableSecretsEngineResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type MountsEnableSecretsEngineError = OpenBaoOpError;
+/** Enable a new secrets engine at the given path. */
+export const mountsEnableSecretsEngine: API.OperationMethod<
+  MountsEnableSecretsEngineRequest,
+  MountsEnableSecretsEngineResponse,
+  MountsEnableSecretsEngineError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: MountsEnableSecretsEngineRequest,
+  output: MountsEnableSecretsEngineResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type MountsListSecretsEnginesError = OpenBaoOpError;
+export const mountsListSecretsEngines: API.OperationMethod<
+  MountsListSecretsEnginesRequest,
+  MountsListSecretsEnginesResponse,
+  MountsListSecretsEnginesError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: MountsListSecretsEnginesRequest,
+  output: MountsListSecretsEnginesResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type MountsReadConfigurationError = OpenBaoOpError;
+/** Read the configuration of the secret engine at the given path. */
+export const mountsReadConfiguration: API.OperationMethod<
+  MountsReadConfigurationRequest,
+  MountsReadConfigurationResponse,
+  MountsReadConfigurationError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: MountsReadConfigurationRequest,
+  output: MountsReadConfigurationResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type MountsReadTuningInformationError = OpenBaoOpError;
+export const mountsReadTuningInformation: API.OperationMethod<
+  MountsReadTuningInformationRequest,
+  MountsReadTuningInformationResponse,
+  MountsReadTuningInformationError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: MountsReadTuningInformationRequest,
+  output: MountsReadTuningInformationResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type MountsTuneConfigurationParametersError = OpenBaoOpError;
+export const mountsTuneConfigurationParameters: API.OperationMethod<
+  MountsTuneConfigurationParametersRequest,
+  MountsTuneConfigurationParametersResponse,
+  MountsTuneConfigurationParametersError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: MountsTuneConfigurationParametersRequest,
+  output: MountsTuneConfigurationParametersResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));