@wandelbots/nova-api 25.5.0-dev.9 → 25.5.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.ts CHANGED
@@ -207,7 +207,7 @@ export interface AllJointPositionsResponse {
207
207
  */
208
208
  export interface App {
209
209
  /**
210
- * The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name).
210
+ * The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name). It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
211
211
  * @type {string}
212
212
  * @memberof App
213
213
  */
@@ -249,118 +249,6 @@ export interface App {
249
249
  */
250
250
  'health_path'?: string;
251
251
  }
252
- /**
253
- *
254
- * @export
255
- * @interface ArrayInput
256
- */
257
- export interface ArrayInput {
258
- /**
259
- *
260
- * @type {Array<ArrayInputArrayInner>}
261
- * @memberof ArrayInput
262
- */
263
- 'array': Array<ArrayInputArrayInner>;
264
- }
265
- /**
266
- *
267
- * @export
268
- * @interface ArrayInputArrayInner
269
- */
270
- export interface ArrayInputArrayInner {
271
- /**
272
- *
273
- * @type {Array<any>}
274
- * @memberof ArrayInputArrayInner
275
- */
276
- 'pose': Array<any>;
277
- /**
278
- *
279
- * @type {Array<any>}
280
- * @memberof ArrayInputArrayInner
281
- */
282
- 'position': Array<any>;
283
- /**
284
- *
285
- * @type {Array<any>}
286
- * @memberof ArrayInputArrayInner
287
- */
288
- 'orientation': Array<any>;
289
- /**
290
- *
291
- * @type {string}
292
- * @memberof ArrayInputArrayInner
293
- */
294
- 'image': string;
295
- /**
296
- *
297
- * @type {string}
298
- * @memberof ArrayInputArrayInner
299
- */
300
- 'pointcloud': string;
301
- /**
302
- *
303
- * @type {Array<ArrayInputArrayInner>}
304
- * @memberof ArrayInputArrayInner
305
- */
306
- 'array': Array<ArrayInputArrayInner>;
307
- }
308
- /**
309
- *
310
- * @export
311
- * @interface ArrayOutput
312
- */
313
- export interface ArrayOutput {
314
- /**
315
- *
316
- * @type {Array<ArrayOutputArrayInner>}
317
- * @memberof ArrayOutput
318
- */
319
- 'array': Array<ArrayOutputArrayInner>;
320
- }
321
- /**
322
- *
323
- * @export
324
- * @interface ArrayOutputArrayInner
325
- */
326
- export interface ArrayOutputArrayInner {
327
- /**
328
- *
329
- * @type {Array<any>}
330
- * @memberof ArrayOutputArrayInner
331
- */
332
- 'pose': Array<any>;
333
- /**
334
- *
335
- * @type {Array<any>}
336
- * @memberof ArrayOutputArrayInner
337
- */
338
- 'position': Array<any>;
339
- /**
340
- *
341
- * @type {Array<any>}
342
- * @memberof ArrayOutputArrayInner
343
- */
344
- 'orientation': Array<any>;
345
- /**
346
- *
347
- * @type {string}
348
- * @memberof ArrayOutputArrayInner
349
- */
350
- 'image': string;
351
- /**
352
- *
353
- * @type {string}
354
- * @memberof ArrayOutputArrayInner
355
- */
356
- 'pointcloud': string;
357
- /**
358
- *
359
- * @type {Array<ArrayOutputArrayInner>}
360
- * @memberof ArrayOutputArrayInner
361
- */
362
- 'array': Array<ArrayOutputArrayInner>;
363
- }
364
252
  /**
365
253
  * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
366
254
  * @export
@@ -594,19 +482,6 @@ export const Capsule2ShapeTypeEnum = {
594
482
 
595
483
  export type Capsule2ShapeTypeEnum = typeof Capsule2ShapeTypeEnum[keyof typeof Capsule2ShapeTypeEnum];
596
484
 
597
- /**
598
- *
599
- * @export
600
- * @interface Capture
601
- */
602
- export interface Capture {
603
- /**
604
- *
605
- * @type {string}
606
- * @memberof Capture
607
- */
608
- 'image': string;
609
- }
610
485
  /**
611
486
  * To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
612
487
  * @export
@@ -638,25 +513,6 @@ export interface Cell {
638
513
  */
639
514
  'apps'?: Array<App>;
640
515
  }
641
- /**
642
- *
643
- * @export
644
- * @interface CodeWithArguments
645
- */
646
- export interface CodeWithArguments {
647
- /**
648
- * Wandelscript code string which describes a Wandelscript Program as content/json.
649
- * @type {string}
650
- * @memberof CodeWithArguments
651
- */
652
- 'code': string;
653
- /**
654
- *
655
- * @type {{ [key: string]: ArrayInputArrayInner; }}
656
- * @memberof CodeWithArguments
657
- */
658
- 'initial_state'?: { [key: string]: ArrayInputArrayInner; } | null;
659
- }
660
516
  /**
661
517
  * Defines a collider with a single shape. A collider is an object that is used for collision detection. It defines the `shape` that is attached with the offset of `pose` to a reference frame. Use colliders to: - Define the shape of a workpiece. The reference frame is the scene origin. - Define the shape of a link in a motion group. The reference frame is the link coordinate system. - Define the shape of a tool. The reference frame is the flange coordinate system.
662
518
  * @export
@@ -1150,7 +1006,7 @@ export interface CoordinateSystem {
1150
1006
  * @type {string}
1151
1007
  * @memberof CoordinateSystem
1152
1008
  */
1153
- 'reference_uid'?: string;
1009
+ 'reference_coordinate_system'?: string;
1154
1010
  /**
1155
1011
  * A three-dimensional vector [x, y, z] with double precision.
1156
1012
  * @type {Array<number>}
@@ -1188,26 +1044,26 @@ export interface CoordinateSystems {
1188
1044
  /**
1189
1045
  *
1190
1046
  * @export
1191
- * @interface CreateProgramRun200Response
1047
+ * @interface CreateProgramOperatorRun200Response
1192
1048
  */
1193
- export interface CreateProgramRun200Response {
1049
+ export interface CreateProgramOperatorRun200Response {
1194
1050
  /**
1195
1051
  * The identifier of the program run for further inspection of the running program.
1196
1052
  * @type {string}
1197
- * @memberof CreateProgramRun200Response
1053
+ * @memberof CreateProgramOperatorRun200Response
1198
1054
  */
1199
1055
  'id'?: string;
1200
1056
  }
1201
1057
  /**
1202
1058
  *
1203
1059
  * @export
1204
- * @interface CreateProgramRunRequest
1060
+ * @interface CreateProgramOperatorRunRequest
1205
1061
  */
1206
- export interface CreateProgramRunRequest {
1062
+ export interface CreateProgramOperatorRunRequest {
1207
1063
  /**
1208
1064
  * The identifier of the program stored in the program library.
1209
1065
  * @type {string}
1210
- * @memberof CreateProgramRunRequest
1066
+ * @memberof CreateProgramOperatorRunRequest
1211
1067
  */
1212
1068
  'program_id': string;
1213
1069
  }
@@ -1250,19 +1106,13 @@ export interface CreateTriggerRequest {
1250
1106
  'type': TriggerType;
1251
1107
  /**
1252
1108
  *
1253
- * @type {CreateTriggerRequestConfig}
1109
+ * @type {OpcuaNodeValueTriggerConfig}
1254
1110
  * @memberof CreateTriggerRequest
1255
1111
  */
1256
- 'config'?: CreateTriggerRequestConfig;
1112
+ 'config'?: OpcuaNodeValueTriggerConfig;
1257
1113
  }
1258
1114
 
1259
1115
 
1260
- /**
1261
- * @type CreateTriggerRequestConfig
1262
- * @export
1263
- */
1264
- export type CreateTriggerRequestConfig = OpcuaNodeValueTriggerConfig;
1265
-
1266
1116
  /**
1267
1117
  *
1268
1118
  * @export
@@ -1434,31 +1284,6 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
1434
1284
  */
1435
1285
  export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
1436
1286
 
1437
- /**
1438
- * The ExecutionResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
1439
- * @export
1440
- * @interface ExecutionResult
1441
- */
1442
- export interface ExecutionResult {
1443
- /**
1444
- *
1445
- * @type {string}
1446
- * @memberof ExecutionResult
1447
- */
1448
- 'motion_group_id': string;
1449
- /**
1450
- *
1451
- * @type {number}
1452
- * @memberof ExecutionResult
1453
- */
1454
- 'motion_duration': number;
1455
- /**
1456
- *
1457
- * @type {Array<Path>}
1458
- * @memberof ExecutionResult
1459
- */
1460
- 'paths': Array<Path>;
1461
- }
1462
1287
  /**
1463
1288
  * A datapoint inside external joint stream.
1464
1289
  * @export
@@ -1803,13 +1628,13 @@ export interface Geometry {
1803
1628
  /**
1804
1629
  *
1805
1630
  * @export
1806
- * @interface GetAllProgramRuns200Response
1631
+ * @interface GetAllProgramOperatorRuns200Response
1807
1632
  */
1808
- export interface GetAllProgramRuns200Response {
1633
+ export interface GetAllProgramOperatorRuns200Response {
1809
1634
  /**
1810
1635
  *
1811
1636
  * @type {Array<ProgramRunObject>}
1812
- * @memberof GetAllProgramRuns200Response
1637
+ * @memberof GetAllProgramOperatorRuns200Response
1813
1638
  */
1814
1639
  'program_runs'?: Array<ProgramRunObject>;
1815
1640
  }
@@ -1854,6 +1679,19 @@ export interface HTTPValidationError {
1854
1679
  */
1855
1680
  'detail'?: Array<ValidationError>;
1856
1681
  }
1682
+ /**
1683
+ *
1684
+ * @export
1685
+ * @interface HTTPValidationError2
1686
+ */
1687
+ export interface HTTPValidationError2 {
1688
+ /**
1689
+ *
1690
+ * @type {Array<ValidationError2>}
1691
+ * @memberof HTTPValidationError2
1692
+ */
1693
+ 'detail'?: Array<ValidationError2>;
1694
+ }
1857
1695
  /**
1858
1696
  * Input/Output boolean value representation.
1859
1697
  * @export
@@ -2377,6 +2215,50 @@ export interface InvalidDofInvalidDof {
2377
2215
  */
2378
2216
  'joint_position'?: Array<number>;
2379
2217
  }
2218
+ /**
2219
+ *
2220
+ * @export
2221
+ * @interface InverseKinematicsRequest
2222
+ */
2223
+ export interface InverseKinematicsRequest {
2224
+ /**
2225
+ * The robot setup as returned from [getOptimizerConfiguration](getOptimizerConfiguration).
2226
+ * @type {OptimizerSetup}
2227
+ * @memberof InverseKinematicsRequest
2228
+ */
2229
+ 'robot_setup': OptimizerSetup;
2230
+ /**
2231
+ * List of TCP poses for which the inverse solutions are computed.
2232
+ * @type {Array<Pose>}
2233
+ * @memberof InverseKinematicsRequest
2234
+ */
2235
+ 'tcp_poses': Array<Pose>;
2236
+ /**
2237
+ * A collection of identifiable colliders.
2238
+ * @type {{ [key: string]: Collider; }}
2239
+ * @memberof InverseKinematicsRequest
2240
+ */
2241
+ 'static_colliders'?: { [key: string]: Collider; };
2242
+ /**
2243
+ * Collision motion group.
2244
+ * @type {CollisionMotionGroup}
2245
+ * @memberof InverseKinematicsRequest
2246
+ */
2247
+ 'collision_motion_group'?: CollisionMotionGroup;
2248
+ }
2249
+ /**
2250
+ *
2251
+ * @export
2252
+ * @interface InverseKinematicsResponse
2253
+ */
2254
+ export interface InverseKinematicsResponse {
2255
+ /**
2256
+ *
2257
+ * @type {Array<Array<Array<number>>>}
2258
+ * @memberof InverseKinematicsResponse
2259
+ */
2260
+ 'joints': Array<Array<Array<number>>>;
2261
+ }
2380
2262
  /**
2381
2263
  * Response signalling an error during jogging execution. This response is sent in case of an unexpected error, e.g. controller disconnects.
2382
2264
  * @export
@@ -3386,6 +3268,7 @@ export const MotionGroupModel = {
3386
3268
  FanucArcMate50iD: 'FANUC_ARC_Mate_50iD',
3387
3269
  FanucArcMate50iD7L: 'FANUC_ARC_Mate_50iD7L',
3388
3270
  FanucArcMate100iD: 'FANUC_ARC_Mate_100iD',
3271
+ FanucArcMate100iD16S: 'FANUC_ARC_Mate_100iD16S',
3389
3272
  FanucArcMate100iD8L: 'FANUC_ARC_Mate_100iD8L',
3390
3273
  FanucArcMate100iD10L: 'FANUC_ARC_Mate_100iD10L',
3391
3274
  FanucArcMate120iD: 'FANUC_ARC_Mate_120iD',
@@ -3449,12 +3332,14 @@ export const MotionGroupModel = {
3449
3332
  YaskawaTurn1: 'Yaskawa_TURN1',
3450
3333
  YaskawaTurn2: 'Yaskawa_TURN2',
3451
3334
  YaskawaTurn3: 'Yaskawa_TURN3',
3452
- KukaKr1502: 'KUKA_KR150_2',
3335
+ KukaKr150R2: 'KUKA_KR150_R2',
3336
+ KukaKr3R540: 'KUKA_KR3_R540',
3453
3337
  KukaKr4R600: 'KUKA_KR4_R600',
3454
3338
  KukaKr6R700: 'KUKA_KR6_R700',
3455
3339
  KukaKr6R7002: 'KUKA_KR6_R700_2',
3456
3340
  KukaKr6R900: 'KUKA_KR6_R900',
3457
3341
  KukaKr6R9002: 'KUKA_KR6_R900_2',
3342
+ KukaKr6R1820: 'KUKA_KR6_R1820',
3458
3343
  KukaKr10R900: 'KUKA_KR10_R900',
3459
3344
  KukaKr10R9002: 'KUKA_KR10_R900_2',
3460
3345
  KukaKr10R1100: 'KUKA_KR10_R1100',
@@ -3466,6 +3351,7 @@ export const MotionGroupModel = {
3466
3351
  KukaKr16R20102: 'KUKA_KR16_R2010_2',
3467
3352
  KukaKr20R1810: 'KUKA_KR20_R1810',
3468
3353
  KukaKr20R18102: 'KUKA_KR20_R1810_2',
3354
+ KukaKr30R3: 'KUKA_KR30_R3',
3469
3355
  KukaKr50R2500: 'KUKA_KR50_R2500',
3470
3356
  KukaKr120R2700: 'KUKA_KR120_R2700',
3471
3357
  KukaKr120R27002: 'KUKA_KR120_R2700_2',
@@ -3825,12 +3711,12 @@ export interface OpcuaNodeValueTriggerConfig {
3825
3711
  'node_value': OpcuaNodeValueTriggerConfigNodeValue;
3826
3712
  }
3827
3713
  /**
3714
+ * @type OpcuaNodeValueTriggerConfigNodeValue
3828
3715
  * Value to trigger the program when matched.
3829
3716
  * @export
3830
- * @interface OpcuaNodeValueTriggerConfigNodeValue
3831
3717
  */
3832
- export interface OpcuaNodeValueTriggerConfigNodeValue {
3833
- }
3718
+ export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
3719
+
3834
3720
  /**
3835
3721
  * The operating state.
3836
3722
  * @export
@@ -3956,19 +3842,6 @@ export const OrientationType = {
3956
3842
  export type OrientationType = typeof OrientationType[keyof typeof OrientationType];
3957
3843
 
3958
3844
 
3959
- /**
3960
- *
3961
- * @export
3962
- * @interface Path
3963
- */
3964
- export interface Path {
3965
- /**
3966
- *
3967
- * @type {Array<RobotState>}
3968
- * @memberof Path
3969
- */
3970
- 'poses'?: Array<RobotState>;
3971
- }
3972
3845
  /**
3973
3846
  * A cartesian point-to-point is representing a joint point-to-point motion from start point to the indicated target pose. The target pose is a joint point-to-point given in cartesian space. The target joint configuration will be calculated to be in the same kinematic configuration as the start point is. If that is not possible, planning will fail.
3974
3847
  * @export
@@ -4491,19 +4364,6 @@ export interface PlaybackSpeedResponsePlaybackSpeedResponse {
4491
4364
  */
4492
4365
  'requested_value': number;
4493
4366
  }
4494
- /**
4495
- *
4496
- * @export
4497
- * @interface PointCloud
4498
- */
4499
- export interface PointCloud {
4500
- /**
4501
- *
4502
- * @type {string}
4503
- * @memberof PointCloud
4504
- */
4505
- 'pointcloud': string;
4506
- }
4507
4367
  /**
4508
4368
  * Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
4509
4369
  * @export
@@ -4551,69 +4411,100 @@ export interface PoseInCoordinateSystem {
4551
4411
  /**
4552
4412
  *
4553
4413
  * @export
4414
+ * @interface ProgramRequest
4415
+ */
4416
+ export interface ProgramRequest {
4417
+ /**
4418
+ *
4419
+ * @type {string}
4420
+ * @memberof ProgramRequest
4421
+ */
4422
+ 'program': string;
4423
+ /**
4424
+ * Identifier of the default robot to use for execution
4425
+ * @type {string}
4426
+ * @memberof ProgramRequest
4427
+ */
4428
+ 'default_robot'?: string;
4429
+ /**
4430
+ * Identifier of the default TCP to use for execution
4431
+ * @type {string}
4432
+ * @memberof ProgramRequest
4433
+ */
4434
+ 'default_tcp'?: string;
4435
+ /**
4436
+ * Initial arguments that are available within the program
4437
+ * @type {object}
4438
+ * @memberof ProgramRequest
4439
+ */
4440
+ 'run_args'?: object;
4441
+ }
4442
+ /**
4443
+ * Holds the state of a program run.
4444
+ * @export
4554
4445
  * @interface ProgramRun
4555
4446
  */
4556
4447
  export interface ProgramRun {
4557
4448
  /**
4558
- *
4449
+ * Unique identifier of the program run
4559
4450
  * @type {string}
4560
4451
  * @memberof ProgramRun
4561
4452
  */
4562
4453
  'id': string;
4563
4454
  /**
4564
- *
4455
+ * State of the program run
4565
4456
  * @type {ProgramRunState}
4566
4457
  * @memberof ProgramRun
4567
4458
  */
4568
4459
  'state': ProgramRunState;
4569
4460
  /**
4570
- *
4461
+ * Logs of the program run
4571
4462
  * @type {string}
4572
4463
  * @memberof ProgramRun
4573
4464
  */
4574
4465
  'logs'?: string;
4575
4466
  /**
4576
- *
4467
+ * Stdout of the program run
4577
4468
  * @type {string}
4578
4469
  * @memberof ProgramRun
4579
4470
  */
4580
4471
  'stdout'?: string;
4581
4472
  /**
4582
- *
4583
- * @type {{ [key: string]: StoreValue; }}
4473
+ * Stores runtime variables of the run
4474
+ * @type {object}
4584
4475
  * @memberof ProgramRun
4585
4476
  */
4586
- 'store'?: { [key: string]: StoreValue; };
4477
+ 'store'?: object;
4587
4478
  /**
4588
- *
4479
+ * Error message of the program run, if any
4589
4480
  * @type {string}
4590
4481
  * @memberof ProgramRun
4591
4482
  */
4592
- 'error'?: string | null;
4483
+ 'error'?: string;
4593
4484
  /**
4594
- *
4485
+ * Traceback of the program run, if any
4595
4486
  * @type {string}
4596
4487
  * @memberof ProgramRun
4597
4488
  */
4598
- 'traceback'?: string | null;
4489
+ 'traceback'?: string;
4599
4490
  /**
4600
- *
4491
+ * Start time of the program run
4601
4492
  * @type {number}
4602
4493
  * @memberof ProgramRun
4603
4494
  */
4604
- 'start_time'?: number | null;
4495
+ 'start_time'?: number;
4605
4496
  /**
4606
- *
4497
+ * End time of the program run
4607
4498
  * @type {number}
4608
4499
  * @memberof ProgramRun
4609
4500
  */
4610
- 'end_time'?: number | null;
4501
+ 'end_time'?: number;
4611
4502
  /**
4612
- *
4613
- * @type {Array<ExecutionResult>}
4503
+ * Execution results of the program run
4504
+ * @type {Array<ProgramRunResult>}
4614
4505
  * @memberof ProgramRun
4615
4506
  */
4616
- 'execution_results'?: Array<ExecutionResult>;
4507
+ 'execution_results'?: Array<ProgramRunResult>;
4617
4508
  }
4618
4509
 
4619
4510
 
@@ -4663,99 +4554,66 @@ export interface ProgramRunObject {
4663
4554
  /**
4664
4555
  *
4665
4556
  * @export
4666
- * @enum {string}
4667
- */
4668
-
4669
- export const ProgramRunState = {
4670
- NotStarted: 'not started',
4671
- Running: 'running',
4672
- Completed: 'completed',
4673
- Failed: 'failed',
4674
- Stopped: 'stopped'
4675
- } as const;
4676
-
4677
- export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4678
-
4679
-
4680
- /**
4681
- *
4682
- * @export
4683
- * @interface ProgramRunnerReference
4557
+ * @interface ProgramRunReference
4684
4558
  */
4685
- export interface ProgramRunnerReference {
4559
+ export interface ProgramRunReference {
4686
4560
  /**
4687
4561
  *
4688
4562
  * @type {string}
4689
- * @memberof ProgramRunnerReference
4563
+ * @memberof ProgramRunReference
4690
4564
  */
4691
4565
  'id': string;
4692
4566
  /**
4693
4567
  *
4694
4568
  * @type {ProgramRunState}
4695
- * @memberof ProgramRunnerReference
4569
+ * @memberof ProgramRunReference
4696
4570
  */
4697
4571
  'state': ProgramRunState;
4698
4572
  }
4699
4573
 
4700
4574
 
4701
4575
  /**
4702
- * A pose (position and orientation)
4576
+ * The ProgramRunResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
4703
4577
  * @export
4704
- * @interface PyjectoryDatatypesCorePose
4578
+ * @interface ProgramRunResult
4705
4579
  */
4706
- export interface PyjectoryDatatypesCorePose {
4707
- /**
4708
- *
4709
- * @type {Array<any>}
4710
- * @memberof PyjectoryDatatypesCorePose
4711
- */
4712
- 'position': Array<any>;
4580
+ export interface ProgramRunResult {
4713
4581
  /**
4714
- *
4715
- * @type {Array<any>}
4716
- * @memberof PyjectoryDatatypesCorePose
4582
+ * Unique identifier of the motion group that was executed
4583
+ * @type {string}
4584
+ * @memberof ProgramRunResult
4717
4585
  */
4718
- 'orientation': Array<any>;
4719
- }
4720
- /**
4721
- * Rotation vector, defined in [rx, ry, rz] with floating numbers. The rotation is represented in vector3 using an axis-angle representation: axis.normalized * angle (angle in radians). Must be defined for the first pose of a path. If not defined for the rest of the path, the previous orientation will be used.
4722
- * @export
4723
- * @interface PyjectoryDatatypesSerializerOrientation
4724
- */
4725
- export interface PyjectoryDatatypesSerializerOrientation {
4586
+ 'motion_group_id': string;
4726
4587
  /**
4727
- *
4728
- * @type {Array<any>}
4729
- * @memberof PyjectoryDatatypesSerializerOrientation
4588
+ * Total execution duration of the motion group
4589
+ * @type {number}
4590
+ * @memberof ProgramRunResult
4730
4591
  */
4731
- 'orientation': Array<any>;
4732
- }
4733
- /**
4734
- * Object\'s position and orientaton, defined in [x, y, z, rx, ry, rz]. x,y,z are defined in millimeters. rx,ry,rz are defined in radians.
4735
- * @export
4736
- * @interface PyjectoryDatatypesSerializerPose
4737
- */
4738
- export interface PyjectoryDatatypesSerializerPose {
4592
+ 'motion_duration': number;
4739
4593
  /**
4740
- *
4741
- * @type {Array<any>}
4742
- * @memberof PyjectoryDatatypesSerializerPose
4594
+ * Paths of the motion group as list of Path objects
4595
+ * @type {Array<Array<RobotState>>}
4596
+ * @memberof ProgramRunResult
4743
4597
  */
4744
- 'pose': Array<any>;
4598
+ 'paths': Array<Array<RobotState>>;
4745
4599
  }
4746
4600
  /**
4747
- * Single point, defined in [x, y, z] with floating numbers. Must be defined.
4601
+ *
4748
4602
  * @export
4749
- * @interface PyjectoryDatatypesSerializerPosition
4603
+ * @enum {string}
4750
4604
  */
4751
- export interface PyjectoryDatatypesSerializerPosition {
4752
- /**
4753
- *
4754
- * @type {Array<any>}
4755
- * @memberof PyjectoryDatatypesSerializerPosition
4756
- */
4757
- 'position': Array<any>;
4758
- }
4605
+
4606
+ export const ProgramRunState = {
4607
+ NotStarted: 'not started',
4608
+ Running: 'running',
4609
+ Completed: 'completed',
4610
+ Failed: 'failed',
4611
+ Stopped: 'stopped'
4612
+ } as const;
4613
+
4614
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4615
+
4616
+
4759
4617
  /**
4760
4618
  * Defines an x-y plane with finite size.
4761
4619
  * @export
@@ -4884,44 +4742,6 @@ export const ReleaseChannel = {
4884
4742
  export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
4885
4743
 
4886
4744
 
4887
- /**
4888
- * Wandelscript code string which describes a Program as text/plain
4889
- * @export
4890
- * @interface Request
4891
- */
4892
- export interface Request {
4893
- /**
4894
- * Wandelscript code string which describes a Wandelscript Program as content/json.
4895
- * @type {string}
4896
- * @memberof Request
4897
- */
4898
- 'code': string;
4899
- /**
4900
- *
4901
- * @type {{ [key: string]: ArrayInputArrayInner; }}
4902
- * @memberof Request
4903
- */
4904
- 'initial_state'?: { [key: string]: ArrayInputArrayInner; };
4905
- }
4906
- /**
4907
- * Wandelscript code string which describes a program
4908
- * @export
4909
- * @interface Request1
4910
- */
4911
- export interface Request1 {
4912
- /**
4913
- * Wandelscript code string which describes a Wandelscript Program as content/json.
4914
- * @type {string}
4915
- * @memberof Request1
4916
- */
4917
- 'code': string;
4918
- /**
4919
- *
4920
- * @type {{ [key: string]: ArrayInputArrayInner; }}
4921
- * @memberof Request1
4922
- */
4923
- 'initial_state'?: { [key: string]: ArrayInputArrayInner; };
4924
- }
4925
4745
  /**
4926
4746
  * The configuration of a physical or virtual robot controller.
4927
4747
  * @export
@@ -5012,23 +4832,23 @@ export interface RobotLinkGeometry {
5012
4832
  'geometry': Geometry;
5013
4833
  }
5014
4834
  /**
5015
- * Collection of information on the current state of the robot
4835
+ * Collection of information on the current state of the robot.
5016
4836
  * @export
5017
4837
  * @interface RobotState
5018
4838
  */
5019
4839
  export interface RobotState {
5020
4840
  /**
5021
4841
  *
5022
- * @type {PyjectoryDatatypesCorePose}
4842
+ * @type {Pose}
5023
4843
  * @memberof RobotState
5024
4844
  */
5025
- 'pose': PyjectoryDatatypesCorePose;
4845
+ 'pose': Pose;
5026
4846
  /**
5027
4847
  *
5028
4848
  * @type {Array<number>}
5029
4849
  * @memberof RobotState
5030
4850
  */
5031
- 'joints'?: Array<number> | null;
4851
+ 'joints'?: Array<number>;
5032
4852
  }
5033
4853
  /**
5034
4854
  * 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.
@@ -5306,6 +5126,22 @@ export interface SafetyZoneLimits {
5306
5126
  */
5307
5127
  'limits': PlanningLimits;
5308
5128
  }
5129
+ /**
5130
+ *
5131
+ * @export
5132
+ * @enum {string}
5133
+ */
5134
+
5135
+ export const ServiceGroup = {
5136
+ SystemService: 'SystemService',
5137
+ CellService: 'CellService',
5138
+ RobotController: 'RobotController',
5139
+ App: 'App'
5140
+ } as const;
5141
+
5142
+ export type ServiceGroup = typeof ServiceGroup[keyof typeof ServiceGroup];
5143
+
5144
+
5309
5145
  /**
5310
5146
  *
5311
5147
  * @export
@@ -5318,6 +5154,12 @@ export interface ServiceStatus {
5318
5154
  * @memberof ServiceStatus
5319
5155
  */
5320
5156
  'service': string;
5157
+ /**
5158
+ *
5159
+ * @type {ServiceGroup}
5160
+ * @memberof ServiceStatus
5161
+ */
5162
+ 'group': ServiceGroup;
5321
5163
  /**
5322
5164
  *
5323
5165
  * @type {ServiceStatusStatus}
@@ -5325,6 +5167,8 @@ export interface ServiceStatus {
5325
5167
  */
5326
5168
  'status': ServiceStatusStatus;
5327
5169
  }
5170
+
5171
+
5328
5172
  /**
5329
5173
  *
5330
5174
  * @export
@@ -5636,49 +5480,6 @@ export interface StartOnIO {
5636
5480
  }
5637
5481
 
5638
5482
 
5639
- /**
5640
- *
5641
- * @export
5642
- * @interface StoreValue
5643
- */
5644
- export interface StoreValue {
5645
- /**
5646
- *
5647
- * @type {Array<any>}
5648
- * @memberof StoreValue
5649
- */
5650
- 'pose': Array<any>;
5651
- /**
5652
- *
5653
- * @type {Array<any>}
5654
- * @memberof StoreValue
5655
- */
5656
- 'position': Array<any>;
5657
- /**
5658
- *
5659
- * @type {Array<any>}
5660
- * @memberof StoreValue
5661
- */
5662
- 'orientation': Array<any>;
5663
- /**
5664
- *
5665
- * @type {string}
5666
- * @memberof StoreValue
5667
- */
5668
- 'image': string;
5669
- /**
5670
- *
5671
- * @type {string}
5672
- * @memberof StoreValue
5673
- */
5674
- 'pointcloud': string;
5675
- /**
5676
- *
5677
- * @type {Array<ArrayOutputArrayInner>}
5678
- * @memberof StoreValue
5679
- */
5680
- 'array': Array<ArrayOutputArrayInner>;
5681
- }
5682
5483
  /**
5683
5484
  * Representing a robot pose in operational space aware of a configured TCP.
5684
5485
  * @export
@@ -5855,6 +5656,12 @@ export interface TrajectoryData {
5855
5656
  * @memberof TrajectoryData
5856
5657
  */
5857
5658
  'message_type': TrajectoryDataMessageTypeEnum;
5659
+ /**
5660
+ * Identifier of the motion-group.
5661
+ * @type {string}
5662
+ * @memberof TrajectoryData
5663
+ */
5664
+ 'motion_group'?: string;
5858
5665
  /**
5859
5666
  * The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
5860
5667
  * @type {JointTrajectory}
@@ -5933,10 +5740,10 @@ export interface TriggerObject {
5933
5740
  'type': TriggerType;
5934
5741
  /**
5935
5742
  *
5936
- * @type {CreateTriggerRequestConfig}
5743
+ * @type {OpcuaNodeValueTriggerConfig}
5937
5744
  * @memberof TriggerObject
5938
5745
  */
5939
- 'config': CreateTriggerRequestConfig;
5746
+ 'config': OpcuaNodeValueTriggerConfig;
5940
5747
  /**
5941
5748
  * ISO 8601 date-time format when the trigger was created.
5942
5749
  * @type {string}
@@ -6054,10 +5861,10 @@ export interface UpdateTriggerRequest {
6054
5861
  'enabled'?: boolean;
6055
5862
  /**
6056
5863
  *
6057
- * @type {CreateTriggerRequestConfig}
5864
+ * @type {OpcuaNodeValueTriggerConfig}
6058
5865
  * @memberof UpdateTriggerRequest
6059
5866
  */
6060
- 'config'?: CreateTriggerRequestConfig;
5867
+ 'config'?: OpcuaNodeValueTriggerConfig;
6061
5868
  }
6062
5869
  /**
6063
5870
  *
@@ -6087,10 +5894,34 @@ export interface ValidationError {
6087
5894
  /**
6088
5895
  *
6089
5896
  * @export
6090
- * @interface ValidationErrorLocInner
5897
+ * @interface ValidationError2
6091
5898
  */
6092
- export interface ValidationErrorLocInner {
5899
+ export interface ValidationError2 {
5900
+ /**
5901
+ *
5902
+ * @type {Array<number>}
5903
+ * @memberof ValidationError2
5904
+ */
5905
+ 'loc': Array<number>;
5906
+ /**
5907
+ *
5908
+ * @type {string}
5909
+ * @memberof ValidationError2
5910
+ */
5911
+ 'msg': string;
5912
+ /**
5913
+ *
5914
+ * @type {string}
5915
+ * @memberof ValidationError2
5916
+ */
5917
+ 'type': string;
6093
5918
  }
5919
+ /**
5920
+ * @type ValidationErrorLocInner
5921
+ * @export
5922
+ */
5923
+ export type ValidationErrorLocInner = number | string;
5924
+
6094
5925
  /**
6095
5926
  * A generic representation of a version number.
6096
5927
  * @export
@@ -6232,6 +6063,7 @@ export const VirtualControllerTypes = {
6232
6063
  AbbIrb460025020: 'abb-irb4600_250_20',
6233
6064
  AbbIrb460025540: 'abb-irb4600_255_40',
6234
6065
  FanucArcMate100iD: 'fanuc-arc_mate_100iD',
6066
+ FanucArcMate100iD16S: 'fanuc-arc_mate_100iD16S',
6235
6067
  FanucArcMate120iD: 'fanuc-arc_mate_120iD',
6236
6068
  FanucArcMate120iD12L: 'fanuc-arc_mate_120iD12L',
6237
6069
  FanucArcMate120iD35: 'fanuc-arc_mate_120iD35',
@@ -6247,6 +6079,7 @@ export const VirtualControllerTypes = {
6247
6079
  FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
6248
6080
  FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
6249
6081
  FanucM10iD12: 'fanuc-m10iD12',
6082
+ FanucM10iD16S: 'fanuc-m10iD16S',
6250
6083
  FanucM20iD25: 'fanuc-m20iD25',
6251
6084
  FanucM20iD35: 'fanuc-m20iD35',
6252
6085
  FanucM900iB280L: 'fanuc-m900iB280L',
@@ -6259,7 +6092,7 @@ export const VirtualControllerTypes = {
6259
6092
  KukaKr10R9002: 'kuka-kr10_r900_2',
6260
6093
  KukaKr120R27002: 'kuka-kr120_r2700_2',
6261
6094
  KukaKr12R18102: 'kuka-kr12_r1810_2',
6262
- KukaKr1502: 'kuka-kr150_2',
6095
+ KukaKr150R2: 'kuka-kr150_r2',
6263
6096
  KukaKr16R16102: 'kuka-kr16_r1610_2',
6264
6097
  KukaKr16R20102: 'kuka-kr16_r2010_2',
6265
6098
  KukaKr20R1810: 'kuka-kr20_r1810',
@@ -6269,10 +6102,13 @@ export const VirtualControllerTypes = {
6269
6102
  KukaKr210R33002: 'kuka-kr210_r3300_2',
6270
6103
  KukaKr240R2700: 'kuka-kr240_r2700',
6271
6104
  KukaKr250R27002: 'kuka-kr250_r2700_2',
6105
+ KukaKr3R540: 'kuka-kr3_r540',
6106
+ KukaKr30R3: 'kuka-kr30_r3',
6272
6107
  KukaKr360L2403: 'kuka-kr360_l240_3',
6273
6108
  KukaKr4R600: 'kuka-kr4_r600',
6274
6109
  KukaKr500L3403: 'kuka-kr500_l340_3',
6275
6110
  KukaKr50R2500: 'kuka-kr50_r2500',
6111
+ KukaKr6R1820: 'kuka-kr6_r1820',
6276
6112
  KukaKr6R7002: 'kuka-kr6_r700_2',
6277
6113
  KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
6278
6114
  KukaKr6R900: 'kuka-kr6_r900',
@@ -6291,11 +6127,21 @@ export const VirtualControllerTypes = {
6291
6127
  YaskawaAr3120: 'yaskawa-ar3120',
6292
6128
  YaskawaAr700: 'yaskawa-ar700',
6293
6129
  YaskawaAr900: 'yaskawa-ar900',
6130
+ YaskawaGp110: 'yaskawa-gp110',
6294
6131
  YaskawaGp12: 'yaskawa-gp12',
6132
+ YaskawaGp180: 'yaskawa-gp180',
6133
+ YaskawaGp180120: 'yaskawa-gp180-120',
6295
6134
  YaskawaGp20hl: 'yaskawa-gp20hl',
6135
+ YaskawaGp215: 'yaskawa-gp215',
6136
+ YaskawaGp225: 'yaskawa-gp225',
6296
6137
  YaskawaGp25: 'yaskawa-gp25',
6138
+ YaskawaGp250: 'yaskawa-gp250',
6297
6139
  YaskawaGp2512: 'yaskawa-gp25_12',
6140
+ YaskawaGp280: 'yaskawa-gp280',
6141
+ YaskawaGp35L: 'yaskawa-gp35L',
6142
+ YaskawaGp400: 'yaskawa-gp400',
6298
6143
  YaskawaGp50: 'yaskawa-gp50',
6144
+ YaskawaGp600: 'yaskawa-gp600',
6299
6145
  YaskawaGp7: 'yaskawa-gp7',
6300
6146
  YaskawaGp8: 'yaskawa-gp8',
6301
6147
  YaskawaGp88: 'yaskawa-gp88',
@@ -9665,6 +9511,129 @@ export class CoordinateSystemsApi extends BaseAPI {
9665
9511
 
9666
9512
 
9667
9513
 
9514
+ /**
9515
+ * InverseKinematicsApi - axios parameter creator
9516
+ * @export
9517
+ */
9518
+ export const InverseKinematicsApiAxiosParamCreator = function (configuration?: Configuration) {
9519
+ return {
9520
+ /**
9521
+ * Returns the reachable joint positions for a list of given poses.
9522
+ * @summary Inverse kinematics
9523
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9524
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
9525
+ * @param {*} [options] Override http request option.
9526
+ * @throws {RequiredError}
9527
+ */
9528
+ inverseKinematics: async (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9529
+ // verify required parameter 'cell' is not null or undefined
9530
+ assertParamExists('inverseKinematics', 'cell', cell)
9531
+ const localVarPath = `/cells/{cell}/kinematic/inverse-kinematics`
9532
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9533
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9534
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9535
+ let baseOptions;
9536
+ if (configuration) {
9537
+ baseOptions = configuration.baseOptions;
9538
+ }
9539
+
9540
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
9541
+ const localVarHeaderParameter = {} as any;
9542
+ const localVarQueryParameter = {} as any;
9543
+
9544
+ // authentication BasicAuth required
9545
+ // http basic authentication required
9546
+ setBasicAuthToObject(localVarRequestOptions, configuration)
9547
+
9548
+ // authentication BearerAuth required
9549
+ // http bearer authentication required
9550
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
9551
+
9552
+
9553
+
9554
+ localVarHeaderParameter['Content-Type'] = 'application/json';
9555
+
9556
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9557
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9558
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9559
+ localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration)
9560
+
9561
+ return {
9562
+ url: toPathString(localVarUrlObj),
9563
+ options: localVarRequestOptions,
9564
+ };
9565
+ },
9566
+ }
9567
+ };
9568
+
9569
+ /**
9570
+ * InverseKinematicsApi - functional programming interface
9571
+ * @export
9572
+ */
9573
+ export const InverseKinematicsApiFp = function(configuration?: Configuration) {
9574
+ const localVarAxiosParamCreator = InverseKinematicsApiAxiosParamCreator(configuration)
9575
+ return {
9576
+ /**
9577
+ * Returns the reachable joint positions for a list of given poses.
9578
+ * @summary Inverse kinematics
9579
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9580
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
9581
+ * @param {*} [options] Override http request option.
9582
+ * @throws {RequiredError}
9583
+ */
9584
+ async inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>> {
9585
+ const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
9586
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9587
+ const localVarOperationServerBasePath = operationServerMap['InverseKinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
9588
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9589
+ },
9590
+ }
9591
+ };
9592
+
9593
+ /**
9594
+ * InverseKinematicsApi - factory interface
9595
+ * @export
9596
+ */
9597
+ export const InverseKinematicsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
9598
+ const localVarFp = InverseKinematicsApiFp(configuration)
9599
+ return {
9600
+ /**
9601
+ * Returns the reachable joint positions for a list of given poses.
9602
+ * @summary Inverse kinematics
9603
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9604
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
9605
+ * @param {*} [options] Override http request option.
9606
+ * @throws {RequiredError}
9607
+ */
9608
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse> {
9609
+ return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
9610
+ },
9611
+ };
9612
+ };
9613
+
9614
+ /**
9615
+ * InverseKinematicsApi - object-oriented interface
9616
+ * @export
9617
+ * @class InverseKinematicsApi
9618
+ * @extends {BaseAPI}
9619
+ */
9620
+ export class InverseKinematicsApi extends BaseAPI {
9621
+ /**
9622
+ * Returns the reachable joint positions for a list of given poses.
9623
+ * @summary Inverse kinematics
9624
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9625
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
9626
+ * @param {*} [options] Override http request option.
9627
+ * @throws {RequiredError}
9628
+ * @memberof InverseKinematicsApi
9629
+ */
9630
+ public inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) {
9631
+ return InverseKinematicsApiFp(this.configuration).inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
9632
+ }
9633
+ }
9634
+
9635
+
9636
+
9668
9637
  /**
9669
9638
  * JoggingApi - axios parameter creator
9670
9639
  * @export
@@ -12012,19 +11981,19 @@ export class MotionGroupKinematicsApi extends BaseAPI {
12012
11981
  export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
12013
11982
  return {
12014
11983
  /**
12015
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
12016
- * @summary Create Program Runner
11984
+ * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
11985
+ * @summary Create program run
12017
11986
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12018
- * @param {Request} request
11987
+ * @param {ProgramRequest} programRequest
12019
11988
  * @param {*} [options] Override http request option.
12020
11989
  * @throws {RequiredError}
12021
11990
  */
12022
- createProgramRunner: async (cell: string, request: Request, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11991
+ createProgramRun: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12023
11992
  // verify required parameter 'cell' is not null or undefined
12024
- assertParamExists('createProgramRunner', 'cell', cell)
12025
- // verify required parameter 'request' is not null or undefined
12026
- assertParamExists('createProgramRunner', 'request', request)
12027
- const localVarPath = `/cells/{cell}/programs/runners`
11993
+ assertParamExists('createProgramRun', 'cell', cell)
11994
+ // verify required parameter 'programRequest' is not null or undefined
11995
+ assertParamExists('createProgramRun', 'programRequest', programRequest)
11996
+ const localVarPath = `/cells/{cell}/programs/runs`
12028
11997
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12029
11998
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12030
11999
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -12047,12 +12016,12 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12047
12016
 
12048
12017
 
12049
12018
 
12050
- localVarHeaderParameter['Content-Type'] = 'text/plain';
12019
+ localVarHeaderParameter['Content-Type'] = 'application/json';
12051
12020
 
12052
12021
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12053
12022
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12054
12023
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12055
- localVarRequestOptions.data = serializeDataIfNeeded(request, localVarRequestOptions, configuration)
12024
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
12056
12025
 
12057
12026
  return {
12058
12027
  url: toPathString(localVarUrlObj),
@@ -12060,18 +12029,18 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12060
12029
  };
12061
12030
  },
12062
12031
  /**
12063
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12064
- * @summary Execute Program
12032
+ * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
12033
+ * @summary Execute program
12065
12034
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12066
- * @param {CodeWithArguments} codeWithArguments
12035
+ * @param {ProgramRequest} programRequest
12067
12036
  * @param {*} [options] Override http request option.
12068
12037
  * @throws {RequiredError}
12069
12038
  */
12070
- executeProgram: async (cell: string, codeWithArguments: CodeWithArguments, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12039
+ executeProgram: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12071
12040
  // verify required parameter 'cell' is not null or undefined
12072
12041
  assertParamExists('executeProgram', 'cell', cell)
12073
- // verify required parameter 'codeWithArguments' is not null or undefined
12074
- assertParamExists('executeProgram', 'codeWithArguments', codeWithArguments)
12042
+ // verify required parameter 'programRequest' is not null or undefined
12043
+ assertParamExists('executeProgram', 'programRequest', programRequest)
12075
12044
  const localVarPath = `/cells/{cell}/programs/execute`
12076
12045
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12077
12046
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -12100,7 +12069,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12100
12069
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12101
12070
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12102
12071
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12103
- localVarRequestOptions.data = serializeDataIfNeeded(codeWithArguments, localVarRequestOptions, configuration)
12072
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
12104
12073
 
12105
12074
  return {
12106
12075
  url: toPathString(localVarUrlObj),
@@ -12108,21 +12077,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12108
12077
  };
12109
12078
  },
12110
12079
  /**
12111
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
12112
- * @summary Get Program Runner
12080
+ * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
12081
+ * @summary Get program run
12113
12082
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12114
- * @param {string} runner
12083
+ * @param {string} run
12115
12084
  * @param {*} [options] Override http request option.
12116
12085
  * @throws {RequiredError}
12117
12086
  */
12118
- getProgramRunner: async (cell: string, runner: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12087
+ getProgramRun: async (cell: string, run: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12119
12088
  // verify required parameter 'cell' is not null or undefined
12120
- assertParamExists('getProgramRunner', 'cell', cell)
12121
- // verify required parameter 'runner' is not null or undefined
12122
- assertParamExists('getProgramRunner', 'runner', runner)
12123
- const localVarPath = `/cells/{cell}/programs/runners/{runner}`
12089
+ assertParamExists('getProgramRun', 'cell', cell)
12090
+ // verify required parameter 'run' is not null or undefined
12091
+ assertParamExists('getProgramRun', 'run', run)
12092
+ const localVarPath = `/cells/{cell}/programs/runs/{run}`
12124
12093
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12125
- .replace(`{${"runner"}}`, encodeURIComponent(String(runner)));
12094
+ .replace(`{${"run"}}`, encodeURIComponent(String(run)));
12126
12095
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12127
12096
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12128
12097
  let baseOptions;
@@ -12154,16 +12123,16 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12154
12123
  };
12155
12124
  },
12156
12125
  /**
12157
- * Get details about all existing program runners.
12158
- * @summary List Program Runners
12126
+ * Get details about all existing runs
12127
+ * @summary List programs
12159
12128
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12160
12129
  * @param {*} [options] Override http request option.
12161
12130
  * @throws {RequiredError}
12162
12131
  */
12163
- listProgramRunners: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12132
+ getProgramRuns: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12164
12133
  // verify required parameter 'cell' is not null or undefined
12165
- assertParamExists('listProgramRunners', 'cell', cell)
12166
- const localVarPath = `/cells/{cell}/programs/runners`
12134
+ assertParamExists('getProgramRuns', 'cell', cell)
12135
+ const localVarPath = `/cells/{cell}/programs/runs`
12167
12136
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12168
12137
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12169
12138
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -12196,19 +12165,19 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12196
12165
  };
