@homeflare/distilled-proxmox 0.2.0 → 0.3.1

package/src/services/cluster.ts

@@ -1,6 +1,7 @@
 // AUTO-GENERATED by scripts/generate.ts from .generated-specs (apidata.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 C from "@distilled.cloud/core/category";
 import * as T from "../traits.ts";
 import {
   ProxmoxProtocol,
@@ -11,6 +12,35 @@ import * as Retry from "../retry.ts";
 
 export type { ProxmoxOpError, ProxmoxOpContext };
 
+/** The backup job does not exist. pve-manager 9.2.11, f6997e698c7933ea8e62319e2bf1bf7262daa56a, PVE/API2/Backup.pm:406,458,755 raises a 400 parameter exception with exactly errors.id = No such job '<id>'. The Proxmox protocol extracts that sole precise detail for matching; unrelated or multi-field validation errors never become absence. Update uses a different exception and is deliberately not attached. */
+export class BackupJobNotFound
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<BackupJobNotFound>()("BackupJobNotFound", {
+      message: S.String,
+    }).pipe(C.withBadRequestError),
+    [{ status: 400, message: { matches: "^No such job '[^']+'$" } }],
+  ) {}
+
+/** The metrics server does not exist. pve-manager 9.2.11, f6997e698c7933ea8e62319e2bf1bf7262daa56a, PVE/API2/Cluster/MetricServer.pm:136 throws status server entry '<id>' does not exist on GET, and line 228 throws no such server '<id>' on PUT. Both are wire 500. DELETE dereferences the plugin config without an explicit absence check and is not declared to return this tag. */
+export class MetricServerNotFound
+  extends /*@__PURE__*/ T.applyErrorMatchers(
+    /*@__PURE__*/ S.TaggedError<MetricServerNotFound>()(
+      "MetricServerNotFound",
+      {
+        message: S.String,
+      },
+    ).pipe(C.withBadRequestError),
+    [
+      {
+        status: 500,
+        message: {
+          matches: "^status server entry '[^']+' does not exist\\n?$",
+        },
+      },
+      { status: 500, message: { matches: "^no such server '[^']+'\\n?$" } },
+    ],
+  ) {}
+
 export interface CreateClusterAcmeAccountRequest {
   /** Contact email addresses. */
   contact: string;
@@ -2586,13 +2616,12 @@ export interface DeleteClusterFirewallAliasRequest {
 export const DeleteClusterFirewallAliasRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     name: S.String.pipe(T.Label()),
-    digest: S.optional(S.String),
+    digest: S.optional(S.String.pipe(T.Query())),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/firewall/aliases/{name}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -2640,13 +2669,12 @@ export const DeleteClusterFirewallGroup2Request = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     group: S.String.pipe(T.Label()),
     pos: S.String.pipe(T.Label()),
-    digest: S.optional(S.String),
+    digest: S.optional(S.String.pipe(T.Query())),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/firewall/groups/{group}/{pos}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -2668,13 +2696,12 @@ export interface DeleteClusterFirewallIpsetRequest {
 export const DeleteClusterFirewallIpsetRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     name: S.String.pipe(T.Label()),
-    force: S.optional(S.String),
+    force: S.optional(S.String.pipe(T.Query())),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/firewall/ipset/{name}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -2698,13 +2725,12 @@ export const DeleteClusterFirewallIpset2Request = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     name: S.String.pipe(T.Label()),
     cidr: S.String.pipe(T.Label()),
-    digest: S.optional(S.String),
+    digest: S.optional(S.String.pipe(T.Query())),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/firewall/ipset/{name}/{cidr}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -2726,13 +2752,12 @@ export interface DeleteClusterFirewallRuleRequest {
 export const DeleteClusterFirewallRuleRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     pos: S.String.pipe(T.Label()),
-    digest: S.optional(S.String),
+    digest: S.optional(S.String.pipe(T.Query())),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/firewall/rules/{pos}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -2774,14 +2799,9 @@ export interface DeleteClusterHaResourceRequest {
 export const DeleteClusterHaResourceRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     sid: S.String.pipe(T.Label()),
-    purge: S.optional(S.String),
+    purge: S.optional(S.String.pipe(T.Query())),
   }).pipe(
-    T.Http({
-      method: "DELETE",
-      uri: "/cluster/ha/resources/{sid}",
-      code: 200,
-      contentType: "form-urlencoded",
-    }),
+    T.Http({ method: "DELETE", uri: "/cluster/ha/resources/{sid}", code: 200 }),
   ),
 ).annotate({
   identifier: "DeleteClusterHaResourceRequest",
@@ -3078,15 +3098,10 @@ export interface DeleteClusterReplicationRequest {
 export const DeleteClusterReplicationRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     id: S.String.pipe(T.Label()),
-    force: S.optional(S.String),
-    keep: S.optional(S.String),
+    force: S.optional(S.String.pipe(T.Query())),
+    keep: S.optional(S.String.pipe(T.Query())),
   }).pipe(
-    T.Http({
-      method: "DELETE",
-      uri: "/cluster/replication/{id}",
-      code: 200,
-      contentType: "form-urlencoded",
-    }),
+    T.Http({ method: "DELETE", uri: "/cluster/replication/{id}", code: 200 }),
   ),
 ).annotate({
   identifier: "DeleteClusterReplicationRequest",
@@ -3107,13 +3122,12 @@ export interface DeleteClusterSdnControllerRequest {
 export const DeleteClusterSdnControllerRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     controller: S.String.pipe(T.Label()),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/sdn/controllers/{controller}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -3135,14 +3149,9 @@ export interface DeleteClusterSdnDnsRequest {
 export const DeleteClusterSdnDnsRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     dns: S.String.pipe(T.Label()),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
   }).pipe(
-    T.Http({
-      method: "DELETE",
-      uri: "/cluster/sdn/dns/{dns}",
-      code: 200,
-      contentType: "form-urlencoded",
-    }),
+    T.Http({ method: "DELETE", uri: "/cluster/sdn/dns/{dns}", code: 200 }),
   ),
 ).annotate({
   identifier: "DeleteClusterSdnDnsRequest",
@@ -3213,14 +3222,9 @@ export interface DeleteClusterSdnIpamRequest {
 export const DeleteClusterSdnIpamRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     ipam: S.String.pipe(T.Label()),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
   }).pipe(
-    T.Http({
-      method: "DELETE",
-      uri: "/cluster/sdn/ipams/{ipam}",
-      code: 200,
-      contentType: "form-urlencoded",
-    }),
+    T.Http({ method: "DELETE", uri: "/cluster/sdn/ipams/{ipam}", code: 200 }),
   ),
 ).annotate({
   identifier: "DeleteClusterSdnIpamRequest",
@@ -3241,16 +3245,9 @@ export interface DeleteClusterSdnLockRequest {
 }
 export const DeleteClusterSdnLockRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
-    force: S.optional(S.String),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
-  }).pipe(
-    T.Http({
-      method: "DELETE",
-      uri: "/cluster/sdn/lock",
-      code: 200,
-      contentType: "form-urlencoded",
-    }),
-  ),
+    force: S.optional(S.String.pipe(T.Query())),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
+  }).pipe(T.Http({ method: "DELETE", uri: "/cluster/sdn/lock", code: 200 })),
 ).annotate({
   identifier: "DeleteClusterSdnLockRequest",
 }) as any as S.Schema<DeleteClusterSdnLockRequest>;
