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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/api.ts CHANGED
@@ -242,6 +242,12 @@ export interface App {
242
242
  * @memberof App
243
243
  */
244
244
  'storage'?: ContainerStorage;
245
+ /**
246
+ * 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.
247
+ * @type {string}
248
+ * @memberof App
249
+ */
250
+ 'health_path'?: string;
245
251
  }
246
252
  /**
247
253
  *
@@ -875,6 +881,31 @@ export interface Compound {
875
881
  */
876
882
  'child_geometries': Array<Geometry>;
877
883
  }
884
+ /**
885
+ * Configuration resource object.
886
+ * @export
887
+ * @interface ConfigurationResource
888
+ */
889
+ export interface ConfigurationResource {
890
+ /**
891
+ * Identifier of a configuration resource.
892
+ * @type {string}
893
+ * @memberof ConfigurationResource
894
+ */
895
+ 'id': string;
896
+ /**
897
+ * Human-readable name of the configuration resource.
898
+ * @type {string}
899
+ * @memberof ConfigurationResource
900
+ */
901
+ 'name': string;
902
+ /**
903
+ * Array of configuration resources.
904
+ * @type {Array<ConfigurationResource>}
905
+ * @memberof ConfigurationResource
906
+ */
907
+ 'children'?: Array<ConfigurationResource>;
908
+ }
878
909
  /**
879
910
  *
880
911
  * @export
@@ -1347,6 +1378,19 @@ export const Direction = {
1347
1378
  export type Direction = typeof Direction[keyof typeof Direction];
1348
1379
 
1349
1380
 
1381
+ /**
1382
+ *
1383
+ * @export
1384
+ * @interface Error2
1385
+ */
1386
+ export interface Error2 {
1387
+ /**
1388
+ *
1389
+ * @type {string}
1390
+ * @memberof Error2
1391
+ */
1392
+ 'message': string;
1393
+ }
1350
1394
  /**
1351
1395
  * @type ExecuteJoggingRequest
1352
1396
  * @export
@@ -1890,7 +1934,7 @@ export interface IODescription {
1890
1934
  * @type {IODirection}
1891
1935
  * @memberof IODescription
1892
1936
  */
1893
- 'direction'?: IODirection;
1937
+ 'direction': IODirection;
1894
1938
  /**
1895
1939
  *
1896
1940
  * @type {IOValueType}
@@ -3304,7 +3348,7 @@ export interface ModelError {
3304
3348
  * @type {string}
3305
3349
  * @memberof ModelError
3306
3350
  */
3307
- 'code': string;
3351
+ 'code'?: string;
3308
3352
  /**
3309
3353
  *
3310
3354
  * @type {string}
@@ -3351,7 +3395,7 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
3351
3395
  export type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
3352
3396
 
3353
3397
  /**
3354
- * The data type describes the physically connected motion groups on a robot controller, e.g. a robot arm.
3398
+ * The data type describes the physically connected motion groups on a robot controller, e.g., a robot arm.
3355
3399
  * @export
3356
3400
  * @interface MotionGroup
3357
3401
  */
@@ -3375,11 +3419,17 @@ export interface MotionGroup {
3375
3419
  */
3376
3420
  'name_from_controller': string;
3377
3421
  /**
3378
- * The robot controller model if available. Usable for frontend 3D visualization.
3422
+ * The robot controller model, if available. Usable for frontend 3D visualization.
3379
3423
  * @type {string}
3380
3424
  * @memberof MotionGroup
3381
3425
  */
3382
3426
  'model_from_controller': string;
3427
+ /**
3428
+ * The serial number of the motion group, if available. If not available, the serial number of the robot controller. if available. If not available, then empty.
3429
+ * @type {string}
3430
+ * @memberof MotionGroup
3431
+ */
3432
+ 'serial_number'?: string;
3383
3433
  }
3384
3434
  /**
3385
3435
  *
@@ -3626,11 +3676,17 @@ export interface MotionGroupPhysical {
3626
3676
  */
3627
3677
  'active': boolean;
3628
3678
  /**
3629
- * The robot controller model if available. Usable for frontend 3D visualization.
3679
+ * The robot controller model, if available. Usable for frontend 3D visualization.
3630
3680
  * @type {string}
3631
3681
  * @memberof MotionGroupPhysical
3632
3682
  */