12197
12166
  },
12198
12167
  /**
12199
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
12200
- * @summary Migrate Program
12168
+ * Simulate a program given as text/plain
12169
+ * @summary Simulate program
12201
12170
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12202
- * @param {Request1} request1
12171
+ * @param {ProgramRequest} programRequest
12203
12172
  * @param {*} [options] Override http request option.
12204
12173
  * @throws {RequiredError}
12205
12174
  */
12206
- migrateProgram: async (cell: string, request1: Request1, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12175
+ simulateProgram: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12207
12176
  // verify required parameter 'cell' is not null or undefined
12208
- assertParamExists('migrateProgram', 'cell', cell)
12209
- // verify required parameter 'request1' is not null or undefined
12210
- assertParamExists('migrateProgram', 'request1', request1)
12211
- const localVarPath = `/cells/{cell}/programs/migrate`
12177
+ assertParamExists('simulateProgram', 'cell', cell)
12178
+ // verify required parameter 'programRequest' is not null or undefined
12179
+ assertParamExists('simulateProgram', 'programRequest', programRequest)
12180
+ const localVarPath = `/cells/{cell}/programs/simulate`
12212
12181
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12213
12182
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12214
12183
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -12231,12 +12200,12 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12231
12200
 
12232
12201
 
12233
12202
 
12234
- localVarHeaderParameter['Content-Type'] = 'text/plain';
12203
+ localVarHeaderParameter['Content-Type'] = 'application/json';
12235
12204
 
12236
12205
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12237
12206
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12238
12207
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12239
- localVarRequestOptions.data = serializeDataIfNeeded(request1, localVarRequestOptions, configuration)
12208
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
12240
12209
 
12241
12210
  return {
12242
12211
  url: toPathString(localVarUrlObj),
@@ -12244,20 +12213,16 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12244
12213
  };
12245
12214
  },
