@wandelbots/nova-api 25.4.0-dev.3 → 25.4.0-dev.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wandelbots/nova-api",
-  "version": "25.4.0-dev.3",
+  "version": "25.4.0-dev.5",
   "description": "API Client to interact with Wandelbots Public API.",
   "files": [
     "*",

package/v2/api.d.ts

@@ -870,6 +870,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
@@ -6740,6 +6765,143 @@ export declare class CellApi extends BaseAPI {
      */
     updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }
+/**
+ * ConfigurationApi - axios parameter creator
+ * @export
+ */
+export declare const ConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+};
+/**
+ * ConfigurationApi - functional programming interface
+ * @export
+ */
+export declare const ConfigurationApiFp: (configuration?: Configuration) => {
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConfigurationResource>>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+};
+/**
+ * ConfigurationApi - factory interface
+ * @export
+ */
+export declare const ConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>>;
+    /**
+     * 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<File>;
+};
+/**
+ * ConfigurationApi - object-oriented interface
+ * @export
+ * @class ConfigurationApi
+ * @extends {BaseAPI}
+ */
+export declare class ConfigurationApi 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 ConfigurationApi
+     */
+    backupConfiguration(resources: Array<string>, metadata?: {
+        [key: string]: string;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Retrieves a list of all available configuration resources for backup purposes.
+     * @summary List Configuration Resources
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConfigurationApi
+     */
+    listConfigurationResources(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationResource[], any>>;
+    /**
+     * 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 ConfigurationApi
+     */
+    restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+}
 /**
  * ControllerApi - axios parameter creator
  * @export

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'
 };
@@ -1640,6 +1640,259 @@ export class CellApi extends BaseAPI {
         return CellApiFp(this.configuration).updateCell(cell, cell2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * ConfigurationApi - axios parameter creator
+ * @export
+ */
+export const ConfigurationApiAxiosParamCreator = 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,
+            };
+        },
+        /**
+         * 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,
+            };
+        },
+    };
+};
+/**
+ * ConfigurationApi - functional programming interface
+ * @export
+ */
+export const ConfigurationApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ConfigurationApiAxiosParamCreator(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['ConfigurationApi.backupConfiguration']?.[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['ConfigurationApi.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['ConfigurationApi.restoreConfiguration']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    };
+};
+/**
+ * ConfigurationApi - factory interface
+ * @export
+ */
+export const ConfigurationApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ConfigurationApiFp(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));
+        },
+        /**
+         * 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));
+        },
+    };
+};
+/**
+ * ConfigurationApi - object-oriented interface
+ * @export
+ * @class ConfigurationApi
+ * @extends {BaseAPI}
+ */
+export class ConfigurationApi 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 ConfigurationApi
+     */
+    backupConfiguration(resources, metadata, options) {
+        return ConfigurationApiFp(this.configuration).backupConfiguration(resources, metadata, 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 ConfigurationApi
+     */
+    listConfigurationResources(options) {
+        return ConfigurationApiFp(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 ConfigurationApi
+     */
+    restoreConfiguration(resources, body, options) {
+        return ConfigurationApiFp(this.configuration).restoreConfiguration(resources, body, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * ControllerApi - axios parameter creator
  * @export