@@ -3270,13 +3267,12 @@ export interface DeleteClusterSdnPrefixListRequest {
 export const DeleteClusterSdnPrefixListRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     id: S.String.pipe(T.Label()),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/sdn/prefix-lists/{id}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -3301,13 +3297,12 @@ export const DeleteClusterSdnPrefixListEntryRequest = /*@__PURE__*/ S.suspend(
     S.Struct({
       id: S.String.pipe(T.Label()),
       url_seq: S.String.pipe(T.Label()),
-      lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+      lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
     }).pipe(
       T.Http({
         method: "DELETE",
         uri: "/cluster/sdn/prefix-lists/{id}/entries/{url_seq}",
         code: 200,
-        contentType: "form-urlencoded",
       }),
     ),
 ).annotate({
@@ -3332,13 +3327,12 @@ export const DeleteClusterSdnRouteMapEntryEntryRequest =
     S.Struct({
       route_map_id: S.String.pipe(T.Label()),
       order: S.String.pipe(T.Label()),
-      lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+      lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
     }).pipe(
       T.Http({
         method: "DELETE",
         uri: "/cluster/sdn/route-maps/entries/{route-map-id}/entry/{order}",
         code: 200,
-        contentType: "form-urlencoded",
       }),
     ),
   ).annotate({
@@ -3359,14 +3353,9 @@ export interface DeleteClusterSdnVnetRequest {
 export const DeleteClusterSdnVnetRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     vnet: S.String.pipe(T.Label()),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
   }).pipe(
-    T.Http({
-      method: "DELETE",
-      uri: "/cluster/sdn/vnets/{vnet}",
-      code: 200,
-      contentType: "form-urlencoded",
-    }),
+    T.Http({ method: "DELETE", uri: "/cluster/sdn/vnets/{vnet}", code: 200 }),
   ),
 ).annotate({
   identifier: "DeleteClusterSdnVnetRequest",
@@ -3390,13 +3379,12 @@ export const DeleteClusterSdnVnetFirewallRuleRequest = /*@__PURE__*/ S.suspend(
     S.Struct({
       vnet: S.String.pipe(T.Label()),
       pos: S.String.pipe(T.Label()),
-      digest: S.optional(S.String),
+      digest: S.optional(S.String.pipe(T.Query())),
     }).pipe(
       T.Http({
         method: "DELETE",
         uri: "/cluster/sdn/vnets/{vnet}/firewall/rules/{pos}",
         code: 200,
-        contentType: "form-urlencoded",
       }),
     ),
 ).annotate({
@@ -3422,15 +3410,14 @@ export interface DeleteClusterSdnVnetIpsRequest {
 export const DeleteClusterSdnVnetIpsRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     vnet: S.String.pipe(T.Label()),
-    ip: S.String,
-    mac: S.optional(S.String),
-    zone: S.String,
+    ip: S.String.pipe(T.Query()),
+    mac: S.optional(S.String.pipe(T.Query())),
+    zone: S.String.pipe(T.Query()),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/sdn/vnets/{vnet}/ips",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -3454,13 +3441,12 @@ export const DeleteClusterSdnVnetSubnetRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     vnet: S.String.pipe(T.Label()),
     subnet: S.String.pipe(T.Label()),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
   }).pipe(
     T.Http({
       method: "DELETE",
       uri: "/cluster/sdn/vnets/{vnet}/subnets/{subnet}",
       code: 200,
-      contentType: "form-urlencoded",
     }),
   ),
 ).annotate({
@@ -3482,14 +3468,9 @@ export interface DeleteClusterSdnZoneRequest {
 export const DeleteClusterSdnZoneRequest = /*@__PURE__*/ S.suspend(() =>
   S.Struct({
     zone: S.String.pipe(T.Label()),
-    lock_token: S.optional(S.String.pipe(T.Body("lock-token"))),
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
   }).pipe(
-    T.Http({
-      method: "DELETE",
-      uri: "/cluster/sdn/zones/{zone}",
-      code: 200,
-      contentType: "form-urlencoded",
-    }),
+    T.Http({ method: "DELETE", uri: "/cluster/sdn/zones/{zone}", code: 200 }),
   ),
 ).annotate({
   identifier: "DeleteClusterSdnZoneRequest",
@@ -15219,7 +15200,7 @@ export const deleteClusterAcmePlugin: API.OperationMethod<
   retry: Retry.Retry,
 }));
 
-export type DeleteClusterBackupError = ProxmoxOpError;
+export type DeleteClusterBackupError = BackupJobNotFound | ProxmoxOpError;
 /** Delete vzdump backup job definition. (root-privileged endpoint) */
 export const deleteClusterBackup: API.OperationMethod<
   DeleteClusterBackupRequest,
@@ -15229,7 +15210,7 @@ export const deleteClusterBackup: API.OperationMethod<
 > = /*@__PURE__*/ API.make(() => ({
   input: DeleteClusterBackupRequest,
   output: DeleteClusterBackupResponse,
-  errors: [],
+  errors: [BackupJobNotFound],
   protocol: ProxmoxProtocol,
   retry: Retry.Retry,
 }));
@@ -15834,7 +15815,7 @@ export const getClusterAcmeTos: API.OperationMethod<
   retry: Retry.Retry,
 }));
 
-export type GetClusterBackupError = ProxmoxOpError;
+export type GetClusterBackupError = BackupJobNotFound | ProxmoxOpError;
 /** Read vzdump backup job definition. */
 export const getClusterBackup: API.OperationMethod<
   GetClusterBackupRequest,
@@ -15844,12 +15825,14 @@ export const getClusterBackup: API.OperationMethod<
 > = /*@__PURE__*/ API.make(() => ({
   input: GetClusterBackupRequest,
   output: GetClusterBackupResponse,
-  errors: [],
+  errors: [BackupJobNotFound],
   protocol: ProxmoxProtocol,
   retry: Retry.Retry,
 }));
 
-export type GetClusterBackupIncludedVolumesError = ProxmoxOpError;
+export type GetClusterBackupIncludedVolumesError =
+  | BackupJobNotFound
+  | ProxmoxOpError;
 /** Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views. (root-privileged endpoint) */
 export const getClusterBackupIncludedVolumes: API.OperationMethod<
   GetClusterBackupIncludedVolumesRequest,
@@ -15859,7 +15842,7 @@ export const getClusterBackupIncludedVolumes: API.OperationMethod<
 > = /*@__PURE__*/ API.make(() => ({
   input: GetClusterBackupIncludedVolumesRequest,
   output: GetClusterBackupIncludedVolumesResponse,
-  errors: [],
+  errors: [BackupJobNotFound],
   protocol: ProxmoxProtocol,
   retry: Retry.Retry,
 }));
@@ -16209,7 +16192,9 @@ export const getClusterMetricsExport: API.OperationMethod<
   retry: Retry.Retry,
 }));
 