12246
12215
  /**
12247
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12248
- * @summary Plan Program
12216
+ * Stop all runs
12217
+ * @summary Stop all programs
12249
12218
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12250
- * @param {Request} request
12251
- * @param {string} [identifier]
12252
12219
  * @param {*} [options] Override http request option.
12253
12220
  * @throws {RequiredError}
12254
12221
  */
12255
- planProgram: async (cell: string, request: Request, identifier?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12222
+ stopAllPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12256
12223
  // verify required parameter 'cell' is not null or undefined
12257
- assertParamExists('planProgram', 'cell', cell)
12258
- // verify required parameter 'request' is not null or undefined
12259
- assertParamExists('planProgram', 'request', request)
12260
- const localVarPath = `/cells/{cell}/programs/plan`
12224
+ assertParamExists('stopAllPrograms', 'cell', cell)
12225
+ const localVarPath = `/cells/{cell}/programs/runs/stop`
12261
12226
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12262
12227
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12263
12228
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -12278,18 +12243,11 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12278
12243
  // http bearer authentication required
12279
12244
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
12280
12245
 
12281
- if (identifier !== undefined) {
12282
- localVarQueryParameter['identifier'] = identifier;
12283
- }
12284
-
12285
12246
 
12286
12247
 
12287
- localVarHeaderParameter['Content-Type'] = 'text/plain';
12288
-
12289
12248
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12290
12249
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12291
12250
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12292
- localVarRequestOptions.data = serializeDataIfNeeded(request, localVarRequestOptions, configuration)
12293
12251
 
12294
12252
  return {
12295
12253
  url: toPathString(localVarUrlObj),
@@ -12297,17 +12255,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12297
12255
  };
12298
12256
  },
