@homeflare/distilled-proxmox-backup 0.2.0

package/src/services/ping.ts

@@ -0,0 +1,43 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (apidoc.js, via scripts/apidoc.ts — see its header). 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 {
+  ProxmoxBackupProtocol,
+  type ProxmoxBackupOpError,
+  type ProxmoxBackupOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { ProxmoxBackupOpError, ProxmoxBackupOpContext };
+
+export interface GetPingRequest {}
+export const GetPingRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "GET", uri: "/ping", code: 200 })),
+).annotate({ identifier: "GetPingRequest" }) as any as S.Schema<GetPingRequest>;
+
+export interface GetPingResponse {
+  pong: unknown;
+}
+export const GetPingResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    pong: S.Unknown,
+  }),
+).annotate({
+  identifier: "GetPingResponse",
+}) as any as S.Schema<GetPingResponse>;
+
+export type GetPingError = ProxmoxBackupOpError;
+/** Dummy method which replies with `{ "pong": True }` */
+export const getPing: API.OperationMethod<
+  GetPingRequest,
+  GetPingResponse,
+  GetPingError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetPingRequest,
+  output: GetPingResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/pull.ts

@@ -0,0 +1,118 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (apidoc.js, via scripts/apidoc.ts — see its header). 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 {
+  ProxmoxBackupProtocol,
+  type ProxmoxBackupOpError,
+  type ProxmoxBackupOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { ProxmoxBackupOpError, ProxmoxBackupOpContext };
+
+export type CreatePullRequestDecryptionKeysList = Array<string>;
+export const CreatePullRequestDecryptionKeysList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<CreatePullRequestDecryptionKeysList>;
+
+export type CreatePullRequestGroupFilterList = Array<string>;
+export const CreatePullRequestGroupFilterList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<CreatePullRequestGroupFilterList>;
+
+export interface CreatePullRequest {
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  burst_in?: string;
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  burst_out?: string;
+  /** List of decryption keys. */
+  decryption_keys?: CreatePullRequestDecryptionKeysList;
+  /** Only synchronize encrypted backup snapshots, exclude others. */
+  encrypted_only?: string;
+  /** List of group filters. */
+  group_filter?: CreatePullRequestGroupFilterList;
+  /** How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value) */
+  max_depth?: string;
+  /** Namespace. */
+  ns?: string;
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  rate_in?: string;
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  rate_out?: string;
+  /** Remote ID. */
+  remote?: string;
+  /** Namespace. */
+  remote_ns?: string;
+  /** Datastore name. */
+  remote_store: string;
+  /** Delete vanished backups. This removes the local copy if the remote backup was deleted. */
+  remove_vanished?: string;
+  /** If the verification failed for a local snapshot, try to pull it again. */
+  resync_corrupt?: string;
+  /** Datastore name. */
+  store: string;
+  /** Limit transfer to last N snapshots (per group), skipping others */
+  transfer_last?: string;
+  /** Only synchronize verified backup snapshots, exclude others. */
+  verified_only?: string;
+  /** The number of worker threads to process groups in parallel. */
+  worker_threads?: string;
+}
+export const CreatePullRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    burst_in: S.optional(S.String.pipe(T.Body("burst-in"))),
+    burst_out: S.optional(S.String.pipe(T.Body("burst-out"))),
+    decryption_keys: S.optional(
+      CreatePullRequestDecryptionKeysList.pipe(T.Body("decryption-keys")),
+    ),
+    encrypted_only: S.optional(S.String.pipe(T.Body("encrypted-only"))),
+    group_filter: S.optional(
+      CreatePullRequestGroupFilterList.pipe(T.Body("group-filter")),
+    ),
+    max_depth: S.optional(S.String.pipe(T.Body("max-depth"))),
+    ns: S.optional(S.String),
+    rate_in: S.optional(S.String.pipe(T.Body("rate-in"))),
+    rate_out: S.optional(S.String.pipe(T.Body("rate-out"))),
+    remote: S.optional(S.String),
+    remote_ns: S.optional(S.String.pipe(T.Body("remote-ns"))),
+    remote_store: S.String.pipe(T.Body("remote-store")),
+    remove_vanished: S.optional(S.String.pipe(T.Body("remove-vanished"))),
+    resync_corrupt: S.optional(S.String.pipe(T.Body("resync-corrupt"))),
+    store: S.String,
+    transfer_last: S.optional(S.String.pipe(T.Body("transfer-last"))),
+    verified_only: S.optional(S.String.pipe(T.Body("verified-only"))),
+    worker_threads: S.optional(S.String.pipe(T.Body("worker-threads"))),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/pull",
+      code: 200,
+      contentType: "form-urlencoded",
+    }),
+  ),
+).annotate({
+  identifier: "CreatePullRequest",
+}) as any as S.Schema<CreatePullRequest>;
+
+export interface CreatePullResponse {}
+export const CreatePullResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "CreatePullResponse",
+}) as any as S.Schema<CreatePullResponse>;
+
+export type CreatePullError = ProxmoxBackupOpError;
+/** Sync store from other repository */
+export const createPull: API.OperationMethod<
+  CreatePullRequest,
+  CreatePullResponse,
+  CreatePullError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreatePullRequest,
+  output: CreatePullResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/push.ts