-export type GetClusterMetricsServerError = ProxmoxOpError;
+export type GetClusterMetricsServerError =
+  | MetricServerNotFound
+  | ProxmoxOpError;
 /** Read metric server configuration. */
 export const getClusterMetricsServer: API.OperationMethod<
   GetClusterMetricsServerRequest,
@@ -16219,7 +16204,7 @@ export const getClusterMetricsServer: API.OperationMethod<
 > = /*@__PURE__*/ API.make(() => ({
   input: GetClusterMetricsServerRequest,
   output: GetClusterMetricsServerResponse,
-  errors: [],
+  errors: [MetricServerNotFound],
   protocol: ProxmoxProtocol,
   retry: Retry.Retry,
 }));
@@ -18039,7 +18024,9 @@ export const putClusterMappingUsb: API.OperationMethod<
   retry: Retry.Retry,
 }));
 
-export type PutClusterMetricsServerError = ProxmoxOpError;
+export type PutClusterMetricsServerError =
+  | MetricServerNotFound
+  | ProxmoxOpError;
 /** Update metric server configuration. (root-privileged endpoint) */
 export const putClusterMetricsServer: API.OperationMethod<
   PutClusterMetricsServerRequest,
@@ -18049,7 +18036,7 @@ export const putClusterMetricsServer: API.OperationMethod<
 > = /*@__PURE__*/ API.make(() => ({
   input: PutClusterMetricsServerRequest,
   output: PutClusterMetricsServerResponse,
-  errors: [],
+  errors: [MetricServerNotFound],
   protocol: ProxmoxProtocol,
   retry: Retry.Retry,
 }));