12299
12257
  /**
12300
- * Stop all runners.
12301
- * @summary Stop All Program Runners
12258
+ * Stop a specific program run.
12259
+ * @summary Stop program run
12302
12260
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12261
+ * @param {string} run
12303
12262
  * @param {*} [options] Override http request option.
12304
12263
  * @throws {RequiredError}
12305
12264
  */
12306
- stopAllProgramRunner: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12265
+ stopProgramRun: async (cell: string, run: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12307
12266
  // verify required parameter 'cell' is not null or undefined
12308
- assertParamExists('stopAllProgramRunner', 'cell', cell)
12309
- const localVarPath = `/cells/{cell}/programs/runners/stop`
12310
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12267
+ assertParamExists('stopProgramRun', 'cell', cell)
12268
+ // verify required parameter 'run' is not null or undefined
12269
+ assertParamExists('stopProgramRun', 'run', run)
12270
+ const localVarPath = `/cells/{cell}/programs/runs/{run}/stop`
12271
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12272
+ .replace(`{${"run"}}`, encodeURIComponent(String(run)));
12311
12273
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12312
12274
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12313
12275
  let baseOptions;
@@ -12339,21 +12301,20 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12339
12301
  };
12340
12302
  },
12341
12303
  /**
12342
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
12343
- * @summary Stop Program Runner
12304
+ * Validate a program
12305
+ * @summary Validate program
12344
12306
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12345
- * @param {string} runner
12307
+ * @param {ProgramRequest} programRequest
12346
12308
  * @param {*} [options] Override http request option.
12347
12309
  * @throws {RequiredError}
12348
12310
  */
