@homeflare/distilled-proxmox 0.2.0

package/src/services/pools.ts

@@ -0,0 +1,397 @@
+// 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 T from "../traits.ts";
+import {
+  ProxmoxProtocol,
+  type ProxmoxOpError,
+  type ProxmoxOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { ProxmoxOpError, ProxmoxOpContext };
+
+export interface CreatePoolRequest {
+  comment?: string;
+  poolid: string;
+}
+export const CreatePoolRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    comment: S.optional(S.String),
+    poolid: S.String,
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/pools",
+      code: 200,
+      contentType: "form-urlencoded",
+    }),
+  ),
+).annotate({
+  identifier: "CreatePoolRequest",
+}) as any as S.Schema<CreatePoolRequest>;
+
+export interface CreatePoolResponse {}
+export const CreatePoolResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "CreatePoolResponse",
+}) as any as S.Schema<CreatePoolResponse>;
+
+export interface DeletePoolRequest {
+  poolid: string;
+}
+export const DeletePoolRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    poolid: S.String.pipe(T.Label()),
+  }).pipe(T.Http({ method: "DELETE", uri: "/pools/{poolid}", code: 200 })),
+).annotate({
+  identifier: "DeletePoolRequest",
+}) as any as S.Schema<DeletePoolRequest>;
+
+export interface DeletePoolResponse {}
+export const DeletePoolResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "DeletePoolResponse",
+}) as any as S.Schema<DeletePoolResponse>;
+
+export interface DeletePoolsRequest {
+  poolid: string;
+}
+export const DeletePoolsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    poolid: S.String,
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/pools",
+      code: 200,
+      contentType: "form-urlencoded",
+    }),
+  ),
+).annotate({
+  identifier: "DeletePoolsRequest",
+}) as any as S.Schema<DeletePoolsRequest>;
+
+export interface DeletePoolsResponse {}
+export const DeletePoolsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "DeletePoolsResponse",
+}) as any as S.Schema<DeletePoolsResponse>;
+
+export type GetPoolRequestType = "qemu" | "lxc" | "storage";
+export const GetPoolRequestType = S.String;
+
+export interface GetPoolRequest {
+  poolid: string;
+  type?: GetPoolRequestType | (string & {});
+}
+export const GetPoolRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    poolid: S.String.pipe(T.Label()),
+    type: S.optional(GetPoolRequestType.pipe(T.Query())),
+  }).pipe(T.Http({ method: "GET", uri: "/pools/{poolid}", code: 200 })),
+).annotate({ identifier: "GetPoolRequest" }) as any as S.Schema<GetPoolRequest>;
+
+export type GetPoolResponseMembersItemType =
+  | "qemu"
+  | "lxc"
+  | "openvz"
+  | "storage";
+export const GetPoolResponseMembersItemType = S.String;
+
+export interface GetPoolResponseMembersItem {
+  id: string;
+  node: string;
+  storage?: string;
+  type: GetPoolResponseMembersItemType;
+  vmid?: number;
+}
+export const GetPoolResponseMembersItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    id: S.String,
+    node: S.String,
+    storage: S.optional(S.String),
+    type: GetPoolResponseMembersItemType,
+    vmid: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "GetPoolResponseMembersItem",
+}) as any as S.Schema<GetPoolResponseMembersItem>;
+
+export type GetPoolResponseMembersList = Array<GetPoolResponseMembersItem>;
+export const GetPoolResponseMembersList = /*@__PURE__*/ S.Array(
+  GetPoolResponseMembersItem,
+) as any as S.Schema<GetPoolResponseMembersList>;
+
+export interface GetPoolResponse {
+  comment?: string;
+  members: GetPoolResponseMembersList;
+}
+export const GetPoolResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    comment: S.optional(S.String),
+    members: GetPoolResponseMembersList,
+  }),
+).annotate({
+  identifier: "GetPoolResponse",
+}) as any as S.Schema<GetPoolResponse>;
+
+export type ListPoolsRequestType = "qemu" | "lxc" | "storage";
+export const ListPoolsRequestType = S.String;
+
+export interface ListPoolsRequest {
+  poolid?: string;
+  type?: ListPoolsRequestType | (string & {});
+}
+export const ListPoolsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    poolid: S.optional(S.String.pipe(T.Query())),
+    type: S.optional(ListPoolsRequestType.pipe(T.Query())),
+  }).pipe(T.Http({ method: "GET", uri: "/pools", code: 200 })),
+).annotate({
+  identifier: "ListPoolsRequest",
+}) as any as S.Schema<ListPoolsRequest>;
+
+export type ListPoolsResponseBodyItemMembersItemType =
+  | "qemu"
+  | "lxc"
+  | "openvz"
+  | "storage";
+export const ListPoolsResponseBodyItemMembersItemType = S.String;
+
+export interface ListPoolsResponseBodyItemMembersItem {
+  id: string;
+  node: string;
+  storage?: string;
+  type: ListPoolsResponseBodyItemMembersItemType;
+  vmid?: number;
+}
+export const ListPoolsResponseBodyItemMembersItem = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      id: S.String,
+      node: S.String,
+      storage: S.optional(S.String),
+      type: ListPoolsResponseBodyItemMembersItemType,
+      vmid: S.optional(S.Number),
+    }),
+).annotate({
+  identifier: "ListPoolsResponseBodyItemMembersItem",
+}) as any as S.Schema<ListPoolsResponseBodyItemMembersItem>;
+
+export type ListPoolsResponseBodyItemMembersList =
+  Array<ListPoolsResponseBodyItemMembersItem>;
+export const ListPoolsResponseBodyItemMembersList = /*@__PURE__*/ S.Array(
+  ListPoolsResponseBodyItemMembersItem,
+) as any as S.Schema<ListPoolsResponseBodyItemMembersList>;
+
+export interface ListPoolsResponseBodyItem {
+  comment?: string;
+  members?: ListPoolsResponseBodyItemMembersList;
+  poolid: string;
+}
+export const ListPoolsResponseBodyItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    comment: S.optional(S.String),
+    members: S.optional(ListPoolsResponseBodyItemMembersList),
+    poolid: S.String,
+  }),
+).annotate({
+  identifier: "ListPoolsResponseBodyItem",
+}) as any as S.Schema<ListPoolsResponseBodyItem>;
+
+export type ListPoolsResponseBodyList = Array<ListPoolsResponseBodyItem>;
+export const ListPoolsResponseBodyList = /*@__PURE__*/ S.Array(
+  ListPoolsResponseBodyItem,
+) as any as S.Schema<ListPoolsResponseBodyList>;
+
+export type ListPoolsResponse = ListPoolsResponseBodyList;
+export const ListPoolsResponse = /*@__PURE__*/ S.suspend(() =>
+  ListPoolsResponseBodyList.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "ListPoolsResponse",
+}) as any as S.Schema<ListPoolsResponse>;
+
+export interface PutPoolRequest {
+  poolid: string;
+  /** Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. */
+  allow_move?: string;
+  comment?: string;
+  /** Remove the passed VMIDs and/or storage IDs instead of adding them. */
+  delete?: string;
+  /** List of storage IDs to add or remove from this pool. */
+  storage?: string;
+  /** List of guest VMIDs to add or remove from this pool. */
+  vms?: string;
+}
+export const PutPoolRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    poolid: S.String.pipe(T.Label()),
+    allow_move: S.optional(S.String.pipe(T.Body("allow-move"))),
+    comment: S.optional(S.String),
+    delete: S.optional(S.String),
+    storage: S.optional(S.String),
+    vms: S.optional(S.String),
+  }).pipe(
+    T.Http({
+      method: "PUT",
+      uri: "/pools/{poolid}",
+      code: 200,
+      contentType: "form-urlencoded",
+    }),
+  ),
+).annotate({ identifier: "PutPoolRequest" }) as any as S.Schema<PutPoolRequest>;
+
+export interface PutPoolResponse {}
+export const PutPoolResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "PutPoolResponse",
+}) as any as S.Schema<PutPoolResponse>;
+
+export interface PutPoolsRequest {
+  /** Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. */
+  allow_move?: string;
+  comment?: string;
+  /** Remove the passed VMIDs and/or storage IDs instead of adding them. */
+  delete?: string;
+  poolid: string;
+  /** List of storage IDs to add or remove from this pool. */
+  storage?: string;
+  /** List of guest VMIDs to add or remove from this pool. */
+  vms?: string;
+}
+export const PutPoolsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    allow_move: S.optional(S.String.pipe(T.Body("allow-move"))),
+    comment: S.optional(S.String),
+    delete: S.optional(S.String),
+    poolid: S.String,
+    storage: S.optional(S.String),
+    vms: S.optional(S.String),
+  }).pipe(
+    T.Http({
+      method: "PUT",
+      uri: "/pools",
+      code: 200,
+      contentType: "form-urlencoded",
+    }),
+  ),
+).annotate({
+  identifier: "PutPoolsRequest",
+}) as any as S.Schema<PutPoolsRequest>;
+
+export interface PutPoolsResponse {}
+export const PutPoolsResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "PutPoolsResponse",
+}) as any as S.Schema<PutPoolsResponse>;
+
+export type CreatePoolError = ProxmoxOpError;
+/** Create new pool. (root-privileged endpoint) */
+export const createPool: API.OperationMethod<
+  CreatePoolRequest,
+  CreatePoolResponse,
+  CreatePoolError,
+  ProxmoxOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreatePoolRequest,
+  output: CreatePoolResponse,
+  errors: [],
+  protocol: ProxmoxProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DeletePoolError = ProxmoxOpError;
+/** Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}'). (root-privileged endpoint) */
+export const deletePool: API.OperationMethod<
+  DeletePoolRequest,
+  DeletePoolResponse,
+  DeletePoolError,
+  ProxmoxOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeletePoolRequest,
+  output: DeletePoolResponse,
+  errors: [],
+  protocol: ProxmoxProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DeletePoolsError = ProxmoxOpError;
+/** Delete pool. (root-privileged endpoint) */
+export const deletePools: API.OperationMethod<
+  DeletePoolsRequest,
+  DeletePoolsResponse,
+  DeletePoolsError,
+  ProxmoxOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeletePoolsRequest,
+  output: DeletePoolsResponse,
+  errors: [],
+  protocol: ProxmoxProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetPoolError = ProxmoxOpError;
+/** Get pool configuration (deprecated, no support for nested pools, use 'GET /pools/?poolid={poolid}'). */
+export const getPool: API.OperationMethod<
+  GetPoolRequest,
+  GetPoolResponse,
+  GetPoolError,
+  ProxmoxOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetPoolRequest,
+  output: GetPoolResponse,
+  errors: [],
+  protocol: ProxmoxProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListPoolsError = ProxmoxOpError;
+/** List pools or get pool configuration. */
+export const listPools: API.OperationMethod<
+  ListPoolsRequest,
+  ListPoolsResponse,
+  ListPoolsError,
+  ProxmoxOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListPoolsRequest,
+  output: ListPoolsResponse,
+  errors: [],
+  protocol: ProxmoxProtocol,
+  retry: Retry.Retry,
+}));
+
+export type PutPoolError = ProxmoxOpError;
+/** Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead). (root-privileged endpoint) */
+export const putPool: API.OperationMethod<
+  PutPoolRequest,
+  PutPoolResponse,
+  PutPoolError,
+  ProxmoxOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: PutPoolRequest,
+  output: PutPoolResponse,
+  errors: [],
+  protocol: ProxmoxProtocol,
+  retry: Retry.Retry,
+}));
+
+export type PutPoolsError = ProxmoxOpError;
+/** Update pool. (root-privileged endpoint) */
+export const putPools: API.OperationMethod<
+  PutPoolsRequest,
+  PutPoolsResponse,
+  PutPoolsError,
+  ProxmoxOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: PutPoolsRequest,
+  output: PutPoolsResponse,
+  errors: [],
+  protocol: ProxmoxProtocol,
+  retry: Retry.Retry,
+}));