@wandelbots/nova-api 25.6.0-dev.40 → 25.6.0-dev.41

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wandelbots/nova-api",
3
- "version": "25.6.0-dev.40",
3
+ "version": "25.6.0-dev.41",
4
4
  "description": "API Client to interact with Wandelbots Public API.",
5
5
  "files": [
6
6
  "*",
package/v2/api.d.ts CHANGED
@@ -683,6 +683,75 @@ export declare const Comparator: {
683
683
  readonly ComparatorLessEqual: "COMPARATOR_LESS_EQUAL";
684
684
  };
685
685
  export type Comparator = typeof Comparator[keyof typeof Comparator];
686
+ /**
687
+ * @type ConfigurationArchiveStatus
688
+ * Result of a backup operation.
689
+ * @export
690
+ */
691
+ export type ConfigurationArchiveStatus = ConfigurationArchiveStatusCreating | ConfigurationArchiveStatusError | ConfigurationArchiveStatusSuccess;
692
+ /**
693
+ *
694
+ * @export
695
+ * @interface ConfigurationArchiveStatusCreating
696
+ */
697
+ export interface ConfigurationArchiveStatusCreating {
698
+ /**
699
+ * Backup is in progress.
700
+ * @type {string}
701
+ * @memberof ConfigurationArchiveStatusCreating
702
+ */
703
+ 'status': ConfigurationArchiveStatusCreatingStatusEnum;
704
+ /**
705
+ * Current completion ratio (0 – 1).
706
+ * @type {number}
707
+ * @memberof ConfigurationArchiveStatusCreating
708
+ */
709
+ 'progress': number;
710
+ }
711
+ export declare const ConfigurationArchiveStatusCreatingStatusEnum: {
712
+ readonly Creating: "creating";
713
+ };
714
+ export type ConfigurationArchiveStatusCreatingStatusEnum = typeof ConfigurationArchiveStatusCreatingStatusEnum[keyof typeof ConfigurationArchiveStatusCreatingStatusEnum];
715
+ /**
716
+ *
717
+ * @export
718
+ * @interface ConfigurationArchiveStatusError
719
+ */
720
+ export interface ConfigurationArchiveStatusError {
721
+ /**
722
+ *
723
+ * @type {string}
724
+ * @memberof ConfigurationArchiveStatusError
725
+ */
726
+ 'status': ConfigurationArchiveStatusErrorStatusEnum;
727
+ /**
728
+ * Human-readable explanation of the failure.
729
+ * @type {string}
730
+ * @memberof ConfigurationArchiveStatusError
731
+ */
732
+ 'message': string;
733
+ }
734
+ export declare const ConfigurationArchiveStatusErrorStatusEnum: {
735
+ readonly Error: "error";
736
+ };
737
+ export type ConfigurationArchiveStatusErrorStatusEnum = typeof ConfigurationArchiveStatusErrorStatusEnum[keyof typeof ConfigurationArchiveStatusErrorStatusEnum];
738
+ /**
739
+ *
740
+ * @export
741
+ * @interface ConfigurationArchiveStatusSuccess
742
+ */
743
+ export interface ConfigurationArchiveStatusSuccess {
744
+ /**
745
+ * Backup successfully created.
746
+ * @type {string}
747
+ * @memberof ConfigurationArchiveStatusSuccess
748
+ */
749
+ 'status': ConfigurationArchiveStatusSuccessStatusEnum;
750
+ }
751
+ export declare const ConfigurationArchiveStatusSuccessStatusEnum: {
752
+ readonly Success: "success";
753
+ };
754
+ export type ConfigurationArchiveStatusSuccessStatusEnum = typeof ConfigurationArchiveStatusSuccessStatusEnum[keyof typeof ConfigurationArchiveStatusSuccessStatusEnum];
686
755
  /**
687
756
  * Configuration resource object.
688
757
  * @export
@@ -8061,6 +8130,14 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
8061
8130
  backupConfiguration: (resources: Array<string>, metadata?: {
8062
8131
  [key: string]: string;
8063
8132
  }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8133
+ /**
8134
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8135
+ * @summary Retrieve Backup Status
8136
+ * @param {string} operationId
8137
+ * @param {*} [options] Override http request option.
8138
+ * @throws {RequiredError}
8139
+ */
8140
+ backupConfigurationStatus: (operationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8064
8141
  /**
8065
8142
  * Check if a more recent Wandelbots NOVA Version is available.
8066
8143
  * @summary Check update
@@ -8131,6 +8208,14 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
8131
8208
  backupConfiguration(resources: Array<string>, metadata?: {
8132
8209
  [key: string]: string;
8133
8210
  }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
8211
+ /**
8212
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8213
+ * @summary Retrieve Backup Status
8214
+ * @param {string} operationId
8215
+ * @param {*} [options] Override http request option.
8216
+ * @throws {RequiredError}
8217
+ */
8218
+ backupConfigurationStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationArchiveStatus>>;
8134
8219
  /**
8135
8220
  * Check if a more recent Wandelbots NOVA Version is available.
8136
8221
  * @summary Check update
@@ -8201,6 +8286,14 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
8201
8286
  backupConfiguration(resources: Array<string>, metadata?: {
8202
8287
  [key: string]: string;
8203
8288
  }, options?: RawAxiosRequestConfig): AxiosPromise<File>;
8289
+ /**
8290
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8291
+ * @summary Retrieve Backup Status
8292
+ * @param {string} operationId
8293
+ * @param {*} [options] Override http request option.
8294
+ * @throws {RequiredError}
8295
+ */
8296
+ backupConfigurationStatus(operationId: string, options?: RawAxiosRequestConfig): AxiosPromise<ConfigurationArchiveStatus>;
8204
8297
  /**
8205
8298
  * Check if a more recent Wandelbots NOVA Version is available.
8206
8299
  * @summary Check update
@@ -8274,6 +8367,15 @@ export declare class SystemApi extends BaseAPI {
8274
8367
  backupConfiguration(resources: Array<string>, metadata?: {
8275
8368
  [key: string]: string;
8276
8369
  }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
8370
+ /**
8371
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8372
+ * @summary Retrieve Backup Status
8373
+ * @param {string} operationId
8374
+ * @param {*} [options] Override http request option.
8375
+ * @throws {RequiredError}
8376
+ * @memberof SystemApi
8377
+ */
8378
+ backupConfigurationStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationArchiveStatus, any>>;
8277
8379
  /**
8278
8380
  * Check if a more recent Wandelbots NOVA Version is available.
8279
8381
  * @summary Check update
package/v2/api.js CHANGED
@@ -62,6 +62,15 @@ export const Comparator = {
62
62
  ComparatorLess: 'COMPARATOR_LESS',
63
63
  ComparatorLessEqual: 'COMPARATOR_LESS_EQUAL'
64
64
  };
65
+ export const ConfigurationArchiveStatusCreatingStatusEnum = {
66
+ Creating: 'creating'
67
+ };
68
+ export const ConfigurationArchiveStatusErrorStatusEnum = {
69
+ Error: 'error'
70
+ };
71
+ export const ConfigurationArchiveStatusSuccessStatusEnum = {
72
+ Success: 'success'
73
+ };
65
74
  export const ConvexHullShapeTypeEnum = {
66
75
  ConvexHull: 'convex_hull'
67
76
  };
@@ -7071,6 +7080,43 @@ export const SystemApiAxiosParamCreator = function (configuration) {
7071
7080
  options: localVarRequestOptions,
7072
7081
  };
7073
7082
  },
7083
+ /**
7084
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7085
+ * @summary Retrieve Backup Status
7086
+ * @param {string} operationId
7087
+ * @param {*} [options] Override http request option.
7088
+ * @throws {RequiredError}
7089
+ */
7090
+ backupConfigurationStatus: async (operationId, options = {}) => {
7091
+ // verify required parameter 'operationId' is not null or undefined
7092
+ assertParamExists('backupConfigurationStatus', 'operationId', operationId);
7093
+ const localVarPath = `/system/configuration/status`;
7094
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7095
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7096
+ let baseOptions;
7097
+ if (configuration) {
7098
+ baseOptions = configuration.baseOptions;
7099
+ }
7100
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
7101
+ const localVarHeaderParameter = {};
7102
+ const localVarQueryParameter = {};
7103
+ // authentication BasicAuth required
7104
+ // http basic authentication required
7105
+ setBasicAuthToObject(localVarRequestOptions, configuration);
7106
+ // authentication BearerAuth required
7107
+ // http bearer authentication required
7108
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
7109
+ if (operationId !== undefined) {
7110
+ localVarQueryParameter['operation_id'] = operationId;
7111
+ }
7112
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7113
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7114
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7115
+ return {
7116
+ url: toPathString(localVarUrlObj),
7117
+ options: localVarRequestOptions,
7118
+ };
7119
+ },
7074
7120
  /**
7075
7121
  * Check if a more recent Wandelbots NOVA Version is available.
7076
7122
  * @summary Check update
@@ -7333,6 +7379,19 @@ export const SystemApiFp = function (configuration) {
7333
7379
  const localVarOperationServerBasePath = operationServerMap['SystemApi.backupConfiguration']?.[localVarOperationServerIndex]?.url;
7334
7380
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7335
7381
  },
7382
+ /**
7383
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7384
+ * @summary Retrieve Backup Status
7385
+ * @param {string} operationId
7386
+ * @param {*} [options] Override http request option.
7387
+ * @throws {RequiredError}
7388
+ */
7389
+ async backupConfigurationStatus(operationId, options) {
7390
+ const localVarAxiosArgs = await localVarAxiosParamCreator.backupConfigurationStatus(operationId, options);
7391
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7392
+ const localVarOperationServerBasePath = operationServerMap['SystemApi.backupConfigurationStatus']?.[localVarOperationServerIndex]?.url;
7393
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7394
+ },
7336
7395
  /**
7337
7396
  * Check if a more recent Wandelbots NOVA Version is available.
7338
7397
  * @summary Check update
@@ -7441,6 +7500,16 @@ export const SystemApiFactory = function (configuration, basePath, axios) {
7441
7500
  backupConfiguration(resources, metadata, options) {
7442
7501
  return localVarFp.backupConfiguration(resources, metadata, options).then((request) => request(axios, basePath));
7443
7502
  },
7503
+ /**
7504
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7505
+ * @summary Retrieve Backup Status
7506
+ * @param {string} operationId
7507
+ * @param {*} [options] Override http request option.
7508
+ * @throws {RequiredError}
7509
+ */
7510
+ backupConfigurationStatus(operationId, options) {
7511
+ return localVarFp.backupConfigurationStatus(operationId, options).then((request) => request(axios, basePath));
7512
+ },
7444
7513
  /**
7445
7514
  * Check if a more recent Wandelbots NOVA Version is available.
7446
7515
  * @summary Check update
@@ -7529,6 +7598,17 @@ export class SystemApi extends BaseAPI {
7529
7598
  backupConfiguration(resources, metadata, options) {
7530
7599
  return SystemApiFp(this.configuration).backupConfiguration(resources, metadata, options).then((request) => request(this.axios, this.basePath));
7531
7600
  }
7601
+ /**
7602
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7603
+ * @summary Retrieve Backup Status
7604
+ * @param {string} operationId
7605
+ * @param {*} [options] Override http request option.
7606
+ * @throws {RequiredError}
7607
+ * @memberof SystemApi
7608
+ */
7609
+ backupConfigurationStatus(operationId, options) {
7610
+ return SystemApiFp(this.configuration).backupConfigurationStatus(operationId, options).then((request) => request(this.axios, this.basePath));
7611
+ }
7532
7612
  /**
7533
7613
  * Check if a more recent Wandelbots NOVA Version is available.
7534
7614
  * @summary Check update
@@ -8133,7 +8213,7 @@ export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
8133
8213
  planTrajectory: async (cell, planTrajectoryRequest, options = {}) => {
8134
8214
  // verify required parameter 'cell' is not null or undefined
8135
8215
  assertParamExists('planTrajectory', 'cell', cell);
8136
- const localVarPath = `/cells/{cell}/motion-planning/plan-trajectory`
8216
+ const localVarPath = `/cells/{cell}/trajectory-planning/plan-trajectory`
8137
8217
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
8138
8218
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
8139
8219
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);