12349
- stopProgramRunner: async (cell: string, runner: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12311
+ validateProgram: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12350
12312
  // verify required parameter 'cell' is not null or undefined
12351
- assertParamExists('stopProgramRunner', 'cell', cell)
12352
- // verify required parameter 'runner' is not null or undefined
12353
- assertParamExists('stopProgramRunner', 'runner', runner)
12354
- const localVarPath = `/cells/{cell}/programs/runners/{runner}/stop`
12355
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
12356
- .replace(`{${"runner"}}`, encodeURIComponent(String(runner)));
12313
+ assertParamExists('validateProgram', 'cell', cell)
12314
+ // verify required parameter 'programRequest' is not null or undefined
12315
+ assertParamExists('validateProgram', 'programRequest', programRequest)
12316
+ const localVarPath = `/cells/{cell}/programs/validate`
12317
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12357
12318
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
12358
12319
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
12359
12320
  let baseOptions;
@@ -12375,9 +12336,12 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
12375
12336
 
12376
12337
 
12377
12338
 
12339
+ localVarHeaderParameter['Content-Type'] = 'application/json';
12340
+
12378
12341
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12379
12342
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12380
12343
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12344
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
12381
12345
 
12382
12346
  return {
12383
12347
  url: toPathString(localVarUrlObj),
@@ -12395,114 +12359,113 @@ export const ProgramApiFp = function(configuration?: Configuration) {
12395
12359
  const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
12396
12360
  return {
12397
12361
  /**
12398
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
12399
- * @summary Create Program Runner
12362
+ * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
12363
+ * @summary Create program run
12400
12364
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12401
- * @param {Request} request
12365
+ * @param {ProgramRequest} programRequest
12402
12366
  * @param {*} [options] Override http request option.
12403
12367
  * @throws {RequiredError}
12404
12368
  */
12405
- async createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunnerReference>> {
12406
- const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRunner(cell, request, options);
12369
+ async createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>> {
12370
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRun(cell, programRequest, options);
12407
12371
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12408
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.createProgramRunner']?.[localVarOperationServerIndex]?.url;
12372
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.createProgramRun']?.[localVarOperationServerIndex]?.url;
12409
12373
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12410
12374
  },
12411
12375
  /**
12412
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12413
- * @summary Execute Program
12376
+ * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
12377
+ * @summary Execute program
12414
12378
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12415
- * @param {CodeWithArguments} codeWithArguments
12379
+ * @param {ProgramRequest} programRequest
12416
12380
  * @param {*} [options] Override http request option.
12417
12381
  * @throws {RequiredError}
12418
12382
  */
12419
- async executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
12420
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell, codeWithArguments, options);
12383
+ async executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
12384
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell, programRequest, options);
12421
12385
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12422
12386
  const localVarOperationServerBasePath = operationServerMap['ProgramApi.executeProgram']?.[localVarOperationServerIndex]?.url;
12423
12387
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12424
12388
  },
12425
12389
  /**
12426
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
12427
- * @summary Get Program Runner
12390
+ * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
12391
+ * @summary Get program run
12428
12392
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12429
- * @param {string} runner
12393
+ * @param {string} run
12430
12394
  * @param {*} [options] Override http request option.
12431
12395
  * @throws {RequiredError}
12432
12396
  */
12433
- async getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
12434
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRunner(cell, runner, options);
12397
+ async getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
12398
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRun(cell, run, options);
12435
12399
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12436
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRunner']?.[localVarOperationServerIndex]?.url;
12400
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRun']?.[localVarOperationServerIndex]?.url;
12437
12401
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12438
12402
  },
12439
12403
  /**
12440
- * Get details about all existing program runners.
12441
- * @summary List Program Runners
12404
+ * Get details about all existing runs
12405
+ * @summary List programs
12442
12406
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12443
12407
  * @param {*} [options] Override http request option.
12444
12408
  * @throws {RequiredError}
12445
12409
  */
12446
- async listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunnerReference>>> {
12447
- const localVarAxiosArgs = await localVarAxiosParamCreator.listProgramRunners(cell, options);
12410
+ async getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>> {
12411
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRuns(cell, options);
12448
12412
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12449
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.listProgramRunners']?.[localVarOperationServerIndex]?.url;
12413
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRuns']?.[localVarOperationServerIndex]?.url;
12450
12414
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12451
12415
  },
12452
12416
  /**
12453
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
12454
- * @summary Migrate Program
12417
+ * Simulate a program given as text/plain
12418
+ * @summary Simulate program
12455
12419
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12456
- * @param {Request1} request1
12420
+ * @param {ProgramRequest} programRequest
12457
12421
  * @param {*} [options] Override http request option.
12458
12422
  * @throws {RequiredError}
12459
12423
  */
12460
- async migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
12461
- const localVarAxiosArgs = await localVarAxiosParamCreator.migrateProgram(cell, request1, options);
12424
+ async simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
12425
+ const localVarAxiosArgs = await localVarAxiosParamCreator.simulateProgram(cell, programRequest, options);
12462
12426
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12463
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.migrateProgram']?.[localVarOperationServerIndex]?.url;
12427
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.simulateProgram']?.[localVarOperationServerIndex]?.url;
12464
12428
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12465
12429
  },
12466
12430
  /**
12467
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12468
- * @summary Plan Program
12431
+ * Stop all runs
12432
+ * @summary Stop all programs
12469
12433
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12470
- * @param {Request} request
12471
- * @param {string} [identifier]
12472
12434
  * @param {*} [options] Override http request option.
12473
12435
  * @throws {RequiredError}
12474
12436
  */
12475
- async planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
12476
- const localVarAxiosArgs = await localVarAxiosParamCreator.planProgram(cell, request, identifier, options);
12437
+ async stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12438
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllPrograms(cell, options);
12477
12439
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12478
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.planProgram']?.[localVarOperationServerIndex]?.url;
12440
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllPrograms']?.[localVarOperationServerIndex]?.url;
12479
12441
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12480
12442
  },
