@wandelbots/nova-api 25.3.0-rc.5 → 25.4.0-dev.11
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/package.json +1 -1
- package/v2/api.d.ts +224 -22
- package/v2/api.js +307 -1
- package/v2/api.js.map +1 -1
- package/v2/api.ts +415 -21
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
|
|
@@ -3937,6 +3981,20 @@ export interface OpcuaNodeValueTriggerConfig {
|
|
|
3937
3981
|
*/
|
|
3938
3982
|
export interface OpcuaNodeValueTriggerConfigNodeValue {
|
|
3939
3983
|
}
|
|
3984
|
+
/**
|
|
3985
|
+
* The operating state.
|
|
3986
|
+
* @export
|
|
3987
|
+
* @enum {string}
|
|
3988
|
+
*/
|
|
3989
|
+
|
|
3990
|
+
export const OperatingState = {
|
|
3991
|
+
Active: 'ACTIVE',
|
|
3992
|
+
Inactive: 'INACTIVE'
|
|
3993
|
+
} as const;
|
|
3994
|
+
|
|
3995
|
+
export type OperatingState = typeof OperatingState[keyof typeof OperatingState];
|
|
3996
|
+
|
|
3997
|
+
|
|
3940
3998
|
/**
|
|
3941
3999
|
* 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
4000
|
* @export
|
|
@@ -5486,6 +5544,27 @@ export const ServiceStatusPhase = {
|
|
|
5486
5544
|
export type ServiceStatusPhase = typeof ServiceStatusPhase[keyof typeof ServiceStatusPhase];
|
|
5487
5545
|
|
|
5488
5546
|
|
|
5547
|
+
/**
|
|
5548
|
+
* 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.
|
|
5549
|
+
* @export
|
|
5550
|
+
* @interface ServiceStatusResponse
|
|
5551
|
+
*/
|
|
5552
|
+
export interface ServiceStatusResponse {
|
|
5553
|
+
/**
|
|
5554
|
+
*
|
|
5555
|
+
* @type {OperatingState}
|
|
5556
|
+
* @memberof ServiceStatusResponse
|
|
5557
|
+
*/
|
|
5558
|
+
'operating_state': OperatingState;
|
|
5559
|
+
/**
|
|
5560
|
+
*
|
|
5561
|
+
* @type {Array<ServiceStatus>}
|
|
5562
|
+
* @memberof ServiceStatusResponse
|
|
5563
|
+
*/
|
|
5564
|
+
'service_status': Array<ServiceStatus>;
|
|
5565
|
+
}
|
|
5566
|
+
|
|
5567
|
+
|
|
5489
5568
|
/**
|
|
5490
5569
|
*
|
|
5491
5570
|
* @export
|
|
@@ -5769,25 +5848,6 @@ export interface StartOnIO {
|
|
|
5769
5848
|
}
|
|
5770
5849
|
|
|
5771
5850
|
|
|
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
5851
|
/**
|
|
5792
5852
|
*
|
|
5793
5853
|
* @export
|
|
@@ -7298,6 +7358,55 @@ export const CellApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
7298
7358
|
|
|
7299
7359
|
|
|
7300
7360
|
|
|
7361
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7362
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7363
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
7364
|
+
|
|
7365
|
+
return {
|
|
7366
|
+
url: toPathString(localVarUrlObj),
|
|
7367
|
+
options: localVarRequestOptions,
|
|
7368
|
+
};
|
|
7369
|
+
},
|
|
7370
|
+
/**
|
|
7371
|
+
* Deactivate or activate the services of a cell.
|
|
7372
|
+
* @summary Operating State
|
|
7373
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7374
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
7375
|
+
* @param {*} [options] Override http request option.
|
|
7376
|
+
* @throws {RequiredError}
|
|
7377
|
+
*/
|
|
7378
|
+
setCellStatus: async (cell: string, operatingState: OperatingState, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
7379
|
+
// verify required parameter 'cell' is not null or undefined
|
|
7380
|
+
assertParamExists('setCellStatus', 'cell', cell)
|
|
7381
|
+
// verify required parameter 'operatingState' is not null or undefined
|
|
7382
|
+
assertParamExists('setCellStatus', 'operatingState', operatingState)
|
|
7383
|
+
const localVarPath = `/cells/{cell}/status`
|
|
7384
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
7385
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7386
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7387
|
+
let baseOptions;
|
|
7388
|
+
if (configuration) {
|
|
7389
|
+
baseOptions = configuration.baseOptions;
|
|
7390
|
+
}
|
|
7391
|
+
|
|
7392
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
7393
|
+
const localVarHeaderParameter = {} as any;
|
|
7394
|
+
const localVarQueryParameter = {} as any;
|
|
7395
|
+
|
|
7396
|
+
// authentication BasicAuth required
|
|
7397
|
+
// http basic authentication required
|
|
7398
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
7399
|
+
|
|
7400
|
+
// authentication BearerAuth required
|
|
7401
|
+
// http bearer authentication required
|
|
7402
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
7403
|
+
|
|
7404
|
+
if (operatingState !== undefined) {
|
|
7405
|
+
localVarQueryParameter['operating_state'] = operatingState;
|
|
7406
|
+
}
|
|
7407
|
+
|
|
7408
|
+
|
|
7409
|
+
|
|
7301
7410
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7302
7411
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7303
7412
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -7418,7 +7527,7 @@ export const CellApiFp = function(configuration?: Configuration) {
|
|
|
7418
7527
|
* @param {*} [options] Override http request option.
|
|
7419
7528
|
* @throws {RequiredError}
|
|
7420
7529
|
*/
|
|
7421
|
-
async getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
7530
|
+
async getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatusResponse>> {
|
|
7422
7531
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getCellStatus(cell, options);
|
|
7423
7532
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7424
7533
|
const localVarOperationServerBasePath = operationServerMap['CellApi.getCellStatus']?.[localVarOperationServerIndex]?.url;
|
|
@@ -7436,6 +7545,20 @@ export const CellApiFp = function(configuration?: Configuration) {
|
|
|
7436
7545
|
const localVarOperationServerBasePath = operationServerMap['CellApi.listCells']?.[localVarOperationServerIndex]?.url;
|
|
7437
7546
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7438
7547
|
},
|
|
7548
|
+
/**
|
|
7549
|
+
* Deactivate or activate the services of a cell.
|
|
7550
|
+
* @summary Operating State
|
|
7551
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7552
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
7553
|
+
* @param {*} [options] Override http request option.
|
|
7554
|
+
* @throws {RequiredError}
|
|
7555
|
+
*/
|
|
7556
|
+
async setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
7557
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setCellStatus(cell, operatingState, options);
|
|
7558
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7559
|
+
const localVarOperationServerBasePath = operationServerMap['CellApi.setCellStatus']?.[localVarOperationServerIndex]?.url;
|
|
7560
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7561
|
+
},
|
|
7439
7562
|
/**
|
|
7440
7563
|
* Update the definition of the entire Cell.
|
|
7441
7564
|
* @summary Update Configuration
|
|
@@ -7500,7 +7623,7 @@ export const CellApiFactory = function (configuration?: Configuration, basePath?
|
|
|
7500
7623
|
* @param {*} [options] Override http request option.
|
|
7501
7624
|
* @throws {RequiredError}
|
|
7502
7625
|
*/
|
|
7503
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
7626
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ServiceStatusResponse> {
|
|
7504
7627
|
return localVarFp.getCellStatus(cell, options).then((request) => request(axios, basePath));
|
|
7505
7628
|
},
|
|
7506
7629
|
/**
|
|
@@ -7512,6 +7635,17 @@ export const CellApiFactory = function (configuration?: Configuration, basePath?
|
|
|
7512
7635
|
listCells(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
|
|
7513
7636
|
return localVarFp.listCells(options).then((request) => request(axios, basePath));
|
|
7514
7637
|
},
|
|
7638
|
+
/**
|
|
7639
|
+
* Deactivate or activate the services of a cell.
|
|
7640
|
+
* @summary Operating State
|
|
7641
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7642
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
7643
|
+
* @param {*} [options] Override http request option.
|
|
7644
|
+
* @throws {RequiredError}
|
|
7645
|
+
*/
|
|
7646
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
7647
|
+
return localVarFp.setCellStatus(cell, operatingState, options).then((request) => request(axios, basePath));
|
|
7648
|
+
},
|
|
7515
7649
|
/**
|
|
7516
7650
|
* Update the definition of the entire Cell.
|
|
7517
7651
|
* @summary Update Configuration
|
|
@@ -7595,6 +7729,19 @@ export class CellApi extends BaseAPI {
|
|
|
7595
7729
|
return CellApiFp(this.configuration).listCells(options).then((request) => request(this.axios, this.basePath));
|
|
7596
7730
|
}
|
|
7597
7731
|
|
|
7732
|
+
/**
|
|
7733
|
+
* Deactivate or activate the services of a cell.
|
|
7734
|
+
* @summary Operating State
|
|
7735
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7736
|
+
* @param {OperatingState} operatingState Set state of the cell. Active or inactive.
|
|
7737
|
+
* @param {*} [options] Override http request option.
|
|
7738
|
+
* @throws {RequiredError}
|
|
7739
|
+
* @memberof CellApi
|
|
7740
|
+
*/
|
|
7741
|
+
public setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig) {
|
|
7742
|
+
return CellApiFp(this.configuration).setCellStatus(cell, operatingState, options).then((request) => request(this.axios, this.basePath));
|
|
7743
|
+
}
|
|
7744
|
+
|
|
7598
7745
|
/**
|
|
7599
7746
|
* Update the definition of the entire Cell.
|
|
7600
7747
|
* @summary Update Configuration
|
|
@@ -16472,6 +16619,56 @@ export class StoreObjectApi extends BaseAPI {
|
|
|
16472
16619
|
*/
|
|
16473
16620
|
export const SystemApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
16474
16621
|
return {
|
|
16622
|
+
/**
|
|
16623
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
16624
|
+
* @summary Retrieve Configuration Backup
|
|
16625
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
16626
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
16627
|
+
* @param {*} [options] Override http request option.
|
|
16628
|
+
* @throws {RequiredError}
|
|
16629
|
+
*/
|
|
16630
|
+
backupConfiguration: async (resources: Array<string>, metadata?: { [key: string]: string; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
16631
|
+
// verify required parameter 'resources' is not null or undefined
|
|
16632
|
+
assertParamExists('backupConfiguration', 'resources', resources)
|
|
16633
|
+
const localVarPath = `/system/configuration`;
|
|
16634
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16635
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16636
|
+
let baseOptions;
|
|
16637
|
+
if (configuration) {
|
|
16638
|
+
baseOptions = configuration.baseOptions;
|
|
16639
|
+
}
|
|
16640
|
+
|
|
16641
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
16642
|
+
const localVarHeaderParameter = {} as any;
|
|
16643
|
+
const localVarQueryParameter = {} as any;
|
|
16644
|
+
|
|
16645
|
+
// authentication BasicAuth required
|
|
16646
|
+
// http basic authentication required
|
|
16647
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
16648
|
+
|
|
16649
|
+
// authentication BearerAuth required
|
|
16650
|
+
// http bearer authentication required
|
|
16651
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
16652
|
+
|
|
16653
|
+
if (resources) {
|
|
16654
|
+
localVarQueryParameter['resources'] = resources.join(COLLECTION_FORMATS.csv);
|
|
16655
|
+
}
|
|
16656
|
+
|
|
16657
|
+
if (metadata !== undefined) {
|
|
16658
|
+
localVarQueryParameter['metadata'] = metadata;
|
|
16659
|
+
}
|
|
16660
|
+
|
|
16661
|
+
|
|
16662
|
+
|
|
16663
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16664
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16665
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
16666
|
+
|
|
16667
|
+
return {
|
|
16668
|
+
url: toPathString(localVarUrlObj),
|
|
16669
|
+
options: localVarRequestOptions,
|
|
16670
|
+
};
|
|
16671
|
+
},
|
|
16475
16672
|
/**
|
|
16476
16673
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
16477
16674
|
* @summary Check update
|
|
@@ -16631,6 +16828,95 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
16631
16828
|
options: localVarRequestOptions,
|
|
16632
16829
|
};
|
|
16633
16830
|
},
|
|
16831
|
+
/**
|
|
16832
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
16833
|
+
* @summary List Configuration Resources
|
|
16834
|
+
* @param {*} [options] Override http request option.
|
|
16835
|
+
* @throws {RequiredError}
|
|
16836
|
+
*/
|
|
16837
|
+
listConfigurationResources: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
16838
|
+
const localVarPath = `/system/configuration/resources`;
|
|
16839
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16840
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16841
|
+
let baseOptions;
|
|
16842
|
+
if (configuration) {
|
|
16843
|
+
baseOptions = configuration.baseOptions;
|
|
16844
|
+
}
|
|
16845
|
+
|
|
16846
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
16847
|
+
const localVarHeaderParameter = {} as any;
|
|
16848
|
+
const localVarQueryParameter = {} as any;
|
|
16849
|
+
|
|
16850
|
+
// authentication BasicAuth required
|
|
16851
|
+
// http basic authentication required
|
|
16852
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
16853
|
+
|
|
16854
|
+
// authentication BearerAuth required
|
|
16855
|
+
// http bearer authentication required
|
|
16856
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
16857
|
+
|
|
16858
|
+
|
|
16859
|
+
|
|
16860
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16861
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16862
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
16863
|
+
|
|
16864
|
+
return {
|
|
16865
|
+
url: toPathString(localVarUrlObj),
|
|
16866
|
+
options: localVarRequestOptions,
|
|
16867
|
+
};
|
|
16868
|
+
},
|
|
16869
|
+
/**
|
|
16870
|
+
* Restores a previously backed up configuration.
|
|
16871
|
+
* @summary Restore Configuration Backup
|
|
16872
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
16873
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
16874
|
+
* @param {*} [options] Override http request option.
|
|
16875
|
+
* @throws {RequiredError}
|
|
16876
|
+
*/
|
|
16877
|
+
restoreConfiguration: async (resources: Array<string>, body: File, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
16878
|
+
// verify required parameter 'resources' is not null or undefined
|
|
16879
|
+
assertParamExists('restoreConfiguration', 'resources', resources)
|
|
16880
|
+
// verify required parameter 'body' is not null or undefined
|
|
16881
|
+
assertParamExists('restoreConfiguration', 'body', body)
|
|
16882
|
+
const localVarPath = `/system/configuration`;
|
|
16883
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16884
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16885
|
+
let baseOptions;
|
|
16886
|
+
if (configuration) {
|
|
16887
|
+
baseOptions = configuration.baseOptions;
|
|
16888
|
+
}
|
|
16889
|
+
|
|
16890
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
16891
|
+
const localVarHeaderParameter = {} as any;
|
|
16892
|
+
const localVarQueryParameter = {} as any;
|
|
16893
|
+
|
|
16894
|
+
// authentication BasicAuth required
|
|
16895
|
+
// http basic authentication required
|
|
16896
|
+
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
16897
|
+
|
|
16898
|
+
// authentication BearerAuth required
|
|
16899
|
+
// http bearer authentication required
|
|
16900
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
16901
|
+
|
|
16902
|
+
if (resources) {
|
|
16903
|
+
localVarQueryParameter['resources'] = resources.join(COLLECTION_FORMATS.csv);
|
|
16904
|
+
}
|
|
16905
|
+
|
|
16906
|
+
|
|
16907
|
+
|
|
16908
|
+
localVarHeaderParameter['Content-Type'] = 'application/gzip';
|
|
16909
|
+
|
|
16910
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16911
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16912
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
16913
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
16914
|
+
|
|
16915
|
+
return {
|
|
16916
|
+
url: toPathString(localVarUrlObj),
|
|
16917
|
+
options: localVarRequestOptions,
|
|
16918
|
+
};
|
|
16919
|
+
},
|
|
16634
16920
|
/**
|
|
16635
16921
|
* 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
16922
|
* @summary Update Wandelbots NOVA version
|
|
@@ -16685,6 +16971,20 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
16685
16971
|
export const SystemApiFp = function(configuration?: Configuration) {
|
|
16686
16972
|
const localVarAxiosParamCreator = SystemApiAxiosParamCreator(configuration)
|
|
16687
16973
|
return {
|
|
16974
|
+
/**
|
|
16975
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
16976
|
+
* @summary Retrieve Configuration Backup
|
|
16977
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
16978
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
16979
|
+
* @param {*} [options] Override http request option.
|
|
16980
|
+
* @throws {RequiredError}
|
|
16981
|
+
*/
|
|
16982
|
+
async backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
16983
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.backupConfiguration(resources, metadata, options);
|
|
16984
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16985
|
+
const localVarOperationServerBasePath = operationServerMap['SystemApi.backupConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
16986
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16987
|
+
},
|
|
16688
16988
|
/**
|
|
16689
16989
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
16690
16990
|
* @summary Check update
|
|
@@ -16734,6 +17034,32 @@ export const SystemApiFp = function(configuration?: Configuration) {
|
|
|
16734
17034
|
const localVarOperationServerBasePath = operationServerMap['SystemApi.getSystemVersion']?.[localVarOperationServerIndex]?.url;
|
|
16735
17035
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16736
17036
|
},
|
|
17037
|
+
/**
|
|
17038
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
17039
|
+
* @summary List Configuration Resources
|
|
17040
|
+
* @param {*} [options] Override http request option.
|
|
17041
|
+
* @throws {RequiredError}
|
|
17042
|
+
*/
|
|
17043
|
+
async listConfigurationResources(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConfigurationResource>>> {
|
|
17044
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listConfigurationResources(options);
|
|
17045
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17046
|
+
const localVarOperationServerBasePath = operationServerMap['SystemApi.listConfigurationResources']?.[localVarOperationServerIndex]?.url;
|
|
17047
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17048
|
+
},
|
|
17049
|
+
/**
|
|
17050
|
+
* Restores a previously backed up configuration.
|
|
17051
|
+
* @summary Restore Configuration Backup
|
|
17052
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
17053
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
17054
|
+
* @param {*} [options] Override http request option.
|
|
17055
|
+
* @throws {RequiredError}
|
|
17056
|
+
*/
|
|
17057
|
+
async restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
17058
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.restoreConfiguration(resources, body, options);
|
|
17059
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17060
|
+
const localVarOperationServerBasePath = operationServerMap['SystemApi.restoreConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
17061
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17062
|
+
},
|
|
16737
17063
|
/**
|
|
16738
17064
|
* 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
17065
|
* @summary Update Wandelbots NOVA version
|
|
@@ -16757,6 +17083,17 @@ export const SystemApiFp = function(configuration?: Configuration) {
|
|
|
16757
17083
|
export const SystemApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
16758
17084
|
const localVarFp = SystemApiFp(configuration)
|
|
16759
17085
|
return {
|
|
17086
|
+
/**
|
|
17087
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
17088
|
+
* @summary Retrieve Configuration Backup
|
|
17089
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
17090
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
17091
|
+
* @param {*} [options] Override http request option.
|
|
17092
|
+
* @throws {RequiredError}
|
|
17093
|
+
*/
|
|
17094
|
+
backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
17095
|
+
return localVarFp.backupConfiguration(resources, metadata, options).then((request) => request(axios, basePath));
|
|
17096
|
+
},
|
|
16760
17097
|
/**
|
|
16761
17098
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
16762
17099
|
* @summary Check update
|
|
@@ -16794,6 +17131,26 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
|
|
|
16794
17131
|
getSystemVersion(options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
16795
17132
|
return localVarFp.getSystemVersion(options).then((request) => request(axios, basePath));
|
|
16796
17133
|
},
|
|
17134
|
+
/**
|
|
17135
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
17136
|
+
* @summary List Configuration Resources
|
|
17137
|
+
* @param {*} [options] Override http request option.
|
|
17138
|
+
* @throws {RequiredError}
|
|
17139
|
+
*/
|
|
17140
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): AxiosPromise<Array<ConfigurationResource>> {
|
|
17141
|
+
return localVarFp.listConfigurationResources(options).then((request) => request(axios, basePath));
|
|
17142
|
+
},
|
|
17143
|
+
/**
|
|
17144
|
+
* Restores a previously backed up configuration.
|
|
17145
|
+
* @summary Restore Configuration Backup
|
|
17146
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
17147
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
17148
|
+
* @param {*} [options] Override http request option.
|
|
17149
|
+
* @throws {RequiredError}
|
|
17150
|
+
*/
|
|
17151
|
+
restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
17152
|
+
return localVarFp.restoreConfiguration(resources, body, options).then((request) => request(axios, basePath));
|
|
17153
|
+
},
|
|
16797
17154
|
/**
|
|
16798
17155
|
* 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
17156
|
* @summary Update Wandelbots NOVA version
|
|
@@ -16814,6 +17171,19 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
|
|
|
16814
17171
|
* @extends {BaseAPI}
|
|
16815
17172
|
*/
|
|
16816
17173
|
export class SystemApi extends BaseAPI {
|
|
17174
|
+
/**
|
|
17175
|
+
* Retrieves a configuration backup based on provided resource identifiers.
|
|
17176
|
+
* @summary Retrieve Configuration Backup
|
|
17177
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
17178
|
+
* @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
|
|
17179
|
+
* @param {*} [options] Override http request option.
|
|
17180
|
+
* @throws {RequiredError}
|
|
17181
|
+
* @memberof SystemApi
|
|
17182
|
+
*/
|
|
17183
|
+
public backupConfiguration(resources: Array<string>, metadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig) {
|
|
17184
|
+
return SystemApiFp(this.configuration).backupConfiguration(resources, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
17185
|
+
}
|
|
17186
|
+
|
|
16817
17187
|
/**
|
|
16818
17188
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
16819
17189
|
* @summary Check update
|
|
@@ -16859,6 +17229,30 @@ export class SystemApi extends BaseAPI {
|
|
|
16859
17229
|
return SystemApiFp(this.configuration).getSystemVersion(options).then((request) => request(this.axios, this.basePath));
|
|
16860
17230
|
}
|
|
16861
17231
|
|
|
17232
|
+
/**
|
|
17233
|
+
* Retrieves a list of all available configuration resources for backup purposes.
|
|
17234
|
+
* @summary List Configuration Resources
|
|
17235
|
+
* @param {*} [options] Override http request option.
|
|
17236
|
+
* @throws {RequiredError}
|
|
17237
|
+
* @memberof SystemApi
|
|
17238
|
+
*/
|
|
17239
|
+
public listConfigurationResources(options?: RawAxiosRequestConfig) {
|
|
17240
|
+
return SystemApiFp(this.configuration).listConfigurationResources(options).then((request) => request(this.axios, this.basePath));
|
|
17241
|
+
}
|
|
17242
|
+
|
|
17243
|
+
/**
|
|
17244
|
+
* Restores a previously backed up configuration.
|
|
17245
|
+
* @summary Restore Configuration Backup
|
|
17246
|
+
* @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
|
|
17247
|
+
* @param {File} body Backup file stream containing the configuration to restore.
|
|
17248
|
+
* @param {*} [options] Override http request option.
|
|
17249
|
+
* @throws {RequiredError}
|
|
17250
|
+
* @memberof SystemApi
|
|
17251
|
+
*/
|
|
17252
|
+
public restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig) {
|
|
17253
|
+
return SystemApiFp(this.configuration).restoreConfiguration(resources, body, options).then((request) => request(this.axios, this.basePath));
|
|
17254
|
+
}
|
|
17255
|
+
|
|
16862
17256
|
/**
|
|
16863
17257
|
* 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
17258
|
* @summary Update Wandelbots NOVA version
|