@mittwald/api-client 4.127.0 → 4.128.0

package/dist/esm/generated/v2/client-react.js

@@ -49,6 +49,28 @@ const buildBackupApi = (baseClient) => ({
     /** Get a ProjectBackup. */
     getProjectBackup: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackup, baseClient.backup.getProjectBackup).getApiResource,
 });
+const buildContainerApi = (baseClient) => ({
+    /** List Registries belonging to a Project. */
+    listRegistries: new ApiCallAsyncResourceFactory(descriptors.containerListRegistries, baseClient.container.listRegistries).getApiResource,
+    /** Get a Stack. */
+    getStack: new ApiCallAsyncResourceFactory(descriptors.containerGetStack, baseClient.container.getStack).getApiResource,
+    /** Get a Registry. */
+    getRegistry: new ApiCallAsyncResourceFactory(descriptors.containerGetRegistry, baseClient.container.getRegistry).getApiResource,
+    /** Get a Volume belonging to a Stack. */
+    getVolume: new ApiCallAsyncResourceFactory(descriptors.containerGetVolume, baseClient.container.getVolume).getApiResource,
+    /** Get a ContainerImageConfig. */
+    getContainerImageConfig: new ApiCallAsyncResourceFactory(descriptors.containerGetContainerImageConfig, baseClient.container.getContainerImageConfig).getApiResource,
+    /** Get logs belonging to a Service. */
+    getServiceLogs: new ApiCallAsyncResourceFactory(descriptors.containerGetServiceLogs, baseClient.container.getServiceLogs).getApiResource,
+    /** Get a Service belonging to a Stack. */
+    getService: new ApiCallAsyncResourceFactory(descriptors.containerGetService, baseClient.container.getService).getApiResource,
+    /** List Services belonging to a Project. */
+    listServices: new ApiCallAsyncResourceFactory(descriptors.containerListServices, baseClient.container.listServices).getApiResource,
+    /** List Stacks belonging to a Project. */
+    listStacks: new ApiCallAsyncResourceFactory(descriptors.containerListStacks, baseClient.container.listStacks).getApiResource,
+    /** List Volumes belonging to a Project. */
+    listVolumes: new ApiCallAsyncResourceFactory(descriptors.containerListVolumes, baseClient.container.listVolumes).getApiResource,
+});
 const buildContractApi = (baseClient) => ({
     /** Return the BaseItem of the Contract with the given ID. */
     getBaseItemOfContract: new ApiCallAsyncResourceFactory(descriptors.contractGetBaseItemOfContract, baseClient.contract.getBaseItemOfContract).getApiResource,
@@ -346,6 +368,8 @@ export class MittwaldAPIV2ClientReact {
     article;
     /** The backup API allows you to manage your project backups. */
     backup;
+    /** The container API allows you to manage your stacks, containers, volumes and registries. */
+    container;
     /** The contract API allows you to manage your contracts and orders */
     contract;
     /** The conversation API allows you to manage your support conversations. */
@@ -380,6 +404,7 @@ export class MittwaldAPIV2ClientReact {
         this.app = buildAppApi(baseClient);
         this.article = buildArticleApi(baseClient);
         this.backup = buildBackupApi(baseClient);
+        this.container = buildContainerApi(baseClient);
         this.contract = buildContractApi(baseClient);
         this.conversation = buildConversationApi(baseClient);
         this.cronjob = buildCronjobApi(baseClient);

package/dist/esm/generated/v2/client.js

@@ -89,6 +89,55 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         /** Change the description of a ProjectBackup. */
         updateProjectBackupDescription: this.requestFunctionFactory(descriptors.backupUpdateProjectBackupDescription),
     };
+    /** The container API allows you to manage your stacks, containers, volumes and registries. */
+    container = {
+        /** List Registries belonging to a Project. */
+        listRegistries: this.requestFunctionFactory(descriptors.containerListRegistries),
+        /** Create a Registry. */
+        createRegistry: this.requestFunctionFactory(descriptors.containerCreateRegistry),
+        /** Get a Stack. */
+        getStack: this.requestFunctionFactory(descriptors.containerGetStack),
+        /** Declaratively create, update or delete Services or Volumes belonging to a Stack. */
+        declareStack: this.requestFunctionFactory(descriptors.containerDeclareStack),
+        /** Create, update or delete Services or Volumes belonging to a Stack. */
+        updateStack: this.requestFunctionFactory(descriptors.containerUpdateStack),
+        /** Get a Registry. */
+        getRegistry: this.requestFunctionFactory(descriptors.containerGetRegistry),
+        /** Delete a Registry. */
+        deleteRegistry: this.requestFunctionFactory(descriptors.containerDeleteRegistry),
+        /** Update a Registry. */
+        updateRegistry: this.requestFunctionFactory(descriptors.containerUpdateRegistry),
+        /** Get a Volume belonging to a Stack. */
+        getVolume: this.requestFunctionFactory(descriptors.containerGetVolume),
+        /** Delete a Volume belonging to a Stack. */
+        deleteVolume: this.requestFunctionFactory(descriptors.containerDeleteVolume),
+        /** Get a ContainerImageConfig. */
+        getContainerImageConfig: this.requestFunctionFactory(descriptors.containerGetContainerImageConfig),
+        /** Get logs belonging to a Service. */
+        getServiceLogs: this.requestFunctionFactory(descriptors.containerGetServiceLogs),
+        /** Get a Service belonging to a Stack. */
+        getService: this.requestFunctionFactory(descriptors.containerGetService),
+        /** List Services belonging to a Project. */
+        listServices: this.requestFunctionFactory(descriptors.containerListServices),
+        /** List Stacks belonging to a Project. */
+        listStacks: this.requestFunctionFactory(descriptors.containerListStacks),
+        /** List Volumes belonging to a Project. */
+        listVolumes: this.requestFunctionFactory(descriptors.containerListVolumes),
+        /** Pulls the latest version of the Service's image and recreates the Service. */
+        pullImageForService: this.requestFunctionFactory(descriptors.containerPullImageForService),
+        /** Recreate a Service. */
+        recreateService: this.requestFunctionFactory(descriptors.containerRecreateService),
+        /** Restart a started Service. */
+        restartService: this.requestFunctionFactory(descriptors.containerRestartService),
+        /** Start a stopped Service. */
+        startService: this.requestFunctionFactory(descriptors.containerStartService),
+        /** Stop a started Service. */
+        stopService: this.requestFunctionFactory(descriptors.containerStopService),
+        /** Validate a Registries' URI. */
+        validateContainerRegistryUri: this.requestFunctionFactory(descriptors.containerValidateContainerRegistryUri),
+        /** Validate a Registries' credentials. */
+        validateRegistryCredentials: this.requestFunctionFactory(descriptors.containerValidateRegistryCredentials),
+    };
     /** The contract API allows you to manage your contracts and orders */
     contract = {
         /** Schedule the Termination of a ContractItem. */

package/dist/esm/generated/v2/descriptors.js

@@ -226,6 +226,144 @@ export const backupUpdateProjectBackupDescription = {
     method: "PATCH",
     operationId: "backup-update-project-backup-description",
 };
+/** List Registries belonging to a Project. */
+export const containerListRegistries = {
+    path: "/v2/projects/{projectId}/registries",
+    method: "GET",
+    operationId: "container-list-registries",
+};
+/** Create a Registry. */
+export const containerCreateRegistry = {
+    path: "/v2/projects/{projectId}/registries",
+    method: "POST",
+    operationId: "container-create-registry",
+};
+/** Get a Stack. */
+export const containerGetStack = {
+    path: "/v2/stacks/{stackId}",
+    method: "GET",
+    operationId: "container-get-stack",
+};
+/** Declaratively create, update or delete Services or Volumes belonging to a Stack. */
+export const containerDeclareStack = {
+    path: "/v2/stacks/{stackId}",
+    method: "PUT",
+    operationId: "container-declare-stack",
+};
+/** Create, update or delete Services or Volumes belonging to a Stack. */
+export const containerUpdateStack = {
+    path: "/v2/stacks/{stackId}",
+    method: "PATCH",
+    operationId: "container-update-stack",
+};
+/** Get a Registry. */
+export const containerGetRegistry = {
+    path: "/v2/registries/{registryId}",
+    method: "GET",
+    operationId: "container-get-registry",
+};
+/** Delete a Registry. */
+export const containerDeleteRegistry = {
+    path: "/v2/registries/{registryId}",
+    method: "DELETE",
+    operationId: "container-delete-registry",
+};
+/** Update a Registry. */
+export const containerUpdateRegistry = {
+    path: "/v2/registries/{registryId}",
+    method: "PATCH",
+    operationId: "container-update-registry",
+};
+/** Get a Volume belonging to a Stack. */
+export const containerGetVolume = {
+    path: "/v2/stacks/{stackId}/volumes/{volumeId}",
+    method: "GET",
+    operationId: "container-get-volume",
+};
+/** Delete a Volume belonging to a Stack. */
+export const containerDeleteVolume = {
+    path: "/v2/stacks/{stackId}/volumes/{volumeId}",
+    method: "DELETE",
+    operationId: "container-delete-volume",
+};
+/** Get a ContainerImageConfig. */
+export const containerGetContainerImageConfig = {
+    path: "/v2/container-image-config",
+    method: "GET",
+    operationId: "container-get-container-image-config",
+};
+/** Get logs belonging to a Service. */
+export const containerGetServiceLogs = {
+    path: "/v2/stacks/{stackId}/services/{serviceId}/logs",
+    method: "GET",
+    operationId: "container-get-service-logs",
+};
+/** Get a Service belonging to a Stack. */
+export const containerGetService = {
+    path: "/v2/stacks/{stackId}/services/{serviceId}",
+    method: "GET",
+    operationId: "container-get-service",
+};
+/** List Services belonging to a Project. */
+export const containerListServices = {
+    path: "/v2/projects/{projectId}/services",
+    method: "GET",
+    operationId: "container-list-services",
+};
+/** List Stacks belonging to a Project. */
+export const containerListStacks = {
+    path: "/v2/projects/{projectId}/stacks",
+    method: "GET",
+    operationId: "container-list-stacks",
+};
+/** List Volumes belonging to a Project. */
+export const containerListVolumes = {
+    path: "/v2/projects/{projectId}/volumes",
+    method: "GET",
+    operationId: "container-list-volumes",
+};
+/** Pulls the latest version of the Service's image and recreates the Service. */
+export const containerPullImageForService = {
+    path: "/v2/stacks/{stackId}/services/{serviceId}/actions/pull",
+    method: "POST",
+    operationId: "container-pull-image-for-service",
+};
+/** Recreate a Service. */
+export const containerRecreateService = {
+    path: "/v2/stacks/{stackId}/services/{serviceId}/actions/recreate",
+    method: "POST",
+    operationId: "container-recreate-service",
+};
+/** Restart a started Service. */
+export const containerRestartService = {
+    path: "/v2/stacks/{stackId}/services/{serviceId}/actions/restart",
+    method: "POST",
+    operationId: "container-restart-service",
+};
+/** Start a stopped Service. */
+export const containerStartService = {
+    path: "/v2/stacks/{stackId}/services/{serviceId}/actions/start",
+    method: "POST",
+    operationId: "container-start-service",
+};
+/** Stop a started Service. */
+export const containerStopService = {
+    path: "/v2/stacks/{stackId}/services/{serviceId}/actions/stop",
+    method: "POST",
+    operationId: "container-stop-service",
+};
+/** Validate a Registries' URI. */
+export const containerValidateContainerRegistryUri = {
+    path: "/v2/actions/validate-container-registry-uri",
+    method: "POST",
+    operationId: "container-validate-container-registry-uri",
+};
+/** Validate a Registries' credentials. */
+export const containerValidateRegistryCredentials = {
+    path: "/v2/registries/{registryId}/actions/validate-credentials",
+    method: "POST",
+    operationId: "container-validate-registry-credentials",
+};
 /** Schedule the Termination of a ContractItem. */
 export const contractTerminateContractItem = {
     path: "/v2/contracts/{contractId}/items/{contractItemId}/termination",

package/dist/esm/version.js

@@ -1 +1 @@
-export const MittwaldAPIClientVersion = '4.126.0';
+export const MittwaldAPIClientVersion = '4.127.0';

package/dist/types/generated/v2/client-react.d.ts

@@ -340,6 +340,155 @@ declare const buildBackupApi: (baseClient: MittwaldAPIV2Client) => {
         status: string;
     }>;
 };
+declare const buildContainerApi: (baseClient: MittwaldAPIV2Client) => {
+    /** List Registries belonging to a Project. */
+    listRegistries: (conf: {
+        projectId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+        queryParameters?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            hasCredentials?: boolean | undefined;
+            limit?: number | undefined;
+            skip?: number | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerRegistry[]>;
+    /** Get a Stack. */
+    getStack: (conf: {
+        stackId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        description: string;
+        disabled: boolean;
+        id: string;
+        prefix: string;
+        projectId: string;
+        services?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[] | undefined;
+        volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[] | undefined;
+    }>;
+    /** Get a Registry. */
+    getRegistry: (conf: {
+        registryId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        credentials?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerRegistryCredentials | undefined;
+        description: string;
+        id: string;
+        projectId: string;
+        uri: string;
+    }>;
+    /** Get a Volume belonging to a Stack. */
+    getVolume: (conf: {
+        stackId: string;
+        volumeId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        id: string;
+        name: string;
+        orphaned: boolean;
+        stackId: string;
+        storageUsageInBytes: number;
+        storageUsageInBytesSetAt: string;
+    }>;
+    /** Get a ContainerImageConfig. */
+    getContainerImageConfig: (conf: {
+        queryParameters: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            imageReference: string;
+            useCredentialsForProjectId?: string | undefined;
+            useCredentialsForRegistryId?: string | undefined;
+            generateAiData?: boolean | undefined;
+        };
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        command?: string[] | undefined;
+        entrypoint?: string[] | undefined;
+        env?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerContainerImageConfigEnv[] | undefined;
+        exposedPorts?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerContainerImageConfigExposedPort[] | undefined;
+        hasAiGeneratedData: boolean;
+        isAiAvailable: boolean;
+        isUserRoot: boolean;
+        overwritingUser?: number | undefined;
+        user: string;
+        userId: number;
+        volumes?: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerContainerImageConfigVolume[] | undefined;
+    }>;
+    /** Get logs belonging to a Service. */
+    getServiceLogs: (conf: {
+        stackId: string;
+        serviceId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<string>;
+    /** Get a Service belonging to a Stack. */
+    getService: (conf: {
+        stackId: string;
+        serviceId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        deployedState: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceState;
+        description: string;
+        id: string;
+        message?: string | undefined;
+        pendingState: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceState;
+        projectId: string;
+        serviceName: string;
+        shortId: string;
+        stackId: string;
+        status: import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceStatus;
+    }>;
+    /** List Services belonging to a Project. */
+    listServices: (conf: {
+        projectId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+        queryParameters?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            stackId?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerServiceResponse[]>;
+    /** List Stacks belonging to a Project. */
+    listStacks: (conf: {
+        projectId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerStackResponse[]>;
+    /** List Volumes belonging to a Project. */
+    listVolumes: (conf: {
+        projectId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            "x-access-token"?: string | undefined;
+        } | undefined;
+        queryParameters?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            stackId?: string | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ContainerVolumeResponse[]>;
+};
 declare const buildContractApi: (baseClient: MittwaldAPIV2Client) => {
     /** Return the BaseItem of the Contract with the given ID. */
     getBaseItemOfContract: (conf: {
@@ -2572,6 +2721,8 @@ export declare class MittwaldAPIV2ClientReact {
     readonly article: ReturnType<typeof buildArticleApi>;
     /** The backup API allows you to manage your project backups. */
     readonly backup: ReturnType<typeof buildBackupApi>;
+    /** The container API allows you to manage your stacks, containers, volumes and registries. */
+    readonly container: ReturnType<typeof buildContainerApi>;
     /** The contract API allows you to manage your contracts and orders */
     readonly contract: ReturnType<typeof buildContractApi>;
     /** The conversation API allows you to manage your support conversations. */