12481
12443
  /**
12482
- * Stop all runners.
12483
- * @summary Stop All Program Runners
12444
+ * Stop a specific program run.
12445
+ * @summary Stop program run
12484
12446
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12447
+ * @param {string} run
12485
12448
  * @param {*} [options] Override http request option.
12486
12449
  * @throws {RequiredError}
12487
12450
  */
12488
- async stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
12489
- const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllProgramRunner(cell, options);
12451
+ async stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12452
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgramRun(cell, run, options);
12490
12453
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12491
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllProgramRunner']?.[localVarOperationServerIndex]?.url;
12454
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgramRun']?.[localVarOperationServerIndex]?.url;
12492
12455
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12493
12456
  },
12494
12457
  /**
12495
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
12496
- * @summary Stop Program Runner
12458
+ * Validate a program
12459
+ * @summary Validate program
12497
12460
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12498
- * @param {string} runner
12461
+ * @param {ProgramRequest} programRequest
12499
12462
  * @param {*} [options] Override http request option.
12500
12463
  * @throws {RequiredError}
12501
12464
  */
12502
- async stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12503
- const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgramRunner(cell, runner, options);
12465
+ async validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
12466
+ const localVarAxiosArgs = await localVarAxiosParamCreator.validateProgram(cell, programRequest, options);
12504
12467
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
12505
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgramRunner']?.[localVarOperationServerIndex]?.url;
12468
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.validateProgram']?.[localVarOperationServerIndex]?.url;
12506
12469
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12507
12470
  },
12508
12471
  }
@@ -12516,91 +12479,90 @@ export const ProgramApiFactory = function (configuration?: Configuration, basePa
12516
12479
  const localVarFp = ProgramApiFp(configuration)
12517
12480
  return {
12518
12481
  /**
12519
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
12520
- * @summary Create Program Runner
12482
+ * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
12483
+ * @summary Create program run
12521
12484
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12522
- * @param {Request} request
12485
+ * @param {ProgramRequest} programRequest
12523
12486
  * @param {*} [options] Override http request option.
12524
12487
  * @throws {RequiredError}
12525
12488
  */
12526
- createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunnerReference> {
12527
- return localVarFp.createProgramRunner(cell, request, options).then((request) => request(axios, basePath));
12489
+ createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference> {
12490
+ return localVarFp.createProgramRun(cell, programRequest, options).then((request) => request(axios, basePath));
12528
12491
  },
12529
12492
  /**
12530
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12531
- * @summary Execute Program
12493
+ * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
12494
+ * @summary Execute program
12532
12495
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12533
- * @param {CodeWithArguments} codeWithArguments
12496
+ * @param {ProgramRequest} programRequest
12534
12497
  * @param {*} [options] Override http request option.
12535
12498
  * @throws {RequiredError}
12536
12499
  */
12537
- executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
12538
- return localVarFp.executeProgram(cell, codeWithArguments, options).then((request) => request(axios, basePath));
12500
+ executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
12501
+ return localVarFp.executeProgram(cell, programRequest, options).then((request) => request(axios, basePath));
12539
12502
  },
12540
12503
  /**
12541
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
12542
- * @summary Get Program Runner
12504
+ * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
12505
+ * @summary Get program run
12543
12506
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12544
- * @param {string} runner
12507
+ * @param {string} run
12545
12508
  * @param {*} [options] Override http request option.
12546
12509
  * @throws {RequiredError}
12547
12510
  */
12548
- getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
12549
- return localVarFp.getProgramRunner(cell, runner, options).then((request) => request(axios, basePath));
12511
+ getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
12512
+ return localVarFp.getProgramRun(cell, run, options).then((request) => request(axios, basePath));
12550
12513
  },
12551
12514
  /**
12552
- * Get details about all existing program runners.
12553
- * @summary List Program Runners
12515
+ * Get details about all existing runs
12516
+ * @summary List programs
12554
12517
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12555
12518
  * @param {*} [options] Override http request option.
12556
12519
  * @throws {RequiredError}
12557
12520
  */
12558
- listProgramRunners(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunnerReference>> {
12559
- return localVarFp.listProgramRunners(cell, options).then((request) => request(axios, basePath));
12521
+ getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>> {
12522
+ return localVarFp.getProgramRuns(cell, options).then((request) => request(axios, basePath));
12560
12523
  },
12561
12524
  /**
12562
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
12563
- * @summary Migrate Program
12525
+ * Simulate a program given as text/plain
12526
+ * @summary Simulate program
12564
12527
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12565
- * @param {Request1} request1
12528
+ * @param {ProgramRequest} programRequest
12566
12529
  * @param {*} [options] Override http request option.
12567
12530
  * @throws {RequiredError}
12568
12531
  */
12569
- migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): AxiosPromise<string> {
12570
- return localVarFp.migrateProgram(cell, request1, options).then((request) => request(axios, basePath));
12532
+ simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
12533
+ return localVarFp.simulateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
12571
12534
  },
12572
12535
  /**
12573
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12574
- * @summary Plan Program
12536
+ * Stop all runs
12537
+ * @summary Stop all programs
12575
12538
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12576
- * @param {Request} request
12577
- * @param {string} [identifier]
12578
12539
  * @param {*} [options] Override http request option.
12579
12540
  * @throws {RequiredError}
12580
12541
  */
12581
- planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
12582
- return localVarFp.planProgram(cell, request, identifier, options).then((request) => request(axios, basePath));
12542
+ stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12543
+ return localVarFp.stopAllPrograms(cell, options).then((request) => request(axios, basePath));
12583
12544
  },
12584
12545
  /**
12585
- * Stop all runners.
12586
- * @summary Stop All Program Runners
12546
+ * Stop a specific program run.
12547
+ * @summary Stop program run
12587
12548
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12549
+ * @param {string} run
12588
12550
  * @param {*} [options] Override http request option.
12589
12551
  * @throws {RequiredError}
12590
12552
  */
12591
- stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<any> {
12592
- return localVarFp.stopAllProgramRunner(cell, options).then((request) => request(axios, basePath));
12553
+ stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12554
+ return localVarFp.stopProgramRun(cell, run, options).then((request) => request(axios, basePath));
12593
12555
  },
12594
12556
  /**
12595
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
12596
- * @summary Stop Program Runner
12557
+ * Validate a program
12558
+ * @summary Validate program
12597
12559
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12598
- * @param {string} runner
12560
+ * @param {ProgramRequest} programRequest
12599
12561
  * @param {*} [options] Override http request option.
12600
12562
  * @throws {RequiredError}
12601
12563
  */
12602
- stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12603
- return localVarFp.stopProgramRunner(cell, runner, options).then((request) => request(axios, basePath));
12564
+ validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12565
+ return localVarFp.validateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
12604
12566
  },
