@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.d.ts CHANGED
@@ -193,7 +193,7 @@ export interface AllJointPositionsResponse {
193
193
  */
194
194
  export interface App {
195
195
  /**
196
- * 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).
196
+ * 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).
197
197
  * @type {string}
198
198
  * @memberof App
199
199
  */
@@ -235,118 +235,6 @@ export interface App {
235
235
  */
236
236
  'health_path'?: string;
237
237
  }
238
- /**
239
- *
240
- * @export
241
- * @interface ArrayInput
242
- */
243
- export interface ArrayInput {
244
- /**
245
- *
246
- * @type {Array<ArrayInputArrayInner>}
247
- * @memberof ArrayInput
248
- */
249
- 'array': Array<ArrayInputArrayInner>;
250
- }
251
- /**
252
- *
253
- * @export
254
- * @interface ArrayInputArrayInner
255
- */
256
- export interface ArrayInputArrayInner {
257
- /**
258
- *
259
- * @type {Array<any>}
260
- * @memberof ArrayInputArrayInner
261
- */
262
- 'pose': Array<any>;
263
- /**
264
- *
265
- * @type {Array<any>}
266
- * @memberof ArrayInputArrayInner
267
- */
268
- 'position': Array<any>;
269
- /**
270
- *
271
- * @type {Array<any>}
272
- * @memberof ArrayInputArrayInner
273
- */
274
- 'orientation': Array<any>;
275
- /**
276
- *
277
- * @type {string}
278
- * @memberof ArrayInputArrayInner
279
- */
280
- 'image': string;
281
- /**
282
- *
283
- * @type {string}
284
- * @memberof ArrayInputArrayInner
285
- */
286
- 'pointcloud': string;
287
- /**
288
- *
289
- * @type {Array<ArrayInputArrayInner>}
290
- * @memberof ArrayInputArrayInner
291
- */
292
- 'array': Array<ArrayInputArrayInner>;
293
- }
294
- /**
295
- *
296
- * @export
297
- * @interface ArrayOutput
298
- */
299
- export interface ArrayOutput {
300
- /**
301
- *
302
- * @type {Array<ArrayOutputArrayInner>}
303
- * @memberof ArrayOutput
304
- */
305
- 'array': Array<ArrayOutputArrayInner>;
306
- }
307
- /**
308
- *
309
- * @export
310
- * @interface ArrayOutputArrayInner
311
- */
312
- export interface ArrayOutputArrayInner {
313
- /**
314
- *
315
- * @type {Array<any>}
316
- * @memberof ArrayOutputArrayInner
317
- */
318
- 'pose': Array<any>;
319
- /**
320
- *
321
- * @type {Array<any>}
322
- * @memberof ArrayOutputArrayInner
323
- */
324
- 'position': Array<any>;
325
- /**
326
- *
327
- * @type {Array<any>}
328
- * @memberof ArrayOutputArrayInner
329
- */
330
- 'orientation': Array<any>;
331
- /**
332
- *
333
- * @type {string}
334
- * @memberof ArrayOutputArrayInner
335
- */
336
- 'image': string;
337
- /**
338
- *
339
- * @type {string}
340
- * @memberof ArrayOutputArrayInner
341
- */
342
- 'pointcloud': string;
343
- /**
344
- *
345
- * @type {Array<ArrayOutputArrayInner>}
346
- * @memberof ArrayOutputArrayInner
347
- */
348
- 'array': Array<ArrayOutputArrayInner>;
349
- }
350
238
  /**
351
239
  * ## 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).
352
240
  * @export
@@ -557,19 +445,6 @@ export declare const Capsule2ShapeTypeEnum: {
557
445
  readonly Capsule: "capsule";
558
446
  };
559
447
  export type Capsule2ShapeTypeEnum = typeof Capsule2ShapeTypeEnum[keyof typeof Capsule2ShapeTypeEnum];
560
- /**
561
- *
562
- * @export
563
- * @interface Capture
564
- */
565
- export interface Capture {
566
- /**
567
- *
568
- * @type {string}
569
- * @memberof Capture
570
- */
571
- 'image': string;
572
- }
573
448
  /**
574
449
  * 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.
575
450
  * @export
@@ -601,27 +476,6 @@ export interface Cell {
601
476
  */
602
477
  'apps'?: Array<App>;
603
478
  }
604
- /**
605
- *
606
- * @export
607
- * @interface CodeWithArguments
608
- */
609
- export interface CodeWithArguments {
610
- /**
611
- * Wandelscript code string which describes a Wandelscript Program as content/json.
612
- * @type {string}
613
- * @memberof CodeWithArguments
614
- */
615
- 'code': string;
616
- /**
617
- *
618
- * @type {{ [key: string]: ArrayInputArrayInner; }}
619
- * @memberof CodeWithArguments
620
- */
621
- 'initial_state'?: {
622
- [key: string]: ArrayInputArrayInner;
623
- } | null;
624
- }
625
479
  /**
626
480
  * 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.
627
481
  * @export
@@ -1139,7 +993,7 @@ export interface CoordinateSystem {
1139
993
  * @type {string}
1140
994
  * @memberof CoordinateSystem
1141
995
  */
1142
- 'reference_uid'?: string;
996
+ 'reference_coordinate_system'?: string;
1143
997
  /**
1144
998
  * A three-dimensional vector [x, y, z] with double precision.
1145
999
  * @type {Array<number>}
@@ -1175,26 +1029,26 @@ export interface CoordinateSystems {
1175
1029
  /**
1176
1030
  *
1177
1031
  * @export
1178
- * @interface CreateProgramRun200Response
1032
+ * @interface CreateProgramOperatorRun200Response
1179
1033
  */
1180
- export interface CreateProgramRun200Response {
1034
+ export interface CreateProgramOperatorRun200Response {
1181
1035
  /**
1182
1036
  * The identifier of the program run for further inspection of the running program.
1183
1037
  * @type {string}
1184
- * @memberof CreateProgramRun200Response
1038
+ * @memberof CreateProgramOperatorRun200Response
1185
1039
  */
1186
1040
  'id'?: string;
1187
1041
  }
1188
1042
  /**
1189
1043
  *
1190
1044
  * @export
1191
- * @interface CreateProgramRunRequest
1045
+ * @interface CreateProgramOperatorRunRequest
1192
1046
  */
1193
- export interface CreateProgramRunRequest {
1047
+ export interface CreateProgramOperatorRunRequest {
1194
1048
  /**
1195
1049
  * The identifier of the program stored in the program library.
1196
1050
  * @type {string}
1197
- * @memberof CreateProgramRunRequest
1051
+ * @memberof CreateProgramOperatorRunRequest
1198
1052
  */
1199
1053
  'program_id': string;
1200
1054
  }
@@ -1237,16 +1091,11 @@ export interface CreateTriggerRequest {
1237
1091
  'type': TriggerType;
1238
1092
  /**
1239
1093
  *
1240
- * @type {CreateTriggerRequestConfig}
1094
+ * @type {OpcuaNodeValueTriggerConfig}
1241
1095
  * @memberof CreateTriggerRequest
1242
1096
  */
1243
- 'config'?: CreateTriggerRequestConfig;
1097
+ 'config'?: OpcuaNodeValueTriggerConfig;
1244
1098
  }
1245
- /**
1246
- * @type CreateTriggerRequestConfig
1247
- * @export
1248
- */
1249
- export type CreateTriggerRequestConfig = OpcuaNodeValueTriggerConfig;
1250
1099
  /**
1251
1100
  *
1252
1101
  * @export
@@ -1407,31 +1256,6 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
1407
1256
  * @export
1408
1257
  */
1409
1258
  export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
1410
- /**
1411
- * 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
1412
- * @export
1413
- * @interface ExecutionResult
1414
- */
1415
- export interface ExecutionResult {
1416
- /**
1417
- *
1418
- * @type {string}
1419
- * @memberof ExecutionResult
1420
- */
1421
- 'motion_group_id': string;
1422
- /**
1423
- *
1424
- * @type {number}
1425
- * @memberof ExecutionResult
1426
- */
1427
- 'motion_duration': number;
1428
- /**
1429
- *
1430
- * @type {Array<Path>}
1431
- * @memberof ExecutionResult
1432
- */
1433
- 'paths': Array<Path>;
1434
- }
1435
1259
  /**
1436
1260
  * A datapoint inside external joint stream.
1437
1261
  * @export
@@ -1758,13 +1582,13 @@ export interface Geometry {
1758
1582
  /**
1759
1583
  *
1760
1584
  * @export
1761
- * @interface GetAllProgramRuns200Response
1585
+ * @interface GetAllProgramOperatorRuns200Response
1762
1586
  */
1763
- export interface GetAllProgramRuns200Response {
1587
+ export interface GetAllProgramOperatorRuns200Response {
1764
1588
  /**
1765
1589
  *
1766
1590
  * @type {Array<ProgramRunObject>}
1767
- * @memberof GetAllProgramRuns200Response
1591
+ * @memberof GetAllProgramOperatorRuns200Response
1768
1592
  */
1769
1593
  'program_runs'?: Array<ProgramRunObject>;
1770
1594
  }
@@ -1807,6 +1631,19 @@ export interface HTTPValidationError {
1807
1631
  */
1808
1632
  'detail'?: Array<ValidationError>;
1809
1633
  }
1634
+ /**
1635
+ *
1636
+ * @export
1637
+ * @interface HTTPValidationError2
1638
+ */
1639
+ export interface HTTPValidationError2 {
1640
+ /**
1641
+ *
1642
+ * @type {Array<ValidationError2>}
1643
+ * @memberof HTTPValidationError2
1644
+ */
1645
+ 'detail'?: Array<ValidationError2>;
1646
+ }
1810
1647
  /**
1811
1648
  * Input/Output boolean value representation.
1812
1649
  * @export
@@ -2310,6 +2147,52 @@ export interface InvalidDofInvalidDof {
2310
2147
  */
2311
2148
  'joint_position'?: Array<number>;
2312
2149
  }
2150
+ /**
2151
+ *
2152
+ * @export
2153
+ * @interface InverseKinematicsRequest
2154
+ */
2155
+ export interface InverseKinematicsRequest {
2156
+ /**
2157
+ * The robot setup as returned from [getOptimizerConfiguration](getOptimizerConfiguration).
2158
+ * @type {OptimizerSetup}
2159
+ * @memberof InverseKinematicsRequest
2160
+ */
2161
+ 'robot_setup': OptimizerSetup;
2162
+ /**
2163
+ * List of TCP poses for which the inverse solutions are computed.
2164
+ * @type {Array<Pose>}
2165
+ * @memberof InverseKinematicsRequest
2166
+ */
2167
+ 'tcp_poses': Array<Pose>;
2168
+ /**
2169
+ * A collection of identifiable colliders.
2170
+ * @type {{ [key: string]: Collider; }}
2171
+ * @memberof InverseKinematicsRequest
2172
+ */
2173
+ 'static_colliders'?: {
2174
+ [key: string]: Collider;
2175
+ };
2176
+ /**
2177
+ * Collision motion group.
2178
+ * @type {CollisionMotionGroup}
2179
+ * @memberof InverseKinematicsRequest
2180
+ */
2181
+ 'collision_motion_group'?: CollisionMotionGroup;
2182
+ }
2183
+ /**
2184
+ *
2185
+ * @export
2186
+ * @interface InverseKinematicsResponse
2187
+ */
2188
+ export interface InverseKinematicsResponse {
2189
+ /**
2190
+ *
2191
+ * @type {Array<Array<Array<number>>>}
2192
+ * @memberof InverseKinematicsResponse
2193
+ */
2194
+ 'joints': Array<Array<Array<number>>>;
2195
+ }
2313
2196
  /**
2314
2197
  * Response signalling an error during jogging execution. This response is sent in case of an unexpected error, e.g. controller disconnects.
2315
2198
  * @export
@@ -3291,6 +3174,7 @@ export declare const MotionGroupModel: {
3291
3174
  readonly FanucArcMate50iD: "FANUC_ARC_Mate_50iD";
3292
3175
  readonly FanucArcMate50iD7L: "FANUC_ARC_Mate_50iD7L";
3293
3176
  readonly FanucArcMate100iD: "FANUC_ARC_Mate_100iD";
3177
+ readonly FanucArcMate100iD16S: "FANUC_ARC_Mate_100iD16S";
3294
3178
  readonly FanucArcMate100iD8L: "FANUC_ARC_Mate_100iD8L";
3295
3179
  readonly FanucArcMate100iD10L: "FANUC_ARC_Mate_100iD10L";
3296
3180
  readonly FanucArcMate120iD: "FANUC_ARC_Mate_120iD";
@@ -3354,12 +3238,14 @@ export declare const MotionGroupModel: {
3354
3238
  readonly YaskawaTurn1: "Yaskawa_TURN1";
3355
3239
  readonly YaskawaTurn2: "Yaskawa_TURN2";
3356
3240
  readonly YaskawaTurn3: "Yaskawa_TURN3";
3357
- readonly KukaKr1502: "KUKA_KR150_2";
3241
+ readonly KukaKr150R2: "KUKA_KR150_R2";
3242
+ readonly KukaKr3R540: "KUKA_KR3_R540";
3358
3243
  readonly KukaKr4R600: "KUKA_KR4_R600";
3359
3244
  readonly KukaKr6R700: "KUKA_KR6_R700";
3360
3245
  readonly KukaKr6R7002: "KUKA_KR6_R700_2";
3361
3246
  readonly KukaKr6R900: "KUKA_KR6_R900";
3362
3247
  readonly KukaKr6R9002: "KUKA_KR6_R900_2";
3248
+ readonly KukaKr6R1820: "KUKA_KR6_R1820";
3363
3249
  readonly KukaKr10R900: "KUKA_KR10_R900";
3364
3250
  readonly KukaKr10R9002: "KUKA_KR10_R900_2";
3365
3251
  readonly KukaKr10R1100: "KUKA_KR10_R1100";
@@ -3371,6 +3257,7 @@ export declare const MotionGroupModel: {
3371
3257
  readonly KukaKr16R20102: "KUKA_KR16_R2010_2";
3372
3258
  readonly KukaKr20R1810: "KUKA_KR20_R1810";
3373
3259
  readonly KukaKr20R18102: "KUKA_KR20_R1810_2";
3260
+ readonly KukaKr30R3: "KUKA_KR30_R3";
3374
3261
  readonly KukaKr50R2500: "KUKA_KR50_R2500";
3375
3262
  readonly KukaKr120R2700: "KUKA_KR120_R2700";
3376
3263
  readonly KukaKr120R27002: "KUKA_KR120_R2700_2";
@@ -3724,12 +3611,11 @@ export interface OpcuaNodeValueTriggerConfig {
3724
3611
  'node_value': OpcuaNodeValueTriggerConfigNodeValue;
3725
3612
  }
3726
3613
  /**
3614
+ * @type OpcuaNodeValueTriggerConfigNodeValue
3727
3615
  * Value to trigger the program when matched.
3728
3616
  * @export
3729
- * @interface OpcuaNodeValueTriggerConfigNodeValue
3730
3617
  */
3731
- export interface OpcuaNodeValueTriggerConfigNodeValue {
3732
- }
3618
+ export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
3733
3619
  /**
3734
3620
  * The operating state.
3735
3621
  * @export
@@ -3841,19 +3727,6 @@ export declare const OrientationType: {
3841
3727
  readonly EulerAnglesExtrinsicZxy: "EULER_ANGLES_EXTRINSIC_ZXY";
3842
3728
  };
3843
3729
  export type OrientationType = typeof OrientationType[keyof typeof OrientationType];
3844
- /**
3845
- *
3846
- * @export
3847
- * @interface Path
3848
- */
3849
- export interface Path {
3850
- /**
3851
- *
3852
- * @type {Array<RobotState>}
3853
- * @memberof Path
3854
- */
3855
- 'poses'?: Array<RobotState>;
3856
- }
3857
3730
  /**
3858
3731
  * 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.
3859
3732
  * @export
@@ -4350,19 +4223,6 @@ export interface PlaybackSpeedResponsePlaybackSpeedResponse {
4350
4223
  */
4351
4224
  'requested_value': number;
4352
4225
  }
4353
- /**
4354
- *
4355
- * @export
4356
- * @interface PointCloud
4357
- */
4358
- export interface PointCloud {
4359
- /**
4360
- *
4361
- * @type {string}
4362
- * @memberof PointCloud
4363
- */
4364
- 'pointcloud': string;
4365
- }
4366
4226
  /**
4367
4227
  * Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
4368
4228
  * @export
@@ -4410,71 +4270,100 @@ export interface PoseInCoordinateSystem {
4410
4270
  /**
4411
4271
  *
4412
4272
  * @export
4273
+ * @interface ProgramRequest
4274
+ */
4275
+ export interface ProgramRequest {
4276
+ /**
4277
+ *
4278
+ * @type {string}
4279
+ * @memberof ProgramRequest
4280
+ */
4281
+ 'program': string;
4282
+ /**
4283
+ * Identifier of the default robot to use for execution
4284
+ * @type {string}
4285
+ * @memberof ProgramRequest
4286
+ */
4287
+ 'default_robot'?: string;
4288
+ /**
4289
+ * Identifier of the default TCP to use for execution
4290
+ * @type {string}
4291
+ * @memberof ProgramRequest
4292
+ */
4293
+ 'default_tcp'?: string;
4294
+ /**
4295
+ * Initial arguments that are available within the program
4296
+ * @type {object}
4297
+ * @memberof ProgramRequest
4298
+ */
4299
+ 'run_args'?: object;
4300
+ }
4301
+ /**
4302
+ * Holds the state of a program run.
4303
+ * @export
4413
4304
  * @interface ProgramRun
4414
4305
  */
4415
4306
  export interface ProgramRun {
4416
4307
  /**
4417
- *
4308
+ * Unique identifier of the program run
4418
4309
  * @type {string}
4419
4310
  * @memberof ProgramRun
4420
4311
  */
4421
4312
  'id': string;
4422
4313
  /**
4423
- *
4314
+ * State of the program run
4424
4315
  * @type {ProgramRunState}
4425
4316
  * @memberof ProgramRun
4426
4317
  */
4427
4318
  'state': ProgramRunState;
4428
4319
  /**
4429
- *
4320
+ * Logs of the program run
4430
4321
  * @type {string}
4431
4322
  * @memberof ProgramRun
4432
4323
  */
4433
4324
  'logs'?: string;
4434
4325
  /**
4435
- *
4326
+ * Stdout of the program run
4436
4327
  * @type {string}
4437
4328
  * @memberof ProgramRun
4438
4329
  */
4439
4330
  'stdout'?: string;
4440
4331
  /**
4441
- *
4442
- * @type {{ [key: string]: StoreValue; }}
4332
+ * Stores runtime variables of the run
4333
+ * @type {object}
4443
4334
  * @memberof ProgramRun
4444
4335
  */
4445
- 'store'?: {
4446
- [key: string]: StoreValue;
4447
- };
4336
+ 'store'?: object;
4448
4337
  /**
4449
- *
4338
+ * Error message of the program run, if any
4450
4339
  * @type {string}
4451
4340
  * @memberof ProgramRun
4452
4341
  */
4453
- 'error'?: string | null;
4342
+ 'error'?: string;
4454
4343
  /**
4455
- *
4344
+ * Traceback of the program run, if any
4456
4345
  * @type {string}
4457
4346
  * @memberof ProgramRun
4458
4347
  */
4459
- 'traceback'?: string | null;
4348
+ 'traceback'?: string;
4460
4349
  /**
4461
- *
4350
+ * Start time of the program run
4462
4351
  * @type {number}
4463
4352
  * @memberof ProgramRun
4464
4353
  */
4465
- 'start_time'?: number | null;
4354
+ 'start_time'?: number;
4466
4355
  /**
4467
- *
4356
+ * End time of the program run
4468
4357
  * @type {number}
4469
4358
  * @memberof ProgramRun
4470
4359
  */
4471
- 'end_time'?: number | null;
4360
+ 'end_time'?: number;
4472
4361
  /**
4473
- *
4474
- * @type {Array<ExecutionResult>}
4362
+ * Execution results of the program run
4363
+ * @type {Array<ProgramRunResult>}
4475
4364
  * @memberof ProgramRun
4476
4365
  */
4477
- 'execution_results'?: Array<ExecutionResult>;
4366
+ 'execution_results'?: Array<ProgramRunResult>;
4478
4367
  }
4479
4368
  /**
4480
4369
  *
@@ -4522,93 +4411,60 @@ export interface ProgramRunObject {
4522
4411
  /**
4523
4412
  *
4524
4413
  * @export
4525
- * @enum {string}
4526
- */
4527
- export declare const ProgramRunState: {
4528
- readonly NotStarted: "not started";
4529
- readonly Running: "running";
4530
- readonly Completed: "completed";
4531
- readonly Failed: "failed";
4532
- readonly Stopped: "stopped";
4533
- };
4534
- export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4535
- /**
4536
- *
4537
- * @export
4538
- * @interface ProgramRunnerReference
4414
+ * @interface ProgramRunReference
4539
4415
  */
4540
- export interface ProgramRunnerReference {
4416
+ export interface ProgramRunReference {
4541
4417
  /**
4542
4418
  *
4543
4419
  * @type {string}
4544
- * @memberof ProgramRunnerReference
4420
+ * @memberof ProgramRunReference
4545
4421
  */
4546
4422
  'id': string;
4547
4423
  /**
4548
4424
  *
4549
4425
  * @type {ProgramRunState}
4550
- * @memberof ProgramRunnerReference
4426
+ * @memberof ProgramRunReference
4551
4427
  */
4552
4428
  'state': ProgramRunState;
4553
4429
  }
4554
4430
  /**
4555
- * A pose (position and orientation)
4431
+ * 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
4556
4432
  * @export
4557
- * @interface PyjectoryDatatypesCorePose
4433
+ * @interface ProgramRunResult
4558
4434
  */
4559
- export interface PyjectoryDatatypesCorePose {
4435
+ export interface ProgramRunResult {
4560
4436
  /**
4561
- *
4562
- * @type {Array<any>}
4563
- * @memberof PyjectoryDatatypesCorePose
4564
- */
4565
- 'position': Array<any>;
4566
- /**
4567
- *
4568
- * @type {Array<any>}
4569
- * @memberof PyjectoryDatatypesCorePose
4437
+ * Unique identifier of the motion group that was executed
4438
+ * @type {string}
4439
+ * @memberof ProgramRunResult
4570
4440
  */
4571
- 'orientation': Array<any>;
4572
- }
4573
- /**
4574
- * 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.
4575
- * @export
4576
- * @interface PyjectoryDatatypesSerializerOrientation
4577
- */
4578
- export interface PyjectoryDatatypesSerializerOrientation {
4441
+ 'motion_group_id': string;
4579
4442
  /**
4580
- *
4581
- * @type {Array<any>}
4582
- * @memberof PyjectoryDatatypesSerializerOrientation
4443
+ * Total execution duration of the motion group
4444
+ * @type {number}
4445
+ * @memberof ProgramRunResult
4583
4446
  */
4584
- 'orientation': Array<any>;
4585
- }
4586
- /**
4587
- * 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.
4588
- * @export
4589
- * @interface PyjectoryDatatypesSerializerPose
4590
- */
4591
- export interface PyjectoryDatatypesSerializerPose {
4447
+ 'motion_duration': number;
4592
4448
  /**
4593
- *
4594
- * @type {Array<any>}
4595
- * @memberof PyjectoryDatatypesSerializerPose
4449
+ * Paths of the motion group as list of Path objects
4450
+ * @type {Array<Array<RobotState>>}
4451
+ * @memberof ProgramRunResult
4596
4452
  */
4597
- 'pose': Array<any>;
4453
+ 'paths': Array<Array<RobotState>>;
4598
4454
  }
4599
4455
  /**
4600
- * Single point, defined in [x, y, z] with floating numbers. Must be defined.
4456
+ *
4601
4457
  * @export
4602
- * @interface PyjectoryDatatypesSerializerPosition
4458
+ * @enum {string}
4603
4459
  */
4604
- export interface PyjectoryDatatypesSerializerPosition {
4605
- /**
4606
- *
4607
- * @type {Array<any>}
4608
- * @memberof PyjectoryDatatypesSerializerPosition
4609
- */
4610
- 'position': Array<any>;
4611
- }
4460
+ export declare const ProgramRunState: {
4461
+ readonly NotStarted: "not started";
4462
+ readonly Running: "running";
4463
+ readonly Completed: "completed";
4464
+ readonly Failed: "failed";
4465
+ readonly Stopped: "stopped";
4466
+ };
4467
+ export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
4612
4468
  /**
4613
4469
  * Defines an x-y plane with finite size.
4614
4470
  * @export
@@ -4727,48 +4583,6 @@ export declare const ReleaseChannel: {
4727
4583
  readonly Next: "next";
4728
4584
  };
4729
4585
  export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
4730
- /**
4731
- * Wandelscript code string which describes a Program as text/plain
4732
- * @export
4733
- * @interface Request
4734
- */
4735
- export interface Request {
4736
- /**
4737
- * Wandelscript code string which describes a Wandelscript Program as content/json.
4738
- * @type {string}
4739
- * @memberof Request
4740
- */
4741
- 'code': string;
4742
- /**
4743
- *
4744
- * @type {{ [key: string]: ArrayInputArrayInner; }}
4745
- * @memberof Request
4746
- */
4747
- 'initial_state'?: {
4748
- [key: string]: ArrayInputArrayInner;
4749
- };
4750
- }
4751
- /**
4752
- * Wandelscript code string which describes a program
4753
- * @export
4754
- * @interface Request1
4755
- */
4756
- export interface Request1 {
4757
- /**
4758
- * Wandelscript code string which describes a Wandelscript Program as content/json.
4759
- * @type {string}
4760
- * @memberof Request1
4761
- */
4762
- 'code': string;
4763
- /**
4764
- *
4765
- * @type {{ [key: string]: ArrayInputArrayInner; }}
4766
- * @memberof Request1
4767
- */
4768
- 'initial_state'?: {
4769
- [key: string]: ArrayInputArrayInner;
4770
- };
4771
- }
4772
4586
  /**
4773
4587
  * The configuration of a physical or virtual robot controller.
4774
4588
  * @export
@@ -4856,23 +4670,23 @@ export interface RobotLinkGeometry {
4856
4670
  'geometry': Geometry;
4857
4671
  }
4858
4672
  /**
4859
- * Collection of information on the current state of the robot
4673
+ * Collection of information on the current state of the robot.
4860
4674
  * @export
4861
4675
  * @interface RobotState
4862
4676
  */
4863
4677
  export interface RobotState {
4864
4678
  /**
4865
4679
  *
4866
- * @type {PyjectoryDatatypesCorePose}
4680
+ * @type {Pose}
4867
4681
  * @memberof RobotState
4868
4682
  */
4869
- 'pose': PyjectoryDatatypesCorePose;
4683
+ 'pose': Pose;
4870
4684
  /**
4871
4685
  *
4872
4686
  * @type {Array<number>}
4873
4687
  * @memberof RobotState
4874
4688
  */
4875
- 'joints'?: Array<number> | null;
4689
+ 'joints'?: Array<number>;
4876
4690
  }
4877
4691
  /**
4878
4692
  * 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.
@@ -5134,6 +4948,18 @@ export interface SafetyZoneLimits {
5134
4948
  */
5135
4949
  'limits': PlanningLimits;
5136
4950
  }
4951
+ /**
4952
+ *
4953
+ * @export
4954
+ * @enum {string}
4955
+ */
4956
+ export declare const ServiceGroup: {
4957
+ readonly SystemService: "SystemService";
4958
+ readonly CellService: "CellService";
4959
+ readonly RobotController: "RobotController";
4960
+ readonly App: "App";
4961
+ };
4962
+ export type ServiceGroup = typeof ServiceGroup[keyof typeof ServiceGroup];
5137
4963
  /**
5138
4964
  *
5139
4965
  * @export
@@ -5146,6 +4972,12 @@ export interface ServiceStatus {
5146
4972
  * @memberof ServiceStatus
5147
4973
  */
5148
4974
  'service': string;
4975
+ /**
4976
+ *
4977
+ * @type {ServiceGroup}
4978
+ * @memberof ServiceStatus
4979
+ */
4980
+ 'group': ServiceGroup;
5149
4981
  /**
5150
4982
  *
5151
4983
  * @type {ServiceStatusStatus}
@@ -5432,49 +5264,6 @@ export interface StartOnIO {
5432
5264
  */
5433
5265
  'comparator': Comparator;
5434
5266
  }
5435
- /**
5436
- *
5437
- * @export
5438
- * @interface StoreValue
5439
- */
5440
- export interface StoreValue {
5441
- /**
5442
- *
5443
- * @type {Array<any>}
5444
- * @memberof StoreValue
5445
- */
5446
- 'pose': Array<any>;
5447
- /**
5448
- *
5449
- * @type {Array<any>}
5450
- * @memberof StoreValue
5451
- */
5452
- 'position': Array<any>;
5453
- /**
5454
- *
5455
- * @type {Array<any>}
5456
- * @memberof StoreValue
5457
- */
5458
- 'orientation': Array<any>;
5459
- /**
5460
- *
5461
- * @type {string}
5462
- * @memberof StoreValue
5463
- */
5464
- 'image': string;
5465
- /**
5466
- *
5467
- * @type {string}
5468
- * @memberof StoreValue
5469
- */
5470
- 'pointcloud': string;
5471
- /**
5472
- *
5473
- * @type {Array<ArrayOutputArrayInner>}
5474
- * @memberof StoreValue
5475
- */
5476
- 'array': Array<ArrayOutputArrayInner>;
5477
- }
5478
5267
  /**
5479
5268
  * Representing a robot pose in operational space aware of a configured TCP.
5480
5269
  * @export
@@ -5648,6 +5437,12 @@ export interface TrajectoryData {
5648
5437
  * @memberof TrajectoryData
5649
5438
  */
5650
5439
  'message_type': TrajectoryDataMessageTypeEnum;
5440
+ /**
5441
+ * Identifier of the motion-group.
5442
+ * @type {string}
5443
+ * @memberof TrajectoryData
5444
+ */
5445
+ 'motion_group'?: string;
5651
5446
  /**
5652
5447
  * The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
5653
5448
  * @type {JointTrajectory}
@@ -5720,10 +5515,10 @@ export interface TriggerObject {
5720
5515
  'type': TriggerType;
5721
5516
  /**
5722
5517
  *
5723
- * @type {CreateTriggerRequestConfig}
5518
+ * @type {OpcuaNodeValueTriggerConfig}
5724
5519
  * @memberof TriggerObject
5725
5520
  */
5726
- 'config': CreateTriggerRequestConfig;
5521
+ 'config': OpcuaNodeValueTriggerConfig;
5727
5522
  /**
5728
5523
  * ISO 8601 date-time format when the trigger was created.
5729
5524
  * @type {string}
@@ -5826,10 +5621,10 @@ export interface UpdateTriggerRequest {
5826
5621
  'enabled'?: boolean;
5827
5622
  /**
5828
5623
  *
5829
- * @type {CreateTriggerRequestConfig}
5624
+ * @type {OpcuaNodeValueTriggerConfig}
5830
5625
  * @memberof UpdateTriggerRequest
5831
5626
  */
5832
- 'config'?: CreateTriggerRequestConfig;
5627
+ 'config'?: OpcuaNodeValueTriggerConfig;
5833
5628
  }
5834
5629
  /**
5835
5630
  *
@@ -5859,10 +5654,33 @@ export interface ValidationError {
5859
5654
  /**
5860
5655
  *
5861
5656
  * @export
5862
- * @interface ValidationErrorLocInner
5657
+ * @interface ValidationError2
5863
5658
  */
5864
- export interface ValidationErrorLocInner {
5659
+ export interface ValidationError2 {
5660
+ /**
5661
+ *
5662
+ * @type {Array<number>}
5663
+ * @memberof ValidationError2
5664
+ */
5665
+ 'loc': Array<number>;
5666
+ /**
5667
+ *
5668
+ * @type {string}
5669
+ * @memberof ValidationError2
5670
+ */
5671
+ 'msg': string;
5672
+ /**
5673
+ *
5674
+ * @type {string}
5675
+ * @memberof ValidationError2
5676
+ */
5677
+ 'type': string;
5865
5678
  }
5679
+ /**
5680
+ * @type ValidationErrorLocInner
5681
+ * @export
5682
+ */
5683
+ export type ValidationErrorLocInner = number | string;
5866
5684
  /**
5867
5685
  * A generic representation of a version number.
5868
5686
  * @export
@@ -6000,6 +5818,7 @@ export declare const VirtualControllerTypes: {
6000
5818
  readonly AbbIrb460025020: "abb-irb4600_250_20";
6001
5819
  readonly AbbIrb460025540: "abb-irb4600_255_40";
6002
5820
  readonly FanucArcMate100iD: "fanuc-arc_mate_100iD";
5821
+ readonly FanucArcMate100iD16S: "fanuc-arc_mate_100iD16S";
6003
5822
  readonly FanucArcMate120iD: "fanuc-arc_mate_120iD";
6004
5823
  readonly FanucArcMate120iD12L: "fanuc-arc_mate_120iD12L";
6005
5824
  readonly FanucArcMate120iD35: "fanuc-arc_mate_120iD35";
@@ -6015,6 +5834,7 @@ export declare const VirtualControllerTypes: {
6015
5834
  readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
6016
5835
  readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
6017
5836
  readonly FanucM10iD12: "fanuc-m10iD12";
5837
+ readonly FanucM10iD16S: "fanuc-m10iD16S";
6018
5838
  readonly FanucM20iD25: "fanuc-m20iD25";
6019
5839
  readonly FanucM20iD35: "fanuc-m20iD35";
6020
5840
  readonly FanucM900iB280L: "fanuc-m900iB280L";
@@ -6027,7 +5847,7 @@ export declare const VirtualControllerTypes: {
6027
5847
  readonly KukaKr10R9002: "kuka-kr10_r900_2";
6028
5848
  readonly KukaKr120R27002: "kuka-kr120_r2700_2";
6029
5849
  readonly KukaKr12R18102: "kuka-kr12_r1810_2";
6030
- readonly KukaKr1502: "kuka-kr150_2";
5850
+ readonly KukaKr150R2: "kuka-kr150_r2";
6031
5851
  readonly KukaKr16R16102: "kuka-kr16_r1610_2";
6032
5852
  readonly KukaKr16R20102: "kuka-kr16_r2010_2";
6033
5853
  readonly KukaKr20R1810: "kuka-kr20_r1810";
@@ -6037,10 +5857,13 @@ export declare const VirtualControllerTypes: {
6037
5857
  readonly KukaKr210R33002: "kuka-kr210_r3300_2";
6038
5858
  readonly KukaKr240R2700: "kuka-kr240_r2700";
6039
5859
  readonly KukaKr250R27002: "kuka-kr250_r2700_2";
5860
+ readonly KukaKr3R540: "kuka-kr3_r540";
5861
+ readonly KukaKr30R3: "kuka-kr30_r3";
6040
5862
  readonly KukaKr360L2403: "kuka-kr360_l240_3";
6041
5863
  readonly KukaKr4R600: "kuka-kr4_r600";
6042
5864
  readonly KukaKr500L3403: "kuka-kr500_l340_3";
6043
5865
  readonly KukaKr50R2500: "kuka-kr50_r2500";
5866
+ readonly KukaKr6R1820: "kuka-kr6_r1820";
6044
5867
  readonly KukaKr6R7002: "kuka-kr6_r700_2";
6045
5868
  readonly KukaKr6R700Sixx: "kuka-kr6_r700_sixx";
6046
5869
  readonly KukaKr6R900: "kuka-kr6_r900";
@@ -6059,11 +5882,21 @@ export declare const VirtualControllerTypes: {
6059
5882
  readonly YaskawaAr3120: "yaskawa-ar3120";
6060
5883
  readonly YaskawaAr700: "yaskawa-ar700";
6061
5884
  readonly YaskawaAr900: "yaskawa-ar900";
5885
+ readonly YaskawaGp110: "yaskawa-gp110";
6062
5886
  readonly YaskawaGp12: "yaskawa-gp12";
5887
+ readonly YaskawaGp180: "yaskawa-gp180";
5888
+ readonly YaskawaGp180120: "yaskawa-gp180-120";
6063
5889
  readonly YaskawaGp20hl: "yaskawa-gp20hl";
5890
+ readonly YaskawaGp215: "yaskawa-gp215";
5891
+ readonly YaskawaGp225: "yaskawa-gp225";
6064
5892
  readonly YaskawaGp25: "yaskawa-gp25";
5893
+ readonly YaskawaGp250: "yaskawa-gp250";
6065
5894
  readonly YaskawaGp2512: "yaskawa-gp25_12";
5895
+ readonly YaskawaGp280: "yaskawa-gp280";
5896
+ readonly YaskawaGp35L: "yaskawa-gp35L";
5897
+ readonly YaskawaGp400: "yaskawa-gp400";
6066
5898
  readonly YaskawaGp50: "yaskawa-gp50";
5899
+ readonly YaskawaGp600: "yaskawa-gp600";
6067
5900
  readonly YaskawaGp7: "yaskawa-gp7";
6068
5901
  readonly YaskawaGp8: "yaskawa-gp8";
6069
5902
  readonly YaskawaGp88: "yaskawa-gp88";
@@ -7621,6 +7454,69 @@ export declare class CoordinateSystemsApi extends BaseAPI {
7621
7454
  */
7622
7455
  transformInCoordinateSystem(cell: string, coordinateSystem: string, poseInCoordinateSystem: PoseInCoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PoseInCoordinateSystem, any>>;
7623
7456
  }
7457
+ /**
7458
+ * InverseKinematicsApi - axios parameter creator
7459
+ * @export
7460
+ */
7461
+ export declare const InverseKinematicsApiAxiosParamCreator: (configuration?: Configuration) => {
7462
+ /**
7463
+ * Returns the reachable joint positions for a list of given poses.
7464
+ * @summary Inverse kinematics
7465
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7466
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
7467
+ * @param {*} [options] Override http request option.
7468
+ * @throws {RequiredError}
7469
+ */
7470
+ inverseKinematics: (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7471
+ };
7472
+ /**
7473
+ * InverseKinematicsApi - functional programming interface
7474
+ * @export
7475
+ */
7476
+ export declare const InverseKinematicsApiFp: (configuration?: Configuration) => {
7477
+ /**
7478
+ * Returns the reachable joint positions for a list of given poses.
7479
+ * @summary Inverse kinematics
7480
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7481
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
7482
+ * @param {*} [options] Override http request option.
7483
+ * @throws {RequiredError}
7484
+ */
7485
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
7486
+ };
7487
+ /**
7488
+ * InverseKinematicsApi - factory interface
7489
+ * @export
7490
+ */
7491
+ export declare const InverseKinematicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7492
+ /**
7493
+ * Returns the reachable joint positions for a list of given poses.
7494
+ * @summary Inverse kinematics
7495
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7496
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
7497
+ * @param {*} [options] Override http request option.
7498
+ * @throws {RequiredError}
7499
+ */
7500
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
7501
+ };
7502
+ /**
7503
+ * InverseKinematicsApi - object-oriented interface
7504
+ * @export
7505
+ * @class InverseKinematicsApi
7506
+ * @extends {BaseAPI}
7507
+ */
7508
+ export declare class InverseKinematicsApi extends BaseAPI {
7509
+ /**
7510
+ * Returns the reachable joint positions for a list of given poses.
7511
+ * @summary Inverse kinematics
7512
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
7513
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
7514
+ * @param {*} [options] Override http request option.
7515
+ * @throws {RequiredError}
7516
+ * @memberof InverseKinematicsApi
7517
+ */
7518
+ inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InverseKinematicsResponse, any>>;
7519
+ }
7624
7520
  /**
7625
7521
  * JoggingApi - axios parameter creator
7626
7522
  * @export
@@ -8694,76 +8590,75 @@ export declare class MotionGroupKinematicsApi extends BaseAPI {
8694
8590
  */
8695
8591
  export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
8696
8592
  /**
8697
- * 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. ```
8698
- * @summary Create Program Runner
8593
+ * 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.
8594
+ * @summary Create program run
8699
8595
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8700
- * @param {Request} request
8596
+ * @param {ProgramRequest} programRequest
8701
8597
  * @param {*} [options] Override http request option.
8702
8598
  * @throws {RequiredError}
8703
8599
  */
8704
- createProgramRunner: (cell: string, request: Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8600
+ createProgramRun: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8705
8601
  /**
8706
- * 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)
8707
- * @summary Execute Program
8602
+ * 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.
8603
+ * @summary Execute program
8708
8604
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8709
- * @param {CodeWithArguments} codeWithArguments
8605
+ * @param {ProgramRequest} programRequest
8710
8606
  * @param {*} [options] Override http request option.
8711
8607
  * @throws {RequiredError}
8712
8608
  */
8713
- executeProgram: (cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8609
+ executeProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8714
8610
  /**
8715
- * 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
8716
- * @summary Get Program Runner
8611
+ * 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, ...
8612
+ * @summary Get program run
8717
8613
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8718
- * @param {string} runner
8614
+ * @param {string} run
8719
8615
  * @param {*} [options] Override http request option.
8720
8616
  * @throws {RequiredError}
8721
8617
  */
8722
- getProgramRunner: (cell: string, runner: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8618
+ getProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8723
8619
  /**
8724
- * Get details about all existing program runners.
8725
- * @summary List Program Runners
8620
+ * Get details about all existing runs
8621
+ * @summary List programs
8726
8622
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8727
8623
  * @param {*} [options] Override http request option.
8728
8624
  * @throws {RequiredError}
8729
8625
  */
8730
- listProgramRunners: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8626
+ getProgramRuns: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8731
8627
  /**
8732
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
8733
- * @summary Migrate Program
8628
+ * Simulate a program given as text/plain
8629
+ * @summary Simulate program
8734
8630
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8735
- * @param {Request1} request1
8631
+ * @param {ProgramRequest} programRequest
8736
8632
  * @param {*} [options] Override http request option.
8737
8633
  * @throws {RequiredError}
8738
8634
  */
8739
- migrateProgram: (cell: string, request1: Request1, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8635
+ simulateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8740
8636
  /**
8741
- * 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)
8742
- * @summary Plan Program
8637
+ * Stop all runs
8638
+ * @summary Stop all programs
8743
8639
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8744
- * @param {Request} request
8745
- * @param {string} [identifier]
8746
8640
  * @param {*} [options] Override http request option.
8747
8641
  * @throws {RequiredError}
8748
8642
  */
8749
- planProgram: (cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8643
+ stopAllPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8750
8644
  /**
8751
- * Stop all runners.
8752
- * @summary Stop All Program Runners
8645
+ * Stop a specific program run.
8646
+ * @summary Stop program run
8753
8647
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8648
+ * @param {string} run
8754
8649
  * @param {*} [options] Override http request option.
8755
8650
  * @throws {RequiredError}
8756
8651
  */
8757
- stopAllProgramRunner: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8652
+ stopProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8758
8653
  /**
8759
- * 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
8760
- * @summary Stop Program Runner
8654
+ * Validate a program
8655
+ * @summary Validate program
8761
8656
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8762
- * @param {string} runner
8657
+ * @param {ProgramRequest} programRequest
8763
8658
  * @param {*} [options] Override http request option.
8764
8659
  * @throws {RequiredError}
8765
8660
  */
8766
- stopProgramRunner: (cell: string, runner: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8661
+ validateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8767
8662
  };
8768
8663
  /**
8769
8664
  * ProgramApi - functional programming interface
@@ -8771,76 +8666,75 @@ export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration
8771
8666
  */
8772
8667
  export declare const ProgramApiFp: (configuration?: Configuration) => {
8773
8668
  /**
8774
- * 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. ```
8775
- * @summary Create Program Runner
8669
+ * 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.
8670
+ * @summary Create program run
8776
8671
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8777
- * @param {Request} request
8672
+ * @param {ProgramRequest} programRequest
8778
8673
  * @param {*} [options] Override http request option.
8779
8674
  * @throws {RequiredError}
8780
8675
  */
8781
- createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunnerReference>>;
8676
+ createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>>;
8782
8677
  /**
8783
- * 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)
8784
- * @summary Execute Program
8678
+ * 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.
8679
+ * @summary Execute program
8785
8680
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8786
- * @param {CodeWithArguments} codeWithArguments
8681
+ * @param {ProgramRequest} programRequest
8787
8682
  * @param {*} [options] Override http request option.
8788
8683
  * @throws {RequiredError}
8789
8684
  */
8790
- executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8685
+ executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8791
8686
  /**
8792
- * 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
8793
- * @summary Get Program Runner
8687
+ * 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, ...
8688
+ * @summary Get program run
8794
8689
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8795
- * @param {string} runner
8690
+ * @param {string} run
8796
8691
  * @param {*} [options] Override http request option.
8797
8692
  * @throws {RequiredError}
8798
8693
  */
8799
- getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8694
+ getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8800
8695
  /**
8801
- * Get details about all existing program runners.
8802
- * @summary List Program Runners
8696
+ * Get details about all existing runs
8697
+ * @summary List programs
8803
8698
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8804
8699
  * @param {*} [options] Override http request option.
8805
8700
  * @throws {RequiredError}
8806
8701
  */
8807
- listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunnerReference>>>;
8702
+ getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>>;
8808
8703
  /**
8809
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
8810
- * @summary Migrate Program
8704
+ * Simulate a program given as text/plain
8705
+ * @summary Simulate program
8811
8706
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8812
- * @param {Request1} request1
8707
+ * @param {ProgramRequest} programRequest
8813
8708
  * @param {*} [options] Override http request option.
8814
8709
  * @throws {RequiredError}
8815
8710
  */
8816
- migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
8711
+ simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8817
8712
  /**
8818
- * 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)
8819
- * @summary Plan Program
8713
+ * Stop all runs
8714
+ * @summary Stop all programs
8820
8715
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8821
- * @param {Request} request
8822
- * @param {string} [identifier]
8823
8716
  * @param {*} [options] Override http request option.
8824
8717
  * @throws {RequiredError}
8825
8718
  */
8826
- planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
8719
+ stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8827
8720
  /**
8828
- * Stop all runners.
8829
- * @summary Stop All Program Runners
8721
+ * Stop a specific program run.
8722
+ * @summary Stop program run
8830
8723
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8724
+ * @param {string} run
8831
8725
  * @param {*} [options] Override http request option.
8832
8726
  * @throws {RequiredError}
8833
8727
  */
8834
- stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
8728
+ stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8835
8729
  /**
8836
- * 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
8837
- * @summary Stop Program Runner
8730
+ * Validate a program
8731
+ * @summary Validate program
8838
8732
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8839
- * @param {string} runner
8733
+ * @param {ProgramRequest} programRequest
8840
8734
  * @param {*} [options] Override http request option.
8841
8735
  * @throws {RequiredError}
8842
8736
  */
8843
- stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8737
+ validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8844
8738
  };
8845
8739
  /**
8846
8740
  * ProgramApi - factory interface
@@ -8848,76 +8742,75 @@ export declare const ProgramApiFp: (configuration?: Configuration) => {
8848
8742
  */
8849
8743
  export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8850
8744
  /**
8851
- * 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. ```
8852
- * @summary Create Program Runner
8745
+ * 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.
8746
+ * @summary Create program run
8853
8747
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8854
- * @param {Request} request
8748
+ * @param {ProgramRequest} programRequest
8855
8749
  * @param {*} [options] Override http request option.
8856
8750
  * @throws {RequiredError}
8857
8751
  */
8858
- createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunnerReference>;
8752
+ createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference>;
8859
8753
  /**
8860
- * 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)
8861
- * @summary Execute Program
8754
+ * 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.
8755
+ * @summary Execute program
8862
8756
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8863
- * @param {CodeWithArguments} codeWithArguments
8757
+ * @param {ProgramRequest} programRequest
8864
8758
  * @param {*} [options] Override http request option.
8865
8759
  * @throws {RequiredError}
8866
8760
  */
8867
- executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8761
+ executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8868
8762
  /**
8869
- * 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
8870
- * @summary Get Program Runner
8763
+ * 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, ...
8764
+ * @summary Get program run
8871
8765
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8872
- * @param {string} runner
8766
+ * @param {string} run
8873
8767
  * @param {*} [options] Override http request option.
8874
8768
  * @throws {RequiredError}
8875
8769
  */
8876
- getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8770
+ getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8877
8771
  /**
8878
- * Get details about all existing program runners.
8879
- * @summary List Program Runners
8772
+ * Get details about all existing runs
8773
+ * @summary List programs
8880
8774
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8881
8775
  * @param {*} [options] Override http request option.
8882
8776
  * @throws {RequiredError}
8883
8777
  */
8884
- listProgramRunners(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunnerReference>>;
8778
+ getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>>;
8885
8779
  /**
8886
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
8887
- * @summary Migrate Program
8780
+ * Simulate a program given as text/plain
8781
+ * @summary Simulate program
8888
8782
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8889
- * @param {Request1} request1
8783
+ * @param {ProgramRequest} programRequest
8890
8784
  * @param {*} [options] Override http request option.
8891
8785
  * @throws {RequiredError}
8892
8786
  */
8893
- migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): AxiosPromise<string>;
8787
+ simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8894
8788
  /**
8895
- * 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)
8896
- * @summary Plan Program
8789
+ * Stop all runs
8790
+ * @summary Stop all programs
8897
8791
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8898
- * @param {Request} request
8899
- * @param {string} [identifier]
8900
8792
  * @param {*} [options] Override http request option.
8901
8793
  * @throws {RequiredError}
8902
8794
  */
8903
- planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
8795
+ stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8904
8796
  /**
8905
- * Stop all runners.
8906
- * @summary Stop All Program Runners
8797
+ * Stop a specific program run.
8798
+ * @summary Stop program run
8907
8799
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8800
+ * @param {string} run
8908
8801
  * @param {*} [options] Override http request option.
8909
8802
  * @throws {RequiredError}
8910
8803
  */
8911
- stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
8804
+ stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8912
8805
  /**
8913
- * 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
8914
- * @summary Stop Program Runner
8806
+ * Validate a program
8807
+ * @summary Validate program
8915
8808
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8916
- * @param {string} runner
8809
+ * @param {ProgramRequest} programRequest
8917
8810
  * @param {*} [options] Override http request option.
8918
8811
  * @throws {RequiredError}
8919
8812
  */
8920
- stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8813
+ validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8921
8814
  };
8922
8815
  /**
8923
8816
  * ProgramApi - object-oriented interface
@@ -8927,84 +8820,83 @@ export declare const ProgramApiFactory: (configuration?: Configuration, basePath
8927
8820
  */
8928
8821
  export declare class ProgramApi extends BaseAPI {
8929
8822
  /**
8930
- * 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. ```
8931
- * @summary Create Program Runner
8823
+ * 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.
8824
+ * @summary Create program run
8932
8825
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8933
- * @param {Request} request
8826
+ * @param {ProgramRequest} programRequest
8934
8827
  * @param {*} [options] Override http request option.
8935
8828
  * @throws {RequiredError}
8936
8829
  * @memberof ProgramApi
8937
8830
  */
8938
- createProgramRunner(cell: string, request: Request, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunnerReference, any>>;
8831
+ createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference, any>>;
8939
8832
  /**
8940
- * 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)
8941
- * @summary Execute Program
8833
+ * 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.
8834
+ * @summary Execute program
8942
8835
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8943
- * @param {CodeWithArguments} codeWithArguments
8836
+ * @param {ProgramRequest} programRequest
8944
8837
  * @param {*} [options] Override http request option.
8945
8838
  * @throws {RequiredError}
8946
8839
  * @memberof ProgramApi
8947
8840
  */
8948
- executeProgram(cell: string, codeWithArguments: CodeWithArguments, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8841
+ executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8949
8842
  /**
8950
- * 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
8951
- * @summary Get Program Runner
8843
+ * 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, ...
8844
+ * @summary Get program run
8952
8845
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8953
- * @param {string} runner
8846
+ * @param {string} run
8954
8847
  * @param {*} [options] Override http request option.
8955
8848
  * @throws {RequiredError}
8956
8849
  * @memberof ProgramApi
8957
8850
  */
8958
- getProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8851
+ getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8959
8852
  /**
8960
- * Get details about all existing program runners.
8961
- * @summary List Program Runners
8853
+ * Get details about all existing runs
8854
+ * @summary List programs
8962
8855
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8963
8856
  * @param {*} [options] Override http request option.
8964
8857
  * @throws {RequiredError}
8965
8858
  * @memberof ProgramApi
8966
8859
  */
8967
- listProgramRunners(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunnerReference[], any>>;
8860
+ getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference[], any>>;
8968
8861
  /**
8969
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
8970
- * @summary Migrate Program
8862
+ * Simulate a program given as text/plain
8863
+ * @summary Simulate program
8971
8864
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8972
- * @param {Request1} request1
8865
+ * @param {ProgramRequest} programRequest
8973
8866
  * @param {*} [options] Override http request option.
8974
8867
  * @throws {RequiredError}
8975
8868
  * @memberof ProgramApi
8976
8869
  */
8977
- migrateProgram(cell: string, request1: Request1, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
8870
+ simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8978
8871
  /**
8979
- * 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)
8980
- * @summary Plan Program
8872
+ * Stop all runs
8873
+ * @summary Stop all programs
8981
8874
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8982
- * @param {Request} request
8983
- * @param {string} [identifier]
8984
8875
  * @param {*} [options] Override http request option.
8985
8876
  * @throws {RequiredError}
8986
8877
  * @memberof ProgramApi
8987
8878
  */
8988
- planProgram(cell: string, request: Request, identifier?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
8879
+ stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8989
8880
  /**
8990
- * Stop all runners.
8991
- * @summary Stop All Program Runners
8881
+ * Stop a specific program run.
8882
+ * @summary Stop program run
8992
8883
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8884
+ * @param {string} run
8993
8885
  * @param {*} [options] Override http request option.
8994
8886
  * @throws {RequiredError}
8995
8887
  * @memberof ProgramApi
8996
8888
  */
8997
- stopAllProgramRunner(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
8889
+ stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8998
8890
  /**
8999
- * 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
9000
- * @summary Stop Program Runner
8891
+ * Validate a program
8892
+ * @summary Validate program
9001
8893
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9002
- * @param {string} runner
8894
+ * @param {ProgramRequest} programRequest
9003
8895
  * @param {*} [options] Override http request option.
9004
8896
  * @throws {RequiredError}
9005
8897
  * @memberof ProgramApi
9006
8898
  */
9007
- stopProgramRunner(cell: string, runner: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8899
+ validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9008
8900
  }
9009
8901
  /**
9010
8902
  * ProgramOperatorApi - axios parameter creator
@@ -9012,14 +8904,14 @@ export declare class ProgramApi extends BaseAPI {
9012
8904
  */
9013
8905
  export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Configuration) => {
9014
8906
  /**
9015
- * <!-- 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.
8907
+ * <!-- 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.
9016
8908
  * @summary Run Program from Library
9017
8909
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9018
- * @param {CreateProgramRunRequest} createProgramRunRequest
8910
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
9019
8911
  * @param {*} [options] Override http request option.
9020
8912
  * @throws {RequiredError}
9021
8913
  */
9022
- createProgramRun: (cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8914
+ createProgramOperatorRun: (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9023
8915
  /**
9024
8916
  * <!-- 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.
9025
8917
  * @summary Create Trigger
@@ -9039,16 +8931,16 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
9039
8931
  */
9040
8932
  deleteTrigger: (trigger: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9041
8933
  /**
9042
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
8934
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
9043
8935
  * @summary Get All Program Runs
9044
8936
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9045
8937
  * @param {string} [state]
9046
8938
  * @param {*} [options] Override http request option.
9047
8939
  * @throws {RequiredError}
9048
8940
  */
9049
- getAllProgramRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8941
+ getAllProgramOperatorRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9050
8942
  /**
9051
- * <!-- 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.
8943
+ * <!-- 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.
9052
8944
  * @summary Get All Triggers
9053
8945
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9054
8946
  * @param {*} [options] Override http request option.
@@ -9056,14 +8948,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
9056
8948
  */
9057
8949
  getAllTriggers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9058
8950
  /**
9059
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
8951
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
9060
8952
  * @summary Get Program Run
9061
8953
  * @param {string} run
9062
8954
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9063
8955
  * @param {*} [options] Override http request option.
9064
8956
  * @throws {RequiredError}
9065
8957
  */
9066
- getProgramRun: (run: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8958
+ getProgramOperatorRun: (run: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9067
8959
  /**
9068
8960
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
9069
8961
  * @summary Get Trigger
@@ -9076,7 +8968,7 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
9076
8968
  /**
9077
8969
  * <!-- 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.
9078
8970
  * @summary Update Trigger
9079
- * @param {string} trigger the id of the trigger
8971
+ * @param {string} trigger The identifier of the trigger.
9080
8972
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9081
8973
  * @param {UpdateTriggerRequest} updateTriggerRequest
9082
8974
  * @param {*} [options] Override http request option.
@@ -9090,14 +8982,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
9090
8982
  */
9091
8983
  export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
9092
8984
  /**
9093
- * <!-- 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.
8985
+ * <!-- 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.
9094
8986
  * @summary Run Program from Library
9095
8987
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9096
- * @param {CreateProgramRunRequest} createProgramRunRequest
8988
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
9097
8989
  * @param {*} [options] Override http request option.
9098
8990
  * @throws {RequiredError}
9099
8991
  */
9100
- createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramRun200Response>>;
8992
+ createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>>;
9101
8993
  /**
9102
8994
  * <!-- 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.
9103
8995
  * @summary Create Trigger
@@ -9117,16 +9009,16 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
9117
9009
  */
9118
9010
  deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
9119
9011
  /**
9120
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
9012
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
9121
9013
  * @summary Get All Program Runs
9122
9014
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9123
9015
  * @param {string} [state]
9124
9016
  * @param {*} [options] Override http request option.
9125
9017
  * @throws {RequiredError}
9126
9018
  */
9127
- getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramRuns200Response>>;
9019
+ getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>>;
9128
9020
  /**
9129
- * <!-- 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.
9021
+ * <!-- 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.
9130
9022
  * @summary Get All Triggers
9131
9023
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9132
9024
  * @param {*} [options] Override http request option.
@@ -9134,14 +9026,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
9134
9026
  */
9135
9027
  getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllTriggers200Response>>;
9136
9028
  /**
9137
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
9029
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
9138
9030
  * @summary Get Program Run
9139
9031
  * @param {string} run
9140
9032
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9141
9033
  * @param {*} [options] Override http request option.
9142
9034
  * @throws {RequiredError}
9143
9035
  */
9144
- getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>>;
9036
+ getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>>;
9145
9037
  /**
9146
9038
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
9147
9039
  * @summary Get Trigger
@@ -9154,7 +9046,7 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
9154
9046
  /**
9155
9047
  * <!-- 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.
9156
9048
  * @summary Update Trigger
9157
- * @param {string} trigger the id of the trigger
9049
+ * @param {string} trigger The identifier of the trigger.
9158
9050
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9159
9051
  * @param {UpdateTriggerRequest} updateTriggerRequest
9160
9052
  * @param {*} [options] Override http request option.
@@ -9168,14 +9060,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
9168
9060
  */
9169
9061
  export declare const ProgramOperatorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
9170
9062
  /**
9171
- * <!-- 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.
9063
+ * <!-- 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.
9172
9064
  * @summary Run Program from Library
9173
9065
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9174
- * @param {CreateProgramRunRequest} createProgramRunRequest
9066
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
9175
9067
  * @param {*} [options] Override http request option.
9176
9068
  * @throws {RequiredError}
9177
9069
  */
9178
- createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramRun200Response>;
9070
+ createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response>;
9179
9071
  /**
9180
9072
  * <!-- 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.
9181
9073
  * @summary Create Trigger
@@ -9195,16 +9087,16 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
9195
9087
  */
9196
9088
  deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
9197
9089
  /**
9198
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
9090
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
9199
9091
  * @summary Get All Program Runs
9200
9092
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9201
9093
  * @param {string} [state]
9202
9094
  * @param {*} [options] Override http request option.
9203
9095
  * @throws {RequiredError}
9204
9096
  */
9205
- getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramRuns200Response>;
9097
+ getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response>;
9206
9098
  /**
9207
- * <!-- 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.
9099
+ * <!-- 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.
9208
9100
  * @summary Get All Triggers
9209
9101
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9210
9102
  * @param {*} [options] Override http request option.
@@ -9212,14 +9104,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
9212
9104
  */
9213
9105
  getAllTriggers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllTriggers200Response>;
9214
9106
  /**
9215
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
9107
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
9216
9108
  * @summary Get Program Run
9217
9109
  * @param {string} run
9218
9110
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9219
9111
  * @param {*} [options] Override http request option.
9220
9112
  * @throws {RequiredError}
9221
9113
  */
9222
- getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject>;
9114
+ getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject>;
9223
9115
  /**
9224
9116
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
9225
9117
  * @summary Get Trigger
@@ -9232,7 +9124,7 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
9232
9124
  /**
9233
9125
  * <!-- 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.
9234
9126
  * @summary Update Trigger
9235
- * @param {string} trigger the id of the trigger
9127
+ * @param {string} trigger The identifier of the trigger.
9236
9128
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9237
9129
  * @param {UpdateTriggerRequest} updateTriggerRequest
9238
9130
  * @param {*} [options] Override http request option.
@@ -9248,15 +9140,15 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
9248
9140
  */
9249
9141
  export declare class ProgramOperatorApi extends BaseAPI {
9250
9142
  /**
9251
- * <!-- 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.
9143
+ * <!-- 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.
9252
9144
  * @summary Run Program from Library
9253
9145
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9254
- * @param {CreateProgramRunRequest} createProgramRunRequest
9146
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
9255
9147
  * @param {*} [options] Override http request option.
9256
9148
  * @throws {RequiredError}
9257
9149
  * @memberof ProgramOperatorApi
9258
9150
  */
9259
- createProgramRun(cell: string, createProgramRunRequest: CreateProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProgramRun200Response, any>>;
9151
+ createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProgramOperatorRun200Response, any>>;
9260
9152
  /**
9261
9153
  * <!-- 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.
9262
9154
  * @summary Create Trigger
@@ -9278,7 +9170,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
9278
9170
  */
9279
9171
  deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
9280
9172
  /**
9281
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
9173
+ * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
9282
9174
  * @summary Get All Program Runs
9283
9175
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9284
9176
  * @param {string} [state]
@@ -9286,9 +9178,9 @@ export declare class ProgramOperatorApi extends BaseAPI {
9286
9178
  * @throws {RequiredError}
9287
9179
  * @memberof ProgramOperatorApi
9288
9180
  */
9289
- getAllProgramRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramRuns200Response, any>>;
9181
+ getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramOperatorRuns200Response, any>>;
9290
9182
  /**
9291
- * <!-- 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.
9183
+ * <!-- 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.
9292
9184
  * @summary Get All Triggers
9293
9185
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9294
9186
  * @param {*} [options] Override http request option.
@@ -9297,7 +9189,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
9297
9189
  */
9298
9190
  getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllTriggers200Response, any>>;
9299
9191
  /**
9300
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
9192
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
9301
9193
  * @summary Get Program Run
9302
9194
  * @param {string} run
9303
9195
  * @param {string} cell Unique identifier addressing a cell in all API calls.
@@ -9305,7 +9197,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
9305
9197
  * @throws {RequiredError}
9306
9198
  * @memberof ProgramOperatorApi
9307
9199
  */
9308
- getProgramRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunObject, any>>;
9200
+ getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunObject, any>>;
9309
9201
  /**
9310
9202
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
9311
9203
  * @summary Get Trigger
@@ -9319,7 +9211,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
9319
9211
  /**
9320
9212
  * <!-- 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.
9321
9213
  * @summary Update Trigger
9322
- * @param {string} trigger the id of the trigger
9214
+ * @param {string} trigger The identifier of the trigger.
9323
9215
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9324
9216
  * @param {UpdateTriggerRequest} updateTriggerRequest
9325
9217
  * @param {*} [options] Override http request option.