@wandelbots/nova-api 25.5.0-dev.9 → 25.6.0-dev.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/package.json +1 -1
- package/v1/api.d.ts +77 -5
- package/v1/api.js +19 -2
- package/v1/api.js.map +1 -1
- package/v1/api.ts +78 -5
- package/v2/api.d.ts +338 -557
- package/v2/api.js +273 -252
- package/v2/api.js.map +1 -1
- package/v2/api.ts +438 -646
package/v2/api.ts
CHANGED
|
@@ -207,7 +207,7 @@ export interface AllJointPositionsResponse {
|
|
|
207
207
|
*/
|
|
208
208
|
export interface App {
|
|
209
209
|
/**
|
|
210
|
-
* The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name).
|
|
210
|
+
* The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name). It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
|
|
211
211
|
* @type {string}
|
|
212
212
|
* @memberof App
|
|
213
213
|
*/
|
|
@@ -249,118 +249,6 @@ export interface App {
|
|
|
249
249
|
*/
|
|
250
250
|
'health_path'?: string;
|
|
251
251
|
}
|
|
252
|
-
/**
|
|
253
|
-
*
|
|
254
|
-
* @export
|
|
255
|
-
* @interface ArrayInput
|
|
256
|
-
*/
|
|
257
|
-
export interface ArrayInput {
|
|
258
|
-
/**
|
|
259
|
-
*
|
|
260
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
261
|
-
* @memberof ArrayInput
|
|
262
|
-
*/
|
|
263
|
-
'array': Array<ArrayInputArrayInner>;
|
|
264
|
-
}
|
|
265
|
-
/**
|
|
266
|
-
*
|
|
267
|
-
* @export
|
|
268
|
-
* @interface ArrayInputArrayInner
|
|
269
|
-
*/
|
|
270
|
-
export interface ArrayInputArrayInner {
|
|
271
|
-
/**
|
|
272
|
-
*
|
|
273
|
-
* @type {Array<any>}
|
|
274
|
-
* @memberof ArrayInputArrayInner
|
|
275
|
-
*/
|
|
276
|
-
'pose': Array<any>;
|
|
277
|
-
/**
|
|
278
|
-
*
|
|
279
|
-
* @type {Array<any>}
|
|
280
|
-
* @memberof ArrayInputArrayInner
|
|
281
|
-
*/
|
|
282
|
-
'position': Array<any>;
|
|
283
|
-
/**
|
|
284
|
-
*
|
|
285
|
-
* @type {Array<any>}
|
|
286
|
-
* @memberof ArrayInputArrayInner
|
|
287
|
-
*/
|
|
288
|
-
'orientation': Array<any>;
|
|
289
|
-
/**
|
|
290
|
-
*
|
|
291
|
-
* @type {string}
|
|
292
|
-
* @memberof ArrayInputArrayInner
|
|
293
|
-
*/
|
|
294
|
-
'image': string;
|
|
295
|
-
/**
|
|
296
|
-
*
|
|
297
|
-
* @type {string}
|
|
298
|
-
* @memberof ArrayInputArrayInner
|
|
299
|
-
*/
|
|
300
|
-
'pointcloud': string;
|
|
301
|
-
/**
|
|
302
|
-
*
|
|
303
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
304
|
-
* @memberof ArrayInputArrayInner
|
|
305
|
-
*/
|
|
306
|
-
'array': Array<ArrayInputArrayInner>;
|
|
307
|
-
}
|
|
308
|
-
/**
|
|
309
|
-
*
|
|
310
|
-
* @export
|
|
311
|
-
* @interface ArrayOutput
|
|
312
|
-
*/
|
|
313
|
-
export interface ArrayOutput {
|
|
314
|
-
/**
|
|
315
|
-
*
|
|
316
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
317
|
-
* @memberof ArrayOutput
|
|
318
|
-
*/
|
|
319
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
320
|
-
}
|
|
321
|
-
/**
|
|
322
|
-
*
|
|
323
|
-
* @export
|
|
324
|
-
* @interface ArrayOutputArrayInner
|
|
325
|
-
*/
|
|
326
|
-
export interface ArrayOutputArrayInner {
|
|
327
|
-
/**
|
|
328
|
-
*
|
|
329
|
-
* @type {Array<any>}
|
|
330
|
-
* @memberof ArrayOutputArrayInner
|
|
331
|
-
*/
|
|
332
|
-
'pose': Array<any>;
|
|
333
|
-
/**
|
|
334
|
-
*
|
|
335
|
-
* @type {Array<any>}
|
|
336
|
-
* @memberof ArrayOutputArrayInner
|
|
337
|
-
*/
|
|
338
|
-
'position': Array<any>;
|
|
339
|
-
/**
|
|
340
|
-
*
|
|
341
|
-
* @type {Array<any>}
|
|
342
|
-
* @memberof ArrayOutputArrayInner
|
|
343
|
-
*/
|
|
344
|
-
'orientation': Array<any>;
|
|
345
|
-
/**
|
|
346
|
-
*
|
|
347
|
-
* @type {string}
|
|
348
|
-
* @memberof ArrayOutputArrayInner
|
|
349
|
-
*/
|
|
350
|
-
'image': string;
|
|
351
|
-
/**
|
|
352
|
-
*
|
|
353
|
-
* @type {string}
|
|
354
|
-
* @memberof ArrayOutputArrayInner
|
|
355
|
-
*/
|
|
356
|
-
'pointcloud': string;
|
|
357
|
-
/**
|
|
358
|
-
*
|
|
359
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
360
|
-
* @memberof ArrayOutputArrayInner
|
|
361
|
-
*/
|
|
362
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
363
|
-
}
|
|
364
252
|
/**
|
|
365
253
|
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
366
254
|
* @export
|
|
@@ -594,19 +482,6 @@ export const Capsule2ShapeTypeEnum = {
|
|
|
594
482
|
|
|
595
483
|
export type Capsule2ShapeTypeEnum = typeof Capsule2ShapeTypeEnum[keyof typeof Capsule2ShapeTypeEnum];
|
|
596
484
|
|
|
597
|
-
/**
|
|
598
|
-
*
|
|
599
|
-
* @export
|
|
600
|
-
* @interface Capture
|
|
601
|
-
*/
|
|
602
|
-
export interface Capture {
|
|
603
|
-
/**
|
|
604
|
-
*
|
|
605
|
-
* @type {string}
|
|
606
|
-
* @memberof Capture
|
|
607
|
-
*/
|
|
608
|
-
'image': string;
|
|
609
|
-
}
|
|
610
485
|
/**
|
|
611
486
|
* To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
|
|
612
487
|
* @export
|
|
@@ -638,25 +513,6 @@ export interface Cell {
|
|
|
638
513
|
*/
|
|
639
514
|
'apps'?: Array<App>;
|
|
640
515
|
}
|
|
641
|
-
/**
|
|
642
|
-
*
|
|
643
|
-
* @export
|
|
644
|
-
* @interface CodeWithArguments
|
|
645
|
-
*/
|
|
646
|
-
export interface CodeWithArguments {
|
|
647
|
-
/**
|
|
648
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
649
|
-
* @type {string}
|
|
650
|
-
* @memberof CodeWithArguments
|
|
651
|
-
*/
|
|
652
|
-
'code': string;
|
|
653
|
-
/**
|
|
654
|
-
*
|
|
655
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
656
|
-
* @memberof CodeWithArguments
|
|
657
|
-
*/
|
|
658
|
-
'initial_state'?: { [key: string]: ArrayInputArrayInner; } | null;
|
|
659
|
-
}
|
|
660
516
|
/**
|
|
661
517
|
* Defines a collider with a single shape. A collider is an object that is used for collision detection. It defines the `shape` that is attached with the offset of `pose` to a reference frame. Use colliders to: - Define the shape of a workpiece. The reference frame is the scene origin. - Define the shape of a link in a motion group. The reference frame is the link coordinate system. - Define the shape of a tool. The reference frame is the flange coordinate system.
|
|
662
518
|
* @export
|
|
@@ -1150,7 +1006,7 @@ export interface CoordinateSystem {
|
|
|
1150
1006
|
* @type {string}
|
|
1151
1007
|
* @memberof CoordinateSystem
|
|
1152
1008
|
*/
|
|
1153
|
-
'
|
|
1009
|
+
'reference_coordinate_system'?: string;
|
|
1154
1010
|
/**
|
|
1155
1011
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
1156
1012
|
* @type {Array<number>}
|
|
@@ -1188,26 +1044,26 @@ export interface CoordinateSystems {
|
|
|
1188
1044
|
/**
|
|
1189
1045
|
*
|
|
1190
1046
|
* @export
|
|
1191
|
-
* @interface
|
|
1047
|
+
* @interface CreateProgramOperatorRun200Response
|
|
1192
1048
|
*/
|
|
1193
|
-
export interface
|
|
1049
|
+
export interface CreateProgramOperatorRun200Response {
|
|
1194
1050
|
/**
|
|
1195
1051
|
* The identifier of the program run for further inspection of the running program.
|
|
1196
1052
|
* @type {string}
|
|
1197
|
-
* @memberof
|
|
1053
|
+
* @memberof CreateProgramOperatorRun200Response
|
|
1198
1054
|
*/
|
|
1199
1055
|
'id'?: string;
|
|
1200
1056
|
}
|
|
1201
1057
|
/**
|
|
1202
1058
|
*
|
|
1203
1059
|
* @export
|
|
1204
|
-
* @interface
|
|
1060
|
+
* @interface CreateProgramOperatorRunRequest
|
|
1205
1061
|
*/
|
|
1206
|
-
export interface
|
|
1062
|
+
export interface CreateProgramOperatorRunRequest {
|
|
1207
1063
|
/**
|
|
1208
1064
|
* The identifier of the program stored in the program library.
|
|
1209
1065
|
* @type {string}
|
|
1210
|
-
* @memberof
|
|
1066
|
+
* @memberof CreateProgramOperatorRunRequest
|
|
1211
1067
|
*/
|
|
1212
1068
|
'program_id': string;
|
|
1213
1069
|
}
|
|
@@ -1250,19 +1106,13 @@ export interface CreateTriggerRequest {
|
|
|
1250
1106
|
'type': TriggerType;
|
|
1251
1107
|
/**
|
|
1252
1108
|
*
|
|
1253
|
-
* @type {
|
|
1109
|
+
* @type {OpcuaNodeValueTriggerConfig}
|
|
1254
1110
|
* @memberof CreateTriggerRequest
|
|
1255
1111
|
*/
|
|
1256
|
-
'config'?:
|
|
1112
|
+
'config'?: OpcuaNodeValueTriggerConfig;
|
|
1257
1113
|
}
|
|
1258
1114
|
|
|
1259
1115
|
|
|
1260
|
-
/**
|
|
1261
|
-
* @type CreateTriggerRequestConfig
|
|
1262
|
-
* @export
|
|
1263
|
-
*/
|
|
1264
|
-
export type CreateTriggerRequestConfig = OpcuaNodeValueTriggerConfig;
|
|
1265
|
-
|
|
1266
1116
|
/**
|
|
1267
1117
|
*
|
|
1268
1118
|
* @export
|
|
@@ -1434,31 +1284,6 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
|
|
|
1434
1284
|
*/
|
|
1435
1285
|
export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
|
|
1436
1286
|
|
|
1437
|
-
/**
|
|
1438
|
-
* The ExecutionResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
|
|
1439
|
-
* @export
|
|
1440
|
-
* @interface ExecutionResult
|
|
1441
|
-
*/
|
|
1442
|
-
export interface ExecutionResult {
|
|
1443
|
-
/**
|
|
1444
|
-
*
|
|
1445
|
-
* @type {string}
|
|
1446
|
-
* @memberof ExecutionResult
|
|
1447
|
-
*/
|
|
1448
|
-
'motion_group_id': string;
|
|
1449
|
-
/**
|
|
1450
|
-
*
|
|
1451
|
-
* @type {number}
|
|
1452
|
-
* @memberof ExecutionResult
|
|
1453
|
-
*/
|
|
1454
|
-
'motion_duration': number;
|
|
1455
|
-
/**
|
|
1456
|
-
*
|
|
1457
|
-
* @type {Array<Path>}
|
|
1458
|
-
* @memberof ExecutionResult
|
|
1459
|
-
*/
|
|
1460
|
-
'paths': Array<Path>;
|
|
1461
|
-
}
|
|
1462
1287
|
/**
|
|
1463
1288
|
* A datapoint inside external joint stream.
|
|
1464
1289
|
* @export
|
|
@@ -1803,13 +1628,13 @@ export interface Geometry {
|
|
|
1803
1628
|
/**
|
|
1804
1629
|
*
|
|
1805
1630
|
* @export
|
|
1806
|
-
* @interface
|
|
1631
|
+
* @interface GetAllProgramOperatorRuns200Response
|
|
1807
1632
|
*/
|
|
1808
|
-
export interface
|
|
1633
|
+
export interface GetAllProgramOperatorRuns200Response {
|
|
1809
1634
|
/**
|
|
1810
1635
|
*
|
|
1811
1636
|
* @type {Array<ProgramRunObject>}
|
|
1812
|
-
* @memberof
|
|
1637
|
+
* @memberof GetAllProgramOperatorRuns200Response
|
|
1813
1638
|
*/
|
|
1814
1639
|
'program_runs'?: Array<ProgramRunObject>;
|
|
1815
1640
|
}
|
|
@@ -1854,6 +1679,19 @@ export interface HTTPValidationError {
|
|
|
1854
1679
|
*/
|
|
1855
1680
|
'detail'?: Array<ValidationError>;
|
|
1856
1681
|
}
|
|
1682
|
+
/**
|
|
1683
|
+
*
|
|
1684
|
+
* @export
|
|
1685
|
+
* @interface HTTPValidationError2
|
|
1686
|
+
*/
|
|
1687
|
+
export interface HTTPValidationError2 {
|
|
1688
|
+
/**
|
|
1689
|
+
*
|
|
1690
|
+
* @type {Array<ValidationError2>}
|
|
1691
|
+
* @memberof HTTPValidationError2
|
|
1692
|
+
*/
|
|
1693
|
+
'detail'?: Array<ValidationError2>;
|
|
1694
|
+
}
|
|
1857
1695
|
/**
|
|
1858
1696
|
* Input/Output boolean value representation.
|
|
1859
1697
|
* @export
|
|
@@ -3386,6 +3224,7 @@ export const MotionGroupModel = {
|
|
|
3386
3224
|
FanucArcMate50iD: 'FANUC_ARC_Mate_50iD',
|
|
3387
3225
|
FanucArcMate50iD7L: 'FANUC_ARC_Mate_50iD7L',
|
|
3388
3226
|
FanucArcMate100iD: 'FANUC_ARC_Mate_100iD',
|
|
3227
|
+
FanucArcMate100iD16S: 'FANUC_ARC_Mate_100iD16S',
|
|
3389
3228
|
FanucArcMate100iD8L: 'FANUC_ARC_Mate_100iD8L',
|
|
3390
3229
|
FanucArcMate100iD10L: 'FANUC_ARC_Mate_100iD10L',
|
|
3391
3230
|
FanucArcMate120iD: 'FANUC_ARC_Mate_120iD',
|
|
@@ -3449,12 +3288,13 @@ export const MotionGroupModel = {
|
|
|
3449
3288
|
YaskawaTurn1: 'Yaskawa_TURN1',
|
|
3450
3289
|
YaskawaTurn2: 'Yaskawa_TURN2',
|
|
3451
3290
|
YaskawaTurn3: 'Yaskawa_TURN3',
|
|
3452
|
-
|
|
3291
|
+
KukaKr150R2: 'KUKA_KR150_R2',
|
|
3453
3292
|
KukaKr4R600: 'KUKA_KR4_R600',
|
|
3454
3293
|
KukaKr6R700: 'KUKA_KR6_R700',
|
|
3455
3294
|
KukaKr6R7002: 'KUKA_KR6_R700_2',
|
|
3456
3295
|
KukaKr6R900: 'KUKA_KR6_R900',
|
|
3457
3296
|
KukaKr6R9002: 'KUKA_KR6_R900_2',
|
|
3297
|
+
KukaKr6R1820: 'KUKA_KR6_R1820',
|
|
3458
3298
|
KukaKr10R900: 'KUKA_KR10_R900',
|
|
3459
3299
|
KukaKr10R9002: 'KUKA_KR10_R900_2',
|
|
3460
3300
|
KukaKr10R1100: 'KUKA_KR10_R1100',
|
|
@@ -3466,6 +3306,7 @@ export const MotionGroupModel = {
|
|
|
3466
3306
|
KukaKr16R20102: 'KUKA_KR16_R2010_2',
|
|
3467
3307
|
KukaKr20R1810: 'KUKA_KR20_R1810',
|
|
3468
3308
|
KukaKr20R18102: 'KUKA_KR20_R1810_2',
|
|
3309
|
+
KukaKr30R3: 'KUKA_KR30_R3',
|
|
3469
3310
|
KukaKr50R2500: 'KUKA_KR50_R2500',
|
|
3470
3311
|
KukaKr120R2700: 'KUKA_KR120_R2700',
|
|
3471
3312
|
KukaKr120R27002: 'KUKA_KR120_R2700_2',
|
|
@@ -3825,12 +3666,12 @@ export interface OpcuaNodeValueTriggerConfig {
|
|
|
3825
3666
|
'node_value': OpcuaNodeValueTriggerConfigNodeValue;
|
|
3826
3667
|
}
|
|
3827
3668
|
/**
|
|
3669
|
+
* @type OpcuaNodeValueTriggerConfigNodeValue
|
|
3828
3670
|
* Value to trigger the program when matched.
|
|
3829
3671
|
* @export
|
|
3830
|
-
* @interface OpcuaNodeValueTriggerConfigNodeValue
|
|
3831
3672
|
*/
|
|
3832
|
-
export
|
|
3833
|
-
|
|
3673
|
+
export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
|
|
3674
|
+
|
|
3834
3675
|
/**
|
|
3835
3676
|
* The operating state.
|
|
3836
3677
|
* @export
|
|
@@ -3956,19 +3797,6 @@ export const OrientationType = {
|
|
|
3956
3797
|
export type OrientationType = typeof OrientationType[keyof typeof OrientationType];
|
|
3957
3798
|
|
|
3958
3799
|
|
|
3959
|
-
/**
|
|
3960
|
-
*
|
|
3961
|
-
* @export
|
|
3962
|
-
* @interface Path
|
|
3963
|
-
*/
|
|
3964
|
-
export interface Path {
|
|
3965
|
-
/**
|
|
3966
|
-
*
|
|
3967
|
-
* @type {Array<RobotState>}
|
|
3968
|
-
* @memberof Path
|
|
3969
|
-
*/
|
|
3970
|
-
'poses'?: Array<RobotState>;
|
|
3971
|
-
}
|
|
3972
3800
|
/**
|
|
3973
3801
|
* A cartesian point-to-point is representing a joint point-to-point motion from start point to the indicated target pose. The target pose is a joint point-to-point given in cartesian space. The target joint configuration will be calculated to be in the same kinematic configuration as the start point is. If that is not possible, planning will fail.
|
|
3974
3802
|
* @export
|
|
@@ -4491,19 +4319,6 @@ export interface PlaybackSpeedResponsePlaybackSpeedResponse {
|
|
|
4491
4319
|
*/
|
|
4492
4320
|
'requested_value': number;
|
|
4493
4321
|
}
|
|
4494
|
-
/**
|
|
4495
|
-
*
|
|
4496
|
-
* @export
|
|
4497
|
-
* @interface PointCloud
|
|
4498
|
-
*/
|
|
4499
|
-
export interface PointCloud {
|
|
4500
|
-
/**
|
|
4501
|
-
*
|
|
4502
|
-
* @type {string}
|
|
4503
|
-
* @memberof PointCloud
|
|
4504
|
-
*/
|
|
4505
|
-
'pointcloud': string;
|
|
4506
|
-
}
|
|
4507
4322
|
/**
|
|
4508
4323
|
* Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
|
|
4509
4324
|
* @export
|
|
@@ -4551,69 +4366,100 @@ export interface PoseInCoordinateSystem {
|
|
|
4551
4366
|
/**
|
|
4552
4367
|
*
|
|
4553
4368
|
* @export
|
|
4369
|
+
* @interface ProgramRequest
|
|
4370
|
+
*/
|
|
4371
|
+
export interface ProgramRequest {
|
|
4372
|
+
/**
|
|
4373
|
+
*
|
|
4374
|
+
* @type {string}
|
|
4375
|
+
* @memberof ProgramRequest
|
|
4376
|
+
*/
|
|
4377
|
+
'program': string;
|
|
4378
|
+
/**
|
|
4379
|
+
* Identifier of the default robot to use for execution
|
|
4380
|
+
* @type {string}
|
|
4381
|
+
* @memberof ProgramRequest
|
|
4382
|
+
*/
|
|
4383
|
+
'default_robot'?: string;
|
|
4384
|
+
/**
|
|
4385
|
+
* Identifier of the default TCP to use for execution
|
|
4386
|
+
* @type {string}
|
|
4387
|
+
* @memberof ProgramRequest
|
|
4388
|
+
*/
|
|
4389
|
+
'default_tcp'?: string;
|
|
4390
|
+
/**
|
|
4391
|
+
* Initial arguments that are available within the program
|
|
4392
|
+
* @type {object}
|
|
4393
|
+
* @memberof ProgramRequest
|
|
4394
|
+
*/
|
|
4395
|
+
'run_args'?: object;
|
|
4396
|
+
}
|
|
4397
|
+
/**
|
|
4398
|
+
* Holds the state of a program run.
|
|
4399
|
+
* @export
|
|
4554
4400
|
* @interface ProgramRun
|
|
4555
4401
|
*/
|
|
4556
4402
|
export interface ProgramRun {
|
|
4557
4403
|
/**
|
|
4558
|
-
*
|
|
4404
|
+
* Unique identifier of the program run
|
|
4559
4405
|
* @type {string}
|
|
4560
4406
|
* @memberof ProgramRun
|
|
4561
4407
|
*/
|
|
4562
4408
|
'id': string;
|
|
4563
4409
|
/**
|
|
4564
|
-
*
|
|
4410
|
+
* State of the program run
|
|
4565
4411
|
* @type {ProgramRunState}
|
|
4566
4412
|
* @memberof ProgramRun
|
|
4567
4413
|
*/
|
|
4568
4414
|
'state': ProgramRunState;
|
|
4569
4415
|
/**
|
|
4570
|
-
*
|
|
4416
|
+
* Logs of the program run
|
|
4571
4417
|
* @type {string}
|
|
4572
4418
|
* @memberof ProgramRun
|
|
4573
4419
|
*/
|
|
4574
4420
|
'logs'?: string;
|
|
4575
4421
|
/**
|
|
4576
|
-
*
|
|
4422
|
+
* Stdout of the program run
|
|
4577
4423
|
* @type {string}
|
|
4578
4424
|
* @memberof ProgramRun
|
|
4579
4425
|
*/
|
|
4580
4426
|
'stdout'?: string;
|
|
4581
4427
|
/**
|
|
4582
|
-
*
|
|
4583
|
-
* @type {
|
|
4428
|
+
* Stores runtime variables of the run
|
|
4429
|
+
* @type {object}
|
|
4584
4430
|
* @memberof ProgramRun
|
|
4585
4431
|
*/
|
|
4586
|
-
'store'?:
|
|
4432
|
+
'store'?: object;
|
|
4587
4433
|
/**
|
|
4588
|
-
*
|
|
4434
|
+
* Error message of the program run, if any
|
|
4589
4435
|
* @type {string}
|
|
4590
4436
|
* @memberof ProgramRun
|
|
4591
4437
|
*/
|
|
4592
|
-
'error'?: string
|
|
4438
|
+
'error'?: string;
|
|
4593
4439
|
/**
|
|
4594
|
-
*
|
|
4440
|
+
* Traceback of the program run, if any
|
|
4595
4441
|
* @type {string}
|
|
4596
4442
|
* @memberof ProgramRun
|
|
4597
4443
|
*/
|
|
4598
|
-
'traceback'?: string
|
|
4444
|
+
'traceback'?: string;
|
|
4599
4445
|
/**
|
|
4600
|
-
*
|
|
4446
|
+
* Start time of the program run
|
|
4601
4447
|
* @type {number}
|
|
4602
4448
|
* @memberof ProgramRun
|
|
4603
4449
|
*/
|
|
4604
|
-
'start_time'?: number
|
|
4450
|
+
'start_time'?: number;
|
|
4605
4451
|
/**
|
|
4606
|
-
*
|
|
4452
|
+
* End time of the program run
|
|
4607
4453
|
* @type {number}
|
|
4608
4454
|
* @memberof ProgramRun
|
|
4609
4455
|
*/
|
|
4610
|
-
'end_time'?: number
|
|
4456
|
+
'end_time'?: number;
|
|
4611
4457
|
/**
|
|
4612
|
-
*
|
|
4613
|
-
* @type {Array<
|
|
4458
|
+
* Execution results of the program run
|
|
4459
|
+
* @type {Array<ProgramRunResult>}
|
|
4614
4460
|
* @memberof ProgramRun
|
|
4615
4461
|
*/
|
|
4616
|
-
'execution_results'?: Array<
|
|
4462
|
+
'execution_results'?: Array<ProgramRunResult>;
|
|
4617
4463
|
}
|
|
4618
4464
|
|
|
4619
4465
|
|
|
@@ -4663,99 +4509,66 @@ export interface ProgramRunObject {
|
|
|
4663
4509
|
/**
|
|
4664
4510
|
*
|
|
4665
4511
|
* @export
|
|
4666
|
-
* @
|
|
4667
|
-
*/
|
|
4668
|
-
|
|
4669
|
-
export const ProgramRunState = {
|
|
4670
|
-
NotStarted: 'not started',
|
|
4671
|
-
Running: 'running',
|
|
4672
|
-
Completed: 'completed',
|
|
4673
|
-
Failed: 'failed',
|
|
4674
|
-
Stopped: 'stopped'
|
|
4675
|
-
} as const;
|
|
4676
|
-
|
|
4677
|
-
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4678
|
-
|
|
4679
|
-
|
|
4680
|
-
/**
|
|
4681
|
-
*
|
|
4682
|
-
* @export
|
|
4683
|
-
* @interface ProgramRunnerReference
|
|
4512
|
+
* @interface ProgramRunReference
|
|
4684
4513
|
*/
|
|
4685
|
-
export interface
|
|
4514
|
+
export interface ProgramRunReference {
|
|
4686
4515
|
/**
|
|
4687
4516
|
*
|
|
4688
4517
|
* @type {string}
|
|
4689
|
-
* @memberof
|
|
4518
|
+
* @memberof ProgramRunReference
|
|
4690
4519
|
*/
|
|
4691
4520
|
'id': string;
|
|
4692
4521
|
/**
|
|
4693
4522
|
*
|
|
4694
4523
|
* @type {ProgramRunState}
|
|
4695
|
-
* @memberof
|
|
4524
|
+
* @memberof ProgramRunReference
|
|
4696
4525
|
*/
|
|
4697
4526
|
'state': ProgramRunState;
|
|
4698
4527
|
}
|
|
4699
4528
|
|
|
4700
4529
|
|
|
4701
4530
|
/**
|
|
4702
|
-
*
|
|
4531
|
+
* The ProgramRunResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
|
|
4703
4532
|
* @export
|
|
4704
|
-
* @interface
|
|
4533
|
+
* @interface ProgramRunResult
|
|
4705
4534
|
*/
|
|
4706
|
-
export interface
|
|
4707
|
-
/**
|
|
4708
|
-
*
|
|
4709
|
-
* @type {Array<any>}
|
|
4710
|
-
* @memberof PyjectoryDatatypesCorePose
|
|
4711
|
-
*/
|
|
4712
|
-
'position': Array<any>;
|
|
4535
|
+
export interface ProgramRunResult {
|
|
4713
4536
|
/**
|
|
4714
|
-
*
|
|
4715
|
-
* @type {
|
|
4716
|
-
* @memberof
|
|
4537
|
+
* Unique identifier of the motion group that was executed
|
|
4538
|
+
* @type {string}
|
|
4539
|
+
* @memberof ProgramRunResult
|
|
4717
4540
|
*/
|
|
4718
|
-
'
|
|
4719
|
-
}
|
|
4720
|
-
/**
|
|
4721
|
-
* Rotation vector, defined in [rx, ry, rz] with floating numbers. The rotation is represented in vector3 using an axis-angle representation: axis.normalized * angle (angle in radians). Must be defined for the first pose of a path. If not defined for the rest of the path, the previous orientation will be used.
|
|
4722
|
-
* @export
|
|
4723
|
-
* @interface PyjectoryDatatypesSerializerOrientation
|
|
4724
|
-
*/
|
|
4725
|
-
export interface PyjectoryDatatypesSerializerOrientation {
|
|
4541
|
+
'motion_group_id': string;
|
|
4726
4542
|
/**
|
|
4727
|
-
*
|
|
4728
|
-
* @type {
|
|
4729
|
-
* @memberof
|
|
4543
|
+
* Total execution duration of the motion group
|
|
4544
|
+
* @type {number}
|
|
4545
|
+
* @memberof ProgramRunResult
|
|
4730
4546
|
*/
|
|
4731
|
-
'
|
|
4732
|
-
}
|
|
4733
|
-
/**
|
|
4734
|
-
* Object\'s position and orientaton, defined in [x, y, z, rx, ry, rz]. x,y,z are defined in millimeters. rx,ry,rz are defined in radians.
|
|
4735
|
-
* @export
|
|
4736
|
-
* @interface PyjectoryDatatypesSerializerPose
|
|
4737
|
-
*/
|
|
4738
|
-
export interface PyjectoryDatatypesSerializerPose {
|
|
4547
|
+
'motion_duration': number;
|
|
4739
4548
|
/**
|
|
4740
|
-
*
|
|
4741
|
-
* @type {Array<
|
|
4742
|
-
* @memberof
|
|
4549
|
+
* Paths of the motion group as list of Path objects
|
|
4550
|
+
* @type {Array<Array<RobotState>>}
|
|
4551
|
+
* @memberof ProgramRunResult
|
|
4743
4552
|
*/
|
|
4744
|
-
'
|
|
4553
|
+
'paths': Array<Array<RobotState>>;
|
|
4745
4554
|
}
|
|
4746
4555
|
/**
|
|
4747
|
-
*
|
|
4556
|
+
*
|
|
4748
4557
|
* @export
|
|
4749
|
-
* @
|
|
4558
|
+
* @enum {string}
|
|
4750
4559
|
*/
|
|
4751
|
-
|
|
4752
|
-
|
|
4753
|
-
|
|
4754
|
-
|
|
4755
|
-
|
|
4756
|
-
|
|
4757
|
-
'
|
|
4758
|
-
}
|
|
4560
|
+
|
|
4561
|
+
export const ProgramRunState = {
|
|
4562
|
+
NotStarted: 'not started',
|
|
4563
|
+
Running: 'running',
|
|
4564
|
+
Completed: 'completed',
|
|
4565
|
+
Failed: 'failed',
|
|
4566
|
+
Stopped: 'stopped'
|
|
4567
|
+
} as const;
|
|
4568
|
+
|
|
4569
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4570
|
+
|
|
4571
|
+
|
|
4759
4572
|
/**
|
|
4760
4573
|
* Defines an x-y plane with finite size.
|
|
4761
4574
|
* @export
|
|
@@ -4884,44 +4697,6 @@ export const ReleaseChannel = {
|
|
|
4884
4697
|
export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
4885
4698
|
|
|
4886
4699
|
|
|
4887
|
-
/**
|
|
4888
|
-
* Wandelscript code string which describes a Program as text/plain
|
|
4889
|
-
* @export
|
|
4890
|
-
* @interface Request
|
|
4891
|
-
*/
|
|
4892
|
-
export interface Request {
|
|
4893
|
-
/**
|
|
4894
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4895
|
-
* @type {string}
|
|
4896
|
-
* @memberof Request
|
|
4897
|
-
*/
|
|
4898
|
-
'code': string;
|
|
4899
|
-
/**
|
|
4900
|
-
*
|
|
4901
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4902
|
-
* @memberof Request
|
|
4903
|
-
*/
|
|
4904
|
-
'initial_state'?: { [key: string]: ArrayInputArrayInner; };
|
|
4905
|
-
}
|
|
4906
|
-
/**
|
|
4907
|
-
* Wandelscript code string which describes a program
|
|
4908
|
-
* @export
|
|
4909
|
-
* @interface Request1
|
|
4910
|
-
*/
|
|
4911
|
-
export interface Request1 {
|
|
4912
|
-
/**
|
|
4913
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4914
|
-
* @type {string}
|
|
4915
|
-
* @memberof Request1
|
|
4916
|
-
*/
|
|
4917
|
-
'code': string;
|
|
4918
|
-
/**
|
|
4919
|
-
*
|
|
4920
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4921
|
-
* @memberof Request1
|
|
4922
|
-
*/
|
|
4923
|
-
'initial_state'?: { [key: string]: ArrayInputArrayInner; };
|
|
4924
|
-
}
|
|
4925
4700
|
/**
|
|
4926
4701
|
* The configuration of a physical or virtual robot controller.
|
|
4927
4702
|
* @export
|
|
@@ -5012,23 +4787,23 @@ export interface RobotLinkGeometry {
|
|
|
5012
4787
|
'geometry': Geometry;
|
|
5013
4788
|
}
|
|
5014
4789
|
/**
|
|
5015
|
-
* Collection of information on the current state of the robot
|
|
4790
|
+
* Collection of information on the current state of the robot.
|
|
5016
4791
|
* @export
|
|
5017
4792
|
* @interface RobotState
|
|
5018
4793
|
*/
|
|
5019
4794
|
export interface RobotState {
|
|
5020
4795
|
/**
|
|
5021
4796
|
*
|
|
5022
|
-
* @type {
|
|
4797
|
+
* @type {Pose}
|
|
5023
4798
|
* @memberof RobotState
|
|
5024
4799
|
*/
|
|
5025
|
-
'pose':
|
|
4800
|
+
'pose': Pose;
|
|
5026
4801
|
/**
|
|
5027
4802
|
*
|
|
5028
4803
|
* @type {Array<number>}
|
|
5029
4804
|
* @memberof RobotState
|
|
5030
4805
|
*/
|
|
5031
|
-
'joints'?: Array<number
|
|
4806
|
+
'joints'?: Array<number>;
|
|
5032
4807
|
}
|
|
5033
4808
|
/**
|
|
5034
4809
|
* The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No input/output interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive input/output information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. Input/Output interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
|
|
@@ -5306,6 +5081,22 @@ export interface SafetyZoneLimits {
|
|
|
5306
5081
|
*/
|
|
5307
5082
|
'limits': PlanningLimits;
|
|
5308
5083
|
}
|
|
5084
|
+
/**
|
|
5085
|
+
*
|
|
5086
|
+
* @export
|
|
5087
|
+
* @enum {string}
|
|
5088
|
+
*/
|
|
5089
|
+
|
|
5090
|
+
export const ServiceGroup = {
|
|
5091
|
+
SystemService: 'SystemService',
|
|
5092
|
+
CellService: 'CellService',
|
|
5093
|
+
RobotController: 'RobotController',
|
|
5094
|
+
App: 'App'
|
|
5095
|
+
} as const;
|
|
5096
|
+
|
|
5097
|
+
export type ServiceGroup = typeof ServiceGroup[keyof typeof ServiceGroup];
|
|
5098
|
+
|
|
5099
|
+
|
|
5309
5100
|
/**
|
|
5310
5101
|
*
|
|
5311
5102
|
* @export
|
|
@@ -5318,6 +5109,12 @@ export interface ServiceStatus {
|
|
|
5318
5109
|
* @memberof ServiceStatus
|
|
5319
5110
|
*/
|
|
5320
5111
|
'service': string;
|
|
5112
|
+
/**
|
|
5113
|
+
*
|
|
5114
|
+
* @type {ServiceGroup}
|
|
5115
|
+
* @memberof ServiceStatus
|
|
5116
|
+
*/
|
|
5117
|
+
'group': ServiceGroup;
|
|
5321
5118
|
/**
|
|
5322
5119
|
*
|
|
5323
5120
|
* @type {ServiceStatusStatus}
|
|
@@ -5325,6 +5122,8 @@ export interface ServiceStatus {
|
|
|
5325
5122
|
*/
|
|
5326
5123
|
'status': ServiceStatusStatus;
|
|
5327
5124
|
}
|
|
5125
|
+
|
|
5126
|
+
|
|
5328
5127
|
/**
|
|
5329
5128
|
*
|
|
5330
5129
|
* @export
|
|
@@ -5636,49 +5435,6 @@ export interface StartOnIO {
|
|
|
5636
5435
|
}
|
|
5637
5436
|
|
|
5638
5437
|
|
|
5639
|
-
/**
|
|
5640
|
-
*
|
|
5641
|
-
* @export
|
|
5642
|
-
* @interface StoreValue
|
|
5643
|
-
*/
|
|
5644
|
-
export interface StoreValue {
|
|
5645
|
-
/**
|
|
5646
|
-
*
|
|
5647
|
-
* @type {Array<any>}
|
|
5648
|
-
* @memberof StoreValue
|
|
5649
|
-
*/
|
|
5650
|
-
'pose': Array<any>;
|
|
5651
|
-
/**
|
|
5652
|
-
*
|
|
5653
|
-
* @type {Array<any>}
|
|
5654
|
-
* @memberof StoreValue
|
|
5655
|
-
*/
|
|
5656
|
-
'position': Array<any>;
|
|
5657
|
-
/**
|
|
5658
|
-
*
|
|
5659
|
-
* @type {Array<any>}
|
|
5660
|
-
* @memberof StoreValue
|
|
5661
|
-
*/
|
|
5662
|
-
'orientation': Array<any>;
|
|
5663
|
-
/**
|
|
5664
|
-
*
|
|
5665
|
-
* @type {string}
|
|
5666
|
-
* @memberof StoreValue
|
|
5667
|
-
*/
|
|
5668
|
-
'image': string;
|
|
5669
|
-
/**
|
|
5670
|
-
*
|
|
5671
|
-
* @type {string}
|
|
5672
|
-
* @memberof StoreValue
|
|
5673
|
-
*/
|
|
5674
|
-
'pointcloud': string;
|
|
5675
|
-
/**
|
|
5676
|
-
*
|
|
5677
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
5678
|
-
* @memberof StoreValue
|
|
5679
|
-
*/
|
|
5680
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
5681
|
-
}
|
|
5682
5438
|
/**
|
|
5683
5439
|
* Representing a robot pose in operational space aware of a configured TCP.
|
|
5684
5440
|
* @export
|
|
@@ -5855,6 +5611,12 @@ export interface TrajectoryData {
|
|
|
5855
5611
|
* @memberof TrajectoryData
|
|
5856
5612
|
*/
|
|
5857
5613
|
'message_type': TrajectoryDataMessageTypeEnum;
|
|
5614
|
+
/**
|
|
5615
|
+
* Identifier of the motion-group.
|
|
5616
|
+
* @type {string}
|
|
5617
|
+
* @memberof TrajectoryData
|
|
5618
|
+
*/
|
|
5619
|
+
'motion_group'?: string;
|
|
5858
5620
|
/**
|
|
5859
5621
|
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
5860
5622
|
* @type {JointTrajectory}
|
|
@@ -5933,10 +5695,10 @@ export interface TriggerObject {
|
|
|
5933
5695
|
'type': TriggerType;
|
|
5934
5696
|
/**
|
|
5935
5697
|
*
|
|
5936
|
-
* @type {
|
|
5698
|
+
* @type {OpcuaNodeValueTriggerConfig}
|
|
5937
5699
|
* @memberof TriggerObject
|
|
5938
5700
|
*/
|
|
5939
|
-
'config':
|
|
5701
|
+
'config': OpcuaNodeValueTriggerConfig;
|
|
5940
5702
|
/**
|
|
5941
5703
|
* ISO 8601 date-time format when the trigger was created.
|
|
5942
5704
|
* @type {string}
|
|
@@ -6054,10 +5816,10 @@ export interface UpdateTriggerRequest {
|
|
|
6054
5816
|
'enabled'?: boolean;
|
|
6055
5817
|
/**
|
|
6056
5818
|
*
|
|
6057
|
-
* @type {
|
|
5819
|
+
* @type {OpcuaNodeValueTriggerConfig}
|
|
6058
5820
|
* @memberof UpdateTriggerRequest
|
|
6059
5821
|
*/
|
|
6060
|
-
'config'?:
|
|
5822
|
+
'config'?: OpcuaNodeValueTriggerConfig;
|
|
6061
5823
|
}
|
|
6062
5824
|
/**
|
|
6063
5825
|
*
|
|
@@ -6087,10 +5849,34 @@ export interface ValidationError {
|
|
|
6087
5849
|
/**
|
|
6088
5850
|
*
|
|
6089
5851
|
* @export
|
|
6090
|
-
* @interface
|
|
5852
|
+
* @interface ValidationError2
|
|
6091
5853
|
*/
|
|
6092
|
-
export interface
|
|
5854
|
+
export interface ValidationError2 {
|
|
5855
|
+
/**
|
|
5856
|
+
*
|
|
5857
|
+
* @type {Array<number>}
|
|
5858
|
+
* @memberof ValidationError2
|
|
5859
|
+
*/
|
|
5860
|
+
'loc': Array<number>;
|
|
5861
|
+
/**
|
|
5862
|
+
*
|
|
5863
|
+
* @type {string}
|
|
5864
|
+
* @memberof ValidationError2
|
|
5865
|
+
*/
|
|
5866
|
+
'msg': string;
|
|
5867
|
+
/**
|
|
5868
|
+
*
|
|
5869
|
+
* @type {string}
|
|
5870
|
+
* @memberof ValidationError2
|
|
5871
|
+
*/
|
|
5872
|
+
'type': string;
|
|
6093
5873
|
}
|
|
5874
|
+
/**
|
|
5875
|
+
* @type ValidationErrorLocInner
|
|
5876
|
+
* @export
|
|
5877
|
+
*/
|
|
5878
|
+
export type ValidationErrorLocInner = number | string;
|
|
5879
|
+
|
|
6094
5880
|
/**
|
|
6095
5881
|
* A generic representation of a version number.
|
|
6096
5882
|
* @export
|
|
@@ -6232,6 +6018,7 @@ export const VirtualControllerTypes = {
|
|
|
6232
6018
|
AbbIrb460025020: 'abb-irb4600_250_20',
|
|
6233
6019
|
AbbIrb460025540: 'abb-irb4600_255_40',
|
|
6234
6020
|
FanucArcMate100iD: 'fanuc-arc_mate_100iD',
|
|
6021
|
+
FanucArcMate100iD16S: 'fanuc-arc_mate_100iD16S',
|
|
6235
6022
|
FanucArcMate120iD: 'fanuc-arc_mate_120iD',
|
|
6236
6023
|
FanucArcMate120iD12L: 'fanuc-arc_mate_120iD12L',
|
|
6237
6024
|
FanucArcMate120iD35: 'fanuc-arc_mate_120iD35',
|
|
@@ -6247,6 +6034,7 @@ export const VirtualControllerTypes = {
|
|
|
6247
6034
|
FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
|
|
6248
6035
|
FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
|
|
6249
6036
|
FanucM10iD12: 'fanuc-m10iD12',
|
|
6037
|
+
FanucM10iD16S: 'fanuc-m10iD16S',
|
|
6250
6038
|
FanucM20iD25: 'fanuc-m20iD25',
|
|
6251
6039
|
FanucM20iD35: 'fanuc-m20iD35',
|
|
6252
6040
|
FanucM900iB280L: 'fanuc-m900iB280L',
|
|
@@ -6259,7 +6047,7 @@ export const VirtualControllerTypes = {
|
|
|
6259
6047
|
KukaKr10R9002: 'kuka-kr10_r900_2',
|
|
6260
6048
|
KukaKr120R27002: 'kuka-kr120_r2700_2',
|
|
6261
6049
|
KukaKr12R18102: 'kuka-kr12_r1810_2',
|
|
6262
|
-
|
|
6050
|
+
KukaKr150R2: 'kuka-kr150_r2',
|
|
6263
6051
|
KukaKr16R16102: 'kuka-kr16_r1610_2',
|
|
6264
6052
|
KukaKr16R20102: 'kuka-kr16_r2010_2',
|
|
6265
6053
|
KukaKr20R1810: 'kuka-kr20_r1810',
|
|
@@ -6269,10 +6057,12 @@ export const VirtualControllerTypes = {
|
|
|
6269
6057
|
KukaKr210R33002: 'kuka-kr210_r3300_2',
|
|
6270
6058
|
KukaKr240R2700: 'kuka-kr240_r2700',
|
|
6271
6059
|
KukaKr250R27002: 'kuka-kr250_r2700_2',
|
|
6060
|
+
KukaKr30R3: 'kuka-kr30_r3',
|
|
6272
6061
|
KukaKr360L2403: 'kuka-kr360_l240_3',
|
|
6273
6062
|
KukaKr4R600: 'kuka-kr4_r600',
|
|
6274
6063
|
KukaKr500L3403: 'kuka-kr500_l340_3',
|
|
6275
6064
|
KukaKr50R2500: 'kuka-kr50_r2500',
|
|
6065
|
+
KukaKr6R1820: 'kuka-kr6_r1820',
|
|
6276
6066
|
KukaKr6R7002: 'kuka-kr6_r700_2',
|
|
6277
6067
|
KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
|
|
6278
6068
|
KukaKr6R900: 'kuka-kr6_r900',
|
|
@@ -6291,11 +6081,21 @@ export const VirtualControllerTypes = {
|
|
|
6291
6081
|
YaskawaAr3120: 'yaskawa-ar3120',
|
|
6292
6082
|
YaskawaAr700: 'yaskawa-ar700',
|
|
6293
6083
|
YaskawaAr900: 'yaskawa-ar900',
|
|
6084
|
+
YaskawaGp110: 'yaskawa-gp110',
|
|
6294
6085
|
YaskawaGp12: 'yaskawa-gp12',
|
|
6086
|
+
YaskawaGp180: 'yaskawa-gp180',
|
|
6087
|
+
YaskawaGp180120: 'yaskawa-gp180-120',
|
|
6295
6088
|
YaskawaGp20hl: 'yaskawa-gp20hl',
|
|
6089
|
+
YaskawaGp215: 'yaskawa-gp215',
|
|
6090
|
+
YaskawaGp225: 'yaskawa-gp225',
|
|
6296
6091
|
YaskawaGp25: 'yaskawa-gp25',
|
|
6092
|
+
YaskawaGp250: 'yaskawa-gp250',
|
|
6297
6093
|
YaskawaGp2512: 'yaskawa-gp25_12',
|
|
6094
|
+
YaskawaGp280: 'yaskawa-gp280',
|
|
6095
|
+
YaskawaGp35L: 'yaskawa-gp35L',
|
|
6096
|
+
YaskawaGp400: 'yaskawa-gp400',
|
|
6298
6097
|
YaskawaGp50: 'yaskawa-gp50',
|
|
6098
|
+
YaskawaGp600: 'yaskawa-gp600',
|
|
6299
6099
|
YaskawaGp7: 'yaskawa-gp7',
|
|
6300
6100
|
YaskawaGp8: 'yaskawa-gp8',
|
|
6301
6101
|
YaskawaGp88: 'yaskawa-gp88',
|
|
@@ -12012,19 +11812,19 @@ export class MotionGroupKinematicsApi extends BaseAPI {
|
|
|
12012
11812
|
export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
12013
11813
|
return {
|
|
12014
11814
|
/**
|
|
12015
|
-
* This endpoint accepts a program
|
|
12016
|
-
* @summary Create
|
|
11815
|
+
* 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.
|
|
11816
|
+
* @summary Create program run
|
|
12017
11817
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12018
|
-
* @param {
|
|
11818
|
+
* @param {ProgramRequest} programRequest
|
|
12019
11819
|
* @param {*} [options] Override http request option.
|
|
12020
11820
|
* @throws {RequiredError}
|
|
12021
11821
|
*/
|
|
12022
|
-
|
|
11822
|
+
createProgramRun: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12023
11823
|
// verify required parameter 'cell' is not null or undefined
|
|
12024
|
-
assertParamExists('
|
|
12025
|
-
// verify required parameter '
|
|
12026
|
-
assertParamExists('
|
|
12027
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
11824
|
+
assertParamExists('createProgramRun', 'cell', cell)
|
|
11825
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
11826
|
+
assertParamExists('createProgramRun', 'programRequest', programRequest)
|
|
11827
|
+
const localVarPath = `/cells/{cell}/programs/runs`
|
|
12028
11828
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12029
11829
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12030
11830
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -12047,12 +11847,12 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12047
11847
|
|
|
12048
11848
|
|
|
12049
11849
|
|
|
12050
|
-
localVarHeaderParameter['Content-Type'] = '
|
|
11850
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12051
11851
|
|
|
12052
11852
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12053
11853
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12054
11854
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12055
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
11855
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
|
|
12056
11856
|
|
|
12057
11857
|
return {
|
|
12058
11858
|
url: toPathString(localVarUrlObj),
|
|
@@ -12060,18 +11860,18 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12060
11860
|
};
|
|
12061
11861
|
},
|
|
12062
11862
|
/**
|
|
12063
|
-
* Execute a program
|
|
12064
|
-
* @summary Execute
|
|
11863
|
+
* 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.
|
|
11864
|
+
* @summary Execute program
|
|
12065
11865
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12066
|
-
* @param {
|
|
11866
|
+
* @param {ProgramRequest} programRequest
|
|
12067
11867
|
* @param {*} [options] Override http request option.
|
|
12068
11868
|
* @throws {RequiredError}
|
|
12069
11869
|
*/
|
|
12070
|
-
executeProgram: async (cell: string,
|
|
11870
|
+
executeProgram: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12071
11871
|
// verify required parameter 'cell' is not null or undefined
|
|
12072
11872
|
assertParamExists('executeProgram', 'cell', cell)
|
|
12073
|
-
// verify required parameter '
|
|
12074
|
-
assertParamExists('executeProgram', '
|
|
11873
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
11874
|
+
assertParamExists('executeProgram', 'programRequest', programRequest)
|
|
12075
11875
|
const localVarPath = `/cells/{cell}/programs/execute`
|
|
12076
11876
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12077
11877
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -12100,7 +11900,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12100
11900
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12101
11901
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12102
11902
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12103
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
11903
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
|
|
12104
11904
|
|
|
12105
11905
|
return {
|
|
12106
11906
|
url: toPathString(localVarUrlObj),
|
|
@@ -12108,21 +11908,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12108
11908
|
};
|
|
12109
11909
|
},
|
|
12110
11910
|
/**
|
|
12111
|
-
* Returns information about a program currently executed.
|
|
12112
|
-
* @summary Get
|
|
11911
|
+
* 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, ...
|
|
11912
|
+
* @summary Get program run
|
|
12113
11913
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12114
|
-
* @param {string}
|
|
11914
|
+
* @param {string} run
|
|
12115
11915
|
* @param {*} [options] Override http request option.
|
|
12116
11916
|
* @throws {RequiredError}
|
|
12117
11917
|
*/
|
|
12118
|
-
|
|
11918
|
+
getProgramRun: async (cell: string, run: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12119
11919
|
// verify required parameter 'cell' is not null or undefined
|
|
12120
|
-
assertParamExists('
|
|
12121
|
-
// verify required parameter '
|
|
12122
|
-
assertParamExists('
|
|
12123
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
11920
|
+
assertParamExists('getProgramRun', 'cell', cell)
|
|
11921
|
+
// verify required parameter 'run' is not null or undefined
|
|
11922
|
+
assertParamExists('getProgramRun', 'run', run)
|
|
11923
|
+
const localVarPath = `/cells/{cell}/programs/runs/{run}`
|
|
12124
11924
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12125
|
-
.replace(`{${"
|
|
11925
|
+
.replace(`{${"run"}}`, encodeURIComponent(String(run)));
|
|
12126
11926
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12127
11927
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12128
11928
|
let baseOptions;
|
|
@@ -12154,16 +11954,16 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12154
11954
|
};
|
|
12155
11955
|
},
|
|
12156
11956
|
/**
|
|
12157
|
-
* Get details about all existing
|
|
12158
|
-
* @summary List
|
|
11957
|
+
* Get details about all existing runs
|
|
11958
|
+
* @summary List programs
|
|
12159
11959
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12160
11960
|
* @param {*} [options] Override http request option.
|
|
12161
11961
|
* @throws {RequiredError}
|
|
12162
11962
|
*/
|
|
12163
|
-
|
|
11963
|
+
getProgramRuns: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12164
11964
|
// verify required parameter 'cell' is not null or undefined
|
|
12165
|
-
assertParamExists('
|
|
12166
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
11965
|
+
assertParamExists('getProgramRuns', 'cell', cell)
|
|
11966
|
+
const localVarPath = `/cells/{cell}/programs/runs`
|
|
12167
11967
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12168
11968
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12169
11969
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -12196,19 +11996,19 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12196
11996
|
};
|
|
12197
11997
|
},
|
|
12198
11998
|
/**
|
|
12199
|
-
*
|
|
12200
|
-
* @summary
|
|
11999
|
+
* Simulate a program given as text/plain
|
|
12000
|
+
* @summary Simulate program
|
|
12201
12001
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12202
|
-
* @param {
|
|
12002
|
+
* @param {ProgramRequest} programRequest
|
|
12203
12003
|
* @param {*} [options] Override http request option.
|
|
12204
12004
|
* @throws {RequiredError}
|
|
12205
12005
|
*/
|
|
12206
|
-
|
|
12006
|
+
simulateProgram: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12207
12007
|
// verify required parameter 'cell' is not null or undefined
|
|
12208
|
-
assertParamExists('
|
|
12209
|
-
// verify required parameter '
|
|
12210
|
-
assertParamExists('
|
|
12211
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
12008
|
+
assertParamExists('simulateProgram', 'cell', cell)
|
|
12009
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
12010
|
+
assertParamExists('simulateProgram', 'programRequest', programRequest)
|
|
12011
|
+
const localVarPath = `/cells/{cell}/programs/simulate`
|
|
12212
12012
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12213
12013
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12214
12014
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -12231,12 +12031,12 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12231
12031
|
|
|
12232
12032
|
|
|
12233
12033
|
|
|
12234
|
-
localVarHeaderParameter['Content-Type'] = '
|
|
12034
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12235
12035
|
|
|
12236
12036
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12237
12037
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12238
12038
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12239
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
12039
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
|
|
12240
12040
|
|
|
12241
12041
|
return {
|
|
12242
12042
|
url: toPathString(localVarUrlObj),
|
|
@@ -12244,20 +12044,16 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12244
12044
|
};
|
|
12245
12045
|
},
|
|
12246
12046
|
/**
|
|
12247
|
-
*
|
|
12248
|
-
* @summary
|
|
12047
|
+
* Stop all runs
|
|
12048
|
+
* @summary Stop all programs
|
|
12249
12049
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12250
|
-
* @param {Request} request
|
|
12251
|
-
* @param {string} [identifier]
|
|
12252
12050
|
* @param {*} [options] Override http request option.
|
|
12253
12051
|
* @throws {RequiredError}
|
|
12254
12052
|
*/
|
|
12255
|
-
|
|
12053
|
+
stopAllPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12256
12054
|
// verify required parameter 'cell' is not null or undefined
|
|
12257
|
-
assertParamExists('
|
|
12258
|
-
|
|
12259
|
-
assertParamExists('planProgram', 'request', request)
|
|
12260
|
-
const localVarPath = `/cells/{cell}/programs/plan`
|
|
12055
|
+
assertParamExists('stopAllPrograms', 'cell', cell)
|
|
12056
|
+
const localVarPath = `/cells/{cell}/programs/runs/stop`
|
|
12261
12057
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12262
12058
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12263
12059
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -12278,18 +12074,11 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12278
12074
|
// http bearer authentication required
|
|
12279
12075
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
12280
12076
|
|
|
12281
|
-
if (identifier !== undefined) {
|
|
12282
|
-
localVarQueryParameter['identifier'] = identifier;
|
|
12283
|
-
}
|
|
12284
|
-
|
|
12285
12077
|
|
|
12286
12078
|
|
|
12287
|
-
localVarHeaderParameter['Content-Type'] = 'text/plain';
|
|
12288
|
-
|
|
12289
12079
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12290
12080
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12291
12081
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12292
|
-
localVarRequestOptions.data = serializeDataIfNeeded(request, localVarRequestOptions, configuration)
|
|
12293
12082
|
|
|
12294
12083
|
return {
|
|
12295
12084
|
url: toPathString(localVarUrlObj),
|
|
@@ -12297,17 +12086,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12297
12086
|
};
|
|
12298
12087
|
},
|
|
12299
12088
|
/**
|
|
12300
|
-
* Stop
|
|
12301
|
-
* @summary Stop
|
|
12089
|
+
* Stop a specific program run.
|
|
12090
|
+
* @summary Stop program run
|
|
12302
12091
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12092
|
+
* @param {string} run
|
|
12303
12093
|
* @param {*} [options] Override http request option.
|
|
12304
12094
|
* @throws {RequiredError}
|
|
12305
12095
|
*/
|
|
12306
|
-
|
|
12096
|
+
stopProgramRun: async (cell: string, run: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12307
12097
|
// verify required parameter 'cell' is not null or undefined
|
|
12308
|
-
assertParamExists('
|
|
12309
|
-
|
|
12310
|
-
|
|
12098
|
+
assertParamExists('stopProgramRun', 'cell', cell)
|
|
12099
|
+
// verify required parameter 'run' is not null or undefined
|
|
12100
|
+
assertParamExists('stopProgramRun', 'run', run)
|
|
12101
|
+
const localVarPath = `/cells/{cell}/programs/runs/{run}/stop`
|
|
12102
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12103
|
+
.replace(`{${"run"}}`, encodeURIComponent(String(run)));
|
|
12311
12104
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12312
12105
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12313
12106
|
let baseOptions;
|
|
@@ -12339,21 +12132,20 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12339
12132
|
};
|
|
12340
12133
|
},
|
|
12341
12134
|
/**
|
|
12342
|
-
*
|
|
12343
|
-
* @summary
|
|
12135
|
+
* Validate a program
|
|
12136
|
+
* @summary Validate program
|
|
12344
12137
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12345
|
-
* @param {
|
|
12138
|
+
* @param {ProgramRequest} programRequest
|
|
12346
12139
|
* @param {*} [options] Override http request option.
|
|
12347
12140
|
* @throws {RequiredError}
|
|
12348
12141
|
*/
|
|
12349
|
-
|
|
12142
|
+
validateProgram: async (cell: string, programRequest: ProgramRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12350
12143
|
// verify required parameter 'cell' is not null or undefined
|
|
12351
|
-
assertParamExists('
|
|
12352
|
-
// verify required parameter '
|
|
12353
|
-
assertParamExists('
|
|
12354
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
12355
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
12356
|
-
.replace(`{${"runner"}}`, encodeURIComponent(String(runner)));
|
|
12144
|
+
assertParamExists('validateProgram', 'cell', cell)
|
|
12145
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
12146
|
+
assertParamExists('validateProgram', 'programRequest', programRequest)
|
|
12147
|
+
const localVarPath = `/cells/{cell}/programs/validate`
|
|
12148
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12357
12149
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12358
12150
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12359
12151
|
let baseOptions;
|
|
@@ -12375,9 +12167,12 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
12375
12167
|
|
|
12376
12168
|
|
|
12377
12169
|
|
|
12170
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
12171
|
+
|
|
12378
12172
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12379
12173
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12380
12174
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12175
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration)
|
|
12381
12176
|
|
|
12382
12177
|
return {
|
|
12383
12178
|
url: toPathString(localVarUrlObj),
|
|
@@ -12395,114 +12190,113 @@ export const ProgramApiFp = function(configuration?: Configuration) {
|
|
|
12395
12190
|
const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
|
|
12396
12191
|
return {
|
|
12397
12192
|
/**
|
|
12398
|
-
* This endpoint accepts a program
|
|
12399
|
-
* @summary Create
|
|
12193
|
+
* 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.
|
|
12194
|
+
* @summary Create program run
|
|
12400
12195
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12401
|
-
* @param {
|
|
12196
|
+
* @param {ProgramRequest} programRequest
|
|
12402
12197
|
* @param {*} [options] Override http request option.
|
|
12403
12198
|
* @throws {RequiredError}
|
|
12404
12199
|
*/
|
|
12405
|
-
async
|
|
12406
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12200
|
+
async createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>> {
|
|
12201
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRun(cell, programRequest, options);
|
|
12407
12202
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12408
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
12203
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.createProgramRun']?.[localVarOperationServerIndex]?.url;
|
|
12409
12204
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12410
12205
|
},
|
|
12411
12206
|
/**
|
|
12412
|
-
* Execute a program
|
|
12413
|
-
* @summary Execute
|
|
12207
|
+
* 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.
|
|
12208
|
+
* @summary Execute program
|
|
12414
12209
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12415
|
-
* @param {
|
|
12210
|
+
* @param {ProgramRequest} programRequest
|
|
12416
12211
|
* @param {*} [options] Override http request option.
|
|
12417
12212
|
* @throws {RequiredError}
|
|
12418
12213
|
*/
|
|
12419
|
-
async executeProgram(cell: string,
|
|
12420
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell,
|
|
12214
|
+
async executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
|
|
12215
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell, programRequest, options);
|
|
12421
12216
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12422
12217
|
const localVarOperationServerBasePath = operationServerMap['ProgramApi.executeProgram']?.[localVarOperationServerIndex]?.url;
|
|
12423
12218
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12424
12219
|
},
|
|
12425
12220
|
/**
|
|
12426
|
-
* Returns information about a program currently executed.
|
|
12427
|
-
* @summary Get
|
|
12221
|
+
* 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, ...
|
|
12222
|
+
* @summary Get program run
|
|
12428
12223
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12429
|
-
* @param {string}
|
|
12224
|
+
* @param {string} run
|
|
12430
12225
|
* @param {*} [options] Override http request option.
|
|
12431
12226
|
* @throws {RequiredError}
|
|
12432
12227
|
*/
|
|
12433
|
-
async
|
|
12434
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12228
|
+
async getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
|
|
12229
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRun(cell, run, options);
|
|
12435
12230
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12436
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
12231
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRun']?.[localVarOperationServerIndex]?.url;
|
|
12437
12232
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12438
12233
|
},
|
|
12439
12234
|
/**
|
|
12440
|
-
* Get details about all existing
|
|
12441
|
-
* @summary List
|
|
12235
|
+
* Get details about all existing runs
|
|
12236
|
+
* @summary List programs
|
|
12442
12237
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12443
12238
|
* @param {*} [options] Override http request option.
|
|
12444
12239
|
* @throws {RequiredError}
|
|
12445
12240
|
*/
|
|
12446
|
-
async
|
|
12447
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12241
|
+
async getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>> {
|
|
12242
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRuns(cell, options);
|
|
12448
12243
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12449
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
12244
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRuns']?.[localVarOperationServerIndex]?.url;
|
|
12450
12245
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12451
12246
|
},
|
|
12452
12247
|
/**
|
|
12453
|
-
*
|
|
12454
|
-
* @summary
|
|
12248
|
+
* Simulate a program given as text/plain
|
|
12249
|
+
* @summary Simulate program
|
|
12455
12250
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12456
|
-
* @param {
|
|
12251
|
+
* @param {ProgramRequest} programRequest
|
|
12457
12252
|
* @param {*} [options] Override http request option.
|
|
12458
12253
|
* @throws {RequiredError}
|
|
12459
12254
|
*/
|
|
12460
|
-
async
|
|
12461
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12255
|
+
async simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
|
|
12256
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.simulateProgram(cell, programRequest, options);
|
|
12462
12257
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12463
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
12258
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.simulateProgram']?.[localVarOperationServerIndex]?.url;
|
|
12464
12259
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12465
12260
|
},
|
|
12466
12261
|
/**
|
|
12467
|
-
*
|
|
12468
|
-
* @summary
|
|
12262
|
+
* Stop all runs
|
|
12263
|
+
* @summary Stop all programs
|
|
12469
12264
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12470
|
-
* @param {Request} request
|
|
12471
|
-
* @param {string} [identifier]
|
|
12472
12265
|
* @param {*} [options] Override http request option.
|
|
12473
12266
|
* @throws {RequiredError}
|
|
12474
12267
|
*/
|
|
12475
|
-
async
|
|
12476
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12268
|
+
async stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
12269
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllPrograms(cell, options);
|
|
12477
12270
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12478
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
12271
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllPrograms']?.[localVarOperationServerIndex]?.url;
|
|
12479
12272
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12480
12273
|
},
|
|
12481
12274
|
/**
|
|
12482
|
-
* Stop
|
|
12483
|
-
* @summary Stop
|
|
12275
|
+
* Stop a specific program run.
|
|
12276
|
+
* @summary Stop program run
|
|
12484
12277
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12278
|
+
* @param {string} run
|
|
12485
12279
|
* @param {*} [options] Override http request option.
|
|
12486
12280
|
* @throws {RequiredError}
|
|
12487
12281
|
*/
|
|
12488
|
-
async
|
|
12489
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12282
|
+
async stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
12283
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgramRun(cell, run, options);
|
|
12490
12284
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12491
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
12285
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgramRun']?.[localVarOperationServerIndex]?.url;
|
|
12492
12286
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12493
12287
|
},
|
|
12494
12288
|
/**
|
|
12495
|
-
*
|
|
12496
|
-
* @summary
|
|
12289
|
+
* Validate a program
|
|
12290
|
+
* @summary Validate program
|
|
12497
12291
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12498
|
-
* @param {
|
|
12292
|
+
* @param {ProgramRequest} programRequest
|
|
12499
12293
|
* @param {*} [options] Override http request option.
|
|
12500
12294
|
* @throws {RequiredError}
|
|
12501
12295
|
*/
|
|
12502
|
-
async
|
|
12503
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12296
|
+
async validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
12297
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.validateProgram(cell, programRequest, options);
|
|
12504
12298
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12505
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
12299
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.validateProgram']?.[localVarOperationServerIndex]?.url;
|
|
12506
12300
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12507
12301
|
},
|
|
12508
12302
|
}
|
|
@@ -12516,91 +12310,90 @@ export const ProgramApiFactory = function (configuration?: Configuration, basePa
|
|
|
12516
12310
|
const localVarFp = ProgramApiFp(configuration)
|
|
12517
12311
|
return {
|
|
12518
12312
|
/**
|
|
12519
|
-
* This endpoint accepts a program
|
|
12520
|
-
* @summary Create
|
|
12313
|
+
* 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.
|
|
12314
|
+
* @summary Create program run
|
|
12521
12315
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12522
|
-
* @param {
|
|
12316
|
+
* @param {ProgramRequest} programRequest
|
|
12523
12317
|
* @param {*} [options] Override http request option.
|
|
12524
12318
|
* @throws {RequiredError}
|
|
12525
12319
|
*/
|
|
12526
|
-
|
|
12527
|
-
return localVarFp.
|
|
12320
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference> {
|
|
12321
|
+
return localVarFp.createProgramRun(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
12528
12322
|
},
|
|
12529
12323
|
/**
|
|
12530
|
-
* Execute a program
|
|
12531
|
-
* @summary Execute
|
|
12324
|
+
* 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.
|
|
12325
|
+
* @summary Execute program
|
|
12532
12326
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12533
|
-
* @param {
|
|
12327
|
+
* @param {ProgramRequest} programRequest
|
|
12534
12328
|
* @param {*} [options] Override http request option.
|
|
12535
12329
|
* @throws {RequiredError}
|
|
12536
12330
|
*/
|
|
12537
|
-
executeProgram(cell: string,
|
|
12538
|
-
return localVarFp.executeProgram(cell,
|
|
12331
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
|
|
12332
|
+
return localVarFp.executeProgram(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
12539
12333
|
},
|
|
12540
12334
|
/**
|
|
12541
|
-
* Returns information about a program currently executed.
|
|
12542
|
-
* @summary Get
|
|
12335
|
+
* 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, ...
|
|
12336
|
+
* @summary Get program run
|
|
12543
12337
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12544
|
-
* @param {string}
|
|
12338
|
+
* @param {string} run
|
|
12545
12339
|
* @param {*} [options] Override http request option.
|
|
12546
12340
|
* @throws {RequiredError}
|
|
12547
12341
|
*/
|
|
12548
|
-
|
|
12549
|
-
return localVarFp.
|
|
12342
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
|
|
12343
|
+
return localVarFp.getProgramRun(cell, run, options).then((request) => request(axios, basePath));
|
|
12550
12344
|
},
|
|
12551
12345
|
/**
|
|
12552
|
-
* Get details about all existing
|
|
12553
|
-
* @summary List
|
|
12346
|
+
* Get details about all existing runs
|
|
12347
|
+
* @summary List programs
|
|
12554
12348
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12555
12349
|
* @param {*} [options] Override http request option.
|
|
12556
12350
|
* @throws {RequiredError}
|
|
12557
12351
|
*/
|
|
12558
|
-
|
|
12559
|
-
return localVarFp.
|
|
12352
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>> {
|
|
12353
|
+
return localVarFp.getProgramRuns(cell, options).then((request) => request(axios, basePath));
|
|
12560
12354
|
},
|
|
12561
12355
|
/**
|
|
12562
|
-
*
|
|
12563
|
-
* @summary
|
|
12356
|
+
* Simulate a program given as text/plain
|
|
12357
|
+
* @summary Simulate program
|
|
12564
12358
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12565
|
-
* @param {
|
|
12359
|
+
* @param {ProgramRequest} programRequest
|
|
12566
12360
|
* @param {*} [options] Override http request option.
|
|
12567
12361
|
* @throws {RequiredError}
|
|
12568
12362
|
*/
|
|
12569
|
-
|
|
12570
|
-
return localVarFp.
|
|
12363
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
|
|
12364
|
+
return localVarFp.simulateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
12571
12365
|
},
|
|
12572
12366
|
/**
|
|
12573
|
-
*
|
|
12574
|
-
* @summary
|
|
12367
|
+
* Stop all runs
|
|
12368
|
+
* @summary Stop all programs
|
|
12575
12369
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12576
|
-
* @param {Request} request
|
|
12577
|
-
* @param {string} [identifier]
|
|
12578
12370
|
* @param {*} [options] Override http request option.
|
|
12579
12371
|
* @throws {RequiredError}
|
|
12580
12372
|
*/
|
|
12581
|
-
|
|
12582
|
-
return localVarFp.
|
|
12373
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12374
|
+
return localVarFp.stopAllPrograms(cell, options).then((request) => request(axios, basePath));
|
|
12583
12375
|
},
|
|
12584
12376
|
/**
|
|
12585
|
-
* Stop
|
|
12586
|
-
* @summary Stop
|
|
12377
|
+
* Stop a specific program run.
|
|
12378
|
+
* @summary Stop program run
|
|
12587
12379
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12380
|
+
* @param {string} run
|
|
12588
12381
|
* @param {*} [options] Override http request option.
|
|
12589
12382
|
* @throws {RequiredError}
|
|
12590
12383
|
*/
|
|
12591
|
-
|
|
12592
|
-
return localVarFp.
|
|
12384
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12385
|
+
return localVarFp.stopProgramRun(cell, run, options).then((request) => request(axios, basePath));
|
|
12593
12386
|
},
|
|
12594
12387
|
/**
|
|
12595
|
-
*
|
|
12596
|
-
* @summary
|
|
12388
|
+
* Validate a program
|
|
12389
|
+
* @summary Validate program
|
|
12597
12390
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12598
|
-
* @param {
|
|
12391
|
+
* @param {ProgramRequest} programRequest
|
|
12599
12392
|
* @param {*} [options] Override http request option.
|
|
12600
12393
|
* @throws {RequiredError}
|
|
12601
12394
|
*/
|
|
12602
|
-
|
|
12603
|
-
return localVarFp.
|
|
12395
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
12396
|
+
return localVarFp.validateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
12604
12397
|
},
|
|
12605
12398
|
};
|
|
12606
12399
|
};
|
|
@@ -12613,106 +12406,105 @@ export const ProgramApiFactory = function (configuration?: Configuration, basePa
|
|
|
12613
12406
|
*/
|
|
12614
12407
|
export class ProgramApi extends BaseAPI {
|
|
12615
12408
|
/**
|
|
12616
|
-
* This endpoint accepts a program
|
|
12617
|
-
* @summary Create
|
|
12409
|
+
* 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.
|
|
12410
|
+
* @summary Create program run
|
|
12618
12411
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12619
|
-
* @param {
|
|
12412
|
+
* @param {ProgramRequest} programRequest
|
|
12620
12413
|
* @param {*} [options] Override http request option.
|
|
12621
12414
|
* @throws {RequiredError}
|
|
12622
12415
|
* @memberof ProgramApi
|
|
12623
12416
|
*/
|
|
12624
|
-
public
|
|
12625
|
-
return ProgramApiFp(this.configuration).
|
|
12417
|
+
public createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
|
|
12418
|
+
return ProgramApiFp(this.configuration).createProgramRun(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12626
12419
|
}
|
|
12627
12420
|
|
|
12628
12421
|
/**
|
|
12629
|
-
* Execute a program
|
|
12630
|
-
* @summary Execute
|
|
12422
|
+
* 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.
|
|
12423
|
+
* @summary Execute program
|
|
12631
12424
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12632
|
-
* @param {
|
|
12425
|
+
* @param {ProgramRequest} programRequest
|
|
12633
12426
|
* @param {*} [options] Override http request option.
|
|
12634
12427
|
* @throws {RequiredError}
|
|
12635
12428
|
* @memberof ProgramApi
|
|
12636
12429
|
*/
|
|
12637
|
-
public executeProgram(cell: string,
|
|
12638
|
-
return ProgramApiFp(this.configuration).executeProgram(cell,
|
|
12430
|
+
public executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
|
|
12431
|
+
return ProgramApiFp(this.configuration).executeProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12639
12432
|
}
|
|
12640
12433
|
|
|
12641
12434
|
/**
|
|
12642
|
-
* Returns information about a program currently executed.
|
|
12643
|
-
* @summary Get
|
|
12435
|
+
* 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, ...
|
|
12436
|
+
* @summary Get program run
|
|
12644
12437
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12645
|
-
* @param {string}
|
|
12438
|
+
* @param {string} run
|
|
12646
12439
|
* @param {*} [options] Override http request option.
|
|
12647
12440
|
* @throws {RequiredError}
|
|
12648
12441
|
* @memberof ProgramApi
|
|
12649
12442
|
*/
|
|
12650
|
-
public
|
|
12651
|
-
return ProgramApiFp(this.configuration).
|
|
12443
|
+
public getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig) {
|
|
12444
|
+
return ProgramApiFp(this.configuration).getProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
|
|
12652
12445
|
}
|
|
12653
12446
|
|
|
12654
12447
|
/**
|
|
12655
|
-
* Get details about all existing
|
|
12656
|
-
* @summary List
|
|
12448
|
+
* Get details about all existing runs
|
|
12449
|
+
* @summary List programs
|
|
12657
12450
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12658
12451
|
* @param {*} [options] Override http request option.
|
|
12659
12452
|
* @throws {RequiredError}
|
|
12660
12453
|
* @memberof ProgramApi
|
|
12661
12454
|
*/
|
|
12662
|
-
public
|
|
12663
|
-
return ProgramApiFp(this.configuration).
|
|
12455
|
+
public getProgramRuns(cell: string, options?: RawAxiosRequestConfig) {
|
|
12456
|
+
return ProgramApiFp(this.configuration).getProgramRuns(cell, options).then((request) => request(this.axios, this.basePath));
|
|
12664
12457
|
}
|
|
12665
12458
|
|
|
12666
12459
|
/**
|
|
12667
|
-
*
|
|
12668
|
-
* @summary
|
|
12460
|
+
* Simulate a program given as text/plain
|
|
12461
|
+
* @summary Simulate program
|
|
12669
12462
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12670
|
-
* @param {
|
|
12463
|
+
* @param {ProgramRequest} programRequest
|
|
12671
12464
|
* @param {*} [options] Override http request option.
|
|
12672
12465
|
* @throws {RequiredError}
|
|
12673
12466
|
* @memberof ProgramApi
|
|
12674
12467
|
*/
|
|
12675
|
-
public
|
|
12676
|
-
return ProgramApiFp(this.configuration).
|
|
12468
|
+
public simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
|
|
12469
|
+
return ProgramApiFp(this.configuration).simulateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12677
12470
|
}
|
|
12678
12471
|
|
|
12679
12472
|
/**
|
|
12680
|
-
*
|
|
12681
|
-
* @summary
|
|
12473
|
+
* Stop all runs
|
|
12474
|
+
* @summary Stop all programs
|
|
12682
12475
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12683
|
-
* @param {Request} request
|
|
12684
|
-
* @param {string} [identifier]
|
|
12685
12476
|
* @param {*} [options] Override http request option.
|
|
12686
12477
|
* @throws {RequiredError}
|
|
12687
12478
|
* @memberof ProgramApi
|
|
12688
12479
|
*/
|
|
12689
|
-
public
|
|
12690
|
-
return ProgramApiFp(this.configuration).
|
|
12480
|
+
public stopAllPrograms(cell: string, options?: RawAxiosRequestConfig) {
|
|
12481
|
+
return ProgramApiFp(this.configuration).stopAllPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
12691
12482
|
}
|
|
12692
12483
|
|
|
12693
12484
|
/**
|
|
12694
|
-
* Stop
|
|
12695
|
-
* @summary Stop
|
|
12485
|
+
* Stop a specific program run.
|
|
12486
|
+
* @summary Stop program run
|
|
12696
12487
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12488
|
+
* @param {string} run
|
|
12697
12489
|
* @param {*} [options] Override http request option.
|
|
12698
12490
|
* @throws {RequiredError}
|
|
12699
12491
|
* @memberof ProgramApi
|
|
12700
12492
|
*/
|
|
12701
|
-
public
|
|
12702
|
-
return ProgramApiFp(this.configuration).
|
|
12493
|
+
public stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig) {
|
|
12494
|
+
return ProgramApiFp(this.configuration).stopProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
|
|
12703
12495
|
}
|
|
12704
12496
|
|
|
12705
12497
|
/**
|
|
12706
|
-
*
|
|
12707
|
-
* @summary
|
|
12498
|
+
* Validate a program
|
|
12499
|
+
* @summary Validate program
|
|
12708
12500
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12709
|
-
* @param {
|
|
12501
|
+
* @param {ProgramRequest} programRequest
|
|
12710
12502
|
* @param {*} [options] Override http request option.
|
|
12711
12503
|
* @throws {RequiredError}
|
|
12712
12504
|
* @memberof ProgramApi
|
|
12713
12505
|
*/
|
|
12714
|
-
public
|
|
12715
|
-
return ProgramApiFp(this.configuration).
|
|
12506
|
+
public validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) {
|
|
12507
|
+
return ProgramApiFp(this.configuration).validateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
12716
12508
|
}
|
|
12717
12509
|
}
|
|
12718
12510
|
|
|
@@ -12725,18 +12517,18 @@ export class ProgramApi extends BaseAPI {
|
|
|
12725
12517
|
export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
12726
12518
|
return {
|
|
12727
12519
|
/**
|
|
12728
|
-
* <!-- theme: danger -->
|
|
12520
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
12729
12521
|
* @summary Run Program from Library
|
|
12730
12522
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12731
|
-
* @param {
|
|
12523
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
12732
12524
|
* @param {*} [options] Override http request option.
|
|
12733
12525
|
* @throws {RequiredError}
|
|
12734
12526
|
*/
|
|
12735
|
-
|
|
12527
|
+
createProgramOperatorRun: async (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12736
12528
|
// verify required parameter 'cell' is not null or undefined
|
|
12737
|
-
assertParamExists('
|
|
12738
|
-
// verify required parameter '
|
|
12739
|
-
assertParamExists('
|
|
12529
|
+
assertParamExists('createProgramOperatorRun', 'cell', cell)
|
|
12530
|
+
// verify required parameter 'createProgramOperatorRunRequest' is not null or undefined
|
|
12531
|
+
assertParamExists('createProgramOperatorRun', 'createProgramOperatorRunRequest', createProgramOperatorRunRequest)
|
|
12740
12532
|
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
12741
12533
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12742
12534
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -12765,7 +12557,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
|
|
|
12765
12557
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12766
12558
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12767
12559
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12768
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
12560
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createProgramOperatorRunRequest, localVarRequestOptions, configuration)
|
|
12769
12561
|
|
|
12770
12562
|
return {
|
|
12771
12563
|
url: toPathString(localVarUrlObj),
|
|
@@ -12867,16 +12659,16 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
|
|
|
12867
12659
|
};
|
|
12868
12660
|
},
|
|
12869
12661
|
/**
|
|
12870
|
-
* <!-- theme: danger -->
|
|
12662
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
12871
12663
|
* @summary Get All Program Runs
|
|
12872
12664
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12873
12665
|
* @param {string} [state]
|
|
12874
12666
|
* @param {*} [options] Override http request option.
|
|
12875
12667
|
* @throws {RequiredError}
|
|
12876
12668
|
*/
|
|
12877
|
-
|
|
12669
|
+
getAllProgramOperatorRuns: async (cell: string, state?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12878
12670
|
// verify required parameter 'cell' is not null or undefined
|
|
12879
|
-
assertParamExists('
|
|
12671
|
+
assertParamExists('getAllProgramOperatorRuns', 'cell', cell)
|
|
12880
12672
|
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
12881
12673
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
12882
12674
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -12914,7 +12706,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
|
|
|
12914
12706
|
};
|
|
12915
12707
|
},
|
|
12916
12708
|
/**
|
|
12917
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
12709
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
12918
12710
|
* @summary Get All Triggers
|
|
12919
12711
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12920
12712
|
* @param {*} [options] Override http request option.
|
|
@@ -12956,18 +12748,18 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
|
|
|
12956
12748
|
};
|
|
12957
12749
|
},
|
|
12958
12750
|
/**
|
|
12959
|
-
* <!-- theme: danger -->
|
|
12751
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
12960
12752
|
* @summary Get Program Run
|
|
12961
12753
|
* @param {string} run
|
|
12962
12754
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
12963
12755
|
* @param {*} [options] Override http request option.
|
|
12964
12756
|
* @throws {RequiredError}
|
|
12965
12757
|
*/
|
|
12966
|
-
|
|
12758
|
+
getProgramOperatorRun: async (run: string, cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12967
12759
|
// verify required parameter 'run' is not null or undefined
|
|
12968
|
-
assertParamExists('
|
|
12760
|
+
assertParamExists('getProgramOperatorRun', 'run', run)
|
|
12969
12761
|
// verify required parameter 'cell' is not null or undefined
|
|
12970
|
-
assertParamExists('
|
|
12762
|
+
assertParamExists('getProgramOperatorRun', 'cell', cell)
|
|
12971
12763
|
const localVarPath = `/cells/{cell}/operator/programs/runs/{run}`
|
|
12972
12764
|
.replace(`{${"run"}}`, encodeURIComponent(String(run)))
|
|
12973
12765
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
@@ -13050,7 +12842,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
|
|
|
13050
12842
|
/**
|
|
13051
12843
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
13052
12844
|
* @summary Update Trigger
|
|
13053
|
-
* @param {string} trigger
|
|
12845
|
+
* @param {string} trigger The identifier of the trigger.
|
|
13054
12846
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13055
12847
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
13056
12848
|
* @param {*} [options] Override http request option.
|
|
@@ -13110,17 +12902,17 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
|
|
|
13110
12902
|
const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration)
|
|
13111
12903
|
return {
|
|
13112
12904
|
/**
|
|
13113
|
-
* <!-- theme: danger -->
|
|
12905
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
13114
12906
|
* @summary Run Program from Library
|
|
13115
12907
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13116
|
-
* @param {
|
|
12908
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
13117
12909
|
* @param {*} [options] Override http request option.
|
|
13118
12910
|
* @throws {RequiredError}
|
|
13119
12911
|
*/
|
|
13120
|
-
async
|
|
13121
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12912
|
+
async createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>> {
|
|
12913
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options);
|
|
13122
12914
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13123
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.
|
|
12915
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
13124
12916
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13125
12917
|
},
|
|
13126
12918
|
/**
|
|
@@ -13152,21 +12944,21 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
|
|
|
13152
12944
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13153
12945
|
},
|
|
13154
12946
|
/**
|
|
13155
|
-
* <!-- theme: danger -->
|
|
12947
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
13156
12948
|
* @summary Get All Program Runs
|
|
13157
12949
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13158
12950
|
* @param {string} [state]
|
|
13159
12951
|
* @param {*} [options] Override http request option.
|
|
13160
12952
|
* @throws {RequiredError}
|
|
13161
12953
|
*/
|
|
13162
|
-
async
|
|
13163
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12954
|
+
async getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>> {
|
|
12955
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramOperatorRuns(cell, state, options);
|
|
13164
12956
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13165
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.
|
|
12957
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramOperatorRuns']?.[localVarOperationServerIndex]?.url;
|
|
13166
12958
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13167
12959
|
},
|
|
13168
12960
|
/**
|
|
13169
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
12961
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
13170
12962
|
* @summary Get All Triggers
|
|
13171
12963
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13172
12964
|
* @param {*} [options] Override http request option.
|
|
@@ -13179,17 +12971,17 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
|
|
|
13179
12971
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13180
12972
|
},
|
|
13181
12973
|
/**
|
|
13182
|
-
* <!-- theme: danger -->
|
|
12974
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
13183
12975
|
* @summary Get Program Run
|
|
13184
12976
|
* @param {string} run
|
|
13185
12977
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13186
12978
|
* @param {*} [options] Override http request option.
|
|
13187
12979
|
* @throws {RequiredError}
|
|
13188
12980
|
*/
|
|
13189
|
-
async
|
|
13190
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
12981
|
+
async getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>> {
|
|
12982
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramOperatorRun(run, cell, options);
|
|
13191
12983
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13192
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.
|
|
12984
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
13193
12985
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13194
12986
|
},
|
|
13195
12987
|
/**
|
|
@@ -13209,7 +13001,7 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
|
|
|
13209
13001
|
/**
|
|
13210
13002
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
13211
13003
|
* @summary Update Trigger
|
|
13212
|
-
* @param {string} trigger
|
|
13004
|
+
* @param {string} trigger The identifier of the trigger.
|
|
13213
13005
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13214
13006
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
13215
13007
|
* @param {*} [options] Override http request option.
|
|
@@ -13232,15 +13024,15 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
|
|
|
13232
13024
|
const localVarFp = ProgramOperatorApiFp(configuration)
|
|
13233
13025
|
return {
|
|
13234
13026
|
/**
|
|
13235
|
-
* <!-- theme: danger -->
|
|
13027
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
13236
13028
|
* @summary Run Program from Library
|
|
13237
13029
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13238
|
-
* @param {
|
|
13030
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
13239
13031
|
* @param {*} [options] Override http request option.
|
|
13240
13032
|
* @throws {RequiredError}
|
|
13241
13033
|
*/
|
|
13242
|
-
|
|
13243
|
-
return localVarFp.
|
|
13034
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response> {
|
|
13035
|
+
return localVarFp.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(axios, basePath));
|
|
13244
13036
|
},
|
|
13245
13037
|
/**
|
|
13246
13038
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
@@ -13265,18 +13057,18 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
|
|
|
13265
13057
|
return localVarFp.deleteTrigger(trigger, cell, options).then((request) => request(axios, basePath));
|
|
13266
13058
|
},
|
|
13267
13059
|
/**
|
|
13268
|
-
* <!-- theme: danger -->
|
|
13060
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
13269
13061
|
* @summary Get All Program Runs
|
|
13270
13062
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13271
13063
|
* @param {string} [state]
|
|
13272
13064
|
* @param {*} [options] Override http request option.
|
|
13273
13065
|
* @throws {RequiredError}
|
|
13274
13066
|
*/
|
|
13275
|
-
|
|
13276
|
-
return localVarFp.
|
|
13067
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response> {
|
|
13068
|
+
return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
|
|
13277
13069
|
},
|
|
13278
13070
|
/**
|
|
13279
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
13071
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
13280
13072
|
* @summary Get All Triggers
|
|
13281
13073
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13282
13074
|
* @param {*} [options] Override http request option.
|
|
@@ -13286,15 +13078,15 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
|
|
|
13286
13078
|
return localVarFp.getAllTriggers(cell, options).then((request) => request(axios, basePath));
|
|
13287
13079
|
},
|
|
13288
13080
|
/**
|
|
13289
|
-
* <!-- theme: danger -->
|
|
13081
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
13290
13082
|
* @summary Get Program Run
|
|
13291
13083
|
* @param {string} run
|
|
13292
13084
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13293
13085
|
* @param {*} [options] Override http request option.
|
|
13294
13086
|
* @throws {RequiredError}
|
|
13295
13087
|
*/
|
|
13296
|
-
|
|
13297
|
-
return localVarFp.
|
|
13088
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject> {
|
|
13089
|
+
return localVarFp.getProgramOperatorRun(run, cell, options).then((request) => request(axios, basePath));
|
|
13298
13090
|
},
|
|
13299
13091
|
/**
|
|
13300
13092
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
@@ -13310,7 +13102,7 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
|
|
|
13310
13102
|
/**
|
|
13311
13103
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
13312
13104
|
* @summary Update Trigger
|
|
13313
|
-
* @param {string} trigger
|
|
13105
|
+
* @param {string} trigger The identifier of the trigger.
|
|
13314
13106
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13315
13107
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
13316
13108
|
* @param {*} [options] Override http request option.
|
|
@@ -13330,16 +13122,16 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
|
|
|
13330
13122
|
*/
|
|
13331
13123
|
export class ProgramOperatorApi extends BaseAPI {
|
|
13332
13124
|
/**
|
|
13333
|
-
* <!-- theme: danger -->
|
|
13125
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
13334
13126
|
* @summary Run Program from Library
|
|
13335
13127
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13336
|
-
* @param {
|
|
13128
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
13337
13129
|
* @param {*} [options] Override http request option.
|
|
13338
13130
|
* @throws {RequiredError}
|
|
13339
13131
|
* @memberof ProgramOperatorApi
|
|
13340
13132
|
*/
|
|
13341
|
-
public
|
|
13342
|
-
return ProgramOperatorApiFp(this.configuration).
|
|
13133
|
+
public createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) {
|
|
13134
|
+
return ProgramOperatorApiFp(this.configuration).createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
13343
13135
|
}
|
|
13344
13136
|
|
|
13345
13137
|
/**
|
|
@@ -13369,7 +13161,7 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
13369
13161
|
}
|
|
13370
13162
|
|
|
13371
13163
|
/**
|
|
13372
|
-
* <!-- theme: danger -->
|
|
13164
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
13373
13165
|
* @summary Get All Program Runs
|
|
13374
13166
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13375
13167
|
* @param {string} [state]
|
|
@@ -13377,12 +13169,12 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
13377
13169
|
* @throws {RequiredError}
|
|
13378
13170
|
* @memberof ProgramOperatorApi
|
|
13379
13171
|
*/
|
|
13380
|
-
public
|
|
13381
|
-
return ProgramOperatorApiFp(this.configuration).
|
|
13172
|
+
public getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig) {
|
|
13173
|
+
return ProgramOperatorApiFp(this.configuration).getAllProgramOperatorRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
|
|
13382
13174
|
}
|
|
13383
13175
|
|
|
13384
13176
|
/**
|
|
13385
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
13177
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
13386
13178
|
* @summary Get All Triggers
|
|
13387
13179
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13388
13180
|
* @param {*} [options] Override http request option.
|
|
@@ -13394,7 +13186,7 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
13394
13186
|
}
|
|
13395
13187
|
|
|
13396
13188
|
/**
|
|
13397
|
-
* <!-- theme: danger -->
|
|
13189
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
13398
13190
|
* @summary Get Program Run
|
|
13399
13191
|
* @param {string} run
|
|
13400
13192
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -13402,8 +13194,8 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
13402
13194
|
* @throws {RequiredError}
|
|
13403
13195
|
* @memberof ProgramOperatorApi
|
|
13404
13196
|
*/
|
|
13405
|
-
public
|
|
13406
|
-
return ProgramOperatorApiFp(this.configuration).
|
|
13197
|
+
public getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig) {
|
|
13198
|
+
return ProgramOperatorApiFp(this.configuration).getProgramOperatorRun(run, cell, options).then((request) => request(this.axios, this.basePath));
|
|
13407
13199
|
}
|
|
13408
13200
|
|
|
13409
13201
|
/**
|
|
@@ -13422,7 +13214,7 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
13422
13214
|
/**
|
|
13423
13215
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
13424
13216
|
* @summary Update Trigger
|
|
13425
|
-
* @param {string} trigger
|
|
13217
|
+
* @param {string} trigger The identifier of the trigger.
|
|
13426
13218
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
13427
13219
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
13428
13220
|
* @param {*} [options] Override http request option.
|