12605
12567
  };
12606
12568
  };
@@ -12613,106 +12575,105 @@ export const ProgramApiFactory = function (configuration?: Configuration, basePa
12613
12575
  */
12614
12576
  export class ProgramApi extends BaseAPI {
12615
12577
  /**
12616
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
12617
- * @summary Create Program Runner
12578
+ * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
12579
+ * @summary Create program run
12618
12580
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12619
- * @param {Request} request
12581
+ * @param {ProgramRequest} programRequest
12620
12582
  * @param {*} [options] Override http request option.
12621
12583
  * @throws {RequiredError}
12622
12584
  * @memberof ProgramApi
12623
12585
  */
12624
- public createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig) {
12625
- return ProgramApiFp(this.configuration).createProgramRunner(cell, request, options).then((request) => request(this.axios, this.basePath));
12586
+ public createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
12587
+ return ProgramApiFp(this.configuration).createProgramRun(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
12626
12588
  }
12627
12589
 
12628
12590
  /**
12629
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12630
- * @summary Execute Program
12591
+ * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
12592
+ * @summary Execute program
12631
12593
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12632
- * @param {CodeWithArguments} codeWithArguments
12594
+ * @param {ProgramRequest} programRequest
12633
12595
  * @param {*} [options] Override http request option.
12634
12596
  * @throws {RequiredError}
12635
12597
  * @memberof ProgramApi
12636
12598
  */
12637
- public executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig) {
12638
- return ProgramApiFp(this.configuration).executeProgram(cell, codeWithArguments, options).then((request) => request(this.axios, this.basePath));
12599
+ public executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
12600
+ return ProgramApiFp(this.configuration).executeProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
12639
12601
  }
12640
12602
 
12641
12603
  /**
12642
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
12643
- * @summary Get Program Runner
12604
+ * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
12605
+ * @summary Get program run
12644
12606
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12645
- * @param {string} runner
12607
+ * @param {string} run
12646
12608
  * @param {*} [options] Override http request option.
12647
12609
  * @throws {RequiredError}
12648
12610
  * @memberof ProgramApi
12649
12611
  */
12650
- public getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig) {
12651
- return ProgramApiFp(this.configuration).getProgramRunner(cell, runner, options).then((request) => request(this.axios, this.basePath));
12612
+ public getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig) {
12613
+ return ProgramApiFp(this.configuration).getProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
12652
12614
  }
12653
12615
 
12654
12616
  /**
12655
- * Get details about all existing program runners.
12656
- * @summary List Program Runners
12617
+ * Get details about all existing runs
12618
+ * @summary List programs
12657
12619
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12658
12620
  * @param {*} [options] Override http request option.
12659
12621
  * @throws {RequiredError}
12660
12622
  * @memberof ProgramApi
12661
12623
  */
12662
- public listProgramRunners(cell: string, options?: RawAxiosRequestConfig) {
12663
- return ProgramApiFp(this.configuration).listProgramRunners(cell, options).then((request) => request(this.axios, this.basePath));
12624
+ public getProgramRuns(cell: string, options?: RawAxiosRequestConfig) {
12625
+ return ProgramApiFp(this.configuration).getProgramRuns(cell, options).then((request) => request(this.axios, this.basePath));
12664
12626
  }
12665
12627
 
12666
12628
  /**
12667
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
12668
- * @summary Migrate Program
12629
+ * Simulate a program given as text/plain
12630
+ * @summary Simulate program
12669
12631
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12670
- * @param {Request1} request1
12632
+ * @param {ProgramRequest} programRequest
12671
12633
  * @param {*} [options] Override http request option.
12672
12634
  * @throws {RequiredError}
12673
12635
  * @memberof ProgramApi
12674
12636
  */
12675
- public migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig) {
12676
- return ProgramApiFp(this.configuration).migrateProgram(cell, request1, options).then((request) => request(this.axios, this.basePath));
12637
+ public simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
12638
+ return ProgramApiFp(this.configuration).simulateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
12677
12639
  }
12678
12640
 
12679
12641
  /**
12680
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
12681
- * @summary Plan Program
12642
+ * Stop all runs
12643
+ * @summary Stop all programs
12682
12644
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12683
- * @param {Request} request
12684
- * @param {string} [identifier]
12685
12645
  * @param {*} [options] Override http request option.
12686
12646
  * @throws {RequiredError}
12687
12647
  * @memberof ProgramApi
12688
12648
  */
12689
- public planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig) {
12690
- return ProgramApiFp(this.configuration).planProgram(cell, request, identifier, options).then((request) => request(this.axios, this.basePath));
12649
+ public stopAllPrograms(cell: string, options?: RawAxiosRequestConfig) {
12650
+ return ProgramApiFp(this.configuration).stopAllPrograms(cell, options).then((request) => request(this.axios, this.basePath));
12691
12651
  }
12692
12652
 
12693
12653
  /**
12694
- * Stop all runners.
12695
- * @summary Stop All Program Runners
12654
+ * Stop a specific program run.
12655
+ * @summary Stop program run
12696
12656
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12657
+ * @param {string} run
12697
12658
  * @param {*} [options] Override http request option.
12698
12659
  * @throws {RequiredError}
12699
12660
  * @memberof ProgramApi
12700
12661
  */
12701
- public stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig) {
12702
- return ProgramApiFp(this.configuration).stopAllProgramRunner(cell, options).then((request) => request(this.axios, this.basePath));
12662
+ public stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig) {
12663
+ return ProgramApiFp(this.configuration).stopProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
12703
12664
  }
12704
12665
 
12705
12666
  /**
12706
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
12707
- * @summary Stop Program Runner
12667
+ * Validate a program
12668
+ * @summary Validate program
12708
12669
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12709
- * @param {string} runner
12670
+ * @param {ProgramRequest} programRequest
12710
12671
  * @param {*} [options] Override http request option.
12711
12672
  * @throws {RequiredError}
12712
12673
  * @memberof ProgramApi
12713
12674
  */
12714
- public stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig) {
12715
- return ProgramApiFp(this.configuration).stopProgramRunner(cell, runner, options).then((request) => request(this.axios, this.basePath));
12675
+ public validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
12676
+ return ProgramApiFp(this.configuration).validateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
12716
12677
  }
12717
12678
  }
12718
12679
 
