@wandelbots/nova-api 25.3.0-rc.4 → 25.4.0-dev.10

package/v2/api.ts

@@ -242,6 +242,12 @@ export interface App {
      * @memberof App
      */
     'storage'?: ContainerStorage;
+    /**
+     * Defines the URL path suffix used to check the application\'s health status. The complete health check URL is constructed as `/$cell/$name/$health_path`. When the application is working as expected, the endpoint returns an HTTP 200 status code.  If not specified, the system will default to using the application icon path suffix (the value of `app_icon`) as the health check endpoint, resulting in `/$cell/$name/$app_icon`.  If the health check fails (no response or non-200 status code), the system will automatically restart the application container to restore service. 
+     * @type {string}
+     * @memberof App
+     */
+    'health_path'?: string;
 }
 /**
  * 
@@ -875,6 +881,31 @@ export interface Compound {
      */
     'child_geometries': Array<Geometry>;
 }
+/**
+ * Configuration resource object.
+ * @export
+ * @interface ConfigurationResource
+ */
+export interface ConfigurationResource {
+    /**
+     * Identifier of a configuration resource.
+     * @type {string}
+     * @memberof ConfigurationResource
+     */
+    'id': string;
+    /**
+     * Human-readable name of the configuration resource.
+     * @type {string}
+     * @memberof ConfigurationResource
+     */
+    'name': string;
+    /**
+     * Array of configuration resources.
+     * @type {Array<ConfigurationResource>}
+     * @memberof ConfigurationResource
+     */
+    'children'?: Array<ConfigurationResource>;
+}
 /**
  * 
  * @export
@@ -1347,6 +1378,19 @@ export const Direction = {
 export type Direction = typeof Direction[keyof typeof Direction];
 
 
+/**
+ * 
+ * @export
+ * @interface Error2
+ */
+export interface Error2 {
+    /**
+     * 
+     * @type {string}
+     * @memberof Error2
+     */
+    'message': string;
+}
 /**
  * @type ExecuteJoggingRequest
  * @export
@@ -5769,25 +5813,6 @@ export interface StartOnIO {
 }
 
 
-/**
- * The `Status` type defines a logical error model that is suitable for different programming environments including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `status` message contains two pieces of data: error code and error message. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). 
- * @export
- * @interface Status
- */
-export interface Status {
-    /**
-     * The status code, which should be an enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). 
-     * @type {number}
-     * @memberof Status
-     */
-    'code'?: number;
-    /**
-     * An error message in English. 
-     * @type {string}
-     * @memberof Status
-     */
-    'message'?: string;
-}
 /**
  * 
  * @export
@@ -16472,6 +16497,56 @@ export class StoreObjectApi extends BaseAPI {
  */
 export const SystemApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Retrieves a configuration backup based on provided resource identifiers. 
+         * @summary Retrieve Configuration Backup
+         * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+         * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backupConfiguration: async (resources: Array<string>, metadata?: { [key: string]: string; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'resources' is not null or undefined
+            assertParamExists('backupConfiguration', 'resources', resources)
+            const localVarPath = `/system/configuration`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (resources) {
+                localVarQueryParameter['resources'] = resources.join(COLLECTION_FORMATS.csv);
+            }
+
+            if (metadata !== undefined) {
+                localVarQueryParameter['metadata'] = metadata;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Check if a more recent Wandelbots NOVA Version is available. 
          * @summary Check update
@@ -16631,6 +16706,95 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieves a list of all available configuration resources for backup purposes. 
+         * @summary List Configuration Resources
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listConfigurationResources: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/system/configuration/resources`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Restores a previously backed up configuration. 
+         * @summary Restore Configuration Backup
+         * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+         * @param {File} body Backup file stream containing the configuration to restore.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restoreConfiguration: async (resources: Array<string>, body: File, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'resources' is not null or undefined
+            assertParamExists('restoreConfiguration', 'resources', resources)
+            // verify required parameter 'body' is not null or undefined
+            assertParamExists('restoreConfiguration', 'body', body)
+            const localVarPath = `/system/configuration`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (resources) {
+                localVarQueryParameter['resources'] = resources.join(COLLECTION_FORMATS.csv);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/gzip';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored. 
          * @summary Update Wandelbots NOVA version
@@ -16685,6 +16849,20 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
 export const SystemApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = SystemApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Retrieves a configuration backup based on provided resource identifiers. 
+         * @summary Retrieve Configuration Backup
+         * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+         * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.backupConfiguration(resources, metadata, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SystemApi.backupConfiguration']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Check if a more recent Wandelbots NOVA Version is available. 
          * @summary Check update
@@ -16734,6 +16912,32 @@ export const SystemApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SystemApi.getSystemVersion']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Retrieves a list of all available configuration resources for backup purposes. 
+         * @summary List Configuration Resources
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listConfigurationResources(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConfigurationResource>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listConfigurationResources(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SystemApi.listConfigurationResources']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Restores a previously backed up configuration. 
+         * @summary Restore Configuration Backup
+         * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+         * @param {File} body Backup file stream containing the configuration to restore.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.restoreConfiguration(resources, body, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SystemApi.restoreConfiguration']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored. 
          * @summary Update Wandelbots NOVA version
@@ -16757,6 +16961,17 @@ export const SystemApiFp = function(configuration?: Configuration) {
 export const SystemApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = SystemApiFp(configuration)
     return {
+        /**
+         * Retrieves a configuration backup based on provided resource identifiers. 
+         * @summary Retrieve Configuration Backup
+         * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+         * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): AxiosPromise<File> {
+            return localVarFp.backupConfiguration(resources, metadata, options).then((request) => request(axios, basePath));
+        },
         /**
          * Check if a more recent Wandelbots NOVA Version is available. 
          * @summary Check update
@@ -16794,6 +17009,26 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
         getSystemVersion(options?: RawAxiosRequestConfig): AxiosPromise<string> {
             return localVarFp.getSystemVersion(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves a list of all available configuration resources for backup purposes. 
+         * @summary List Configuration Resources
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listConfigurationResources(options?: RawAxiosRequestConfig): AxiosPromise<Array<ConfigurationResource>> {
+            return localVarFp.listConfigurationResources(options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Restores a previously backed up configuration. 
+         * @summary Restore Configuration Backup
+         * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+         * @param {File} body Backup file stream containing the configuration to restore.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.restoreConfiguration(resources, body, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored. 
          * @summary Update Wandelbots NOVA version
@@ -16814,6 +17049,19 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
  * @extends {BaseAPI}
  */
 export class SystemApi extends BaseAPI {
+    /**
+     * Retrieves a configuration backup based on provided resource identifiers. 
+     * @summary Retrieve Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemApi
+     */
+    public backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig) {
+        return SystemApiFp(this.configuration).backupConfiguration(resources, metadata, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Check if a more recent Wandelbots NOVA Version is available. 
      * @summary Check update
@@ -16859,6 +17107,30 @@ export class SystemApi extends BaseAPI {
         return SystemApiFp(this.configuration).getSystemVersion(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Retrieves a list of all available configuration resources for backup purposes. 
+     * @summary List Configuration Resources
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemApi
+     */
+    public listConfigurationResources(options?: RawAxiosRequestConfig) {
+        return SystemApiFp(this.configuration).listConfigurationResources(options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Restores a previously backed up configuration. 
+     * @summary Restore Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {File} body Backup file stream containing the configuration to restore.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemApi
+     */
+    public restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig) {
+        return SystemApiFp(this.configuration).restoreConfiguration(resources, body, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored. 
      * @summary Update Wandelbots NOVA version