@wandelbots/nova-api 25.4.0-dev.2 → 25.4.0-dev.20

package/v2/api.js

@@ -16,7 +16,7 @@ import globalAxios from 'axios';
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setBasicAuthToObject, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 // @ts-ignore
-import { BASE_PATH, BaseAPI, operationServerMap } from './base';
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from './base';
 export const AbbControllerKindEnum = {
     AbbController: 'AbbController'
 };
@@ -320,6 +320,15 @@ export const MotionGroupModel = {
     KukaKr270R31002: 'KUKA_KR270_R3100_2',
     KukaKr360R2830: 'KUKA_KR360_R2830'
 };
+/**
+ * The operating state.
+ * @export
+ * @enum {string}
+ */
+export const OperatingState = {
+    Active: 'ACTIVE',
+    Inactive: 'INACTIVE'
+};
 /**
  * Current operation mode of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - OPERATION_MODE_MANUAL (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed) - OPERATION_MODE_AUTO (without needing to press enabling switch) All other modes are considered as non-operational.
  * @export
@@ -1355,6 +1364,47 @@ export const CellApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Deactivate or activate the services of a cell.
+         * @summary Operating State
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCellStatus: async (cell, operatingState, options = {}) => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('setCellStatus', 'cell', cell);
+            // verify required parameter 'operatingState' is not null or undefined
+            assertParamExists('setCellStatus', 'operatingState', operatingState);
+            const localVarPath = `/cells/{cell}/status`
+                .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
+            // 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: 'PUT', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration);
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration);
+            if (operatingState !== undefined) {
+                localVarQueryParameter['operating_state'] = operatingState;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update the definition of the entire Cell.
          * @summary Update Configuration
@@ -1474,6 +1524,20 @@ export const CellApiFp = function (configuration) {
             const localVarOperationServerBasePath = operationServerMap['CellApi.listCells']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Deactivate or activate the services of a cell.
+         * @summary Operating State
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async setCellStatus(cell, operatingState, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setCellStatus(cell, operatingState, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CellApi.setCellStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Update the definition of the entire Cell.
          * @summary Update Configuration
@@ -1549,6 +1613,17 @@ export const CellApiFactory = function (configuration, basePath, axios) {
         listCells(options) {
             return localVarFp.listCells(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Deactivate or activate the services of a cell.
+         * @summary Operating State
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCellStatus(cell, operatingState, options) {
+            return localVarFp.setCellStatus(cell, operatingState, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update the definition of the entire Cell.
          * @summary Update Configuration
@@ -1626,6 +1701,18 @@ export class CellApi extends BaseAPI {
     listCells(options) {
         return CellApiFp(this.configuration).listCells(options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deactivate or activate the services of a cell.
+     * @summary Operating State
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CellApi
+     */
+    setCellStatus(cell, operatingState, options) {
+        return CellApiFp(this.configuration).setCellStatus(cell, operatingState, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Update the definition of the entire Cell.
      * @summary Update Configuration
@@ -9603,6 +9690,47 @@ export class StoreObjectApi extends BaseAPI {
  */
 export const SystemApiAxiosParamCreator = function (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, metadata, options = {}) => {
+            // 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 = {};
+            const localVarQueryParameter = {};
+            // 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
@@ -9733,6 +9861,79 @@ export const SystemApiAxiosParamCreator = function (configuration) {
                 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 = {}) => {
+            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 = {};
+            const localVarQueryParameter = {};
+            // 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, body, options = {}) => {
+            // 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 = {};
+            const localVarQueryParameter = {};
+            // 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
@@ -9778,6 +9979,20 @@ export const SystemApiAxiosParamCreator = function (configuration) {
 export const SystemApiFp = function (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, metadata, options) {
+            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
@@ -9827,6 +10042,32 @@ export const SystemApiFp = function (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) {
+            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, body, options) {
+            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
@@ -9849,6 +10090,17 @@ export const SystemApiFp = function (configuration) {
 export const SystemApiFactory = function (configuration, basePath, axios) {
     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, metadata, options) {
+            return localVarFp.backupConfiguration(resources, metadata, options).then((request) => request(axios, basePath));
+        },
         /**
          * Check if a more recent Wandelbots NOVA Version is available.
          * @summary Check update
@@ -9886,6 +10138,26 @@ export const SystemApiFactory = function (configuration, basePath, axios) {
         getSystemVersion(options) {
             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) {
+            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, body, options) {
+            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
@@ -9905,6 +10177,18 @@ export const SystemApiFactory = function (configuration, basePath, axios) {
  * @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
+     */
+    backupConfiguration(resources, metadata, options) {
+        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
@@ -9946,6 +10230,28 @@ export class SystemApi extends BaseAPI {
     getSystemVersion(options) {
         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
+     */
+    listConfigurationResources(options) {
+        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
+     */
+    restoreConfiguration(resources, body, options) {
+        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