@@ -12725,18 +12686,18 @@ export class ProgramApi extends BaseAPI {
12725
12686
  export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Configuration) {
12726
12687
  return {
12727
12688
  /**
12728
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
12689
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
12729
12690
  * @summary Run Program from Library
12730
12691
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12731
- * @param {CreateProgramRunRequest} createProgramRunRequest
12692
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
12732
12693
  * @param {*} [options] Override http request option.
12733
12694
  * @throws {RequiredError}
12734
12695
  */
12735
- createProgramRun: async (cell: string, createProgramRunRequest: CreateProgramRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12696
+ createProgramOperatorRun: async (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12736
12697
  // verify required parameter 'cell' is not null or undefined
12737
- assertParamExists('createProgramRun', 'cell', cell)
12738
- // verify required parameter 'createProgramRunRequest' is not null or undefined
12739
- assertParamExists('createProgramRun', 'createProgramRunRequest', createProgramRunRequest)
12698
+ assertParamExists('createProgramOperatorRun', 'cell', cell)
12699
+ // verify required parameter 'createProgramOperatorRunRequest' is not null or undefined
12700
+ assertParamExists('createProgramOperatorRun', 'createProgramOperatorRunRequest', createProgramOperatorRunRequest)
12740
12701
  const localVarPath = `/cells/{cell}/operator/programs/runs`
12741
12702
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12742
12703
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -12765,7 +12726,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
12765
12726
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12766
12727
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12767
12728
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
12768
- localVarRequestOptions.data = serializeDataIfNeeded(createProgramRunRequest, localVarRequestOptions, configuration)
12729
+ localVarRequestOptions.data = serializeDataIfNeeded(createProgramOperatorRunRequest, localVarRequestOptions, configuration)
12769
12730
 
12770
12731
  return {
12771
12732
  url: toPathString(localVarUrlObj),
@@ -12867,16 +12828,16 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
12867
12828
  };
12868
12829
  },
12869
12830
  /**
12870
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
12831
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
12871
12832
  * @summary Get All Program Runs
12872
12833
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12873
12834
  * @param {string} [state]
12874
12835
  * @param {*} [options] Override http request option.
12875
12836
  * @throws {RequiredError}
12876
12837
  */
12877
- getAllProgramRuns: async (cell: string, state?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12838
+ getAllProgramOperatorRuns: async (cell: string, state?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12878
12839
  // verify required parameter 'cell' is not null or undefined
12879
- assertParamExists('getAllProgramRuns', 'cell', cell)
12840
+ assertParamExists('getAllProgramOperatorRuns', 'cell', cell)
12880
12841
  const localVarPath = `/cells/{cell}/operator/programs/runs`
12881
12842
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
12882
12843
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -12914,7 +12875,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
12914
12875
  };
12915
12876
  },
12916
12877
  /**
12917
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
12878
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
12918
12879
  * @summary Get All Triggers
12919
12880
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12920
12881
  * @param {*} [options] Override http request option.
@@ -12956,18 +12917,18 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
12956
12917
  };
12957
12918
  },
12958
12919
  /**
12959
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
12920
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
12960
12921
  * @summary Get Program Run
12961
12922
  * @param {string} run
12962
12923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12963
12924
  * @param {*} [options] Override http request option.
12964
12925
  * @throws {RequiredError}
12965
12926
  */
12966
- getProgramRun: async (run: string, cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12927
+ getProgramOperatorRun: async (run: string, cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
12967
12928
  // verify required parameter 'run' is not null or undefined
12968
- assertParamExists('getProgramRun', 'run', run)
12929
+ assertParamExists('getProgramOperatorRun', 'run', run)
12969
12930
  // verify required parameter 'cell' is not null or undefined
12970
- assertParamExists('getProgramRun', 'cell', cell)
12931
+ assertParamExists('getProgramOperatorRun', 'cell', cell)
12971
12932
  const localVarPath = `/cells/{cell}/operator/programs/runs/{run}`
12972
12933
  .replace(`{${"run"}}`, encodeURIComponent(String(run)))
12973
12934
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
@@ -13050,7 +13011,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
13050
13011
  /**
13051
13012
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
13052
13013
  * @summary Update Trigger
13053
- * @param {string} trigger the id of the trigger
13014
+ * @param {string} trigger The identifier of the trigger.
13054
13015
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13055
13016
  * @param {UpdateTriggerRequest} updateTriggerRequest
13056
13017
  * @param {*} [options] Override http request option.
@@ -13110,17 +13071,17 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
13110
13071
  const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration)
13111
13072
  return {
13112
13073
  /**
13113
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
13074
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
13114
13075
  * @summary Run Program from Library
13115
13076
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13116
- * @param {CreateProgramRunRequest} createProgramRunRequest
13077
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
13117
13078
  * @param {*} [options] Override http request option.
13118
13079
  * @throws {RequiredError}
13119
13080
  */
13120
- async createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramRun200Response>> {
13121
- const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRun(cell, createProgramRunRequest, options);
13081
+ async createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>> {
13082
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options);
13122
13083
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13123
- const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramRun']?.[localVarOperationServerIndex]?.url;
13084
+ const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
13124
13085
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13125
13086
  },
13126
13087
  /**
@@ -13152,21 +13113,21 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
13152
13113
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13153
13114
  },
13154
13115
  /**
13155
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
13116
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
13156
13117
  * @summary Get All Program Runs
13157
13118
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13158
13119
  * @param {string} [state]
13159
13120
  * @param {*} [options] Override http request option.
13160
13121
  * @throws {RequiredError}
13161
13122
  */
13162
- async getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramRuns200Response>> {
13163
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramRuns(cell, state, options);
13123
+ async getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>> {
13124
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramOperatorRuns(cell, state, options);
13164
13125
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13165
- const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramRuns']?.[localVarOperationServerIndex]?.url;
13126
+ const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramOperatorRuns']?.[localVarOperationServerIndex]?.url;
13166
13127
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13167
13128
  },
13168
13129
  /**
13169
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
13130
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
13170
13131
  * @summary Get All Triggers
13171
13132
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13172
13133
  * @param {*} [options] Override http request option.
@@ -13179,17 +13140,17 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
13179
13140
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13180
13141
  },
13181
13142
  /**
13182
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
13143
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
13183
13144
  * @summary Get Program Run
13184
13145
  * @param {string} run
13185
13146
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13186
13147
  * @param {*} [options] Override http request option.
13187
13148
  * @throws {RequiredError}
13188
13149
  */
13189
- async getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>> {
13190
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRun(run, cell, options);
13150
+ async getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>> {
13151
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramOperatorRun(run, cell, options);
13191
13152
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
13192
- const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramRun']?.[localVarOperationServerIndex]?.url;
13153
+ const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
13193
13154
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13194
13155
  },
13195
13156
  /**
@@ -13209,7 +13170,7 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
13209
13170
  /**
13210
13171
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
13211
13172
  * @summary Update Trigger
13212
- * @param {string} trigger the id of the trigger
13173
+ * @param {string} trigger The identifier of the trigger.
13213
13174
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13214
13175
  * @param {UpdateTriggerRequest} updateTriggerRequest
13215
13176
  * @param {*} [options] Override http request option.
@@ -13232,15 +13193,15 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13232
13193
  const localVarFp = ProgramOperatorApiFp(configuration)
13233
13194
  return {
13234
13195
  /**
13235
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
13196
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
13236
13197
  * @summary Run Program from Library
13237
13198
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13238
- * @param {CreateProgramRunRequest} createProgramRunRequest
13199
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
13239
13200
  * @param {*} [options] Override http request option.
13240
13201
  * @throws {RequiredError}
13241
13202
  */
13242
- createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramRun200Response> {
13243
- return localVarFp.createProgramRun(cell, createProgramRunRequest, options).then((request) => request(axios, basePath));
13203
+ createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response> {
13204
+ return localVarFp.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(axios, basePath));
13244
13205
  },
13245
13206
  /**
13246
13207
  * <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
@@ -13265,18 +13226,18 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13265
13226
  return localVarFp.deleteTrigger(trigger, cell, options).then((request) => request(axios, basePath));
13266
13227
  },
13267
13228
  /**
13268
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
13229
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
13269
13230
  * @summary Get All Program Runs
13270
13231
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13271
13232
  * @param {string} [state]
13272
13233
  * @param {*} [options] Override http request option.
13273
13234
  * @throws {RequiredError}
13274
13235
  */
13275
- getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramRuns200Response> {
13276
- return localVarFp.getAllProgramRuns(cell, state, options).then((request) => request(axios, basePath));
13236
+ getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response> {
13237
+ return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
13277
13238
  },
13278
13239
  /**
13279
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
13240
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
13280
13241
  * @summary Get All Triggers
13281
13242
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13282
13243
  * @param {*} [options] Override http request option.
@@ -13286,15 +13247,15 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13286
13247
  return localVarFp.getAllTriggers(cell, options).then((request) => request(axios, basePath));
13287
13248
  },
13288
13249
  /**
13289
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
13250
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
13290
13251
  * @summary Get Program Run
13291
13252
  * @param {string} run
13292
13253
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13293
13254
  * @param {*} [options] Override http request option.
13294
13255
  * @throws {RequiredError}
13295
13256
  */
13296
- getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject> {
13297
- return localVarFp.getProgramRun(run, cell, options).then((request) => request(axios, basePath));
13257
+ getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject> {
13258
+ return localVarFp.getProgramOperatorRun(run, cell, options).then((request) => request(axios, basePath));
13298
13259
  },
13299
13260
  /**
13300
13261
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
@@ -13310,7 +13271,7 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13310
13271
  /**
13311
13272
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
13312
13273
  * @summary Update Trigger
13313
- * @param {string} trigger the id of the trigger
13274
+ * @param {string} trigger The identifier of the trigger.
13314
13275
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13315
13276
  * @param {UpdateTriggerRequest} updateTriggerRequest
13316
13277
  * @param {*} [options] Override http request option.
@@ -13330,16 +13291,16 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13330
13291
  */
13331
13292
  export class ProgramOperatorApi extends BaseAPI {
13332
13293
  /**
13333
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
13294
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
13334
13295
  * @summary Run Program from Library
13335
13296
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13336
- * @param {CreateProgramRunRequest} createProgramRunRequest
13297
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
13337
13298
  * @param {*} [options] Override http request option.
13338
13299
  * @throws {RequiredError}
13339
13300
  * @memberof ProgramOperatorApi
13340
13301
  */
13341
- public createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig) {
13342
- return ProgramOperatorApiFp(this.configuration).createProgramRun(cell, createProgramRunRequest, options).then((request) => request(this.axios, this.basePath));
13302
+ public createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) {
13303
+ return ProgramOperatorApiFp(this.configuration).createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(this.axios, this.basePath));
13343
13304
  }
13344
13305
 
13345
13306
  /**
@@ -13369,7 +13330,7 @@ export class ProgramOperatorApi extends BaseAPI {
13369
13330
  }
13370
13331
 
13371
13332
  /**
13372
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
13333
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
13373
13334
  * @summary Get All Program Runs
13374
13335
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13375
13336
  * @param {string} [state]
@@ -13377,12 +13338,12 @@ export class ProgramOperatorApi extends BaseAPI {
13377
13338
  * @throws {RequiredError}
13378
13339
  * @memberof ProgramOperatorApi
13379
13340
  */
13380
- public getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig) {
13381
- return ProgramOperatorApiFp(this.configuration).getAllProgramRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
13341
+ public getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig) {
13342
+ return ProgramOperatorApiFp(this.configuration).getAllProgramOperatorRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
13382
13343
  }
13383
13344
 
13384
13345
  /**
13385
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
13346
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
13386
13347
  * @summary Get All Triggers
13387
13348
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13388
13349
  * @param {*} [options] Override http request option.
@@ -13394,7 +13355,7 @@ export class ProgramOperatorApi extends BaseAPI {
13394
13355
  }
13395
13356
 
13396
13357
  /**
13397
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
13358
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
13398
13359
  * @summary Get Program Run
13399
13360
  * @param {string} run
13400
13361
  * @param {string} cell Unique identifier addressing a cell in all API calls.
@@ -13402,8 +13363,8 @@ export class ProgramOperatorApi extends BaseAPI {
13402
13363
  * @throws {RequiredError}
13403
13364
  * @memberof ProgramOperatorApi
13404
13365
  */
13405
- public getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig) {
13406
- return ProgramOperatorApiFp(this.configuration).getProgramRun(run, cell, options).then((request) => request(this.axios, this.basePath));
13366
+ public getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig) {
13367
+ return ProgramOperatorApiFp(this.configuration).getProgramOperatorRun(run, cell, options).then((request) => request(this.axios, this.basePath));
13407
13368
  }
13408
13369
 
13409
13370
  /**
@@ -13422,7 +13383,7 @@ export class ProgramOperatorApi extends BaseAPI {
13422
13383
  /**
13423
13384
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
13424
13385
  * @summary Update Trigger
13425
- * @param {string} trigger the id of the trigger
13386
+ * @param {string} trigger The identifier of the trigger.
13426
13387
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13427
13388
  * @param {UpdateTriggerRequest} updateTriggerRequest
13428
13389
  * @param {*} [options] Override http request option.