@wandelbots/nova-api 25.7.0-dev.9 → 25.7.0-rc.2

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.js CHANGED
@@ -86,8 +86,17 @@ export const Direction = {
86
86
  DirectionForward: 'DIRECTION_FORWARD',
87
87
  DirectionBackward: 'DIRECTION_BACKWARD'
88
88
  };
89
- export const EndOfTrajectoryKindEnum = {
90
- EndOfTrajectory: 'END_OF_TRAJECTORY'
89
+ export const ErrorInvalidJointCountErrorFeedbackNameEnum = {
90
+ ErrorInvalidJointCount: 'ErrorInvalidJointCount'
91
+ };
92
+ export const ErrorJointLimitExceededErrorFeedbackNameEnum = {
93
+ ErrorJointLimitExceeded: 'ErrorJointLimitExceeded'
94
+ };
95
+ export const ErrorJointPositionCollisionErrorFeedbackNameEnum = {
96
+ ErrorJointPositionCollision: 'ErrorJointPositionCollision'
97
+ };
98
+ export const ErrorMaxIterationsExceededErrorFeedbackNameEnum = {
99
+ ErrorMaxIterationsExceeded: 'ErrorMaxIterationsExceeded'
91
100
  };
92
101
  export const FanucControllerKindEnum = {
93
102
  FanucController: 'FanucController'
@@ -153,6 +162,21 @@ export const IntegerValueValueTypeEnum = {
153
162
  export const JoggingDetailsKindEnum = {
154
163
  Jogging: 'JOGGING'
155
164
  };
165
+ export const JoggingPausedByUserKindEnum = {
166
+ PausedByUser: 'PAUSED_BY_USER'
167
+ };
168
+ export const JoggingPausedNearCollisionKindEnum = {
169
+ PausedNearCollision: 'PAUSED_NEAR_COLLISION'
170
+ };
171
+ export const JoggingPausedNearJointLimitKindEnum = {
172
+ PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
173
+ };
174
+ export const JoggingPausedOnIOKindEnum = {
175
+ PausedOnIo: 'PAUSED_ON_IO'
176
+ };
177
+ export const JoggingRunningKindEnum = {
178
+ Running: 'RUNNING'
179
+ };
156
180
  export const JointVelocityRequestMessageTypeEnum = {
157
181
  JointVelocityRequest: 'JointVelocityRequest'
158
182
  };
@@ -186,6 +210,9 @@ export const Manufacturer = {
186
210
  Universalrobots: 'universalrobots',
187
211
  Yaskawa: 'yaskawa'
188
212
  };
213
+ export const MidpointInsertionAlgorithmAlgorithmNameEnum = {
214
+ MidpointInsertionAlgorithm: 'MidpointInsertionAlgorithm'
215
+ };
189
216
  export const MovementErrorResponseKindEnum = {
190
217
  MotionError: 'MOTION_ERROR'
191
218
  };
@@ -275,21 +302,6 @@ export const PauseMovementRequestMessageTypeEnum = {
275
302
  export const PauseMovementResponseKindEnum = {
276
303
  PauseReceived: 'PAUSE_RECEIVED'
277
304
  };
278
- export const PausedByRequestKindEnum = {
279
- PausedByUser: 'PAUSED_BY_USER'
280
- };
281
- export const PausedByUserKindEnum = {
282
- PausedByUser: 'PAUSED_BY_USER'
283
- };
284
- export const PausedNearCollisionKindEnum = {
285
- PausedNearCollision: 'PAUSED_NEAR_COLLISION'
286
- };
287
- export const PausedNearJointLimitKindEnum = {
288
- PausedNearJointLimit: 'PAUSED_NEAR_JOINT_LIMIT'
289
- };
290
- export const PausedOnIOKindEnum = {
291
- PausedOnIo: 'PAUSED_ON_IO'
292
- };
293
305
  export const PlaneShapeTypeEnum = {
294
306
  Plane: 'plane'
295
307
  };
@@ -299,6 +311,9 @@ export const PlaybackSpeedRequestMessageTypeEnum = {
299
311
  export const PlaybackSpeedResponseKindEnum = {
300
312
  PlaybackSpeedReceived: 'PLAYBACK_SPEED_RECEIVED'
301
313
  };
314
+ export const RRTConnectAlgorithmAlgorithmNameEnum = {
315
+ RrtConnectAlgorithm: 'RRTConnectAlgorithm'
316
+ };
302
317
  export const RectangleShapeTypeEnum = {
303
318
  Rectangle: 'rectangle'
304
319
  };
@@ -315,22 +330,16 @@ export const ReleaseChannel = {
315
330
  Next: 'next'
316
331
  };
317
332
  /**
318
- * The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No input/output interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive input/output information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. Input/Output interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
333
+ * Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
319
334
  * @export
320
335
  * @enum {string}
321
336
  */
322
337
  export const RobotSystemMode = {
323
- RobotSystemModeUndefined: 'ROBOT_SYSTEM_MODE_UNDEFINED',
324
- RobotSystemModeDisconnect: 'ROBOT_SYSTEM_MODE_DISCONNECT',
325
- RobotSystemModeMonitor: 'ROBOT_SYSTEM_MODE_MONITOR',
326
- RobotSystemModeControl: 'ROBOT_SYSTEM_MODE_CONTROL',
327
- RobotSystemModeFreeDrive: 'ROBOT_SYSTEM_MODE_FREE_DRIVE'
328
- };
329
- export const RunningKindEnum = {
330
- Running: 'RUNNING'
331
- };
332
- export const Running1KindEnum = {
333
- Running: 'RUNNING'
338
+ ModeControllerNotConfigured: 'MODE_CONTROLLER_NOT_CONFIGURED',
339
+ ModeInitializing: 'MODE_INITIALIZING',
340
+ ModeMonitor: 'MODE_MONITOR',
341
+ ModeControl: 'MODE_CONTROL',
342
+ ModeFreeDrive: 'MODE_FREE_DRIVE'
334
343
  };
335
344
  /**
336
345
  * Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
@@ -437,9 +446,24 @@ export const TrajectoryDataMessageTypeEnum = {
437
446
  export const TrajectoryDetailsKindEnum = {
438
447
  Trajectory: 'TRAJECTORY'
439
448
  };
449
+ export const TrajectoryEndedKindEnum = {
450
+ EndOfTrajectory: 'END_OF_TRAJECTORY'
451
+ };
440
452
  export const TrajectoryIdMessageTypeEnum = {
441
453
  TrajectoryId: 'TrajectoryId'
442
454
  };
455
+ export const TrajectoryPausedByUserKindEnum = {
456
+ PausedByUser: 'PAUSED_BY_USER'
457
+ };
458
+ export const TrajectoryPausedOnIOKindEnum = {
459
+ PausedOnIo: 'PAUSED_ON_IO'
460
+ };
461
+ export const TrajectoryRunningKindEnum = {
462
+ Running: 'RUNNING'
463
+ };
464
+ export const TrajectoryWaitForIOKindEnum = {
465
+ WaitForIo: 'WAIT_FOR_IO'
466
+ };
443
467
  /**
444
468
  * The unit of input/output value.
445
469
  * @export
@@ -503,6 +527,7 @@ export const VirtualControllerTypes = {
503
527
  FanucCrx20ial: 'fanuc-crx20ial',
504
528
  FanucCrx25ia: 'fanuc-crx25ia',
505
529
  FanucCrx30ia: 'fanuc-crx30ia',
530
+ FanucCrx5ia: 'fanuc-crx5ia',
506
531
  FanucLrMate200iD: 'fanuc-lr_mate_200iD',
507
532
  FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
508
533
  FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
@@ -510,6 +535,7 @@ export const VirtualControllerTypes = {
510
535
  FanucM10iD16S: 'fanuc-m10iD16S',
511
536
  FanucM20iD25: 'fanuc-m20iD25',
512
537
  FanucM20iD35: 'fanuc-m20iD35',
538
+ FanucM710iC20L: 'fanuc-m710iC20L',
513
539
  FanucM900iB280L: 'fanuc-m900iB280L',
514
540
  FanucM900iB360E: 'fanuc-m900iB360E',
515
541
  FanucR2000ic125l: 'fanuc-r2000ic125l',
@@ -577,9 +603,6 @@ export const VirtualControllerTypes = {
577
603
  YaskawaHc10dtp: 'yaskawa-hc10dtp',
578
604
  YaskawaHc20dtp: 'yaskawa-hc20dtp'
579
605
  };
580
- export const WaitForIOKindEnum = {
581
- WaitForIo: 'WAIT_FOR_IO'
582
- };
583
606
  export const YaskawaControllerKindEnum = {
584
607
  YaskawaController: 'YaskawaController'
585
608
  };
@@ -590,7 +613,7 @@ export const YaskawaControllerKindEnum = {
590
613
  export const ApplicationApiAxiosParamCreator = function (configuration) {
591
614
  return {
592
615
  /**
593
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
616
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
594
617
  * @summary Add Application
595
618
  * @param {string} cell Unique identifier addressing a cell in all API calls.
596
619
  * @param {App} app
@@ -847,7 +870,7 @@ export const ApplicationApiFp = function (configuration) {
847
870
  const localVarAxiosParamCreator = ApplicationApiAxiosParamCreator(configuration);
848
871
  return {
849
872
  /**
850
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
873
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
851
874
  * @summary Add Application
852
875
  * @param {string} cell Unique identifier addressing a cell in all API calls.
853
876
  * @param {App} app
@@ -943,7 +966,7 @@ export const ApplicationApiFactory = function (configuration, basePath, axios) {
943
966
  const localVarFp = ApplicationApiFp(configuration);
944
967
  return {
945
968
  /**
946
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
969
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
947
970
  * @summary Add Application
948
971
  * @param {string} cell Unique identifier addressing a cell in all API calls.
949
972
  * @param {App} app
@@ -1021,7 +1044,7 @@ export const ApplicationApiFactory = function (configuration, basePath, axios) {
1021
1044
  */
1022
1045
  export class ApplicationApi extends BaseAPI {
1023
1046
  /**
1024
- * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The endpoint where the API is reachable from the container serving the Application. > - `BASE_PATH`: The root path of the deployed Application. It will be reachable via: http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell where the application is deployed.
1047
+ * Install a basic, containerized web application to the cell to control robots with a customized frontend. Prerequisites: A Docker hub account or similar container registry account, with valid credentials. After adding the application to the cell, open the application on the Wandelbots NOVA home screen. Read [build your application](/docs/docs/development/) for more information. <!-- theme: none --> > #### Predefined Environment Variables > - `NOVA_API`: The API endpoint accessible from within the application container. > - `NATS_BROKER`: The NATS broker endpoint accessible from within the application container. > - `BASE_PATH`: The application\'s root path, accessible at http://$host/$BASE_PATH > - `CELL_NAME`: The name of the cell hosting the deployed application.
1025
1048
  * @summary Add Application
1026
1049
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1027
1050
  * @param {App} app
@@ -1902,45 +1925,6 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
1902
1925
  options: localVarRequestOptions,
1903
1926
  };
1904
1927
  },
1905
- /**
1906
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
1907
- * @summary Current Mode
1908
- * @param {string} cell Unique identifier addressing a cell in all API calls.
1909
- * @param {string} controller Unique identifier to address a controller in the cell.
1910
- * @param {*} [options] Override http request option.
1911
- * @throws {RequiredError}
1912
- */
1913
- getMode: async (cell, controller, options = {}) => {
1914
- // verify required parameter 'cell' is not null or undefined
1915
- assertParamExists('getMode', 'cell', cell);
1916
- // verify required parameter 'controller' is not null or undefined
1917
- assertParamExists('getMode', 'controller', controller);
1918
- const localVarPath = `/cells/{cell}/controllers/{controller}/mode`
1919
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
1920
- .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
1921
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1922
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1923
- let baseOptions;
1924
- if (configuration) {
1925
- baseOptions = configuration.baseOptions;
1926
- }
1927
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1928
- const localVarHeaderParameter = {};
1929
- const localVarQueryParameter = {};
1930
- // authentication BasicAuth required
1931
- // http basic authentication required
1932
- setBasicAuthToObject(localVarRequestOptions, configuration);
1933
- // authentication BearerAuth required
1934
- // http bearer authentication required
1935
- await setBearerAuthToObject(localVarHeaderParameter, configuration);
1936
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1937
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1938
- localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1939
- return {
1940
- url: toPathString(localVarUrlObj),
1941
- options: localVarRequestOptions,
1942
- };
1943
- },
1944
1928
  /**
1945
1929
  * Get the configuration for a robot controller.
1946
1930
  * @summary Robot Controller
@@ -2098,7 +2082,7 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
2098
2082
  };
2099
2083
  },
2100
2084
  /**
2101
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2085
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2102
2086
  * @summary Set Default Mode
2103
2087
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2104
2088
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2186,15 +2170,16 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
2186
2170
  };
2187
2171
  },
2188
2172
  /**
2189
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
2173
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
2190
2174
  * @summary Stream State
2191
2175
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2192
2176
  * @param {string} controller Unique identifier to address a controller in the cell.
2193
2177
  * @param {number} [responseRate]
2178
+ * @param {number} [addControllerTimeout]
2194
2179
  * @param {*} [options] Override http request option.
2195
2180
  * @throws {RequiredError}
2196
2181
  */
2197
- streamRobotControllerState: async (cell, controller, responseRate, options = {}) => {
2182
+ streamRobotControllerState: async (cell, controller, responseRate, addControllerTimeout, options = {}) => {
2198
2183
  // verify required parameter 'cell' is not null or undefined
2199
2184
  assertParamExists('streamRobotControllerState', 'cell', cell);
2200
2185
  // verify required parameter 'controller' is not null or undefined
@@ -2220,6 +2205,9 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
2220
2205
  if (responseRate !== undefined) {
2221
2206
  localVarQueryParameter['response_rate'] = responseRate;
2222
2207
  }
2208
+ if (addControllerTimeout !== undefined) {
2209
+ localVarQueryParameter['add_controller_timeout'] = addControllerTimeout;
2210
+ }
2223
2211
  setSearchParams(localVarUrlObj, localVarQueryParameter);
2224
2212
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2225
2213
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -2373,20 +2361,6 @@ export const ControllerApiFp = function (configuration) {
2373
2361
  const localVarOperationServerBasePath = operationServerMap['ControllerApi.getCurrentRobotControllerState']?.[localVarOperationServerIndex]?.url;
2374
2362
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2375
2363
  },
2376
- /**
2377
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
2378
- * @summary Current Mode
2379
- * @param {string} cell Unique identifier addressing a cell in all API calls.
2380
- * @param {string} controller Unique identifier to address a controller in the cell.
2381
- * @param {*} [options] Override http request option.
2382
- * @throws {RequiredError}
2383
- */
2384
- async getMode(cell, controller, options) {
2385
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMode(cell, controller, options);
2386
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2387
- const localVarOperationServerBasePath = operationServerMap['ControllerApi.getMode']?.[localVarOperationServerIndex]?.url;
2388
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2389
- },
2390
2364
  /**
2391
2365
  * Get the configuration for a robot controller.
2392
2366
  * @summary Robot Controller
@@ -2444,7 +2418,7 @@ export const ControllerApiFp = function (configuration) {
2444
2418
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2445
2419
  },
2446
2420
  /**
2447
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2421
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2448
2422
  * @summary Set Default Mode
2449
2423
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2450
2424
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2474,16 +2448,17 @@ export const ControllerApiFp = function (configuration) {
2474
2448
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2475
2449
  },
2476
2450
  /**
2477
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
2451
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
2478
2452
  * @summary Stream State
2479
2453
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2480
2454
  * @param {string} controller Unique identifier to address a controller in the cell.
2481
2455
  * @param {number} [responseRate]
2456
+ * @param {number} [addControllerTimeout]
2482
2457
  * @param {*} [options] Override http request option.
2483
2458
  * @throws {RequiredError}
2484
2459
  */
2485
- async streamRobotControllerState(cell, controller, responseRate, options) {
2486
- const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, options);
2460
+ async streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
2461
+ const localVarAxiosArgs = await localVarAxiosParamCreator.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options);
2487
2462
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2488
2463
  const localVarOperationServerBasePath = operationServerMap['ControllerApi.streamRobotControllerState']?.[localVarOperationServerIndex]?.url;
2489
2464
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2583,17 +2558,6 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
2583
2558
  getCurrentRobotControllerState(cell, controller, options) {
2584
2559
  return localVarFp.getCurrentRobotControllerState(cell, controller, options).then((request) => request(axios, basePath));
2585
2560
  },
2586
- /**
2587
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
2588
- * @summary Current Mode
2589
- * @param {string} cell Unique identifier addressing a cell in all API calls.
2590
- * @param {string} controller Unique identifier to address a controller in the cell.
2591
- * @param {*} [options] Override http request option.
2592
- * @throws {RequiredError}
2593
- */
2594
- getMode(cell, controller, options) {
2595
- return localVarFp.getMode(cell, controller, options).then((request) => request(axios, basePath));
2596
- },
2597
2561
  /**
2598
2562
  * Get the configuration for a robot controller.
2599
2563
  * @summary Robot Controller
@@ -2639,7 +2603,7 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
2639
2603
  return localVarFp.listRobotControllers(cell, options).then((request) => request(axios, basePath));
2640
2604
  },
2641
2605
  /**
2642
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2606
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2643
2607
  * @summary Set Default Mode
2644
2608
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2645
2609
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2663,16 +2627,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
2663
2627
  return localVarFp.streamFreeDrive(cell, controller, responseRate, options).then((request) => request(axios, basePath));
2664
2628
  },
2665
2629
  /**
2666
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
2630
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
2667
2631
  * @summary Stream State
2668
2632
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2669
2633
  * @param {string} controller Unique identifier to address a controller in the cell.
2670
2634
  * @param {number} [responseRate]
2635
+ * @param {number} [addControllerTimeout]
2671
2636
  * @param {*} [options] Override http request option.
2672
2637
  * @throws {RequiredError}
2673
2638
  */
2674
- streamRobotControllerState(cell, controller, responseRate, options) {
2675
- return localVarFp.streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(axios, basePath));
2639
+ streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
2640
+ return localVarFp.streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(axios, basePath));
2676
2641
  },
2677
2642
  /**
2678
2643
  * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
@@ -2772,18 +2737,6 @@ export class ControllerApi extends BaseAPI {
2772
2737
  getCurrentRobotControllerState(cell, controller, options) {
2773
2738
  return ControllerApiFp(this.configuration).getCurrentRobotControllerState(cell, controller, options).then((request) => request(this.axios, this.basePath));
2774
2739
  }
2775
- /**
2776
- * Get the current robot system mode of a registered robot controller. The robot system mode indicates if a robot controller can be used. See [setDefaultMode](setDefaultMode) for more information about the different modes. The mode is influenced by the operating mode of the robot controller. The operating mode can be changed via [setDefaultMode](setDefaultMode). Request the current operating mode of the robot controller via [getCurrentRobotControllerState](getCurrentRobotControllerState).
2777
- * @summary Current Mode
2778
- * @param {string} cell Unique identifier addressing a cell in all API calls.
2779
- * @param {string} controller Unique identifier to address a controller in the cell.
2780
- * @param {*} [options] Override http request option.
2781
- * @throws {RequiredError}
2782
- * @memberof ControllerApi
2783
- */
2784
- getMode(cell, controller, options) {
2785
- return ControllerApiFp(this.configuration).getMode(cell, controller, options).then((request) => request(this.axios, this.basePath));
2786
- }
2787
2740
  /**
2788
2741
  * Get the configuration for a robot controller.
2789
2742
  * @summary Robot Controller
@@ -2833,7 +2786,7 @@ export class ControllerApi extends BaseAPI {
2833
2786
  return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
2834
2787
  }
2835
2788
  /**
2836
- * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2789
+ * Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state \'normal\' or \'reduced\'. If the robot controller is in `manual` operating mode, you have manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
2837
2790
  * @summary Set Default Mode
2838
2791
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2839
2792
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2859,17 +2812,18 @@ export class ControllerApi extends BaseAPI {
2859
2812
  return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
2860
2813
  }
2861
2814
  /**
2862
- * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller.
2815
+ * <!-- theme: danger --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
2863
2816
  * @summary Stream State
2864
2817
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2865
2818
  * @param {string} controller Unique identifier to address a controller in the cell.
2866
2819
  * @param {number} [responseRate]
2820
+ * @param {number} [addControllerTimeout]
2867
2821
  * @param {*} [options] Override http request option.
2868
2822
  * @throws {RequiredError}
2869
2823
  * @memberof ControllerApi
2870
2824
  */
2871
- streamRobotControllerState(cell, controller, responseRate, options) {
2872
- return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
2825
+ streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options) {
2826
+ return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
2873
2827
  }
2874
2828
  /**
2875
2829
  * Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. <!-- theme: warning --> > **WARNING** > > Using it in conjunction with the settings app may lead to unpredictable behavior.
@@ -3482,6 +3436,44 @@ export class JoggingApi extends BaseAPI {
3482
3436
  */
3483
3437
  export const KinematicsApiAxiosParamCreator = function (configuration) {
3484
3438
  return {
3439
+ /**
3440
+ * Returns the TCP poses for a list of given joint positions.
3441
+ * @summary Forward kinematics
3442
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3443
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
3444
+ * @param {*} [options] Override http request option.
3445
+ * @throws {RequiredError}
3446
+ */
3447
+ forwardKinematics: async (cell, forwardKinematicsRequest, options = {}) => {
3448
+ // verify required parameter 'cell' is not null or undefined
3449
+ assertParamExists('forwardKinematics', 'cell', cell);
3450
+ const localVarPath = `/cells/{cell}/kinematic/forward`
3451
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
3452
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3453
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3454
+ let baseOptions;
3455
+ if (configuration) {
3456
+ baseOptions = configuration.baseOptions;
3457
+ }
3458
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
3459
+ const localVarHeaderParameter = {};
3460
+ const localVarQueryParameter = {};
3461
+ // authentication BasicAuth required
3462
+ // http basic authentication required
3463
+ setBasicAuthToObject(localVarRequestOptions, configuration);
3464
+ // authentication BearerAuth required
3465
+ // http bearer authentication required
3466
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
3467
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3468
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3469
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3470
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
3471
+ localVarRequestOptions.data = serializeDataIfNeeded(forwardKinematicsRequest, localVarRequestOptions, configuration);
3472
+ return {
3473
+ url: toPathString(localVarUrlObj),
3474
+ options: localVarRequestOptions,
3475
+ };
3476
+ },
3485
3477
  /**
3486
3478
  * Returns the reachable joint positions for a list of given poses.
3487
3479
  * @summary Inverse kinematics
@@ -3529,6 +3521,20 @@ export const KinematicsApiAxiosParamCreator = function (configuration) {
3529
3521
  export const KinematicsApiFp = function (configuration) {
3530
3522
  const localVarAxiosParamCreator = KinematicsApiAxiosParamCreator(configuration);
3531
3523
  return {
3524
+ /**
3525
+ * Returns the TCP poses for a list of given joint positions.
3526
+ * @summary Forward kinematics
3527
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3528
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
3529
+ * @param {*} [options] Override http request option.
3530
+ * @throws {RequiredError}
3531
+ */
3532
+ async forwardKinematics(cell, forwardKinematicsRequest, options) {
3533
+ const localVarAxiosArgs = await localVarAxiosParamCreator.forwardKinematics(cell, forwardKinematicsRequest, options);
3534
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3535
+ const localVarOperationServerBasePath = operationServerMap['KinematicsApi.forwardKinematics']?.[localVarOperationServerIndex]?.url;
3536
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3537
+ },
3532
3538
  /**
3533
3539
  * Returns the reachable joint positions for a list of given poses.
3534
3540
  * @summary Inverse kinematics
@@ -3552,6 +3558,17 @@ export const KinematicsApiFp = function (configuration) {
3552
3558
  export const KinematicsApiFactory = function (configuration, basePath, axios) {
3553
3559
  const localVarFp = KinematicsApiFp(configuration);
3554
3560
  return {
3561
+ /**
3562
+ * Returns the TCP poses for a list of given joint positions.
3563
+ * @summary Forward kinematics
3564
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3565
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
3566
+ * @param {*} [options] Override http request option.
3567
+ * @throws {RequiredError}
3568
+ */
3569
+ forwardKinematics(cell, forwardKinematicsRequest, options) {
3570
+ return localVarFp.forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(axios, basePath));
3571
+ },
3555
3572
  /**
3556
3573
  * Returns the reachable joint positions for a list of given poses.
3557
3574
  * @summary Inverse kinematics
@@ -3572,6 +3589,18 @@ export const KinematicsApiFactory = function (configuration, basePath, axios) {
3572
3589
  * @extends {BaseAPI}
3573
3590
  */
3574
3591
  export class KinematicsApi extends BaseAPI {
3592
+ /**
3593
+ * Returns the TCP poses for a list of given joint positions.
3594
+ * @summary Forward kinematics
3595
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3596
+ * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
3597
+ * @param {*} [options] Override http request option.
3598
+ * @throws {RequiredError}
3599
+ * @memberof KinematicsApi
3600
+ */
3601
+ forwardKinematics(cell, forwardKinematicsRequest, options) {
3602
+ return KinematicsApiFp(this.configuration).forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
3603
+ }
3575
3604
  /**
3576
3605
  * Returns the reachable joint positions for a list of given poses.
3577
3606
  * @summary Inverse kinematics
@@ -5308,27 +5337,27 @@ export class StoreCollisionComponentsApi extends BaseAPI {
5308
5337
  }
5309
5338
  }
5310
5339
  /**
5311
- * StoreCollisionScenesApi - axios parameter creator
5340
+ * StoreCollisionSetupsApi - axios parameter creator
5312
5341
  * @export
5313
5342
  */
5314
- export const StoreCollisionScenesApiAxiosParamCreator = function (configuration) {
5343
+ export const StoreCollisionSetupsApiAxiosParamCreator = function (configuration) {
5315
5344
  return {
5316
5345
  /**
5317
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5318
- * @summary Delete Scene
5346
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
5347
+ * @summary Delete Collision Setup
5319
5348
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5320
- * @param {string} scene Unique identifier addressing a collision scene.
5349
+ * @param {string} setup Identifier of the collision setup
5321
5350
  * @param {*} [options] Override http request option.
5322
5351
  * @throws {RequiredError}
5323
5352
  */
5324
- deleteStoredCollisionScene: async (cell, scene, options = {}) => {
5353
+ deleteStoredCollisionSetup: async (cell, setup, options = {}) => {
5325
5354
  // verify required parameter 'cell' is not null or undefined
5326
- assertParamExists('deleteStoredCollisionScene', 'cell', cell);
5327
- // verify required parameter 'scene' is not null or undefined
5328
- assertParamExists('deleteStoredCollisionScene', 'scene', scene);
5329
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
5355
+ assertParamExists('deleteStoredCollisionSetup', 'cell', cell);
5356
+ // verify required parameter 'setup' is not null or undefined
5357
+ assertParamExists('deleteStoredCollisionSetup', 'setup', setup);
5358
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
5330
5359
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5331
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
5360
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
5332
5361
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5333
5362
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5334
5363
  let baseOptions;
@@ -5353,21 +5382,21 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5353
5382
  };
5354
5383
  },
5355
5384
  /**
5356
- * Returns the stored scene.
5357
- * @summary Get Scene
5385
+ * Returns the stored collision setup.
5386
+ * @summary Get Collision Setup
5358
5387
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5359
- * @param {string} scene Unique identifier addressing a collision scene.
5388
+ * @param {string} setup Identifier of the collision setup
5360
5389
  * @param {*} [options] Override http request option.
5361
5390
  * @throws {RequiredError}
5362
5391
  */
5363
- getStoredCollisionScene: async (cell, scene, options = {}) => {
5392
+ getStoredCollisionSetup: async (cell, setup, options = {}) => {
5364
5393
  // verify required parameter 'cell' is not null or undefined
5365
- assertParamExists('getStoredCollisionScene', 'cell', cell);
5366
- // verify required parameter 'scene' is not null or undefined
5367
- assertParamExists('getStoredCollisionScene', 'scene', scene);
5368
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
5394
+ assertParamExists('getStoredCollisionSetup', 'cell', cell);
5395
+ // verify required parameter 'setup' is not null or undefined
5396
+ assertParamExists('getStoredCollisionSetup', 'setup', setup);
5397
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
5369
5398
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5370
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
5399
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
5371
5400
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5372
5401
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5373
5402
  let baseOptions;
@@ -5392,16 +5421,16 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5392
5421
  };
5393
5422
  },
5394
5423
  /**
5395
- * Returns a list of stored scenes.
5396
- * @summary List Scenes
5424
+ * Returns a list of stored collision setups.
5425
+ * @summary List Collision Setups
5397
5426
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5398
5427
  * @param {*} [options] Override http request option.
5399
5428
  * @throws {RequiredError}
5400
5429
  */
5401
- listStoredCollisionScenes: async (cell, options = {}) => {
5430
+ listStoredCollisionSetups: async (cell, options = {}) => {
5402
5431
  // verify required parameter 'cell' is not null or undefined
5403
- assertParamExists('listStoredCollisionScenes', 'cell', cell);
5404
- const localVarPath = `/cells/{cell}/store/collision/scenes`
5432
+ assertParamExists('listStoredCollisionSetups', 'cell', cell);
5433
+ const localVarPath = `/cells/{cell}/store/collision/setups`
5405
5434
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5406
5435
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5407
5436
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5427,24 +5456,24 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5427
5456
  };
5428
5457
  },
5429
5458
  /**
5430
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5431
- * @summary Store Scene
5459
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
5460
+ * @summary Store Collision Setup
5432
5461
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5433
- * @param {string} scene Unique identifier addressing a collision scene.
5434
- * @param {CollisionSceneAssembly} collisionSceneAssembly
5462
+ * @param {string} setup Identifier of the collision setup
5463
+ * @param {CollisionSetup} collisionSetup
5435
5464
  * @param {*} [options] Override http request option.
5436
5465
  * @throws {RequiredError}
5437
5466
  */
5438
- storeCollisionScene: async (cell, scene, collisionSceneAssembly, options = {}) => {
5467
+ storeCollisionSetup: async (cell, setup, collisionSetup, options = {}) => {
5439
5468
  // verify required parameter 'cell' is not null or undefined
5440
- assertParamExists('storeCollisionScene', 'cell', cell);
5441
- // verify required parameter 'scene' is not null or undefined
5442
- assertParamExists('storeCollisionScene', 'scene', scene);
5443
- // verify required parameter 'collisionSceneAssembly' is not null or undefined
5444
- assertParamExists('storeCollisionScene', 'collisionSceneAssembly', collisionSceneAssembly);
5445
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
5469
+ assertParamExists('storeCollisionSetup', 'cell', cell);
5470
+ // verify required parameter 'setup' is not null or undefined
5471
+ assertParamExists('storeCollisionSetup', 'setup', setup);
5472
+ // verify required parameter 'collisionSetup' is not null or undefined
5473
+ assertParamExists('storeCollisionSetup', 'collisionSetup', collisionSetup);
5474
+ const localVarPath = `/cells/{cell}/store/collision/setups/{setup}`
5446
5475
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5447
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
5476
+ .replace(`{${"setup"}}`, encodeURIComponent(String(setup)));
5448
5477
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5449
5478
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5450
5479
  let baseOptions;
@@ -5464,7 +5493,7 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5464
5493
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5465
5494
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5466
5495
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5467
- localVarRequestOptions.data = serializeDataIfNeeded(collisionSceneAssembly, localVarRequestOptions, configuration);
5496
+ localVarRequestOptions.data = serializeDataIfNeeded(collisionSetup, localVarRequestOptions, configuration);
5468
5497
  return {
5469
5498
  url: toPathString(localVarUrlObj),
5470
5499
  options: localVarRequestOptions,
@@ -5473,177 +5502,177 @@ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration)
5473
5502
  };
5474
5503
  };
5475
5504
  /**
5476
- * StoreCollisionScenesApi - functional programming interface
5505
+ * StoreCollisionSetupsApi - functional programming interface
5477
5506
  * @export
5478
5507
  */
5479
- export const StoreCollisionScenesApiFp = function (configuration) {
5480
- const localVarAxiosParamCreator = StoreCollisionScenesApiAxiosParamCreator(configuration);
5508
+ export const StoreCollisionSetupsApiFp = function (configuration) {
5509
+ const localVarAxiosParamCreator = StoreCollisionSetupsApiAxiosParamCreator(configuration);
5481
5510
  return {
5482
5511
  /**
5483
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5484
- * @summary Delete Scene
5512
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
5513
+ * @summary Delete Collision Setup
5485
5514
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5486
- * @param {string} scene Unique identifier addressing a collision scene.
5515
+ * @param {string} setup Identifier of the collision setup
5487
5516
  * @param {*} [options] Override http request option.
5488
5517
  * @throws {RequiredError}
5489
5518
  */
5490
- async deleteStoredCollisionScene(cell, scene, options) {
5491
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionScene(cell, scene, options);
5519
+ async deleteStoredCollisionSetup(cell, setup, options) {
5520
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionSetup(cell, setup, options);
5492
5521
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5493
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.deleteStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
5522
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.deleteStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
5494
5523
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5495
5524
  },
5496
5525
  /**
5497
- * Returns the stored scene.
5498
- * @summary Get Scene
5526
+ * Returns the stored collision setup.
5527
+ * @summary Get Collision Setup
5499
5528
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5500
- * @param {string} scene Unique identifier addressing a collision scene.
5529
+ * @param {string} setup Identifier of the collision setup
5501
5530
  * @param {*} [options] Override http request option.
5502
5531
  * @throws {RequiredError}
5503
5532
  */
5504
- async getStoredCollisionScene(cell, scene, options) {
5505
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionScene(cell, scene, options);
5533
+ async getStoredCollisionSetup(cell, setup, options) {
5534
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionSetup(cell, setup, options);
5506
5535
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5507
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.getStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
5536
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.getStoredCollisionSetup']?.[localVarOperationServerIndex]?.url;
5508
5537
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5509
5538
  },
5510
5539
  /**
5511
- * Returns a list of stored scenes.
5512
- * @summary List Scenes
5540
+ * Returns a list of stored collision setups.
5541
+ * @summary List Collision Setups
5513
5542
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5514
5543
  * @param {*} [options] Override http request option.
5515
5544
  * @throws {RequiredError}
5516
5545
  */
5517
- async listStoredCollisionScenes(cell, options) {
5518
- const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionScenes(cell, options);
5546
+ async listStoredCollisionSetups(cell, options) {
5547
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionSetups(cell, options);
5519
5548
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5520
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.listStoredCollisionScenes']?.[localVarOperationServerIndex]?.url;
5549
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.listStoredCollisionSetups']?.[localVarOperationServerIndex]?.url;
5521
5550
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5522
5551
  },
5523
5552
  /**
5524
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5525
- * @summary Store Scene
5553
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
5554
+ * @summary Store Collision Setup
5526
5555
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5527
- * @param {string} scene Unique identifier addressing a collision scene.
5528
- * @param {CollisionSceneAssembly} collisionSceneAssembly
5556
+ * @param {string} setup Identifier of the collision setup
5557
+ * @param {CollisionSetup} collisionSetup
5529
5558
  * @param {*} [options] Override http request option.
5530
5559
  * @throws {RequiredError}
5531
5560
  */
5532
- async storeCollisionScene(cell, scene, collisionSceneAssembly, options) {
5533
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionScene(cell, scene, collisionSceneAssembly, options);
5561
+ async storeCollisionSetup(cell, setup, collisionSetup, options) {
5562
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionSetup(cell, setup, collisionSetup, options);
5534
5563
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5535
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.storeCollisionScene']?.[localVarOperationServerIndex]?.url;
5564
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionSetupsApi.storeCollisionSetup']?.[localVarOperationServerIndex]?.url;
5536
5565
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5537
5566
  },
5538
5567
  };
5539
5568
  };
5540
5569
  /**
5541
- * StoreCollisionScenesApi - factory interface
5570
+ * StoreCollisionSetupsApi - factory interface
5542
5571
  * @export
5543
5572
  */
5544
- export const StoreCollisionScenesApiFactory = function (configuration, basePath, axios) {
5545
- const localVarFp = StoreCollisionScenesApiFp(configuration);
5573
+ export const StoreCollisionSetupsApiFactory = function (configuration, basePath, axios) {
5574
+ const localVarFp = StoreCollisionSetupsApiFp(configuration);
5546
5575
  return {
5547
5576
  /**
5548
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5549
- * @summary Delete Scene
5577
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
5578
+ * @summary Delete Collision Setup
5550
5579
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5551
- * @param {string} scene Unique identifier addressing a collision scene.
5580
+ * @param {string} setup Identifier of the collision setup
5552
5581
  * @param {*} [options] Override http request option.
5553
5582
  * @throws {RequiredError}
5554
5583
  */
5555
- deleteStoredCollisionScene(cell, scene, options) {
5556
- return localVarFp.deleteStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
5584
+ deleteStoredCollisionSetup(cell, setup, options) {
5585
+ return localVarFp.deleteStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
5557
5586
  },
5558
5587
  /**
5559
- * Returns the stored scene.
5560
- * @summary Get Scene
5588
+ * Returns the stored collision setup.
5589
+ * @summary Get Collision Setup
5561
5590
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5562
- * @param {string} scene Unique identifier addressing a collision scene.
5591
+ * @param {string} setup Identifier of the collision setup
5563
5592
  * @param {*} [options] Override http request option.
5564
5593
  * @throws {RequiredError}
5565
5594
  */
5566
- getStoredCollisionScene(cell, scene, options) {
5567
- return localVarFp.getStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
5595
+ getStoredCollisionSetup(cell, setup, options) {
5596
+ return localVarFp.getStoredCollisionSetup(cell, setup, options).then((request) => request(axios, basePath));
5568
5597
  },
5569
5598
  /**
5570
- * Returns a list of stored scenes.
5571
- * @summary List Scenes
5599
+ * Returns a list of stored collision setups.
5600
+ * @summary List Collision Setups
5572
5601
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5573
5602
  * @param {*} [options] Override http request option.
5574
5603
  * @throws {RequiredError}
5575
5604
  */
5576
- listStoredCollisionScenes(cell, options) {
5577
- return localVarFp.listStoredCollisionScenes(cell, options).then((request) => request(axios, basePath));
5605
+ listStoredCollisionSetups(cell, options) {
5606
+ return localVarFp.listStoredCollisionSetups(cell, options).then((request) => request(axios, basePath));
5578
5607
  },
5579
5608
  /**
5580
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5581
- * @summary Store Scene
5609
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
5610
+ * @summary Store Collision Setup
5582
5611
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5583
- * @param {string} scene Unique identifier addressing a collision scene.
5584
- * @param {CollisionSceneAssembly} collisionSceneAssembly
5612
+ * @param {string} setup Identifier of the collision setup
5613
+ * @param {CollisionSetup} collisionSetup
5585
5614
  * @param {*} [options] Override http request option.
5586
5615
  * @throws {RequiredError}
5587
5616
  */
5588
- storeCollisionScene(cell, scene, collisionSceneAssembly, options) {
5589
- return localVarFp.storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(axios, basePath));
5617
+ storeCollisionSetup(cell, setup, collisionSetup, options) {
5618
+ return localVarFp.storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(axios, basePath));
5590
5619
  },
5591
5620
  };
5592
5621
  };
5593
5622
  /**
5594
- * StoreCollisionScenesApi - object-oriented interface
5623
+ * StoreCollisionSetupsApi - object-oriented interface
5595
5624
  * @export
5596
- * @class StoreCollisionScenesApi
5625
+ * @class StoreCollisionSetupsApi
5597
5626
  * @extends {BaseAPI}
5598
5627
  */
5599
- export class StoreCollisionScenesApi extends BaseAPI {
5628
+ export class StoreCollisionSetupsApi extends BaseAPI {
5600
5629
  /**
5601
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
5602
- * @summary Delete Scene
5630
+ * Deletes the stored collision setup. <!-- theme: danger --> > This will delete persistently stored data.
5631
+ * @summary Delete Collision Setup
5603
5632
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5604
- * @param {string} scene Unique identifier addressing a collision scene.
5633
+ * @param {string} setup Identifier of the collision setup
5605
5634
  * @param {*} [options] Override http request option.
5606
5635
  * @throws {RequiredError}
5607
- * @memberof StoreCollisionScenesApi
5636
+ * @memberof StoreCollisionSetupsApi
5608
5637
  */
5609
- deleteStoredCollisionScene(cell, scene, options) {
5610
- return StoreCollisionScenesApiFp(this.configuration).deleteStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
5638
+ deleteStoredCollisionSetup(cell, setup, options) {
5639
+ return StoreCollisionSetupsApiFp(this.configuration).deleteStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
5611
5640
  }
5612
5641
  /**
5613
- * Returns the stored scene.
5614
- * @summary Get Scene
5642
+ * Returns the stored collision setup.
5643
+ * @summary Get Collision Setup
5615
5644
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5616
- * @param {string} scene Unique identifier addressing a collision scene.
5645
+ * @param {string} setup Identifier of the collision setup
5617
5646
  * @param {*} [options] Override http request option.
5618
5647
  * @throws {RequiredError}
5619
- * @memberof StoreCollisionScenesApi
5648
+ * @memberof StoreCollisionSetupsApi
5620
5649
  */
5621
- getStoredCollisionScene(cell, scene, options) {
5622
- return StoreCollisionScenesApiFp(this.configuration).getStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
5650
+ getStoredCollisionSetup(cell, setup, options) {
5651
+ return StoreCollisionSetupsApiFp(this.configuration).getStoredCollisionSetup(cell, setup, options).then((request) => request(this.axios, this.basePath));
5623
5652
  }
5624
5653
  /**
5625
- * Returns a list of stored scenes.
5626
- * @summary List Scenes
5654
+ * Returns a list of stored collision setups.
5655
+ * @summary List Collision Setups
5627
5656
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5628
5657
  * @param {*} [options] Override http request option.
5629
5658
  * @throws {RequiredError}
5630
- * @memberof StoreCollisionScenesApi
5659
+ * @memberof StoreCollisionSetupsApi
5631
5660
  */
5632
- listStoredCollisionScenes(cell, options) {
5633
- return StoreCollisionScenesApiFp(this.configuration).listStoredCollisionScenes(cell, options).then((request) => request(this.axios, this.basePath));
5661
+ listStoredCollisionSetups(cell, options) {
5662
+ return StoreCollisionSetupsApiFp(this.configuration).listStoredCollisionSetups(cell, options).then((request) => request(this.axios, this.basePath));
5634
5663
  }
5635
5664
  /**
5636
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
5637
- * @summary Store Scene
5665
+ * Stores collision setup. If the collision setup does not exist, it will be created. If the collision setup exists, it will be updated.
5666
+ * @summary Store Collision Setup
5638
5667
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5639
- * @param {string} scene Unique identifier addressing a collision scene.
5640
- * @param {CollisionSceneAssembly} collisionSceneAssembly
5668
+ * @param {string} setup Identifier of the collision setup
5669
+ * @param {CollisionSetup} collisionSetup
5641
5670
  * @param {*} [options] Override http request option.
5642
5671
  * @throws {RequiredError}
5643
- * @memberof StoreCollisionScenesApi
5672
+ * @memberof StoreCollisionSetupsApi
5644
5673
  */
5645
- storeCollisionScene(cell, scene, collisionSceneAssembly, options) {
5646
- return StoreCollisionScenesApiFp(this.configuration).storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(this.axios, this.basePath));
5674
+ storeCollisionSetup(cell, setup, collisionSetup, options) {
5675
+ return StoreCollisionSetupsApiFp(this.configuration).storeCollisionSetup(cell, setup, collisionSetup, options).then((request) => request(this.axios, this.basePath));
5647
5676
  }
5648
5677
  }
5649
5678
  /**
@@ -6148,16 +6177,14 @@ export class StoreObjectApi extends BaseAPI {
6148
6177
  export const SystemApiAxiosParamCreator = function (configuration) {
6149
6178
  return {
6150
6179
  /**
6151
- * Retrieves a configuration backup based on provided resource identifiers.
6180
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
6152
6181
  * @summary Retrieve Configuration Backup
6153
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
6182
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
6154
6183
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
6155
6184
  * @param {*} [options] Override http request option.
6156
6185
  * @throws {RequiredError}
6157
6186
  */
6158
6187
  backupConfiguration: async (resources, metadata, options = {}) => {
6159
- // verify required parameter 'resources' is not null or undefined
6160
- assertParamExists('backupConfiguration', 'resources', resources);
6161
6188
  const localVarPath = `/system/configuration`;
6162
6189
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6163
6190
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -6474,9 +6501,9 @@ export const SystemApiFp = function (configuration) {
6474
6501
  const localVarAxiosParamCreator = SystemApiAxiosParamCreator(configuration);
6475
6502
  return {
6476
6503
  /**
6477
- * Retrieves a configuration backup based on provided resource identifiers.
6504
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
6478
6505
  * @summary Retrieve Configuration Backup
6479
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
6506
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
6480
6507
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
6481
6508
  * @param {*} [options] Override http request option.
6482
6509
  * @throws {RequiredError}
@@ -6598,9 +6625,9 @@ export const SystemApiFactory = function (configuration, basePath, axios) {
6598
6625
  const localVarFp = SystemApiFp(configuration);
6599
6626
  return {
6600
6627
  /**
6601
- * Retrieves a configuration backup based on provided resource identifiers.
6628
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
6602
6629
  * @summary Retrieve Configuration Backup
6603
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
6630
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
6604
6631
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
6605
6632
  * @param {*} [options] Override http request option.
6606
6633
  * @throws {RequiredError}
@@ -6695,9 +6722,9 @@ export const SystemApiFactory = function (configuration, basePath, axios) {
6695
6722
  */
6696
6723
  export class SystemApi extends BaseAPI {
6697
6724
  /**
6698
- * Retrieves a configuration backup based on provided resource identifiers.
6725
+ * Retrieves a configuration backup based on provided resource identifiers. If an empty array of resources is provided, a backup for all resources will be retrieved.
6699
6726
  * @summary Retrieve Configuration Backup
6700
- * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
6727
+ * @param {Array<string>} [resources] List of resource identifiers to include in the retrieval.
6701
6728
  * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
6702
6729
  * @param {*} [options] Override http request option.
6703
6730
  * @throws {RequiredError}
@@ -7352,6 +7379,44 @@ export class TrajectoryExecutionApi extends BaseAPI {
7352
7379
  */
7353
7380
  export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
7354
7381
  return {
7382
+ /**
7383
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7384
+ * @summary Plan Collision-Free Trajectory
7385
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7386
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
7387
+ * @param {*} [options] Override http request option.
7388
+ * @throws {RequiredError}
7389
+ */
7390
+ planCollisionFree: async (cell, planCollisionFreeRequest, options = {}) => {
7391
+ // verify required parameter 'cell' is not null or undefined
7392
+ assertParamExists('planCollisionFree', 'cell', cell);
7393
+ const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`
7394
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
7395
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
7396
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
7397
+ let baseOptions;
7398
+ if (configuration) {
7399
+ baseOptions = configuration.baseOptions;
7400
+ }
7401
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
7402
+ const localVarHeaderParameter = {};
7403
+ const localVarQueryParameter = {};
7404
+ // authentication BasicAuth required
7405
+ // http basic authentication required
7406
+ setBasicAuthToObject(localVarRequestOptions, configuration);
7407
+ // authentication BearerAuth required
7408
+ // http bearer authentication required
7409
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
7410
+ localVarHeaderParameter['Content-Type'] = 'application/json';
7411
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7412
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7413
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
7414
+ localVarRequestOptions.data = serializeDataIfNeeded(planCollisionFreeRequest, localVarRequestOptions, configuration);
7415
+ return {
7416
+ url: toPathString(localVarUrlObj),
7417
+ options: localVarRequestOptions,
7418
+ };
7419
+ },
7355
7420
  /**
7356
7421
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7357
7422
  * @summary Plan Trajectory
@@ -7399,6 +7464,20 @@ export const TrajectoryPlanningApiAxiosParamCreator = function (configuration) {
7399
7464
  export const TrajectoryPlanningApiFp = function (configuration) {
7400
7465
  const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration);
7401
7466
  return {
7467
+ /**
7468
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7469
+ * @summary Plan Collision-Free Trajectory
7470
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7471
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
7472
+ * @param {*} [options] Override http request option.
7473
+ * @throws {RequiredError}
7474
+ */
7475
+ async planCollisionFree(cell, planCollisionFreeRequest, options) {
7476
+ const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
7477
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
7478
+ const localVarOperationServerBasePath = operationServerMap['TrajectoryPlanningApi.planCollisionFree']?.[localVarOperationServerIndex]?.url;
7479
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7480
+ },
7402
7481
  /**
7403
7482
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7404
7483
  * @summary Plan Trajectory
@@ -7422,6 +7501,17 @@ export const TrajectoryPlanningApiFp = function (configuration) {
7422
7501
  export const TrajectoryPlanningApiFactory = function (configuration, basePath, axios) {
7423
7502
  const localVarFp = TrajectoryPlanningApiFp(configuration);
7424
7503
  return {
7504
+ /**
7505
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7506
+ * @summary Plan Collision-Free Trajectory
7507
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7508
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
7509
+ * @param {*} [options] Override http request option.
7510
+ * @throws {RequiredError}
7511
+ */
7512
+ planCollisionFree(cell, planCollisionFreeRequest, options) {
7513
+ return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios, basePath));
7514
+ },
7425
7515
  /**
7426
7516
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7427
7517
  * @summary Plan Trajectory
@@ -7442,6 +7532,18 @@ export const TrajectoryPlanningApiFactory = function (configuration, basePath, a
7442
7532
  * @extends {BaseAPI}
7443
7533
  */
7444
7534
  export class TrajectoryPlanningApi extends BaseAPI {
7535
+ /**
7536
+ * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
7537
+ * @summary Plan Collision-Free Trajectory
7538
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7539
+ * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
7540
+ * @param {*} [options] Override http request option.
7541
+ * @throws {RequiredError}
7542
+ * @memberof TrajectoryPlanningApi
7543
+ */
7544
+ planCollisionFree(cell, planCollisionFreeRequest, options) {
7545
+ return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
7546
+ }
7445
7547
  /**
7446
7548
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. EXCEPTION: If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
7447
7549
  * @summary Plan Trajectory