3633
3683
  'model_from_controller'?: string;
3684
+ /**
3685
+ * The serial number of the motion group, if available. If not available, the serial number of the robot controller. if available. If not available, the response is empty.
3686
+ * @type {string}
3687
+ * @memberof MotionGroupPhysical
3688
+ */
3689
+ 'serial_number'?: string;
3634
3690
  }
3635
3691
  /**
3636
3692
  * Holding static properties of the motion group.
@@ -3937,6 +3993,20 @@ export interface OpcuaNodeValueTriggerConfig {
3937
3993
  */
3938
3994
  export interface OpcuaNodeValueTriggerConfigNodeValue {
3939
3995
  }
3996
+ /**
3997
+ * The operating state.
3998
+ * @export
3999
+ * @enum {string}
4000
+ */
4001
+
4002
+ export const OperatingState = {
4003
+ Active: 'ACTIVE',
4004
+ Inactive: 'INACTIVE'
4005
+ } as const;
4006
+
4007
+ export type OperatingState = typeof OperatingState[keyof typeof OperatingState];
4008
+
4009
+
3940
4010
  /**
3941
4011
  * 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.
3942
4012
  * @export
@@ -5486,6 +5556,27 @@ export const ServiceStatusPhase = {
5486
5556
  export type ServiceStatusPhase = typeof ServiceStatusPhase[keyof typeof ServiceStatusPhase];
5487
5557
 
5488
5558
 
5559
+ /**
5560
+ * Response containing both the overall operating state of the cell and detailed status information for each service within the cell. The operating state indicates whether the cell is active or inactive, while the service statuses provide specific health and operational information for individual service running in the cell.
5561
+ * @export
5562
+ * @interface ServiceStatusResponse
5563
+ */
5564
+ export interface ServiceStatusResponse {
5565
+ /**
5566
+ *
5567
+ * @type {OperatingState}
5568
+ * @memberof ServiceStatusResponse
5569
+ */
5570
+ 'operating_state': OperatingState;
5571
+ /**
5572
+ *
5573
+ * @type {Array<ServiceStatus>}
5574
+ * @memberof ServiceStatusResponse
5575
+ */
5576
+ 'service_status': Array<ServiceStatus>;
5577
+ }
5578
+
5579
+
5489
5580
  /**
5490
5581
  *
5491
5582
  * @export
@@ -5769,25 +5860,6 @@ export interface StartOnIO {
5769
5860
  }
5770
5861
 
5771
5862
 
5772
- /**
5773
- * 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).
5774
- * @export
5775
- * @interface Status
5776
- */
5777
- export interface Status {
5778
- /**
5779
- * The status code, which should be an enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto).
5780
- * @type {number}
5781
- * @memberof Status
5782
- */
5783
- 'code'?: number;
5784
- /**
5785
- * An error message in English.
5786
- * @type {string}
5787
- * @memberof Status
5788
- */
5789
- 'message'?: string;
5790
- }
5791
5863
  /**
5792
5864
  *
5793
5865
  * @export
@@ -7298,6 +7370,55 @@ export const CellApiAxiosParamCreator = function (configuration?: Configuration)
7298
7370
 
7299
7371
 
7300
7372
 
7373
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7374
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7375
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
7376
+
7377
+ return {
7378
+ url: toPathString(localVarUrlObj),
7379
+ options: localVarRequestOptions,
7380
+ };
7381
+ },
7382
+ /**
7383
+ * Deactivate or activate the services of a cell.
7384
+ * @summary Operating State
7385
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7386
+ * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
7387
+ * @param {*} [options] Override http request option.
7388
+ * @throws {RequiredError}
7389
+ */
7390
+ setCellStatus: async (cell: string, operatingState: OperatingState, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
7391
+ // verify required parameter 'cell' is not null or undefined
7392
+ assertParamExists('setCellStatus', 'cell', cell)
7393
+ // verify required parameter 'operatingState' is not null or undefined
7394
+ assertParamExists('setCellStatus', 'operatingState', operatingState)
7395
+ const localVarPath = `/cells/{cell}/status`
7396
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
7397
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7398
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7399
+ let baseOptions;
7400
+ if (configuration) {
7401
+ baseOptions = configuration.baseOptions;
7402
+ }
7403
+
7404
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
7405
+ const localVarHeaderParameter = {} as any;
7406
+ const localVarQueryParameter = {} as any;
7407
+
7408
+ // authentication BasicAuth required
7409
+ // http basic authentication required
7410
+ setBasicAuthToObject(localVarRequestOptions, configuration)
7411
+
7412
+ // authentication BearerAuth required
7413
+ // http bearer authentication required
7414
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
7415
+
7416
+ if (operatingState !== undefined) {
7417
+ localVarQueryParameter['operating_state'] = operatingState;
7418
+ }
7419
+
7420
+
7421
+
7301
7422
  setSearchParams(localVarUrlObj, localVarQueryParameter);
7302
7423
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7303
7424
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -7418,7 +7539,7 @@ export const CellApiFp = function(configuration?: Configuration) {
7418
7539
  * @param {*} [options] Override http request option.
7419
7540
  * @throws {RequiredError}
7420
7541
  */
7421
- async getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServiceStatus>>> {
7542
+ async getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatusResponse>> {
7422
7543
  const localVarAxiosArgs = await localVarAxiosParamCreator.getCellStatus(cell, options);
7423
7544
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7424
7545
  const localVarOperationServerBasePath = operationServerMap['CellApi.getCellStatus']?.[localVarOperationServerIndex]?.url;
@@ -7436,6 +7557,20 @@ export const CellApiFp = function(configuration?: Configuration) {
7436
7557
  const localVarOperationServerBasePath = operationServerMap['CellApi.listCells']?.[localVarOperationServerIndex]?.url;
7437
7558
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7438
7559
  },
7560
+ /**
7561
+ * Deactivate or activate the services of a cell.
7562
+ * @summary Operating State
7563
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7564
+ * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
7565
+ * @param {*} [options] Override http request option.
7566
+ * @throws {RequiredError}
7567
+ */
7568
+ async setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
7569
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setCellStatus(cell, operatingState, options);
7570
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7571
+ const localVarOperationServerBasePath = operationServerMap['CellApi.setCellStatus']?.[localVarOperationServerIndex]?.url;
7572
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7573
+ },
7439
7574
  /**
7440
7575
  * Update the definition of the entire Cell.
7441
7576
  * @summary Update Configuration
@@ -7500,7 +7635,7 @@ export const CellApiFactory = function (configuration?: Configuration, basePath?
7500
7635
  * @param {*} [options] Override http request option.
7501
7636
  * @throws {RequiredError}
7502
7637
  */
7503
- getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ServiceStatus>> {
7638
+ getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ServiceStatusResponse> {
7504
7639
  return localVarFp.getCellStatus(cell, options).then((request) => request(axios, basePath));
7505
7640
  },
7506
7641
  /**
@@ -7512,6 +7647,17 @@ export const CellApiFactory = function (configuration?: Configuration, basePath?
7512
7647
  listCells(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
7513
7648
  return localVarFp.listCells(options).then((request) => request(axios, basePath));
7514
7649
  },
7650
+ /**
7651
+ * Deactivate or activate the services of a cell.
7652
+ * @summary Operating State
7653
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7654
+ * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
7655
+ * @param {*} [options] Override http request option.
7656
+ * @throws {RequiredError}
7657
+ */
7658
+ setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): AxiosPromise<void> {
7659
+ return localVarFp.setCellStatus(cell, operatingState, options).then((request) => request(axios, basePath));
7660
+ },
7515
7661
  /**
7516
7662
  * Update the definition of the entire Cell.
7517
7663
  * @summary Update Configuration
@@ -7595,6 +7741,19 @@ export class CellApi extends BaseAPI {
7595
7741
  return CellApiFp(this.configuration).listCells(options).then((request) => request(this.axios, this.basePath));
7596
7742
  }
7597
7743
 
7744
+ /**
7745
+ * Deactivate or activate the services of a cell.
7746
+ * @summary Operating State
7747
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7748
+ * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
7749
+ * @param {*} [options] Override http request option.
7750
+ * @throws {RequiredError}
7751
+ * @memberof CellApi
7752
+ */
7753
+ public setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig) {
7754
+ return CellApiFp(this.configuration).setCellStatus(cell, operatingState, options).then((request) => request(this.axios, this.basePath));
7755
+ }
7756
+
7598
7757
  /**
7599
7758
  * Update the definition of the entire Cell.
7600
7759
  * @summary Update Configuration
@@ -16472,6 +16631,56 @@ export class StoreObjectApi extends BaseAPI {
16472
16631
  */
16473
16632
  export const SystemApiAxiosParamCreator = function (configuration?: Configuration) {
16474
16633
  return {
16634
+ /**
16635
+ * Retrieves a configuration backup based on provided resource identifiers.
16636
+ * @summary Retrieve Configuration Backup
16637
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
16638
+ * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
16639
+ * @param {*} [options] Override http request option.
16640
+ * @throws {RequiredError}
16641
+ */
16642
+ backupConfiguration: async (resources: Array<string>, metadata?: { [key: string]: string; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16643
+ // verify required parameter 'resources' is not null or undefined
16644
+ assertParamExists('backupConfiguration', 'resources', resources)
16645
+ const localVarPath = `/system/configuration`;
16646
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16647
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16648
+ let baseOptions;
16649
+ if (configuration) {
16650
+ baseOptions = configuration.baseOptions;
16651
+ }
16652
+
16653
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
16654
+ const localVarHeaderParameter = {} as any;
16655
+ const localVarQueryParameter = {} as any;
16656
+
16657
+ // authentication BasicAuth required
16658
+ // http basic authentication required
16659
+ setBasicAuthToObject(localVarRequestOptions, configuration)
16660
+
16661
+ // authentication BearerAuth required
16662
+ // http bearer authentication required
16663
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
16664
+
16665
+ if (resources) {
16666
+ localVarQueryParameter['resources'] = resources.join(COLLECTION_FORMATS.csv);
16667
+ }
16668
+
16669
+ if (metadata !== undefined) {
16670
+ localVarQueryParameter['metadata'] = metadata;
16671
+ }
16672
+
16673
+
16674
+
16675
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16676
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16677
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16678
+
16679
+ return {
16680
+ url: toPathString(localVarUrlObj),
16681
+ options: localVarRequestOptions,
16682
+ };
16683
+ },
16475
16684
  /**
16476
16685
  * Check if a more recent Wandelbots NOVA Version is available.
16477
16686
  * @summary Check update
@@ -16631,6 +16840,95 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
16631
16840
  options: localVarRequestOptions,
16632
16841
  };
16633
16842
  },
16843
+ /**
16844
+ * Retrieves a list of all available configuration resources for backup purposes.
16845
+ * @summary List Configuration Resources
16846
+ * @param {*} [options] Override http request option.
16847
+ * @throws {RequiredError}
16848
+ */
16849
+ listConfigurationResources: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16850
+ const localVarPath = `/system/configuration/resources`;
16851
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16852
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16853
+ let baseOptions;
16854
+ if (configuration) {
16855
+ baseOptions = configuration.baseOptions;
16856
+ }
16857
+
16858
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
16859
+ const localVarHeaderParameter = {} as any;
16860
+ const localVarQueryParameter = {} as any;
16861
+
16862
+ // authentication BasicAuth required
16863
+ // http basic authentication required
16864
+ setBasicAuthToObject(localVarRequestOptions, configuration)
16865
+
16866
+ // authentication BearerAuth required
16867
+ // http bearer authentication required
16868
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
16869
+
16870
+
16871
+
16872
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16873
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16874
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16875
+
16876
+ return {
16877
+ url: toPathString(localVarUrlObj),
16878
+ options: localVarRequestOptions,
16879
+ };
16880
+ },
16881
+ /**
16882
+ * Restores a previously backed up configuration.
16883
+ * @summary Restore Configuration Backup
16884
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
16885
+ * @param {File} body Backup file stream containing the configuration to restore.
16886
+ * @param {*} [options] Override http request option.
16887
+ * @throws {RequiredError}
16888
+ */
16889
+ restoreConfiguration: async (resources: Array<string>, body: File, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16890
+ // verify required parameter 'resources' is not null or undefined
16891
+ assertParamExists('restoreConfiguration', 'resources', resources)
16892
+ // verify required parameter 'body' is not null or undefined
16893
+ assertParamExists('restoreConfiguration', 'body', body)
16894
+ const localVarPath = `/system/configuration`;
16895
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16896
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16897
+ let baseOptions;
16898
+ if (configuration) {
16899
+ baseOptions = configuration.baseOptions;
16900
+ }
16901
+
16902
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
16903
+ const localVarHeaderParameter = {} as any;
16904
+ const localVarQueryParameter = {} as any;
16905
+
16906
+ // authentication BasicAuth required
16907
+ // http basic authentication required
16908
+ setBasicAuthToObject(localVarRequestOptions, configuration)
16909
+
16910
+ // authentication BearerAuth required
16911
+ // http bearer authentication required
16912
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
16913
+
16914
+ if (resources) {
16915
+ localVarQueryParameter['resources'] = resources.join(COLLECTION_FORMATS.csv);
16916
+ }
16917
+
16918
+
16919
+
16920
+ localVarHeaderParameter['Content-Type'] = 'application/gzip';
16921
+
16922
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16923
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16924
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16925
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
16926
+
16927
+ return {
16928
+ url: toPathString(localVarUrlObj),
16929
+ options: localVarRequestOptions,
16930
+ };
16931
+ },
16634
16932
  /**
16635
16933
  * 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.
16636
16934
  * @summary Update Wandelbots NOVA version
@@ -16685,6 +16983,20 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
16685
16983
  export const SystemApiFp = function(configuration?: Configuration) {
16686
16984
  const localVarAxiosParamCreator = SystemApiAxiosParamCreator(configuration)
16687
16985
  return {
16986
+ /**
16987
+ * Retrieves a configuration backup based on provided resource identifiers.
16988
+ * @summary Retrieve Configuration Backup
16989
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
16990
+ * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
16991
+ * @param {*} [options] Override http request option.
16992
+ * @throws {RequiredError}
16993
+ */
16994
+ async backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
16995
+ const localVarAxiosArgs = await localVarAxiosParamCreator.backupConfiguration(resources, metadata, options);
16996
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16997
+ const localVarOperationServerBasePath = operationServerMap['SystemApi.backupConfiguration']?.[localVarOperationServerIndex]?.url;
16998
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16999
+ },
16688
17000
  /**
16689
17001
  * Check if a more recent Wandelbots NOVA Version is available.
16690
17002
  * @summary Check update
@@ -16734,6 +17046,32 @@ export const SystemApiFp = function(configuration?: Configuration) {
16734
17046
  const localVarOperationServerBasePath = operationServerMap['SystemApi.getSystemVersion']?.[localVarOperationServerIndex]?.url;
16735
17047
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16736
17048
  },
17049
+ /**
17050
+ * Retrieves a list of all available configuration resources for backup purposes.
17051
+ * @summary List Configuration Resources
17052
+ * @param {*} [options] Override http request option.
17053
+ * @throws {RequiredError}
17054
+ */
17055
+ async listConfigurationResources(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConfigurationResource>>> {
17056
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listConfigurationResources(options);
17057
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
17058
+ const localVarOperationServerBasePath = operationServerMap['SystemApi.listConfigurationResources']?.[localVarOperationServerIndex]?.url;
17059
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17060
+ },
17061
+ /**
17062
+ * Restores a previously backed up configuration.
17063
+ * @summary Restore Configuration Backup
17064
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
17065
+ * @param {File} body Backup file stream containing the configuration to restore.
17066
+ * @param {*} [options] Override http request option.
17067
+ * @throws {RequiredError}
17068
+ */
17069
+ async restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
17070
+ const localVarAxiosArgs = await localVarAxiosParamCreator.restoreConfiguration(resources, body, options);
17071
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
17072
+ const localVarOperationServerBasePath = operationServerMap['SystemApi.restoreConfiguration']?.[localVarOperationServerIndex]?.url;
17073
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17074
+ },
16737
17075
  /**
16738
17076
  * 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.
16739
17077
  * @summary Update Wandelbots NOVA version
@@ -16757,6 +17095,17 @@ export const SystemApiFp = function(configuration?: Configuration) {
16757
17095
  export const SystemApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
16758
17096
  const localVarFp = SystemApiFp(configuration)
16759
17097
  return {
17098
+ /**
17099
+ * Retrieves a configuration backup based on provided resource identifiers.
17100
+ * @summary Retrieve Configuration Backup
17101
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
17102
+ * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
17103
+ * @param {*} [options] Override http request option.
17104
+ * @throws {RequiredError}
17105
+ */
17106
+ backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): AxiosPromise<File> {
17107
+ return localVarFp.backupConfiguration(resources, metadata, options).then((request) => request(axios, basePath));
17108
+ },
16760
17109
  /**
16761
17110
  * Check if a more recent Wandelbots NOVA Version is available.
16762
17111
  * @summary Check update
@@ -16794,6 +17143,26 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
16794
17143
  getSystemVersion(options?: RawAxiosRequestConfig): AxiosPromise<string> {
16795
17144
  return localVarFp.getSystemVersion(options).then((request) => request(axios, basePath));
16796
17145
  },
17146
+ /**
17147
+ * Retrieves a list of all available configuration resources for backup purposes.
17148
+ * @summary List Configuration Resources
17149
+ * @param {*} [options] Override http request option.
17150
+ * @throws {RequiredError}
17151
+ */
17152
+ listConfigurationResources(options?: RawAxiosRequestConfig): AxiosPromise<Array<ConfigurationResource>> {
17153
+ return localVarFp.listConfigurationResources(options).then((request) => request(axios, basePath));
17154
+ },
17155
+ /**
17156
+ * Restores a previously backed up configuration.
17157
+ * @summary Restore Configuration Backup
17158
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
17159
+ * @param {File} body Backup file stream containing the configuration to restore.
17160
+ * @param {*} [options] Override http request option.
17161
+ * @throws {RequiredError}
17162
+ */
17163
+ restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): AxiosPromise<void> {
17164
+ return localVarFp.restoreConfiguration(resources, body, options).then((request) => request(axios, basePath));
17165
+ },
16797
17166
  /**
16798
17167
  * 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.
16799
17168
  * @summary Update Wandelbots NOVA version
@@ -16814,6 +17183,19 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
16814
17183
  * @extends {BaseAPI}
16815
17184
  */
16816
17185
  export class SystemApi extends BaseAPI {
17186
+ /**
17187
+ * Retrieves a configuration backup based on provided resource identifiers.
17188
+ * @summary Retrieve Configuration Backup
17189
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
17190
+ * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
17191
+ * @param {*} [options] Override http request option.
17192
+ * @throws {RequiredError}
17193
+ * @memberof SystemApi
17194
+ */
17195
+ public backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig) {
17196
+ return SystemApiFp(this.configuration).backupConfiguration(resources, metadata, options).then((request) => request(this.axios, this.basePath));
17197
+ }
17198
+
16817
17199
  /**
16818
17200
  * Check if a more recent Wandelbots NOVA Version is available.
16819
17201
  * @summary Check update
@@ -16859,6 +17241,30 @@ export class SystemApi extends BaseAPI {
16859
17241
  return SystemApiFp(this.configuration).getSystemVersion(options).then((request) => request(this.axios, this.basePath));
16860
17242
  }
16861
17243
 
17244
+ /**
17245
+ * Retrieves a list of all available configuration resources for backup purposes.
17246
+ * @summary List Configuration Resources
17247
+ * @param {*} [options] Override http request option.
17248
+ * @throws {RequiredError}
17249
+ * @memberof SystemApi
17250
+ */
17251
+ public listConfigurationResources(options?: RawAxiosRequestConfig) {
17252
+ return SystemApiFp(this.configuration).listConfigurationResources(options).then((request) => request(this.axios, this.basePath));
17253
+ }
17254
+
17255
+ /**
17256
+ * Restores a previously backed up configuration.
17257
+ * @summary Restore Configuration Backup
17258
+ * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
17259
+ * @param {File} body Backup file stream containing the configuration to restore.
17260
+ * @param {*} [options] Override http request option.
17261
+ * @throws {RequiredError}
17262
+ * @memberof SystemApi
17263
+ */
17264
+ public restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig) {
17265
+ return SystemApiFp(this.configuration).restoreConfiguration(resources, body, options).then((request) => request(this.axios, this.basePath));
17266
+ }
17267
+
16862
17268
  /**
16863
17269
  * 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.
16864
17270
  * @summary Update Wandelbots NOVA version