@homeflare/distilled-openbao 0.2.0

package/src/services/auditing.ts

@@ -0,0 +1,318 @@
+// 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 AuditingCalculateHashRequest {
+  /** The name of the backend. Cannot be delimited. Example: "mysql" */
+  path: string;
+  input?: string;
+}
+export const AuditingCalculateHashRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+    input: S.optional(S.String),
+  }).pipe(T.Http({ method: "POST", uri: "/sys/audit-hash/{path}", code: 200 })),
+).annotate({
+  identifier: "AuditingCalculateHashRequest",
+}) as any as S.Schema<AuditingCalculateHashRequest>;
+
+export interface AuditingCalculateHashResponse {
+  hash?: string;
+}
+export const AuditingCalculateHashResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    hash: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "AuditingCalculateHashResponse",
+}) as any as S.Schema<AuditingCalculateHashResponse>;
+
+export interface AuditingDisableDeviceRequest {
+  /** The name of the backend. Cannot be delimited. Example: "mysql" */
+  path: string;
+}
+export const AuditingDisableDeviceRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+  }).pipe(T.Http({ method: "DELETE", uri: "/sys/audit/{path}", code: 200 })),
+).annotate({
+  identifier: "AuditingDisableDeviceRequest",
+}) as any as S.Schema<AuditingDisableDeviceRequest>;
+
+export interface AuditingDisableDeviceResponse {}
+export const AuditingDisableDeviceResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "AuditingDisableDeviceResponse",
+}) as any as S.Schema<AuditingDisableDeviceResponse>;
+
+export interface AuditingDisableRequestHeaderRequest {
+  header: string;
+}
+export const AuditingDisableRequestHeaderRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    header: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/sys/config/auditing/request-headers/{header}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "AuditingDisableRequestHeaderRequest",
+}) as any as S.Schema<AuditingDisableRequestHeaderRequest>;
+
+export interface AuditingDisableRequestHeaderResponse {}
+export const AuditingDisableRequestHeaderResponse = /*@__PURE__*/ S.suspend(
+  () => S.Struct({}),
+).annotate({
+  identifier: "AuditingDisableRequestHeaderResponse",
+}) as any as S.Schema<AuditingDisableRequestHeaderResponse>;
+
+export interface AuditingEnableDeviceRequest {
+  /** The name of the backend. Cannot be delimited. Example: "mysql" */
+  path: string;
+  /** User-friendly description for this audit backend. */
+  description?: string;
+  /** Mark the mount as a local mount, which is not replicated and is unaffected by replication. */
+  local?: boolean;
+  /** Configuration options for the audit backend. */
+  options?: unknown;
+  /** The type of the backend. Example: "mysql" */
+  type?: string;
+}
+export const AuditingEnableDeviceRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    path: S.String.pipe(T.Label()),
+    description: S.optional(S.String),
+    local: S.optional(S.Boolean),
+    options: S.optional(S.Unknown),
+    type: S.optional(S.String),
+  }).pipe(T.Http({ method: "POST", uri: "/sys/audit/{path}", code: 200 })),
+).annotate({
+  identifier: "AuditingEnableDeviceRequest",
+}) as any as S.Schema<AuditingEnableDeviceRequest>;
+
+export interface AuditingEnableDeviceResponse {}
+export const AuditingEnableDeviceResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "AuditingEnableDeviceResponse",
+}) as any as S.Schema<AuditingEnableDeviceResponse>;
+
+export interface AuditingEnableRequestHeaderRequest {
+  header: string;
+  hmac?: boolean;
+}
+export const AuditingEnableRequestHeaderRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    header: S.String.pipe(T.Label()),
+    hmac: S.optional(S.Boolean),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/sys/config/auditing/request-headers/{header}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "AuditingEnableRequestHeaderRequest",
+}) as any as S.Schema<AuditingEnableRequestHeaderRequest>;
+
+export interface AuditingEnableRequestHeaderResponse {}
+export const AuditingEnableRequestHeaderResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "AuditingEnableRequestHeaderResponse",
+}) as any as S.Schema<AuditingEnableRequestHeaderResponse>;
+
+export interface AuditingListEnabledDevicesRequest {}
+export const AuditingListEnabledDevicesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "GET", uri: "/sys/audit", code: 200 })),
+).annotate({
+  identifier: "AuditingListEnabledDevicesRequest",
+}) as any as S.Schema<AuditingListEnabledDevicesRequest>;
+
+export interface AuditingListEnabledDevicesResponse {}
+export const AuditingListEnabledDevicesResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "AuditingListEnabledDevicesResponse",
+}) as any as S.Schema<AuditingListEnabledDevicesResponse>;
+
+export interface AuditingListRequestHeadersRequest {}
+export const AuditingListRequestHeadersRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/sys/config/auditing/request-headers",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "AuditingListRequestHeadersRequest",
+}) as any as S.Schema<AuditingListRequestHeadersRequest>;
+
+export interface AuditingListRequestHeadersResponse {
+  headers?: unknown;
+}
+export const AuditingListRequestHeadersResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    headers: S.optional(S.Unknown),
+  }),
+).annotate({
+  identifier: "AuditingListRequestHeadersResponse",
+}) as any as S.Schema<AuditingListRequestHeadersResponse>;
+
+export interface AuditingReadRequestHeaderInformationRequest {
+  header: string;
+}
+export const AuditingReadRequestHeaderInformationRequest =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      header: S.String.pipe(T.Label()),
+    }).pipe(
+      T.Http({
+        method: "GET",
+        uri: "/sys/config/auditing/request-headers/{header}",
+        code: 200,
+      }),
+    ),
+  ).annotate({
+    identifier: "AuditingReadRequestHeaderInformationRequest",
+  }) as any as S.Schema<AuditingReadRequestHeaderInformationRequest>;
+
+export interface AuditingReadRequestHeaderInformationResponse {}
+export const AuditingReadRequestHeaderInformationResponse =
+  /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
+    identifier: "AuditingReadRequestHeaderInformationResponse",
+  }) as any as S.Schema<AuditingReadRequestHeaderInformationResponse>;
+
+export type AuditingCalculateHashError = OpenBaoOpError;
+export const auditingCalculateHash: API.OperationMethod<
+  AuditingCalculateHashRequest,
+  AuditingCalculateHashResponse,
+  AuditingCalculateHashError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingCalculateHashRequest,
+  output: AuditingCalculateHashResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type AuditingDisableDeviceError = OpenBaoOpError;
+/** Disable the audit device at the given path. */
+export const auditingDisableDevice: API.OperationMethod<
+  AuditingDisableDeviceRequest,
+  AuditingDisableDeviceResponse,
+  AuditingDisableDeviceError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingDisableDeviceRequest,
+  output: AuditingDisableDeviceResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type AuditingDisableRequestHeaderError = OpenBaoOpError;
+/** Disable auditing of the given request header. */
+export const auditingDisableRequestHeader: API.OperationMethod<
+  AuditingDisableRequestHeaderRequest,
+  AuditingDisableRequestHeaderResponse,
+  AuditingDisableRequestHeaderError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingDisableRequestHeaderRequest,
+  output: AuditingDisableRequestHeaderResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type AuditingEnableDeviceError = OpenBaoOpError;
+/** Enable a new audit device at the supplied path. */
+export const auditingEnableDevice: API.OperationMethod<
+  AuditingEnableDeviceRequest,
+  AuditingEnableDeviceResponse,
+  AuditingEnableDeviceError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingEnableDeviceRequest,
+  output: AuditingEnableDeviceResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type AuditingEnableRequestHeaderError = OpenBaoOpError;
+/** Enable auditing of a header. */
+export const auditingEnableRequestHeader: API.OperationMethod<
+  AuditingEnableRequestHeaderRequest,
+  AuditingEnableRequestHeaderResponse,
+  AuditingEnableRequestHeaderError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingEnableRequestHeaderRequest,
+  output: AuditingEnableRequestHeaderResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type AuditingListEnabledDevicesError = OpenBaoOpError;
+/** List the enabled audit devices. */
+export const auditingListEnabledDevices: API.OperationMethod<
+  AuditingListEnabledDevicesRequest,
+  AuditingListEnabledDevicesResponse,
+  AuditingListEnabledDevicesError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingListEnabledDevicesRequest,
+  output: AuditingListEnabledDevicesResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type AuditingListRequestHeadersError = OpenBaoOpError;
+/** List the request headers that are configured to be audited. */
+export const auditingListRequestHeaders: API.OperationMethod<
+  AuditingListRequestHeadersRequest,
+  AuditingListRequestHeadersResponse,
+  AuditingListRequestHeadersError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingListRequestHeadersRequest,
+  output: AuditingListRequestHeadersResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type AuditingReadRequestHeaderInformationError = OpenBaoOpError;
+/** List the information for the given request header. */
+export const auditingReadRequestHeaderInformation: API.OperationMethod<
+  AuditingReadRequestHeaderInformationRequest,
+  AuditingReadRequestHeaderInformationResponse,
+  AuditingReadRequestHeaderInformationError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AuditingReadRequestHeaderInformationRequest,
+  output: AuditingReadRequestHeaderInformationResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));