@@ -0,0 +1,108 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (apidoc.js, via scripts/apidoc.ts — see its header). 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 {
+  ProxmoxBackupProtocol,
+  type ProxmoxBackupOpError,
+  type ProxmoxBackupOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { ProxmoxBackupOpError, ProxmoxBackupOpContext };
+
+export type CreatePushRequestGroupFilterList = Array<string>;
+export const CreatePushRequestGroupFilterList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<CreatePushRequestGroupFilterList>;
+
+export interface CreatePushRequest {
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  burst_in?: string;
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  burst_out?: string;
+  /** Only synchronize encrypted backup snapshots, exclude others. */
+  encrypted_only?: string;
+  /** ID to uniquely identify encryption/decription key */
+  encryption_key?: string;
+  /** List of group filters. */
+  group_filter?: CreatePushRequestGroupFilterList;
+  /** How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value) */
+  max_depth?: string;
+  /** Namespace. */
+  ns?: string;
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  rate_in?: string;
+  /** Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...). */
+  rate_out?: string;
+  /** Remote ID. */
+  remote: string;
+  /** Namespace. */
+  remote_ns?: string;
+  /** Datastore name. */
+  remote_store: string;
+  /** Delete vanished backups. This removes the local copy if the remote backup was deleted. */
+  remove_vanished?: string;
+  /** Datastore name. */
+  store: string;
+  /** Limit transfer to last N snapshots (per group), skipping others */
+  transfer_last?: string;
+  /** Only synchronize verified backup snapshots, exclude others. */
+  verified_only?: string;
+  /** The number of worker threads to process groups in parallel. */
+  worker_threads?: string;
+}
+export const CreatePushRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    burst_in: S.optional(S.String.pipe(T.Body("burst-in"))),
+    burst_out: S.optional(S.String.pipe(T.Body("burst-out"))),
+    encrypted_only: S.optional(S.String.pipe(T.Body("encrypted-only"))),
+    encryption_key: S.optional(S.String.pipe(T.Body("encryption-key"))),
+    group_filter: S.optional(
+      CreatePushRequestGroupFilterList.pipe(T.Body("group-filter")),
+    ),
+    max_depth: S.optional(S.String.pipe(T.Body("max-depth"))),
+    ns: S.optional(S.String),
+    rate_in: S.optional(S.String.pipe(T.Body("rate-in"))),
+    rate_out: S.optional(S.String.pipe(T.Body("rate-out"))),
+    remote: S.String,
+    remote_ns: S.optional(S.String.pipe(T.Body("remote-ns"))),
+    remote_store: S.String.pipe(T.Body("remote-store")),
+    remove_vanished: S.optional(S.String.pipe(T.Body("remove-vanished"))),
+    store: S.String,
+    transfer_last: S.optional(S.String.pipe(T.Body("transfer-last"))),
+    verified_only: S.optional(S.String.pipe(T.Body("verified-only"))),
+    worker_threads: S.optional(S.String.pipe(T.Body("worker-threads"))),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/push",
+      code: 200,
+      contentType: "form-urlencoded",
+    }),
+  ),
+).annotate({
+  identifier: "CreatePushRequest",
+}) as any as S.Schema<CreatePushRequest>;
+
+export interface CreatePushResponse {}
+export const CreatePushResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "CreatePushResponse",
+}) as any as S.Schema<CreatePushResponse>;
+
+export type CreatePushError = ProxmoxBackupOpError;
+/** Push store to other repository */
+export const createPush: API.OperationMethod<
+  CreatePushRequest,
+  CreatePushResponse,
+  CreatePushError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreatePushRequest,
+  output: CreatePushResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/reader.ts

