@homeflare/distilled-proxmox 0.2.0 → 0.3.1

package/dist/services/cluster.js

@@ -1,9 +1,30 @@
 // 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.js";
 import { ProxmoxProtocol, } from "../protocol.js";
 import * as Retry from "../retry.js";
+/** 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__*/ /*@__PURE__*/ T.applyErrorMatchers(
+/*@__PURE__*/ S.TaggedError()("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__*/ /*@__PURE__*/ T.applyErrorMatchers(
+/*@__PURE__*/ S.TaggedError()("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 const CreateClusterAcmeAccountRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
     contact: S.String,
     directory: S.optional(S.String),
@@ -908,12 +929,11 @@ export const DeleteClusterConfigNodeResponse = /*@__PURE__*/ S.suspend(() => S.S
 });
 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({
     identifier: "DeleteClusterFirewallAliasRequest",
 });
@@ -935,12 +955,11 @@ export const DeleteClusterFirewallGroupResponse = /*@__PURE__*/ S.suspend(() =>
 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({
     identifier: "DeleteClusterFirewallGroup2Request",
 });
@@ -949,12 +968,11 @@ export const DeleteClusterFirewallGroup2Response = /*@__PURE__*/ S.suspend(() =>
 });
 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({
     identifier: "DeleteClusterFirewallIpsetRequest",
 });
@@ -964,12 +982,11 @@ export const DeleteClusterFirewallIpsetResponse = /*@__PURE__*/ S.suspend(() =>
 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({
     identifier: "DeleteClusterFirewallIpset2Request",
 });
@@ -978,12 +995,11 @@ export const DeleteClusterFirewallIpset2Response = /*@__PURE__*/ S.suspend(() =>
 });
 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({
     identifier: "DeleteClusterFirewallRuleRequest",
 });
@@ -1000,13 +1016,8 @@ export const DeleteClusterHaGroupResponse = /*@__PURE__*/ S.suspend(() => S.Stru
 });
 export const DeleteClusterHaResourceRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
     sid: S.String.pipe(T.Label()),
-    purge: S.optional(S.String),
-}).pipe(T.Http({
-    method: "DELETE",
-    uri: "/cluster/ha/resources/{sid}",
-    code: 200,
-    contentType: "form-urlencoded",
-}))).annotate({
+    purge: S.optional(S.String.pipe(T.Query())),
+}).pipe(T.Http({ method: "DELETE", uri: "/cluster/ha/resources/{sid}", code: 200 }))).annotate({
     identifier: "DeleteClusterHaResourceRequest",
 });
 export const DeleteClusterHaResourceResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
@@ -1150,14 +1161,9 @@ export const DeleteClusterQemuCustomCpuModelResponse = /*@__PURE__*/ S.suspend((
 });
 export const DeleteClusterReplicationRequest = /*@__PURE__*/ S.suspend(() => S.Struct({
     id: S.String.pipe(T.Label()),
-    force: S.optional(S.String),
-    keep: S.optional(S.String),
-}).pipe(T.Http({
-    method: "DELETE",
-    uri: "/cluster/replication/{id}",
-    code: 200,
-    contentType: "form-urlencoded",
-}))).annotate({
+    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 }))).annotate({
     identifier: "DeleteClusterReplicationRequest",
 });
 export const DeleteClusterReplicationResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
@@ -1165,12 +1171,11 @@ export const DeleteClusterReplicationResponse = /*@__PURE__*/ S.suspend(() => S.
 });
 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({
     identifier: "DeleteClusterSdnControllerRequest",
 });
@@ -1179,13 +1184,8 @@ export const DeleteClusterSdnControllerResponse = /*@__PURE__*/ S.suspend(() =>
 });
 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"))),
-}).pipe(T.Http({
-    method: "DELETE",
-    uri: "/cluster/sdn/dns/{dns}",
-    code: 200,
-    contentType: "form-urlencoded",
-}))).annotate({
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
+}).pipe(T.Http({ method: "DELETE", uri: "/cluster/sdn/dns/{dns}", code: 200 }))).annotate({
     identifier: "DeleteClusterSdnDnsRequest",
 });
 export const DeleteClusterSdnDnsResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
@@ -1218,27 +1218,17 @@ export const DeleteClusterSdnFabricNodeResponse = /*@__PURE__*/ S.suspend(() =>
 });
 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"))),
-}).pipe(T.Http({
-    method: "DELETE",
-    uri: "/cluster/sdn/ipams/{ipam}",
-    code: 200,
-    contentType: "form-urlencoded",
-}))).annotate({
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
+}).pipe(T.Http({ method: "DELETE", uri: "/cluster/sdn/ipams/{ipam}", code: 200 }))).annotate({
     identifier: "DeleteClusterSdnIpamRequest",
 });
 export const DeleteClusterSdnIpamResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
     identifier: "DeleteClusterSdnIpamResponse",
 });
 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",
-}))).annotate({
+    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",
 });
 export const DeleteClusterSdnLockResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
@@ -1246,12 +1236,11 @@ export const DeleteClusterSdnLockResponse = /*@__PURE__*/ S.suspend(() => S.Stru
 });
 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({
     identifier: "DeleteClusterSdnPrefixListRequest",
 });
@@ -1261,12 +1250,11 @@ export const DeleteClusterSdnPrefixListResponse = /*@__PURE__*/ S.suspend(() =>
 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({
     identifier: "DeleteClusterSdnPrefixListEntryRequest",
 });
@@ -1277,12 +1265,11 @@ export const DeleteClusterSdnRouteMapEntryEntryRequest =
 /*@__PURE__*/ S.suspend(() => 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({
     identifier: "DeleteClusterSdnRouteMapEntryEntryRequest",
 });
@@ -1292,13 +1279,8 @@ export const DeleteClusterSdnRouteMapEntryEntryResponse =
 });
 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"))),
-}).pipe(T.Http({
-    method: "DELETE",
-    uri: "/cluster/sdn/vnets/{vnet}",
-    code: 200,
-    contentType: "form-urlencoded",
-}))).annotate({
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
+}).pipe(T.Http({ method: "DELETE", uri: "/cluster/sdn/vnets/{vnet}", code: 200 }))).annotate({
     identifier: "DeleteClusterSdnVnetRequest",
 });
 export const DeleteClusterSdnVnetResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
@@ -1307,12 +1289,11 @@ export const DeleteClusterSdnVnetResponse = /*@__PURE__*/ S.suspend(() => S.Stru
 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({
     identifier: "DeleteClusterSdnVnetFirewallRuleRequest",
 });
@@ -1321,14 +1302,13 @@ export const DeleteClusterSdnVnetFirewallRuleResponse = /*@__PURE__*/ S.suspend(
 });
 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({
     identifier: "DeleteClusterSdnVnetIpsRequest",
 });
@@ -1338,12 +1318,11 @@ export const DeleteClusterSdnVnetIpsResponse = /*@__PURE__*/ S.suspend(() => S.S
 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({
     identifier: "DeleteClusterSdnVnetSubnetRequest",
 });
@@ -1352,13 +1331,8 @@ export const DeleteClusterSdnVnetSubnetResponse = /*@__PURE__*/ S.suspend(() =>
 });
 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"))),
-}).pipe(T.Http({
-    method: "DELETE",
-    uri: "/cluster/sdn/zones/{zone}",
-    code: 200,
-    contentType: "form-urlencoded",
-}))).annotate({
+    lock_token: S.optional(S.String.pipe(T.Query("lock-token"))),
+}).pipe(T.Http({ method: "DELETE", uri: "/cluster/sdn/zones/{zone}", code: 200 }))).annotate({
     identifier: "DeleteClusterSdnZoneRequest",
 });
 export const DeleteClusterSdnZoneResponse = /*@__PURE__*/ S.suspend(() => S.Struct({})).annotate({
@@ -5630,7 +5604,7 @@ export const deleteClusterAcmePlugin = /*@__PURE__*/ API.make(() => ({
 export const deleteClusterBackup = /*@__PURE__*/ API.make(() => ({
     input: DeleteClusterBackupRequest,
     output: DeleteClusterBackupResponse,
-    errors: [],
+    errors: [BackupJobNotFound],
     protocol: ProxmoxProtocol,
     retry: Retry.Retry,
 }));
@@ -5958,7 +5932,7 @@ export const getClusterAcmeTos = /*@__PURE__*/ API.make(() => ({
 export const getClusterBackup = /*@__PURE__*/ API.make(() => ({
     input: GetClusterBackupRequest,
     output: GetClusterBackupResponse,
-    errors: [],
+    errors: [BackupJobNotFound],
     protocol: ProxmoxProtocol,
     retry: Retry.Retry,
 }));
@@ -5966,7 +5940,7 @@ export const getClusterBackup = /*@__PURE__*/ API.make(() => ({
 export const getClusterBackupIncludedVolumes = /*@__PURE__*/ API.make(() => ({
     input: GetClusterBackupIncludedVolumesRequest,
     output: GetClusterBackupIncludedVolumesResponse,
-    errors: [],
+    errors: [BackupJobNotFound],
     protocol: ProxmoxProtocol,
     retry: Retry.Retry,
 }));
@@ -6158,7 +6132,7 @@ export const getClusterMetricsExport = /*@__PURE__*/ API.make(() => ({
 export const getClusterMetricsServer = /*@__PURE__*/ API.make(() => ({
     input: GetClusterMetricsServerRequest,
     output: GetClusterMetricsServerResponse,
-    errors: [],
+    errors: [MetricServerNotFound],
     protocol: ProxmoxProtocol,
     retry: Retry.Retry,
 }));
@@ -7134,7 +7108,7 @@ export const putClusterMappingUsb = /*@__PURE__*/ API.make(() => ({
 export const putClusterMetricsServer = /*@__PURE__*/ API.make(() => ({
     input: PutClusterMetricsServerRequest,
     output: PutClusterMetricsServerResponse,
-    errors: [],
+    errors: [MetricServerNotFound],
     protocol: ProxmoxProtocol,
     retry: Retry.Retry,
 }));