@@ -0,0 +1,196 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (apidoc.js, via scripts/apidoc.ts — see its header). 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 {
+  ProxmoxBackupProtocol,
+  type ProxmoxBackupOpError,
+  type ProxmoxBackupOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { ProxmoxBackupOpError, ProxmoxBackupOpContext };
+
+export type GetReaderRequestBackupType = "vm" | "ct" | "host";
+export const GetReaderRequestBackupType = S.String;
+
+export interface GetReaderRequest {
+  /** Backup ID. */
+  backup_id: string;
+  /** Backup time (Unix epoch.) */
+  backup_time: string;
+  /** Backup type. */
+  backup_type: GetReaderRequestBackupType | (string & {});
+  /** Enable verbose debug logging. */
+  debug?: string;
+  /** Namespace. */
+  ns?: string;
+  /** Datastore name. */
+  store: string;
+}
+export const GetReaderRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    backup_id: S.String.pipe(T.Query("backup-id")),
+    backup_time: S.String.pipe(T.Query("backup-time")),
+    backup_type: GetReaderRequestBackupType.pipe(T.Query("backup-type")),
+    debug: S.optional(S.String.pipe(T.Query())),
+    ns: S.optional(S.String.pipe(T.Query())),
+    store: S.String.pipe(T.Query()),
+  }).pipe(T.Http({ method: "GET", uri: "/reader", code: 200 })),
+).annotate({
+  identifier: "GetReaderRequest",
+}) as any as S.Schema<GetReaderRequest>;
+
+export interface GetReaderResponse {}
+export const GetReaderResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetReaderResponse",
+}) as any as S.Schema<GetReaderResponse>;
+
+export interface GetReaderUpgradeRequest {}
+export const GetReaderUpgradeRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/reader/_upgrade_", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetReaderUpgradeRequest",
+}) as any as S.Schema<GetReaderUpgradeRequest>;
+
+export interface GetReaderUpgradeResponse {}
+export const GetReaderUpgradeResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetReaderUpgradeResponse",
+}) as any as S.Schema<GetReaderUpgradeResponse>;
+
+export interface GetReaderUpgradeChunkRequest {
+  /** Chunk digest (SHA256). */
+  digest: string;
+}
+export const GetReaderUpgradeChunkRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    digest: S.String.pipe(T.Query()),
+  }).pipe(T.Http({ method: "GET", uri: "/reader/_upgrade_/chunk", code: 200 })),
+).annotate({
+  identifier: "GetReaderUpgradeChunkRequest",
+}) as any as S.Schema<GetReaderUpgradeChunkRequest>;
+
+export interface GetReaderUpgradeChunkResponse {}
+export const GetReaderUpgradeChunkResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetReaderUpgradeChunkResponse",
+}) as any as S.Schema<GetReaderUpgradeChunkResponse>;
+
+export interface GetReaderUpgradeDownloadRequest {
+  /** Backup archive name. */
+  file_name: string;
+}
+export const GetReaderUpgradeDownloadRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    file_name: S.String.pipe(T.Query("file-name")),
+  }).pipe(
+    T.Http({ method: "GET", uri: "/reader/_upgrade_/download", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetReaderUpgradeDownloadRequest",
+}) as any as S.Schema<GetReaderUpgradeDownloadRequest>;
+
+export interface GetReaderUpgradeDownloadResponse {}
+export const GetReaderUpgradeDownloadResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetReaderUpgradeDownloadResponse",
+}) as any as S.Schema<GetReaderUpgradeDownloadResponse>;
+
+export interface GetReaderUpgradeSpeedtestRequest {}
+export const GetReaderUpgradeSpeedtestRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/reader/_upgrade_/speedtest", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetReaderUpgradeSpeedtestRequest",
+}) as any as S.Schema<GetReaderUpgradeSpeedtestRequest>;
+
+export interface GetReaderUpgradeSpeedtestResponse {}
+export const GetReaderUpgradeSpeedtestResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetReaderUpgradeSpeedtestResponse",
+}) as any as S.Schema<GetReaderUpgradeSpeedtestResponse>;
+
+export type GetReaderError = ProxmoxBackupOpError;
+/** Upgraded to backup protocol ('proxmox-backup-reader-protocol-v1'). */
+export const getReader: API.OperationMethod<
+  GetReaderRequest,
+  GetReaderResponse,
+  GetReaderError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetReaderRequest,
+  output: GetReaderResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetReaderUpgradeError = ProxmoxBackupOpError;
+/** Directory index. */
+export const getReaderUpgrade: API.OperationMethod<
+  GetReaderUpgradeRequest,
+  GetReaderUpgradeResponse,
+  GetReaderUpgradeError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetReaderUpgradeRequest,
+  output: GetReaderUpgradeResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetReaderUpgradeChunkError = ProxmoxBackupOpError;
+/** Download specified chunk. */
+export const getReaderUpgradeChunk: API.OperationMethod<
+  GetReaderUpgradeChunkRequest,
+  GetReaderUpgradeChunkResponse,
+  GetReaderUpgradeChunkError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetReaderUpgradeChunkRequest,
+  output: GetReaderUpgradeChunkResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetReaderUpgradeDownloadError = ProxmoxBackupOpError;
+/** Download specified file. */
+export const getReaderUpgradeDownload: API.OperationMethod<
+  GetReaderUpgradeDownloadRequest,
+  GetReaderUpgradeDownloadResponse,
+  GetReaderUpgradeDownloadError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetReaderUpgradeDownloadRequest,
+  output: GetReaderUpgradeDownloadResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetReaderUpgradeSpeedtestError = ProxmoxBackupOpError;
+/** Test 1M block download speed. */
+export const getReaderUpgradeSpeedtest: API.OperationMethod<
+  GetReaderUpgradeSpeedtestRequest,
+  GetReaderUpgradeSpeedtestResponse,
+  GetReaderUpgradeSpeedtestError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetReaderUpgradeSpeedtestRequest,
+  output: GetReaderUpgradeSpeedtestResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/root.ts

@@ -0,0 +1,39 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (apidoc.js, via scripts/apidoc.ts — see its header). 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 {
+  ProxmoxBackupProtocol,
+  type ProxmoxBackupOpError,
+  type ProxmoxBackupOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { ProxmoxBackupOpError, ProxmoxBackupOpContext };
+
+export interface GetRootRequest {}
+export const GetRootRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(T.Http({ method: "GET", uri: "/", code: 200 })),
+).annotate({ identifier: "GetRootRequest" }) as any as S.Schema<GetRootRequest>;
+
+export interface GetRootResponse {}
+export const GetRootResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "GetRootResponse",
+}) as any as S.Schema<GetRootResponse>;
+
+export type GetRootError = ProxmoxBackupOpError;
+/** Directory index. */
+export const getRoot: API.OperationMethod<
+  GetRootRequest,
+  GetRootResponse,
+  GetRootError,
+  ProxmoxBackupOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetRootRequest,
+  output: GetRootResponse,
+  errors: [],
+  protocol: ProxmoxBackupProtocol,
+  retry: Retry.Retry,
+}));