@wandelbots/nova-api 25.5.0-dev.2 → 25.5.0-dev.21
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 +75 -3
- package/v1/api.js +17 -0
- package/v1/api.js.map +1 -1
- package/v1/api.ts +76 -3
- package/v2/api.d.ts +496 -1018
- package/v2/api.js +1693 -2114
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1963 -2753
package/v2/api.d.ts
CHANGED
|
@@ -193,7 +193,7 @@ export interface AllJointPositionsResponse {
|
|
|
193
193
|
*/
|
|
194
194
|
export interface App {
|
|
195
195
|
/**
|
|
196
|
-
* The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name).
|
|
196
|
+
* The name of the provided application. The name must be unique within the cell and is used as a identifier for addressing the application in all API calls , e.g. when updating the application. It also defines where the application is reachable (/$cell/$name). It must be a valid k8s label name as defined by [RFC 1035](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names).
|
|
197
197
|
* @type {string}
|
|
198
198
|
* @memberof App
|
|
199
199
|
*/
|
|
@@ -235,118 +235,6 @@ export interface App {
|
|
|
235
235
|
*/
|
|
236
236
|
'health_path'?: string;
|
|
237
237
|
}
|
|
238
|
-
/**
|
|
239
|
-
*
|
|
240
|
-
* @export
|
|
241
|
-
* @interface ArrayInput
|
|
242
|
-
*/
|
|
243
|
-
export interface ArrayInput {
|
|
244
|
-
/**
|
|
245
|
-
*
|
|
246
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
247
|
-
* @memberof ArrayInput
|
|
248
|
-
*/
|
|
249
|
-
'array': Array<ArrayInputArrayInner>;
|
|
250
|
-
}
|
|
251
|
-
/**
|
|
252
|
-
*
|
|
253
|
-
* @export
|
|
254
|
-
* @interface ArrayInputArrayInner
|
|
255
|
-
*/
|
|
256
|
-
export interface ArrayInputArrayInner {
|
|
257
|
-
/**
|
|
258
|
-
*
|
|
259
|
-
* @type {Array<any>}
|
|
260
|
-
* @memberof ArrayInputArrayInner
|
|
261
|
-
*/
|
|
262
|
-
'pose': Array<any>;
|
|
263
|
-
/**
|
|
264
|
-
*
|
|
265
|
-
* @type {Array<any>}
|
|
266
|
-
* @memberof ArrayInputArrayInner
|
|
267
|
-
*/
|
|
268
|
-
'position': Array<any>;
|
|
269
|
-
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {Array<any>}
|
|
272
|
-
* @memberof ArrayInputArrayInner
|
|
273
|
-
*/
|
|
274
|
-
'orientation': Array<any>;
|
|
275
|
-
/**
|
|
276
|
-
*
|
|
277
|
-
* @type {string}
|
|
278
|
-
* @memberof ArrayInputArrayInner
|
|
279
|
-
*/
|
|
280
|
-
'image': string;
|
|
281
|
-
/**
|
|
282
|
-
*
|
|
283
|
-
* @type {string}
|
|
284
|
-
* @memberof ArrayInputArrayInner
|
|
285
|
-
*/
|
|
286
|
-
'pointcloud': string;
|
|
287
|
-
/**
|
|
288
|
-
*
|
|
289
|
-
* @type {Array<ArrayInputArrayInner>}
|
|
290
|
-
* @memberof ArrayInputArrayInner
|
|
291
|
-
*/
|
|
292
|
-
'array': Array<ArrayInputArrayInner>;
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
*
|
|
296
|
-
* @export
|
|
297
|
-
* @interface ArrayOutput
|
|
298
|
-
*/
|
|
299
|
-
export interface ArrayOutput {
|
|
300
|
-
/**
|
|
301
|
-
*
|
|
302
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
303
|
-
* @memberof ArrayOutput
|
|
304
|
-
*/
|
|
305
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
306
|
-
}
|
|
307
|
-
/**
|
|
308
|
-
*
|
|
309
|
-
* @export
|
|
310
|
-
* @interface ArrayOutputArrayInner
|
|
311
|
-
*/
|
|
312
|
-
export interface ArrayOutputArrayInner {
|
|
313
|
-
/**
|
|
314
|
-
*
|
|
315
|
-
* @type {Array<any>}
|
|
316
|
-
* @memberof ArrayOutputArrayInner
|
|
317
|
-
*/
|
|
318
|
-
'pose': Array<any>;
|
|
319
|
-
/**
|
|
320
|
-
*
|
|
321
|
-
* @type {Array<any>}
|
|
322
|
-
* @memberof ArrayOutputArrayInner
|
|
323
|
-
*/
|
|
324
|
-
'position': Array<any>;
|
|
325
|
-
/**
|
|
326
|
-
*
|
|
327
|
-
* @type {Array<any>}
|
|
328
|
-
* @memberof ArrayOutputArrayInner
|
|
329
|
-
*/
|
|
330
|
-
'orientation': Array<any>;
|
|
331
|
-
/**
|
|
332
|
-
*
|
|
333
|
-
* @type {string}
|
|
334
|
-
* @memberof ArrayOutputArrayInner
|
|
335
|
-
*/
|
|
336
|
-
'image': string;
|
|
337
|
-
/**
|
|
338
|
-
*
|
|
339
|
-
* @type {string}
|
|
340
|
-
* @memberof ArrayOutputArrayInner
|
|
341
|
-
*/
|
|
342
|
-
'pointcloud': string;
|
|
343
|
-
/**
|
|
344
|
-
*
|
|
345
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
346
|
-
* @memberof ArrayOutputArrayInner
|
|
347
|
-
*/
|
|
348
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
349
|
-
}
|
|
350
238
|
/**
|
|
351
239
|
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion group instantly takes any commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g. with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
352
240
|
* @export
|
|
@@ -557,19 +445,6 @@ export declare const Capsule2ShapeTypeEnum: {
|
|
|
557
445
|
readonly Capsule: "capsule";
|
|
558
446
|
};
|
|
559
447
|
export type Capsule2ShapeTypeEnum = typeof Capsule2ShapeTypeEnum[keyof typeof Capsule2ShapeTypeEnum];
|
|
560
|
-
/**
|
|
561
|
-
*
|
|
562
|
-
* @export
|
|
563
|
-
* @interface Capture
|
|
564
|
-
*/
|
|
565
|
-
export interface Capture {
|
|
566
|
-
/**
|
|
567
|
-
*
|
|
568
|
-
* @type {string}
|
|
569
|
-
* @memberof Capture
|
|
570
|
-
*/
|
|
571
|
-
'image': string;
|
|
572
|
-
}
|
|
573
448
|
/**
|
|
574
449
|
* To create a robot cell, only a valid name is required. Once created, a robot cell provides access to the Wandelbots NOVA foundation services. The configuration can be customized, e.g. robot controllers, also within apps.
|
|
575
450
|
* @export
|
|
@@ -601,27 +476,6 @@ export interface Cell {
|
|
|
601
476
|
*/
|
|
602
477
|
'apps'?: Array<App>;
|
|
603
478
|
}
|
|
604
|
-
/**
|
|
605
|
-
*
|
|
606
|
-
* @export
|
|
607
|
-
* @interface CodeWithArguments
|
|
608
|
-
*/
|
|
609
|
-
export interface CodeWithArguments {
|
|
610
|
-
/**
|
|
611
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
612
|
-
* @type {string}
|
|
613
|
-
* @memberof CodeWithArguments
|
|
614
|
-
*/
|
|
615
|
-
'code': string;
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
619
|
-
* @memberof CodeWithArguments
|
|
620
|
-
*/
|
|
621
|
-
'initial_state'?: {
|
|
622
|
-
[key: string]: ArrayInputArrayInner;
|
|
623
|
-
} | null;
|
|
624
|
-
}
|
|
625
479
|
/**
|
|
626
480
|
* Defines a collider with a single shape. A collider is an object that is used for collision detection. It defines the `shape` that is attached with the offset of `pose` to a reference frame. Use colliders to: - Define the shape of a workpiece. The reference frame is the scene origin. - Define the shape of a link in a motion group. The reference frame is the link coordinate system. - Define the shape of a tool. The reference frame is the flange coordinate system.
|
|
627
481
|
* @export
|
|
@@ -1175,26 +1029,26 @@ export interface CoordinateSystems {
|
|
|
1175
1029
|
/**
|
|
1176
1030
|
*
|
|
1177
1031
|
* @export
|
|
1178
|
-
* @interface
|
|
1032
|
+
* @interface CreateProgramOperatorRun200Response
|
|
1179
1033
|
*/
|
|
1180
|
-
export interface
|
|
1034
|
+
export interface CreateProgramOperatorRun200Response {
|
|
1181
1035
|
/**
|
|
1182
1036
|
* The identifier of the program run for further inspection of the running program.
|
|
1183
1037
|
* @type {string}
|
|
1184
|
-
* @memberof
|
|
1038
|
+
* @memberof CreateProgramOperatorRun200Response
|
|
1185
1039
|
*/
|
|
1186
1040
|
'id'?: string;
|
|
1187
1041
|
}
|
|
1188
1042
|
/**
|
|
1189
1043
|
*
|
|
1190
1044
|
* @export
|
|
1191
|
-
* @interface
|
|
1045
|
+
* @interface CreateProgramOperatorRunRequest
|
|
1192
1046
|
*/
|
|
1193
|
-
export interface
|
|
1047
|
+
export interface CreateProgramOperatorRunRequest {
|
|
1194
1048
|
/**
|
|
1195
1049
|
* The identifier of the program stored in the program library.
|
|
1196
1050
|
* @type {string}
|
|
1197
|
-
* @memberof
|
|
1051
|
+
* @memberof CreateProgramOperatorRunRequest
|
|
1198
1052
|
*/
|
|
1199
1053
|
'program_id': string;
|
|
1200
1054
|
}
|
|
@@ -1407,31 +1261,6 @@ export type ExecuteTrajectoryRequest = InitializeMovementRequest | PauseMovement
|
|
|
1407
1261
|
* @export
|
|
1408
1262
|
*/
|
|
1409
1263
|
export type ExecuteTrajectoryResponse = InitializeMovementResponse | Movement | MovementError | PauseMovementResponse | PlaybackSpeedResponse | Standstill;
|
|
1410
|
-
/**
|
|
1411
|
-
* The ExecutionResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
|
|
1412
|
-
* @export
|
|
1413
|
-
* @interface ExecutionResult
|
|
1414
|
-
*/
|
|
1415
|
-
export interface ExecutionResult {
|
|
1416
|
-
/**
|
|
1417
|
-
*
|
|
1418
|
-
* @type {string}
|
|
1419
|
-
* @memberof ExecutionResult
|
|
1420
|
-
*/
|
|
1421
|
-
'motion_group_id': string;
|
|
1422
|
-
/**
|
|
1423
|
-
*
|
|
1424
|
-
* @type {number}
|
|
1425
|
-
* @memberof ExecutionResult
|
|
1426
|
-
*/
|
|
1427
|
-
'motion_duration': number;
|
|
1428
|
-
/**
|
|
1429
|
-
*
|
|
1430
|
-
* @type {Array<Path>}
|
|
1431
|
-
* @memberof ExecutionResult
|
|
1432
|
-
*/
|
|
1433
|
-
'paths': Array<Path>;
|
|
1434
|
-
}
|
|
1435
1264
|
/**
|
|
1436
1265
|
* A datapoint inside external joint stream.
|
|
1437
1266
|
* @export
|
|
@@ -1758,13 +1587,13 @@ export interface Geometry {
|
|
|
1758
1587
|
/**
|
|
1759
1588
|
*
|
|
1760
1589
|
* @export
|
|
1761
|
-
* @interface
|
|
1590
|
+
* @interface GetAllProgramOperatorRuns200Response
|
|
1762
1591
|
*/
|
|
1763
|
-
export interface
|
|
1592
|
+
export interface GetAllProgramOperatorRuns200Response {
|
|
1764
1593
|
/**
|
|
1765
1594
|
*
|
|
1766
1595
|
* @type {Array<ProgramRunObject>}
|
|
1767
|
-
* @memberof
|
|
1596
|
+
* @memberof GetAllProgramOperatorRuns200Response
|
|
1768
1597
|
*/
|
|
1769
1598
|
'program_runs'?: Array<ProgramRunObject>;
|
|
1770
1599
|
}
|
|
@@ -1797,28 +1626,28 @@ export interface GetModeResponse {
|
|
|
1797
1626
|
/**
|
|
1798
1627
|
*
|
|
1799
1628
|
* @export
|
|
1800
|
-
* @interface
|
|
1629
|
+
* @interface HTTPValidationError
|
|
1801
1630
|
*/
|
|
1802
|
-
export interface
|
|
1631
|
+
export interface HTTPValidationError {
|
|
1803
1632
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
* @type {
|
|
1806
|
-
* @memberof
|
|
1633
|
+
*
|
|
1634
|
+
* @type {Array<ValidationError>}
|
|
1635
|
+
* @memberof HTTPValidationError
|
|
1807
1636
|
*/
|
|
1808
|
-
'detail'
|
|
1637
|
+
'detail'?: Array<ValidationError>;
|
|
1809
1638
|
}
|
|
1810
1639
|
/**
|
|
1811
1640
|
*
|
|
1812
1641
|
* @export
|
|
1813
|
-
* @interface
|
|
1642
|
+
* @interface HTTPValidationError2
|
|
1814
1643
|
*/
|
|
1815
|
-
export interface
|
|
1644
|
+
export interface HTTPValidationError2 {
|
|
1816
1645
|
/**
|
|
1817
1646
|
*
|
|
1818
|
-
* @type {Array<
|
|
1819
|
-
* @memberof
|
|
1647
|
+
* @type {Array<ValidationError2>}
|
|
1648
|
+
* @memberof HTTPValidationError2
|
|
1820
1649
|
*/
|
|
1821
|
-
'detail'?: Array<
|
|
1650
|
+
'detail'?: Array<ValidationError2>;
|
|
1822
1651
|
}
|
|
1823
1652
|
/**
|
|
1824
1653
|
* Input/Output boolean value representation.
|
|
@@ -2988,19 +2817,6 @@ export interface ListPayloadsResponse {
|
|
|
2988
2817
|
*/
|
|
2989
2818
|
'payloads'?: Array<Payload>;
|
|
2990
2819
|
}
|
|
2991
|
-
/**
|
|
2992
|
-
* List of all the stored programs, represented by their metadata.
|
|
2993
|
-
* @export
|
|
2994
|
-
* @interface ListProgramMetadataResponse
|
|
2995
|
-
*/
|
|
2996
|
-
export interface ListProgramMetadataResponse {
|
|
2997
|
-
/**
|
|
2998
|
-
*
|
|
2999
|
-
* @type {Array<ProgramMetadata>}
|
|
3000
|
-
* @memberof ListProgramMetadataResponse
|
|
3001
|
-
*/
|
|
3002
|
-
'programs': Array<ProgramMetadata>;
|
|
3003
|
-
}
|
|
3004
2820
|
/**
|
|
3005
2821
|
*
|
|
3006
2822
|
* @export
|
|
@@ -3317,6 +3133,7 @@ export declare const MotionGroupModel: {
|
|
|
3317
3133
|
readonly FanucArcMate50iD: "FANUC_ARC_Mate_50iD";
|
|
3318
3134
|
readonly FanucArcMate50iD7L: "FANUC_ARC_Mate_50iD7L";
|
|
3319
3135
|
readonly FanucArcMate100iD: "FANUC_ARC_Mate_100iD";
|
|
3136
|
+
readonly FanucArcMate100iD16S: "FANUC_ARC_Mate_100iD16S";
|
|
3320
3137
|
readonly FanucArcMate100iD8L: "FANUC_ARC_Mate_100iD8L";
|
|
3321
3138
|
readonly FanucArcMate100iD10L: "FANUC_ARC_Mate_100iD10L";
|
|
3322
3139
|
readonly FanucArcMate120iD: "FANUC_ARC_Mate_120iD";
|
|
@@ -3386,6 +3203,7 @@ export declare const MotionGroupModel: {
|
|
|
3386
3203
|
readonly KukaKr6R7002: "KUKA_KR6_R700_2";
|
|
3387
3204
|
readonly KukaKr6R900: "KUKA_KR6_R900";
|
|
3388
3205
|
readonly KukaKr6R9002: "KUKA_KR6_R900_2";
|
|
3206
|
+
readonly KukaKr6R1820: "KUKA_KR6_R1820";
|
|
3389
3207
|
readonly KukaKr10R900: "KUKA_KR10_R900";
|
|
3390
3208
|
readonly KukaKr10R9002: "KUKA_KR10_R900_2";
|
|
3391
3209
|
readonly KukaKr10R1100: "KUKA_KR10_R1100";
|
|
@@ -3397,6 +3215,7 @@ export declare const MotionGroupModel: {
|
|
|
3397
3215
|
readonly KukaKr16R20102: "KUKA_KR16_R2010_2";
|
|
3398
3216
|
readonly KukaKr20R1810: "KUKA_KR20_R1810";
|
|
3399
3217
|
readonly KukaKr20R18102: "KUKA_KR20_R1810_2";
|
|
3218
|
+
readonly KukaKr303: "KUKA_KR30_3";
|
|
3400
3219
|
readonly KukaKr50R2500: "KUKA_KR50_R2500";
|
|
3401
3220
|
readonly KukaKr120R2700: "KUKA_KR120_R2700";
|
|
3402
3221
|
readonly KukaKr120R27002: "KUKA_KR120_R2700_2";
|
|
@@ -3867,19 +3686,6 @@ export declare const OrientationType: {
|
|
|
3867
3686
|
readonly EulerAnglesExtrinsicZxy: "EULER_ANGLES_EXTRINSIC_ZXY";
|
|
3868
3687
|
};
|
|
3869
3688
|
export type OrientationType = typeof OrientationType[keyof typeof OrientationType];
|
|
3870
|
-
/**
|
|
3871
|
-
*
|
|
3872
|
-
* @export
|
|
3873
|
-
* @interface Path
|
|
3874
|
-
*/
|
|
3875
|
-
export interface Path {
|
|
3876
|
-
/**
|
|
3877
|
-
*
|
|
3878
|
-
* @type {Array<RobotState>}
|
|
3879
|
-
* @memberof Path
|
|
3880
|
-
*/
|
|
3881
|
-
'poses'?: Array<RobotState>;
|
|
3882
|
-
}
|
|
3883
3689
|
/**
|
|
3884
3690
|
* 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.
|
|
3885
3691
|
* @export
|
|
@@ -4376,19 +4182,6 @@ export interface PlaybackSpeedResponsePlaybackSpeedResponse {
|
|
|
4376
4182
|
*/
|
|
4377
4183
|
'requested_value': number;
|
|
4378
4184
|
}
|
|
4379
|
-
/**
|
|
4380
|
-
*
|
|
4381
|
-
* @export
|
|
4382
|
-
* @interface PointCloud
|
|
4383
|
-
*/
|
|
4384
|
-
export interface PointCloud {
|
|
4385
|
-
/**
|
|
4386
|
-
*
|
|
4387
|
-
* @type {string}
|
|
4388
|
-
* @memberof PointCloud
|
|
4389
|
-
*/
|
|
4390
|
-
'pointcloud': string;
|
|
4391
|
-
}
|
|
4392
4185
|
/**
|
|
4393
4186
|
* Defines a pose in 3D space. A pose is a combination of a position and an orientation. The position is applied before the orientation.
|
|
4394
4187
|
* @export
|
|
@@ -4434,116 +4227,102 @@ export interface PoseInCoordinateSystem {
|
|
|
4434
4227
|
'coordinate_system'?: string;
|
|
4435
4228
|
}
|
|
4436
4229
|
/**
|
|
4437
|
-
*
|
|
4230
|
+
*
|
|
4438
4231
|
* @export
|
|
4439
|
-
* @interface
|
|
4232
|
+
* @interface ProgramRequest
|
|
4440
4233
|
*/
|
|
4441
|
-
export interface
|
|
4442
|
-
/**
|
|
4443
|
-
* The unique identifier of the program.
|
|
4444
|
-
* @type {string}
|
|
4445
|
-
* @memberof ProgramMetadata
|
|
4446
|
-
*/
|
|
4447
|
-
'id': string;
|
|
4234
|
+
export interface ProgramRequest {
|
|
4448
4235
|
/**
|
|
4449
|
-
*
|
|
4236
|
+
*
|
|
4450
4237
|
* @type {string}
|
|
4451
|
-
* @memberof
|
|
4238
|
+
* @memberof ProgramRequest
|
|
4452
4239
|
*/
|
|
4453
|
-
'
|
|
4240
|
+
'program': string;
|
|
4454
4241
|
/**
|
|
4455
|
-
*
|
|
4242
|
+
* Identifier of the default robot to use for execution
|
|
4456
4243
|
* @type {string}
|
|
4457
|
-
* @memberof
|
|
4244
|
+
* @memberof ProgramRequest
|
|
4458
4245
|
*/
|
|
4459
|
-
'
|
|
4246
|
+
'default_robot'?: string;
|
|
4460
4247
|
/**
|
|
4461
|
-
*
|
|
4248
|
+
* Identifier of the default TCP to use for execution
|
|
4462
4249
|
* @type {string}
|
|
4463
|
-
* @memberof
|
|
4464
|
-
*/
|
|
4465
|
-
'last_updated_date': string;
|
|
4466
|
-
/**
|
|
4467
|
-
* Whether the program is accessible for the enduser or only for the developer.
|
|
4468
|
-
* @type {boolean}
|
|
4469
|
-
* @memberof ProgramMetadata
|
|
4250
|
+
* @memberof ProgramRequest
|
|
4470
4251
|
*/
|
|
4471
|
-
'
|
|
4252
|
+
'default_tcp'?: string;
|
|
4472
4253
|
/**
|
|
4473
|
-
*
|
|
4474
|
-
* @type {
|
|
4475
|
-
* @memberof
|
|
4254
|
+
* Initial arguments that are available within the program
|
|
4255
|
+
* @type {object}
|
|
4256
|
+
* @memberof ProgramRequest
|
|
4476
4257
|
*/
|
|
4477
|
-
'
|
|
4258
|
+
'run_args'?: object;
|
|
4478
4259
|
}
|
|
4479
4260
|
/**
|
|
4480
|
-
*
|
|
4261
|
+
* Holds the state of a program run.
|
|
4481
4262
|
* @export
|
|
4482
4263
|
* @interface ProgramRun
|
|
4483
4264
|
*/
|
|
4484
4265
|
export interface ProgramRun {
|
|
4485
4266
|
/**
|
|
4486
|
-
*
|
|
4267
|
+
* Unique id of the program run
|
|
4487
4268
|
* @type {string}
|
|
4488
4269
|
* @memberof ProgramRun
|
|
4489
4270
|
*/
|
|
4490
4271
|
'id': string;
|
|
4491
4272
|
/**
|
|
4492
|
-
*
|
|
4273
|
+
* State of the program run
|
|
4493
4274
|
* @type {ProgramRunState}
|
|
4494
4275
|
* @memberof ProgramRun
|
|
4495
4276
|
*/
|
|
4496
4277
|
'state': ProgramRunState;
|
|
4497
4278
|
/**
|
|
4498
|
-
*
|
|
4279
|
+
* Logs of the program run
|
|
4499
4280
|
* @type {string}
|
|
4500
4281
|
* @memberof ProgramRun
|
|
4501
4282
|
*/
|
|
4502
4283
|
'logs'?: string;
|
|
4503
4284
|
/**
|
|
4504
|
-
*
|
|
4285
|
+
* Stdout of the program run
|
|
4505
4286
|
* @type {string}
|
|
4506
4287
|
* @memberof ProgramRun
|
|
4507
4288
|
*/
|
|
4508
4289
|
'stdout'?: string;
|
|
4509
4290
|
/**
|
|
4510
|
-
*
|
|
4511
|
-
* @type {
|
|
4291
|
+
* Stores runtime variables of the run
|
|
4292
|
+
* @type {object}
|
|
4512
4293
|
* @memberof ProgramRun
|
|
4513
4294
|
*/
|
|
4514
|
-
'store'?:
|
|
4515
|
-
[key: string]: StoreValue;
|
|
4516
|
-
};
|
|
4295
|
+
'store'?: object;
|
|
4517
4296
|
/**
|
|
4518
|
-
*
|
|
4297
|
+
* Error message of the program run, if any
|
|
4519
4298
|
* @type {string}
|
|
4520
4299
|
* @memberof ProgramRun
|
|
4521
4300
|
*/
|
|
4522
|
-
'error'?: string
|
|
4301
|
+
'error'?: string;
|
|
4523
4302
|
/**
|
|
4524
|
-
*
|
|
4303
|
+
* Traceback of the program run, if any
|
|
4525
4304
|
* @type {string}
|
|
4526
4305
|
* @memberof ProgramRun
|
|
4527
4306
|
*/
|
|
4528
|
-
'traceback'?: string
|
|
4307
|
+
'traceback'?: string;
|
|
4529
4308
|
/**
|
|
4530
|
-
*
|
|
4309
|
+
* Start time of the program run
|
|
4531
4310
|
* @type {number}
|
|
4532
4311
|
* @memberof ProgramRun
|
|
4533
4312
|
*/
|
|
4534
|
-
'start_time'?: number
|
|
4313
|
+
'start_time'?: number;
|
|
4535
4314
|
/**
|
|
4536
|
-
*
|
|
4315
|
+
* End time of the program run
|
|
4537
4316
|
* @type {number}
|
|
4538
4317
|
* @memberof ProgramRun
|
|
4539
4318
|
*/
|
|
4540
|
-
'end_time'?: number
|
|
4319
|
+
'end_time'?: number;
|
|
4541
4320
|
/**
|
|
4542
|
-
*
|
|
4543
|
-
* @type {Array<
|
|
4321
|
+
* Execution results of the program run
|
|
4322
|
+
* @type {Array<ProgramRunResult>}
|
|
4544
4323
|
* @memberof ProgramRun
|
|
4545
4324
|
*/
|
|
4546
|
-
'execution_results'?: Array<
|
|
4325
|
+
'execution_results'?: Array<ProgramRunResult>;
|
|
4547
4326
|
}
|
|
4548
4327
|
/**
|
|
4549
4328
|
*
|
|
@@ -4591,93 +4370,60 @@ export interface ProgramRunObject {
|
|
|
4591
4370
|
/**
|
|
4592
4371
|
*
|
|
4593
4372
|
* @export
|
|
4594
|
-
* @
|
|
4595
|
-
*/
|
|
4596
|
-
export declare const ProgramRunState: {
|
|
4597
|
-
readonly NotStarted: "not started";
|
|
4598
|
-
readonly Running: "running";
|
|
4599
|
-
readonly Completed: "completed";
|
|
4600
|
-
readonly Failed: "failed";
|
|
4601
|
-
readonly Stopped: "stopped";
|
|
4602
|
-
};
|
|
4603
|
-
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4604
|
-
/**
|
|
4605
|
-
*
|
|
4606
|
-
* @export
|
|
4607
|
-
* @interface ProgramRunnerReference
|
|
4373
|
+
* @interface ProgramRunReference
|
|
4608
4374
|
*/
|
|
4609
|
-
export interface
|
|
4375
|
+
export interface ProgramRunReference {
|
|
4610
4376
|
/**
|
|
4611
4377
|
*
|
|
4612
4378
|
* @type {string}
|
|
4613
|
-
* @memberof
|
|
4379
|
+
* @memberof ProgramRunReference
|
|
4614
4380
|
*/
|
|
4615
4381
|
'id': string;
|
|
4616
4382
|
/**
|
|
4617
4383
|
*
|
|
4618
4384
|
* @type {ProgramRunState}
|
|
4619
|
-
* @memberof
|
|
4385
|
+
* @memberof ProgramRunReference
|
|
4620
4386
|
*/
|
|
4621
4387
|
'state': ProgramRunState;
|
|
4622
4388
|
}
|
|
4623
4389
|
/**
|
|
4624
|
-
*
|
|
4390
|
+
* The ProgramRunResult object contains the execution results of a robot. Arguments: motion_group_id: The unique id 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
|
|
4625
4391
|
* @export
|
|
4626
|
-
* @interface
|
|
4392
|
+
* @interface ProgramRunResult
|
|
4627
4393
|
*/
|
|
4628
|
-
export interface
|
|
4394
|
+
export interface ProgramRunResult {
|
|
4629
4395
|
/**
|
|
4630
|
-
*
|
|
4631
|
-
* @type {
|
|
4632
|
-
* @memberof
|
|
4633
|
-
*/
|
|
4634
|
-
'position': Array<any>;
|
|
4635
|
-
/**
|
|
4636
|
-
*
|
|
4637
|
-
* @type {Array<any>}
|
|
4638
|
-
* @memberof PyjectoryDatatypesCorePose
|
|
4396
|
+
* Unique id of the motion group that was executed
|
|
4397
|
+
* @type {string}
|
|
4398
|
+
* @memberof ProgramRunResult
|
|
4639
4399
|
*/
|
|
4640
|
-
'
|
|
4641
|
-
}
|
|
4642
|
-
/**
|
|
4643
|
-
* 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.
|
|
4644
|
-
* @export
|
|
4645
|
-
* @interface PyjectoryDatatypesSerializerOrientation
|
|
4646
|
-
*/
|
|
4647
|
-
export interface PyjectoryDatatypesSerializerOrientation {
|
|
4400
|
+
'motion_group_id': string;
|
|
4648
4401
|
/**
|
|
4649
|
-
*
|
|
4650
|
-
* @type {
|
|
4651
|
-
* @memberof
|
|
4402
|
+
* Total execution duration of the motion group
|
|
4403
|
+
* @type {number}
|
|
4404
|
+
* @memberof ProgramRunResult
|
|
4652
4405
|
*/
|
|
4653
|
-
'
|
|
4654
|
-
}
|
|
4655
|
-
/**
|
|
4656
|
-
* 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.
|
|
4657
|
-
* @export
|
|
4658
|
-
* @interface PyjectoryDatatypesSerializerPose
|
|
4659
|
-
*/
|
|
4660
|
-
export interface PyjectoryDatatypesSerializerPose {
|
|
4406
|
+
'motion_duration': number;
|
|
4661
4407
|
/**
|
|
4662
|
-
*
|
|
4663
|
-
* @type {Array<
|
|
4664
|
-
* @memberof
|
|
4408
|
+
* Paths of the motion group as list of Path objects
|
|
4409
|
+
* @type {Array<Array<RobotState>>}
|
|
4410
|
+
* @memberof ProgramRunResult
|
|
4665
4411
|
*/
|
|
4666
|
-
'
|
|
4412
|
+
'paths': Array<Array<RobotState>>;
|
|
4667
4413
|
}
|
|
4668
4414
|
/**
|
|
4669
|
-
*
|
|
4415
|
+
*
|
|
4670
4416
|
* @export
|
|
4671
|
-
* @
|
|
4417
|
+
* @enum {string}
|
|
4672
4418
|
*/
|
|
4673
|
-
export
|
|
4674
|
-
|
|
4675
|
-
|
|
4676
|
-
|
|
4677
|
-
|
|
4678
|
-
|
|
4679
|
-
|
|
4680
|
-
|
|
4419
|
+
export declare const ProgramRunState: {
|
|
4420
|
+
readonly NotStarted: "not started";
|
|
4421
|
+
readonly Running: "running";
|
|
4422
|
+
readonly Completed: "completed";
|
|
4423
|
+
readonly Failed: "failed";
|
|
4424
|
+
readonly Stopped: "stopped";
|
|
4425
|
+
};
|
|
4426
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4681
4427
|
/**
|
|
4682
4428
|
* Defines an x-y plane with finite size.
|
|
4683
4429
|
* @export
|
|
@@ -4796,48 +4542,6 @@ export declare const ReleaseChannel: {
|
|
|
4796
4542
|
readonly Next: "next";
|
|
4797
4543
|
};
|
|
4798
4544
|
export type ReleaseChannel = typeof ReleaseChannel[keyof typeof ReleaseChannel];
|
|
4799
|
-
/**
|
|
4800
|
-
* Wandelscript code string which describes a Program as text/plain
|
|
4801
|
-
* @export
|
|
4802
|
-
* @interface Request
|
|
4803
|
-
*/
|
|
4804
|
-
export interface Request {
|
|
4805
|
-
/**
|
|
4806
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4807
|
-
* @type {string}
|
|
4808
|
-
* @memberof Request
|
|
4809
|
-
*/
|
|
4810
|
-
'code': string;
|
|
4811
|
-
/**
|
|
4812
|
-
*
|
|
4813
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4814
|
-
* @memberof Request
|
|
4815
|
-
*/
|
|
4816
|
-
'initial_state'?: {
|
|
4817
|
-
[key: string]: ArrayInputArrayInner;
|
|
4818
|
-
};
|
|
4819
|
-
}
|
|
4820
|
-
/**
|
|
4821
|
-
* Wandelscript code string which describes a program
|
|
4822
|
-
* @export
|
|
4823
|
-
* @interface Request1
|
|
4824
|
-
*/
|
|
4825
|
-
export interface Request1 {
|
|
4826
|
-
/**
|
|
4827
|
-
* Wandelscript code string which describes a Wandelscript Program as content/json.
|
|
4828
|
-
* @type {string}
|
|
4829
|
-
* @memberof Request1
|
|
4830
|
-
*/
|
|
4831
|
-
'code': string;
|
|
4832
|
-
/**
|
|
4833
|
-
*
|
|
4834
|
-
* @type {{ [key: string]: ArrayInputArrayInner; }}
|
|
4835
|
-
* @memberof Request1
|
|
4836
|
-
*/
|
|
4837
|
-
'initial_state'?: {
|
|
4838
|
-
[key: string]: ArrayInputArrayInner;
|
|
4839
|
-
};
|
|
4840
|
-
}
|
|
4841
4545
|
/**
|
|
4842
4546
|
* The configuration of a physical or virtual robot controller.
|
|
4843
4547
|
* @export
|
|
@@ -4925,23 +4629,23 @@ export interface RobotLinkGeometry {
|
|
|
4925
4629
|
'geometry': Geometry;
|
|
4926
4630
|
}
|
|
4927
4631
|
/**
|
|
4928
|
-
* Collection of information on the current state of the robot
|
|
4632
|
+
* Collection of information on the current state of the robot.
|
|
4929
4633
|
* @export
|
|
4930
4634
|
* @interface RobotState
|
|
4931
4635
|
*/
|
|
4932
4636
|
export interface RobotState {
|
|
4933
4637
|
/**
|
|
4934
4638
|
*
|
|
4935
|
-
* @type {
|
|
4639
|
+
* @type {Pose}
|
|
4936
4640
|
* @memberof RobotState
|
|
4937
4641
|
*/
|
|
4938
|
-
'pose':
|
|
4642
|
+
'pose': Pose;
|
|
4939
4643
|
/**
|
|
4940
4644
|
*
|
|
4941
4645
|
* @type {Array<number>}
|
|
4942
4646
|
* @memberof RobotState
|
|
4943
4647
|
*/
|
|
4944
|
-
'joints'?: Array<number
|
|
4648
|
+
'joints'?: Array<number>;
|
|
4945
4649
|
}
|
|
4946
4650
|
/**
|
|
4947
4651
|
* 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.
|
|
@@ -5203,6 +4907,18 @@ export interface SafetyZoneLimits {
|
|
|
5203
4907
|
*/
|
|
5204
4908
|
'limits': PlanningLimits;
|
|
5205
4909
|
}
|
|
4910
|
+
/**
|
|
4911
|
+
*
|
|
4912
|
+
* @export
|
|
4913
|
+
* @enum {string}
|
|
4914
|
+
*/
|
|
4915
|
+
export declare const ServiceGroup: {
|
|
4916
|
+
readonly SystemService: "SystemService";
|
|
4917
|
+
readonly CellService: "CellService";
|
|
4918
|
+
readonly RobotController: "RobotController";
|
|
4919
|
+
readonly App: "App";
|
|
4920
|
+
};
|
|
4921
|
+
export type ServiceGroup = typeof ServiceGroup[keyof typeof ServiceGroup];
|
|
5206
4922
|
/**
|
|
5207
4923
|
*
|
|
5208
4924
|
* @export
|
|
@@ -5215,6 +4931,12 @@ export interface ServiceStatus {
|
|
|
5215
4931
|
* @memberof ServiceStatus
|
|
5216
4932
|
*/
|
|
5217
4933
|
'service': string;
|
|
4934
|
+
/**
|
|
4935
|
+
*
|
|
4936
|
+
* @type {ServiceGroup}
|
|
4937
|
+
* @memberof ServiceStatus
|
|
4938
|
+
*/
|
|
4939
|
+
'group': ServiceGroup;
|
|
5218
4940
|
/**
|
|
5219
4941
|
*
|
|
5220
4942
|
* @type {ServiceStatusStatus}
|
|
@@ -5502,60 +5224,17 @@ export interface StartOnIO {
|
|
|
5502
5224
|
'comparator': Comparator;
|
|
5503
5225
|
}
|
|
5504
5226
|
/**
|
|
5505
|
-
*
|
|
5227
|
+
* Representing a robot pose in operational space aware of a configured TCP.
|
|
5506
5228
|
* @export
|
|
5507
|
-
* @interface
|
|
5229
|
+
* @interface TcpPose
|
|
5508
5230
|
*/
|
|
5509
|
-
export interface
|
|
5231
|
+
export interface TcpPose {
|
|
5510
5232
|
/**
|
|
5511
|
-
*
|
|
5512
|
-
* @type {Array<
|
|
5513
|
-
* @memberof
|
|
5233
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
5234
|
+
* @type {Array<number>}
|
|
5235
|
+
* @memberof TcpPose
|
|
5514
5236
|
*/
|
|
5515
|
-
'
|
|
5516
|
-
/**
|
|
5517
|
-
*
|
|
5518
|
-
* @type {Array<any>}
|
|
5519
|
-
* @memberof StoreValue
|
|
5520
|
-
*/
|
|
5521
|
-
'position': Array<any>;
|
|
5522
|
-
/**
|
|
5523
|
-
*
|
|
5524
|
-
* @type {Array<any>}
|
|
5525
|
-
* @memberof StoreValue
|
|
5526
|
-
*/
|
|
5527
|
-
'orientation': Array<any>;
|
|
5528
|
-
/**
|
|
5529
|
-
*
|
|
5530
|
-
* @type {string}
|
|
5531
|
-
* @memberof StoreValue
|
|
5532
|
-
*/
|
|
5533
|
-
'image': string;
|
|
5534
|
-
/**
|
|
5535
|
-
*
|
|
5536
|
-
* @type {string}
|
|
5537
|
-
* @memberof StoreValue
|
|
5538
|
-
*/
|
|
5539
|
-
'pointcloud': string;
|
|
5540
|
-
/**
|
|
5541
|
-
*
|
|
5542
|
-
* @type {Array<ArrayOutputArrayInner>}
|
|
5543
|
-
* @memberof StoreValue
|
|
5544
|
-
*/
|
|
5545
|
-
'array': Array<ArrayOutputArrayInner>;
|
|
5546
|
-
}
|
|
5547
|
-
/**
|
|
5548
|
-
* Representing a robot pose in operational space aware of a configured TCP.
|
|
5549
|
-
* @export
|
|
5550
|
-
* @interface TcpPose
|
|
5551
|
-
*/
|
|
5552
|
-
export interface TcpPose {
|
|
5553
|
-
/**
|
|
5554
|
-
* A three-dimensional vector [x, y, z] with double precision.
|
|
5555
|
-
* @type {Array<number>}
|
|
5556
|
-
* @memberof TcpPose
|
|
5557
|
-
*/
|
|
5558
|
-
'position': Array<number>;
|
|
5237
|
+
'position': Array<number>;
|
|
5559
5238
|
/**
|
|
5560
5239
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
5561
5240
|
* @type {Array<number>}
|
|
@@ -5717,6 +5396,12 @@ export interface TrajectoryData {
|
|
|
5717
5396
|
* @memberof TrajectoryData
|
|
5718
5397
|
*/
|
|
5719
5398
|
'message_type': TrajectoryDataMessageTypeEnum;
|
|
5399
|
+
/**
|
|
5400
|
+
* Identifier of the motion-group.
|
|
5401
|
+
* @type {string}
|
|
5402
|
+
* @memberof TrajectoryData
|
|
5403
|
+
*/
|
|
5404
|
+
'motion_group'?: string;
|
|
5720
5405
|
/**
|
|
5721
5406
|
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
5722
5407
|
* @type {JointTrajectory}
|
|
@@ -5875,31 +5560,6 @@ export interface UpdateNovaVersionRequest {
|
|
|
5875
5560
|
*/
|
|
5876
5561
|
'channel': ReleaseChannel;
|
|
5877
5562
|
}
|
|
5878
|
-
/**
|
|
5879
|
-
* This message is used to update the metadata of a program. Only the set fields get updated.
|
|
5880
|
-
* @export
|
|
5881
|
-
* @interface UpdateProgramMetadataRequest
|
|
5882
|
-
*/
|
|
5883
|
-
export interface UpdateProgramMetadataRequest {
|
|
5884
|
-
/**
|
|
5885
|
-
*
|
|
5886
|
-
* @type {string}
|
|
5887
|
-
* @memberof UpdateProgramMetadataRequest
|
|
5888
|
-
*/
|
|
5889
|
-
'name'?: string;
|
|
5890
|
-
/**
|
|
5891
|
-
*
|
|
5892
|
-
* @type {boolean}
|
|
5893
|
-
* @memberof UpdateProgramMetadataRequest
|
|
5894
|
-
*/
|
|
5895
|
-
'is_hidden'?: boolean;
|
|
5896
|
-
/**
|
|
5897
|
-
*
|
|
5898
|
-
* @type {string}
|
|
5899
|
-
* @memberof UpdateProgramMetadataRequest
|
|
5900
|
-
*/
|
|
5901
|
-
'image'?: string;
|
|
5902
|
-
}
|
|
5903
5563
|
/**
|
|
5904
5564
|
*
|
|
5905
5565
|
* @export
|
|
@@ -5953,10 +5613,33 @@ export interface ValidationError {
|
|
|
5953
5613
|
/**
|
|
5954
5614
|
*
|
|
5955
5615
|
* @export
|
|
5956
|
-
* @interface
|
|
5616
|
+
* @interface ValidationError2
|
|
5957
5617
|
*/
|
|
5958
|
-
export interface
|
|
5618
|
+
export interface ValidationError2 {
|
|
5619
|
+
/**
|
|
5620
|
+
*
|
|
5621
|
+
* @type {Array<number>}
|
|
5622
|
+
* @memberof ValidationError2
|
|
5623
|
+
*/
|
|
5624
|
+
'loc': Array<number>;
|
|
5625
|
+
/**
|
|
5626
|
+
*
|
|
5627
|
+
* @type {string}
|
|
5628
|
+
* @memberof ValidationError2
|
|
5629
|
+
*/
|
|
5630
|
+
'msg': string;
|
|
5631
|
+
/**
|
|
5632
|
+
*
|
|
5633
|
+
* @type {string}
|
|
5634
|
+
* @memberof ValidationError2
|
|
5635
|
+
*/
|
|
5636
|
+
'type': string;
|
|
5959
5637
|
}
|
|
5638
|
+
/**
|
|
5639
|
+
* @type ValidationErrorLocInner
|
|
5640
|
+
* @export
|
|
5641
|
+
*/
|
|
5642
|
+
export type ValidationErrorLocInner = number | string;
|
|
5960
5643
|
/**
|
|
5961
5644
|
* A generic representation of a version number.
|
|
5962
5645
|
* @export
|
|
@@ -6094,6 +5777,7 @@ export declare const VirtualControllerTypes: {
|
|
|
6094
5777
|
readonly AbbIrb460025020: "abb-irb4600_250_20";
|
|
6095
5778
|
readonly AbbIrb460025540: "abb-irb4600_255_40";
|
|
6096
5779
|
readonly FanucArcMate100iD: "fanuc-arc_mate_100iD";
|
|
5780
|
+
readonly FanucArcMate100iD16S: "fanuc-arc_mate_100iD16S";
|
|
6097
5781
|
readonly FanucArcMate120iD: "fanuc-arc_mate_120iD";
|
|
6098
5782
|
readonly FanucArcMate120iD12L: "fanuc-arc_mate_120iD12L";
|
|
6099
5783
|
readonly FanucArcMate120iD35: "fanuc-arc_mate_120iD35";
|
|
@@ -6109,6 +5793,7 @@ export declare const VirtualControllerTypes: {
|
|
|
6109
5793
|
readonly FanucLrMate200iD4S: "fanuc-lr_mate_200iD4S";
|
|
6110
5794
|
readonly FanucLrMate200iD7L: "fanuc-lr_mate_200iD7L";
|
|
6111
5795
|
readonly FanucM10iD12: "fanuc-m10iD12";
|
|
5796
|
+
readonly FanucM10iD16S: "fanuc-m10iD16S";
|
|
6112
5797
|
readonly FanucM20iD25: "fanuc-m20iD25";
|
|
6113
5798
|
readonly FanucM20iD35: "fanuc-m20iD35";
|
|
6114
5799
|
readonly FanucM900iB280L: "fanuc-m900iB280L";
|
|
@@ -6131,10 +5816,12 @@ export declare const VirtualControllerTypes: {
|
|
|
6131
5816
|
readonly KukaKr210R33002: "kuka-kr210_r3300_2";
|
|
6132
5817
|
readonly KukaKr240R2700: "kuka-kr240_r2700";
|
|
6133
5818
|
readonly KukaKr250R27002: "kuka-kr250_r2700_2";
|
|
5819
|
+
readonly KukaKr303: "kuka-kr30_3";
|
|
6134
5820
|
readonly KukaKr360L2403: "kuka-kr360_l240_3";
|
|
6135
5821
|
readonly KukaKr4R600: "kuka-kr4_r600";
|
|
6136
5822
|
readonly KukaKr500L3403: "kuka-kr500_l340_3";
|
|
6137
5823
|
readonly KukaKr50R2500: "kuka-kr50_r2500";
|
|
5824
|
+
readonly KukaKr6R1820: "kuka-kr6_r1820";
|
|
6138
5825
|
readonly KukaKr6R7002: "kuka-kr6_r700_2";
|
|
6139
5826
|
readonly KukaKr6R700Sixx: "kuka-kr6_r700_sixx";
|
|
6140
5827
|
readonly KukaKr6R900: "kuka-kr6_r900";
|
|
@@ -6153,11 +5840,21 @@ export declare const VirtualControllerTypes: {
|
|
|
6153
5840
|
readonly YaskawaAr3120: "yaskawa-ar3120";
|
|
6154
5841
|
readonly YaskawaAr700: "yaskawa-ar700";
|
|
6155
5842
|
readonly YaskawaAr900: "yaskawa-ar900";
|
|
5843
|
+
readonly YaskawaGp110: "yaskawa-gp110";
|
|
6156
5844
|
readonly YaskawaGp12: "yaskawa-gp12";
|
|
5845
|
+
readonly YaskawaGp180: "yaskawa-gp180";
|
|
5846
|
+
readonly YaskawaGp180120: "yaskawa-gp180-120";
|
|
6157
5847
|
readonly YaskawaGp20hl: "yaskawa-gp20hl";
|
|
5848
|
+
readonly YaskawaGp215: "yaskawa-gp215";
|
|
5849
|
+
readonly YaskawaGp225: "yaskawa-gp225";
|
|
6158
5850
|
readonly YaskawaGp25: "yaskawa-gp25";
|
|
5851
|
+
readonly YaskawaGp250: "yaskawa-gp250";
|
|
6159
5852
|
readonly YaskawaGp2512: "yaskawa-gp25_12";
|
|
5853
|
+
readonly YaskawaGp280: "yaskawa-gp280";
|
|
5854
|
+
readonly YaskawaGp35L: "yaskawa-gp35L";
|
|
5855
|
+
readonly YaskawaGp400: "yaskawa-gp400";
|
|
6160
5856
|
readonly YaskawaGp50: "yaskawa-gp50";
|
|
5857
|
+
readonly YaskawaGp600: "yaskawa-gp600";
|
|
6161
5858
|
readonly YaskawaGp7: "yaskawa-gp7";
|
|
6162
5859
|
readonly YaskawaGp8: "yaskawa-gp8";
|
|
6163
5860
|
readonly YaskawaGp88: "yaskawa-gp88";
|
|
@@ -8788,76 +8485,75 @@ export declare class MotionGroupKinematicsApi extends BaseAPI {
|
|
|
8788
8485
|
*/
|
|
8789
8486
|
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8790
8487
|
/**
|
|
8791
|
-
* This endpoint accepts a program
|
|
8792
|
-
* @summary Create
|
|
8488
|
+
* 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.
|
|
8489
|
+
* @summary Create program run
|
|
8793
8490
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8794
|
-
* @param {
|
|
8491
|
+
* @param {ProgramRequest} programRequest
|
|
8795
8492
|
* @param {*} [options] Override http request option.
|
|
8796
8493
|
* @throws {RequiredError}
|
|
8797
8494
|
*/
|
|
8798
|
-
|
|
8495
|
+
createProgramRun: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8799
8496
|
/**
|
|
8800
|
-
* Execute a program
|
|
8801
|
-
* @summary Execute
|
|
8497
|
+
* 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.
|
|
8498
|
+
* @summary Execute program
|
|
8802
8499
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8803
|
-
* @param {
|
|
8500
|
+
* @param {ProgramRequest} programRequest
|
|
8804
8501
|
* @param {*} [options] Override http request option.
|
|
8805
8502
|
* @throws {RequiredError}
|
|
8806
8503
|
*/
|
|
8807
|
-
executeProgram: (cell: string,
|
|
8504
|
+
executeProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8808
8505
|
/**
|
|
8809
|
-
* Returns information about a program currently executed.
|
|
8810
|
-
* @summary Get
|
|
8506
|
+
* 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, ...
|
|
8507
|
+
* @summary Get program run
|
|
8811
8508
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8812
|
-
* @param {string}
|
|
8509
|
+
* @param {string} run
|
|
8813
8510
|
* @param {*} [options] Override http request option.
|
|
8814
8511
|
* @throws {RequiredError}
|
|
8815
8512
|
*/
|
|
8816
|
-
|
|
8513
|
+
getProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8817
8514
|
/**
|
|
8818
|
-
* Get details about all existing
|
|
8819
|
-
* @summary List
|
|
8515
|
+
* Get details about all existing runs
|
|
8516
|
+
* @summary List programs
|
|
8820
8517
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8821
8518
|
* @param {*} [options] Override http request option.
|
|
8822
8519
|
* @throws {RequiredError}
|
|
8823
8520
|
*/
|
|
8824
|
-
|
|
8521
|
+
getProgramRuns: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8825
8522
|
/**
|
|
8826
|
-
*
|
|
8827
|
-
* @summary
|
|
8523
|
+
* Simulate a program given as text/plain
|
|
8524
|
+
* @summary Simulate program
|
|
8828
8525
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8829
|
-
* @param {
|
|
8526
|
+
* @param {ProgramRequest} programRequest
|
|
8830
8527
|
* @param {*} [options] Override http request option.
|
|
8831
8528
|
* @throws {RequiredError}
|
|
8832
8529
|
*/
|
|
8833
|
-
|
|
8530
|
+
simulateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8834
8531
|
/**
|
|
8835
|
-
*
|
|
8836
|
-
* @summary
|
|
8532
|
+
* Stop all runs
|
|
8533
|
+
* @summary Stop all programs
|
|
8837
8534
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8838
|
-
* @param {Request} request
|
|
8839
|
-
* @param {string} [identifier]
|
|
8840
8535
|
* @param {*} [options] Override http request option.
|
|
8841
8536
|
* @throws {RequiredError}
|
|
8842
8537
|
*/
|
|
8843
|
-
|
|
8538
|
+
stopAllPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8844
8539
|
/**
|
|
8845
|
-
* Stop
|
|
8846
|
-
* @summary Stop
|
|
8540
|
+
* Stop a specific program run.
|
|
8541
|
+
* @summary Stop program run
|
|
8847
8542
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8543
|
+
* @param {string} run
|
|
8848
8544
|
* @param {*} [options] Override http request option.
|
|
8849
8545
|
* @throws {RequiredError}
|
|
8850
8546
|
*/
|
|
8851
|
-
|
|
8547
|
+
stopProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8852
8548
|
/**
|
|
8853
|
-
*
|
|
8854
|
-
* @summary
|
|
8549
|
+
* Validate a program
|
|
8550
|
+
* @summary Validate program
|
|
8855
8551
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8856
|
-
* @param {
|
|
8552
|
+
* @param {ProgramRequest} programRequest
|
|
8857
8553
|
* @param {*} [options] Override http request option.
|
|
8858
8554
|
* @throws {RequiredError}
|
|
8859
8555
|
*/
|
|
8860
|
-
|
|
8556
|
+
validateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8861
8557
|
};
|
|
8862
8558
|
/**
|
|
8863
8559
|
* ProgramApi - functional programming interface
|
|
@@ -8865,76 +8561,75 @@ export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8865
8561
|
*/
|
|
8866
8562
|
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8867
8563
|
/**
|
|
8868
|
-
* This endpoint accepts a program
|
|
8869
|
-
* @summary Create
|
|
8564
|
+
* 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.
|
|
8565
|
+
* @summary Create program run
|
|
8870
8566
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8871
|
-
* @param {
|
|
8567
|
+
* @param {ProgramRequest} programRequest
|
|
8872
8568
|
* @param {*} [options] Override http request option.
|
|
8873
8569
|
* @throws {RequiredError}
|
|
8874
8570
|
*/
|
|
8875
|
-
|
|
8571
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>>;
|
|
8876
8572
|
/**
|
|
8877
|
-
* Execute a program
|
|
8878
|
-
* @summary Execute
|
|
8573
|
+
* 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.
|
|
8574
|
+
* @summary Execute program
|
|
8879
8575
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8880
|
-
* @param {
|
|
8576
|
+
* @param {ProgramRequest} programRequest
|
|
8881
8577
|
* @param {*} [options] Override http request option.
|
|
8882
8578
|
* @throws {RequiredError}
|
|
8883
8579
|
*/
|
|
8884
|
-
executeProgram(cell: string,
|
|
8580
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8885
8581
|
/**
|
|
8886
|
-
* Returns information about a program currently executed.
|
|
8887
|
-
* @summary Get
|
|
8582
|
+
* 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, ...
|
|
8583
|
+
* @summary Get program run
|
|
8888
8584
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8889
|
-
* @param {string}
|
|
8585
|
+
* @param {string} run
|
|
8890
8586
|
* @param {*} [options] Override http request option.
|
|
8891
8587
|
* @throws {RequiredError}
|
|
8892
8588
|
*/
|
|
8893
|
-
|
|
8589
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8894
8590
|
/**
|
|
8895
|
-
* Get details about all existing
|
|
8896
|
-
* @summary List
|
|
8591
|
+
* Get details about all existing runs
|
|
8592
|
+
* @summary List programs
|
|
8897
8593
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8898
8594
|
* @param {*} [options] Override http request option.
|
|
8899
8595
|
* @throws {RequiredError}
|
|
8900
8596
|
*/
|
|
8901
|
-
|
|
8597
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>>;
|
|
8902
8598
|
/**
|
|
8903
|
-
*
|
|
8904
|
-
* @summary
|
|
8599
|
+
* Simulate a program given as text/plain
|
|
8600
|
+
* @summary Simulate program
|
|
8905
8601
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8906
|
-
* @param {
|
|
8602
|
+
* @param {ProgramRequest} programRequest
|
|
8907
8603
|
* @param {*} [options] Override http request option.
|
|
8908
8604
|
* @throws {RequiredError}
|
|
8909
8605
|
*/
|
|
8910
|
-
|
|
8606
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8911
8607
|
/**
|
|
8912
|
-
*
|
|
8913
|
-
* @summary
|
|
8608
|
+
* Stop all runs
|
|
8609
|
+
* @summary Stop all programs
|
|
8914
8610
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8915
|
-
* @param {Request} request
|
|
8916
|
-
* @param {string} [identifier]
|
|
8917
8611
|
* @param {*} [options] Override http request option.
|
|
8918
8612
|
* @throws {RequiredError}
|
|
8919
8613
|
*/
|
|
8920
|
-
|
|
8614
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8921
8615
|
/**
|
|
8922
|
-
* Stop
|
|
8923
|
-
* @summary Stop
|
|
8616
|
+
* Stop a specific program run.
|
|
8617
|
+
* @summary Stop program run
|
|
8924
8618
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8619
|
+
* @param {string} run
|
|
8925
8620
|
* @param {*} [options] Override http request option.
|
|
8926
8621
|
* @throws {RequiredError}
|
|
8927
8622
|
*/
|
|
8928
|
-
|
|
8623
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8929
8624
|
/**
|
|
8930
|
-
*
|
|
8931
|
-
* @summary
|
|
8625
|
+
* Validate a program
|
|
8626
|
+
* @summary Validate program
|
|
8932
8627
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8933
|
-
* @param {
|
|
8628
|
+
* @param {ProgramRequest} programRequest
|
|
8934
8629
|
* @param {*} [options] Override http request option.
|
|
8935
8630
|
* @throws {RequiredError}
|
|
8936
8631
|
*/
|
|
8937
|
-
|
|
8632
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8938
8633
|
};
|
|
8939
8634
|
/**
|
|
8940
8635
|
* ProgramApi - factory interface
|
|
@@ -8942,76 +8637,75 @@ export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
8942
8637
|
*/
|
|
8943
8638
|
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8944
8639
|
/**
|
|
8945
|
-
* This endpoint accepts a program
|
|
8946
|
-
* @summary Create
|
|
8640
|
+
* 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.
|
|
8641
|
+
* @summary Create program run
|
|
8947
8642
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8948
|
-
* @param {
|
|
8643
|
+
* @param {ProgramRequest} programRequest
|
|
8949
8644
|
* @param {*} [options] Override http request option.
|
|
8950
8645
|
* @throws {RequiredError}
|
|
8951
8646
|
*/
|
|
8952
|
-
|
|
8647
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference>;
|
|
8953
8648
|
/**
|
|
8954
|
-
* Execute a program
|
|
8955
|
-
* @summary Execute
|
|
8649
|
+
* 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.
|
|
8650
|
+
* @summary Execute program
|
|
8956
8651
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8957
|
-
* @param {
|
|
8652
|
+
* @param {ProgramRequest} programRequest
|
|
8958
8653
|
* @param {*} [options] Override http request option.
|
|
8959
8654
|
* @throws {RequiredError}
|
|
8960
8655
|
*/
|
|
8961
|
-
executeProgram(cell: string,
|
|
8656
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8962
8657
|
/**
|
|
8963
|
-
* Returns information about a program currently executed.
|
|
8964
|
-
* @summary Get
|
|
8658
|
+
* 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, ...
|
|
8659
|
+
* @summary Get program run
|
|
8965
8660
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8966
|
-
* @param {string}
|
|
8661
|
+
* @param {string} run
|
|
8967
8662
|
* @param {*} [options] Override http request option.
|
|
8968
8663
|
* @throws {RequiredError}
|
|
8969
8664
|
*/
|
|
8970
|
-
|
|
8665
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8971
8666
|
/**
|
|
8972
|
-
* Get details about all existing
|
|
8973
|
-
* @summary List
|
|
8667
|
+
* Get details about all existing runs
|
|
8668
|
+
* @summary List programs
|
|
8974
8669
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8975
8670
|
* @param {*} [options] Override http request option.
|
|
8976
8671
|
* @throws {RequiredError}
|
|
8977
8672
|
*/
|
|
8978
|
-
|
|
8673
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>>;
|
|
8979
8674
|
/**
|
|
8980
|
-
*
|
|
8981
|
-
* @summary
|
|
8675
|
+
* Simulate a program given as text/plain
|
|
8676
|
+
* @summary Simulate program
|
|
8982
8677
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8983
|
-
* @param {
|
|
8678
|
+
* @param {ProgramRequest} programRequest
|
|
8984
8679
|
* @param {*} [options] Override http request option.
|
|
8985
8680
|
* @throws {RequiredError}
|
|
8986
8681
|
*/
|
|
8987
|
-
|
|
8682
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8988
8683
|
/**
|
|
8989
|
-
*
|
|
8990
|
-
* @summary
|
|
8684
|
+
* Stop all runs
|
|
8685
|
+
* @summary Stop all programs
|
|
8991
8686
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8992
|
-
* @param {Request} request
|
|
8993
|
-
* @param {string} [identifier]
|
|
8994
8687
|
* @param {*} [options] Override http request option.
|
|
8995
8688
|
* @throws {RequiredError}
|
|
8996
8689
|
*/
|
|
8997
|
-
|
|
8690
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8998
8691
|
/**
|
|
8999
|
-
* Stop
|
|
9000
|
-
* @summary Stop
|
|
8692
|
+
* Stop a specific program run.
|
|
8693
|
+
* @summary Stop program run
|
|
9001
8694
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8695
|
+
* @param {string} run
|
|
9002
8696
|
* @param {*} [options] Override http request option.
|
|
9003
8697
|
* @throws {RequiredError}
|
|
9004
8698
|
*/
|
|
9005
|
-
|
|
8699
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9006
8700
|
/**
|
|
9007
|
-
*
|
|
9008
|
-
* @summary
|
|
8701
|
+
* Validate a program
|
|
8702
|
+
* @summary Validate program
|
|
9009
8703
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9010
|
-
* @param {
|
|
8704
|
+
* @param {ProgramRequest} programRequest
|
|
9011
8705
|
* @param {*} [options] Override http request option.
|
|
9012
8706
|
* @throws {RequiredError}
|
|
9013
8707
|
*/
|
|
9014
|
-
|
|
8708
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9015
8709
|
};
|
|
9016
8710
|
/**
|
|
9017
8711
|
* ProgramApi - object-oriented interface
|
|
@@ -9021,485 +8715,83 @@ export declare const ProgramApiFactory: (configuration?: Configuration, basePath
|
|
|
9021
8715
|
*/
|
|
9022
8716
|
export declare class ProgramApi extends BaseAPI {
|
|
9023
8717
|
/**
|
|
9024
|
-
* This endpoint accepts a program
|
|
9025
|
-
* @summary Create
|
|
8718
|
+
* 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.
|
|
8719
|
+
* @summary Create program run
|
|
9026
8720
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9027
|
-
* @param {
|
|
8721
|
+
* @param {ProgramRequest} programRequest
|
|
9028
8722
|
* @param {*} [options] Override http request option.
|
|
9029
8723
|
* @throws {RequiredError}
|
|
9030
8724
|
* @memberof ProgramApi
|
|
9031
8725
|
*/
|
|
9032
|
-
|
|
8726
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference, any>>;
|
|
9033
8727
|
/**
|
|
9034
|
-
* Execute a program
|
|
9035
|
-
* @summary Execute
|
|
8728
|
+
* 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.
|
|
8729
|
+
* @summary Execute program
|
|
9036
8730
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9037
|
-
* @param {
|
|
8731
|
+
* @param {ProgramRequest} programRequest
|
|
9038
8732
|
* @param {*} [options] Override http request option.
|
|
9039
8733
|
* @throws {RequiredError}
|
|
9040
8734
|
* @memberof ProgramApi
|
|
9041
8735
|
*/
|
|
9042
|
-
executeProgram(cell: string,
|
|
8736
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9043
8737
|
/**
|
|
9044
|
-
* Returns information about a program currently executed.
|
|
9045
|
-
* @summary Get
|
|
8738
|
+
* 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, ...
|
|
8739
|
+
* @summary Get program run
|
|
9046
8740
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9047
|
-
* @param {string}
|
|
8741
|
+
* @param {string} run
|
|
9048
8742
|
* @param {*} [options] Override http request option.
|
|
9049
8743
|
* @throws {RequiredError}
|
|
9050
8744
|
* @memberof ProgramApi
|
|
9051
8745
|
*/
|
|
9052
|
-
|
|
8746
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9053
8747
|
/**
|
|
9054
|
-
* Get details about all existing
|
|
9055
|
-
* @summary List
|
|
8748
|
+
* Get details about all existing runs
|
|
8749
|
+
* @summary List programs
|
|
9056
8750
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9057
8751
|
* @param {*} [options] Override http request option.
|
|
9058
8752
|
* @throws {RequiredError}
|
|
9059
8753
|
* @memberof ProgramApi
|
|
9060
8754
|
*/
|
|
9061
|
-
|
|
8755
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference[], any>>;
|
|
9062
8756
|
/**
|
|
9063
|
-
*
|
|
9064
|
-
* @summary
|
|
8757
|
+
* Simulate a program given as text/plain
|
|
8758
|
+
* @summary Simulate program
|
|
9065
8759
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9066
|
-
* @param {
|
|
8760
|
+
* @param {ProgramRequest} programRequest
|
|
9067
8761
|
* @param {*} [options] Override http request option.
|
|
9068
8762
|
* @throws {RequiredError}
|
|
9069
8763
|
* @memberof ProgramApi
|
|
9070
8764
|
*/
|
|
9071
|
-
|
|
8765
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9072
8766
|
/**
|
|
9073
|
-
*
|
|
9074
|
-
* @summary
|
|
8767
|
+
* Stop all runs
|
|
8768
|
+
* @summary Stop all programs
|
|
9075
8769
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9076
|
-
* @param {Request} request
|
|
9077
|
-
* @param {string} [identifier]
|
|
9078
8770
|
* @param {*} [options] Override http request option.
|
|
9079
8771
|
* @throws {RequiredError}
|
|
9080
8772
|
* @memberof ProgramApi
|
|
9081
8773
|
*/
|
|
9082
|
-
|
|
8774
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9083
8775
|
/**
|
|
9084
|
-
* Stop
|
|
9085
|
-
* @summary Stop
|
|
8776
|
+
* Stop a specific program run.
|
|
8777
|
+
* @summary Stop program run
|
|
9086
8778
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8779
|
+
* @param {string} run
|
|
9087
8780
|
* @param {*} [options] Override http request option.
|
|
9088
8781
|
* @throws {RequiredError}
|
|
9089
8782
|
* @memberof ProgramApi
|
|
9090
8783
|
*/
|
|
9091
|
-
|
|
8784
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9092
8785
|
/**
|
|
9093
|
-
*
|
|
9094
|
-
* @summary
|
|
8786
|
+
* Validate a program
|
|
8787
|
+
* @summary Validate program
|
|
9095
8788
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9096
|
-
* @param {
|
|
8789
|
+
* @param {ProgramRequest} programRequest
|
|
9097
8790
|
* @param {*} [options] Override http request option.
|
|
9098
8791
|
* @throws {RequiredError}
|
|
9099
8792
|
* @memberof ProgramApi
|
|
9100
8793
|
*/
|
|
9101
|
-
|
|
9102
|
-
}
|
|
9103
|
-
/**
|
|
9104
|
-
* ProgramLibraryApi - axios parameter creator
|
|
9105
|
-
* @export
|
|
9106
|
-
*/
|
|
9107
|
-
export declare const ProgramLibraryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9108
|
-
/**
|
|
9109
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9110
|
-
* @summary Create Program
|
|
9111
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9112
|
-
* @param {string} body
|
|
9113
|
-
* @param {string} [name]
|
|
9114
|
-
* @param {*} [options] Override http request option.
|
|
9115
|
-
* @throws {RequiredError}
|
|
9116
|
-
*/
|
|
9117
|
-
createProgram: (cell: string, body: string, name?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9118
|
-
/**
|
|
9119
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9120
|
-
* @summary Delete Program
|
|
9121
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9122
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9123
|
-
* @param {*} [options] Override http request option.
|
|
9124
|
-
* @throws {RequiredError}
|
|
9125
|
-
*/
|
|
9126
|
-
deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9127
|
-
/**
|
|
9128
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9129
|
-
* @summary Delete Program List
|
|
9130
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9131
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9132
|
-
* @param {*} [options] Override http request option.
|
|
9133
|
-
* @throws {RequiredError}
|
|
9134
|
-
*/
|
|
9135
|
-
deleteProgramList: (cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9136
|
-
/**
|
|
9137
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9138
|
-
* @summary Get Program
|
|
9139
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9140
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9141
|
-
* @param {*} [options] Override http request option.
|
|
9142
|
-
* @throws {RequiredError}
|
|
9143
|
-
*/
|
|
9144
|
-
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9145
|
-
/**
|
|
9146
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9147
|
-
* @summary Update Program
|
|
9148
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9149
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9150
|
-
* @param {string} body
|
|
9151
|
-
* @param {*} [options] Override http request option.
|
|
9152
|
-
* @throws {RequiredError}
|
|
9153
|
-
*/
|
|
9154
|
-
updateProgram: (cell: string, program: string, body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9155
|
-
};
|
|
9156
|
-
/**
|
|
9157
|
-
* ProgramLibraryApi - functional programming interface
|
|
9158
|
-
* @export
|
|
9159
|
-
*/
|
|
9160
|
-
export declare const ProgramLibraryApiFp: (configuration?: Configuration) => {
|
|
9161
|
-
/**
|
|
9162
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9163
|
-
* @summary Create Program
|
|
9164
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9165
|
-
* @param {string} body
|
|
9166
|
-
* @param {string} [name]
|
|
9167
|
-
* @param {*} [options] Override http request option.
|
|
9168
|
-
* @throws {RequiredError}
|
|
9169
|
-
*/
|
|
9170
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9171
|
-
/**
|
|
9172
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9173
|
-
* @summary Delete Program
|
|
9174
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9175
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9176
|
-
* @param {*} [options] Override http request option.
|
|
9177
|
-
* @throws {RequiredError}
|
|
9178
|
-
*/
|
|
9179
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9180
|
-
/**
|
|
9181
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9182
|
-
* @summary Delete Program List
|
|
9183
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9184
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9185
|
-
* @param {*} [options] Override http request option.
|
|
9186
|
-
* @throws {RequiredError}
|
|
9187
|
-
*/
|
|
9188
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProgramMetadataResponse>>;
|
|
9189
|
-
/**
|
|
9190
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9191
|
-
* @summary Get Program
|
|
9192
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9193
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9194
|
-
* @param {*} [options] Override http request option.
|
|
9195
|
-
* @throws {RequiredError}
|
|
9196
|
-
*/
|
|
9197
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
9198
|
-
/**
|
|
9199
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9200
|
-
* @summary Update Program
|
|
9201
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9202
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9203
|
-
* @param {string} body
|
|
9204
|
-
* @param {*} [options] Override http request option.
|
|
9205
|
-
* @throws {RequiredError}
|
|
9206
|
-
*/
|
|
9207
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9208
|
-
};
|
|
9209
|
-
/**
|
|
9210
|
-
* ProgramLibraryApi - factory interface
|
|
9211
|
-
* @export
|
|
9212
|
-
*/
|
|
9213
|
-
export declare const ProgramLibraryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9214
|
-
/**
|
|
9215
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9216
|
-
* @summary Create Program
|
|
9217
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9218
|
-
* @param {string} body
|
|
9219
|
-
* @param {string} [name]
|
|
9220
|
-
* @param {*} [options] Override http request option.
|
|
9221
|
-
* @throws {RequiredError}
|
|
9222
|
-
*/
|
|
9223
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9224
|
-
/**
|
|
9225
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9226
|
-
* @summary Delete Program
|
|
9227
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9228
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9229
|
-
* @param {*} [options] Override http request option.
|
|
9230
|
-
* @throws {RequiredError}
|
|
9231
|
-
*/
|
|
9232
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9233
|
-
/**
|
|
9234
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9235
|
-
* @summary Delete Program List
|
|
9236
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9237
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9238
|
-
* @param {*} [options] Override http request option.
|
|
9239
|
-
* @throws {RequiredError}
|
|
9240
|
-
*/
|
|
9241
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<ListProgramMetadataResponse>;
|
|
9242
|
-
/**
|
|
9243
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9244
|
-
* @summary Get Program
|
|
9245
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9246
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9247
|
-
* @param {*} [options] Override http request option.
|
|
9248
|
-
* @throws {RequiredError}
|
|
9249
|
-
*/
|
|
9250
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
9251
|
-
/**
|
|
9252
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9253
|
-
* @summary Update Program
|
|
9254
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9255
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9256
|
-
* @param {string} body
|
|
9257
|
-
* @param {*} [options] Override http request option.
|
|
9258
|
-
* @throws {RequiredError}
|
|
9259
|
-
*/
|
|
9260
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9261
|
-
};
|
|
9262
|
-
/**
|
|
9263
|
-
* ProgramLibraryApi - object-oriented interface
|
|
9264
|
-
* @export
|
|
9265
|
-
* @class ProgramLibraryApi
|
|
9266
|
-
* @extends {BaseAPI}
|
|
9267
|
-
*/
|
|
9268
|
-
export declare class ProgramLibraryApi extends BaseAPI {
|
|
9269
|
-
/**
|
|
9270
|
-
* <!-- theme: danger --> > **Experimental** Creates a new program. The corresponding metadata is created as well. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9271
|
-
* @summary Create Program
|
|
9272
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9273
|
-
* @param {string} body
|
|
9274
|
-
* @param {string} [name]
|
|
9275
|
-
* @param {*} [options] Override http request option.
|
|
9276
|
-
* @throws {RequiredError}
|
|
9277
|
-
* @memberof ProgramLibraryApi
|
|
9278
|
-
*/
|
|
9279
|
-
createProgram(cell: string, body: string, name?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9280
|
-
/**
|
|
9281
|
-
* # EXPERIMENTAL > **Note:** This endpoint is experimental and might experience functional changes in the future. Deletes the program with the corresponding metadata. This action is irreversible. Does not delete the associated recipes.
|
|
9282
|
-
* @summary Delete Program
|
|
9283
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9284
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9285
|
-
* @param {*} [options] Override http request option.
|
|
9286
|
-
* @throws {RequiredError}
|
|
9287
|
-
* @memberof ProgramLibraryApi
|
|
9288
|
-
*/
|
|
9289
|
-
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9290
|
-
/**
|
|
9291
|
-
* <!-- theme: danger --> > **Experimental** Deletes the provided list of programs with the corresponding metadata. This action is irreversible.
|
|
9292
|
-
* @summary Delete Program List
|
|
9293
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9294
|
-
* @param {Array<string>} programIds Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9295
|
-
* @param {*} [options] Override http request option.
|
|
9296
|
-
* @throws {RequiredError}
|
|
9297
|
-
* @memberof ProgramLibraryApi
|
|
9298
|
-
*/
|
|
9299
|
-
deleteProgramList(cell: string, programIds: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
9300
|
-
/**
|
|
9301
|
-
* <!-- theme: danger --> > **Experimental** Returns the content of the program. The identifier of the program is received upon creation or from the metadata list of all the programs.
|
|
9302
|
-
* @summary Get Program
|
|
9303
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9304
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9305
|
-
* @param {*} [options] Override http request option.
|
|
9306
|
-
* @throws {RequiredError}
|
|
9307
|
-
* @memberof ProgramLibraryApi
|
|
9308
|
-
*/
|
|
9309
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
9310
|
-
/**
|
|
9311
|
-
* <!-- theme: danger --> > **Experimental** Updates the content of the program. The update overwrites the existing content. The metadata is updated in correspondence. ## Examples ``` move via p2p() to [0, 0, 0, 0, 0, 0] move frame(\"flange\") to [1, 2, 0] move via line() to [1, 1, 0] a := planned_pose() ``` ``` {% from \'schneider_conveyor_v1.j2\' import schneider_conveyor_library -%} {{ schneider_conveyor_library() }} def start_main(): conveyor_speed_percentage = {{ conveyor_speed_percentage | round(4) }} conveyer_speed = conveyor_speed_percentage*1500 schneider_conveyor_start(conveyer_speed) end ```
|
|
9312
|
-
* @summary Update Program
|
|
9313
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9314
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9315
|
-
* @param {string} body
|
|
9316
|
-
* @param {*} [options] Override http request option.
|
|
9317
|
-
* @throws {RequiredError}
|
|
9318
|
-
* @memberof ProgramLibraryApi
|
|
9319
|
-
*/
|
|
9320
|
-
updateProgram(cell: string, program: string, body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9321
|
-
}
|
|
9322
|
-
/**
|
|
9323
|
-
* ProgramLibraryMetadataApi - axios parameter creator
|
|
9324
|
-
* @export
|
|
9325
|
-
*/
|
|
9326
|
-
export declare const ProgramLibraryMetadataApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9327
|
-
/**
|
|
9328
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9329
|
-
* @summary Get Program Metadata
|
|
9330
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9331
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9332
|
-
* @param {*} [options] Override http request option.
|
|
9333
|
-
* @throws {RequiredError}
|
|
9334
|
-
*/
|
|
9335
|
-
getProgramMetadata: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9336
|
-
/**
|
|
9337
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9338
|
-
* @summary List Program Metadata
|
|
9339
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9340
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9341
|
-
* @param {*} [options] Override http request option.
|
|
9342
|
-
* @throws {RequiredError}
|
|
9343
|
-
*/
|
|
9344
|
-
listProgramMetadata: (cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9345
|
-
/**
|
|
9346
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9347
|
-
* @summary Update Program Metadata
|
|
9348
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9349
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9350
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9351
|
-
* @param {*} [options] Override http request option.
|
|
9352
|
-
* @throws {RequiredError}
|
|
9353
|
-
*/
|
|
9354
|
-
updateProgramMetadata: (cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9355
|
-
/**
|
|
9356
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9357
|
-
* @summary Upload Program Metadata Image
|
|
9358
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9359
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9360
|
-
* @param {File} file
|
|
9361
|
-
* @param {*} [options] Override http request option.
|
|
9362
|
-
* @throws {RequiredError}
|
|
9363
|
-
*/
|
|
9364
|
-
uploadProgramMetadataImage: (cell: string, program: string, file: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9365
|
-
};
|
|
9366
|
-
/**
|
|
9367
|
-
* ProgramLibraryMetadataApi - functional programming interface
|
|
9368
|
-
* @export
|
|
9369
|
-
*/
|
|
9370
|
-
export declare const ProgramLibraryMetadataApiFp: (configuration?: Configuration) => {
|
|
9371
|
-
/**
|
|
9372
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9373
|
-
* @summary Get Program Metadata
|
|
9374
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9375
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9376
|
-
* @param {*} [options] Override http request option.
|
|
9377
|
-
* @throws {RequiredError}
|
|
9378
|
-
*/
|
|
9379
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9380
|
-
/**
|
|
9381
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9382
|
-
* @summary List Program Metadata
|
|
9383
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9384
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9385
|
-
* @param {*} [options] Override http request option.
|
|
9386
|
-
* @throws {RequiredError}
|
|
9387
|
-
*/
|
|
9388
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProgramMetadataResponse>>;
|
|
9389
|
-
/**
|
|
9390
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9391
|
-
* @summary Update Program Metadata
|
|
9392
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9393
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9394
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9395
|
-
* @param {*} [options] Override http request option.
|
|
9396
|
-
* @throws {RequiredError}
|
|
9397
|
-
*/
|
|
9398
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9399
|
-
/**
|
|
9400
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9401
|
-
* @summary Upload Program Metadata Image
|
|
9402
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9403
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9404
|
-
* @param {File} file
|
|
9405
|
-
* @param {*} [options] Override http request option.
|
|
9406
|
-
* @throws {RequiredError}
|
|
9407
|
-
*/
|
|
9408
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramMetadata>>;
|
|
9409
|
-
};
|
|
9410
|
-
/**
|
|
9411
|
-
* ProgramLibraryMetadataApi - factory interface
|
|
9412
|
-
* @export
|
|
9413
|
-
*/
|
|
9414
|
-
export declare const ProgramLibraryMetadataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9415
|
-
/**
|
|
9416
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9417
|
-
* @summary Get Program Metadata
|
|
9418
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9419
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9420
|
-
* @param {*} [options] Override http request option.
|
|
9421
|
-
* @throws {RequiredError}
|
|
9422
|
-
*/
|
|
9423
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9424
|
-
/**
|
|
9425
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9426
|
-
* @summary List Program Metadata
|
|
9427
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9428
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9429
|
-
* @param {*} [options] Override http request option.
|
|
9430
|
-
* @throws {RequiredError}
|
|
9431
|
-
*/
|
|
9432
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ListProgramMetadataResponse>;
|
|
9433
|
-
/**
|
|
9434
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9435
|
-
* @summary Update Program Metadata
|
|
9436
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9437
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9438
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9439
|
-
* @param {*} [options] Override http request option.
|
|
9440
|
-
* @throws {RequiredError}
|
|
9441
|
-
*/
|
|
9442
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9443
|
-
/**
|
|
9444
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9445
|
-
* @summary Upload Program Metadata Image
|
|
9446
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9447
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9448
|
-
* @param {File} file
|
|
9449
|
-
* @param {*} [options] Override http request option.
|
|
9450
|
-
* @throws {RequiredError}
|
|
9451
|
-
*/
|
|
9452
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<ProgramMetadata>;
|
|
9453
|
-
};
|
|
9454
|
-
/**
|
|
9455
|
-
* ProgramLibraryMetadataApi - object-oriented interface
|
|
9456
|
-
* @export
|
|
9457
|
-
* @class ProgramLibraryMetadataApi
|
|
9458
|
-
* @extends {BaseAPI}
|
|
9459
|
-
*/
|
|
9460
|
-
export declare class ProgramLibraryMetadataApi extends BaseAPI {
|
|
9461
|
-
/**
|
|
9462
|
-
* <!-- theme: danger --> > **Experimental** Returns metadata of the corresponding program.
|
|
9463
|
-
* @summary Get Program Metadata
|
|
9464
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9465
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9466
|
-
* @param {*} [options] Override http request option.
|
|
9467
|
-
* @throws {RequiredError}
|
|
9468
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9469
|
-
*/
|
|
9470
|
-
getProgramMetadata(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9471
|
-
/**
|
|
9472
|
-
* <!-- theme: danger --> > **Experimental** Returns a list of all the stored programs, represented by their metadata.
|
|
9473
|
-
* @summary List Program Metadata
|
|
9474
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9475
|
-
* @param {boolean} [showHidden] If true, hidden programs, where the `is_hidden` flag is active, are included in the list.
|
|
9476
|
-
* @param {*} [options] Override http request option.
|
|
9477
|
-
* @throws {RequiredError}
|
|
9478
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9479
|
-
*/
|
|
9480
|
-
listProgramMetadata(cell: string, showHidden?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProgramMetadataResponse, any>>;
|
|
9481
|
-
/**
|
|
9482
|
-
* <!-- theme: danger --> > **Experimental** Updates the metadata of the corresponding program. The update is partial, only the set fields get updated.
|
|
9483
|
-
* @summary Update Program Metadata
|
|
9484
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9485
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9486
|
-
* @param {UpdateProgramMetadataRequest} updateProgramMetadataRequest
|
|
9487
|
-
* @param {*} [options] Override http request option.
|
|
9488
|
-
* @throws {RequiredError}
|
|
9489
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9490
|
-
*/
|
|
9491
|
-
updateProgramMetadata(cell: string, program: string, updateProgramMetadataRequest: UpdateProgramMetadataRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
9492
|
-
/**
|
|
9493
|
-
* <!-- theme: danger --> > **Experimental** Uploads an image for the corresponding program. The image is served as a static file. The path to the image is stored in the metadata.
|
|
9494
|
-
* @summary Upload Program Metadata Image
|
|
9495
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9496
|
-
* @param {string} program Recieved from [listProgramMetadata](listProgramMetadata) or from the response of [createProgram](createProgram).
|
|
9497
|
-
* @param {File} file
|
|
9498
|
-
* @param {*} [options] Override http request option.
|
|
9499
|
-
* @throws {RequiredError}
|
|
9500
|
-
* @memberof ProgramLibraryMetadataApi
|
|
9501
|
-
*/
|
|
9502
|
-
uploadProgramMetadataImage(cell: string, program: string, file: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramMetadata, any>>;
|
|
8794
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9503
8795
|
}
|
|
9504
8796
|
/**
|
|
9505
8797
|
* ProgramOperatorApi - axios parameter creator
|
|
@@ -9507,14 +8799,14 @@ export declare class ProgramLibraryMetadataApi extends BaseAPI {
|
|
|
9507
8799
|
*/
|
|
9508
8800
|
export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9509
8801
|
/**
|
|
9510
|
-
* <!-- theme: danger -->
|
|
8802
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9511
8803
|
* @summary Run Program from Library
|
|
9512
8804
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9513
|
-
* @param {
|
|
8805
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9514
8806
|
* @param {*} [options] Override http request option.
|
|
9515
8807
|
* @throws {RequiredError}
|
|
9516
8808
|
*/
|
|
9517
|
-
|
|
8809
|
+
createProgramOperatorRun: (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9518
8810
|
/**
|
|
9519
8811
|
* <!-- 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.
|
|
9520
8812
|
* @summary Create Trigger
|
|
@@ -9534,14 +8826,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9534
8826
|
*/
|
|
9535
8827
|
deleteTrigger: (trigger: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9536
8828
|
/**
|
|
9537
|
-
* <!-- theme: danger -->
|
|
8829
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9538
8830
|
* @summary Get All Program Runs
|
|
9539
8831
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9540
8832
|
* @param {string} [state]
|
|
9541
8833
|
* @param {*} [options] Override http request option.
|
|
9542
8834
|
* @throws {RequiredError}
|
|
9543
8835
|
*/
|
|
9544
|
-
|
|
8836
|
+
getAllProgramOperatorRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9545
8837
|
/**
|
|
9546
8838
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9547
8839
|
* @summary Get All Triggers
|
|
@@ -9551,14 +8843,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9551
8843
|
*/
|
|
9552
8844
|
getAllTriggers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9553
8845
|
/**
|
|
9554
|
-
* <!-- theme: danger -->
|
|
8846
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9555
8847
|
* @summary Get Program Run
|
|
9556
8848
|
* @param {string} run
|
|
9557
8849
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9558
8850
|
* @param {*} [options] Override http request option.
|
|
9559
8851
|
* @throws {RequiredError}
|
|
9560
8852
|
*/
|
|
9561
|
-
|
|
8853
|
+
getProgramOperatorRun: (run: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9562
8854
|
/**
|
|
9563
8855
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9564
8856
|
* @summary Get Trigger
|
|
@@ -9585,14 +8877,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9585
8877
|
*/
|
|
9586
8878
|
export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
9587
8879
|
/**
|
|
9588
|
-
* <!-- theme: danger -->
|
|
8880
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9589
8881
|
* @summary Run Program from Library
|
|
9590
8882
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9591
|
-
* @param {
|
|
8883
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9592
8884
|
* @param {*} [options] Override http request option.
|
|
9593
8885
|
* @throws {RequiredError}
|
|
9594
8886
|
*/
|
|
9595
|
-
|
|
8887
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>>;
|
|
9596
8888
|
/**
|
|
9597
8889
|
* <!-- 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.
|
|
9598
8890
|
* @summary Create Trigger
|
|
@@ -9612,14 +8904,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9612
8904
|
*/
|
|
9613
8905
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9614
8906
|
/**
|
|
9615
|
-
* <!-- theme: danger -->
|
|
8907
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9616
8908
|
* @summary Get All Program Runs
|
|
9617
8909
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9618
8910
|
* @param {string} [state]
|
|
9619
8911
|
* @param {*} [options] Override http request option.
|
|
9620
8912
|
* @throws {RequiredError}
|
|
9621
8913
|
*/
|
|
9622
|
-
|
|
8914
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>>;
|
|
9623
8915
|
/**
|
|
9624
8916
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9625
8917
|
* @summary Get All Triggers
|
|
@@ -9629,14 +8921,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9629
8921
|
*/
|
|
9630
8922
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllTriggers200Response>>;
|
|
9631
8923
|
/**
|
|
9632
|
-
* <!-- theme: danger -->
|
|
8924
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9633
8925
|
* @summary Get Program Run
|
|
9634
8926
|
* @param {string} run
|
|
9635
8927
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9636
8928
|
* @param {*} [options] Override http request option.
|
|
9637
8929
|
* @throws {RequiredError}
|
|
9638
8930
|
*/
|
|
9639
|
-
|
|
8931
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>>;
|
|
9640
8932
|
/**
|
|
9641
8933
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9642
8934
|
* @summary Get Trigger
|
|
@@ -9663,14 +8955,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9663
8955
|
*/
|
|
9664
8956
|
export declare const ProgramOperatorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9665
8957
|
/**
|
|
9666
|
-
* <!-- theme: danger -->
|
|
8958
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9667
8959
|
* @summary Run Program from Library
|
|
9668
8960
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9669
|
-
* @param {
|
|
8961
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9670
8962
|
* @param {*} [options] Override http request option.
|
|
9671
8963
|
* @throws {RequiredError}
|
|
9672
8964
|
*/
|
|
9673
|
-
|
|
8965
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response>;
|
|
9674
8966
|
/**
|
|
9675
8967
|
* <!-- 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.
|
|
9676
8968
|
* @summary Create Trigger
|
|
@@ -9690,14 +8982,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9690
8982
|
*/
|
|
9691
8983
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9692
8984
|
/**
|
|
9693
|
-
* <!-- theme: danger -->
|
|
8985
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9694
8986
|
* @summary Get All Program Runs
|
|
9695
8987
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9696
8988
|
* @param {string} [state]
|
|
9697
8989
|
* @param {*} [options] Override http request option.
|
|
9698
8990
|
* @throws {RequiredError}
|
|
9699
8991
|
*/
|
|
9700
|
-
|
|
8992
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response>;
|
|
9701
8993
|
/**
|
|
9702
8994
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9703
8995
|
* @summary Get All Triggers
|
|
@@ -9707,14 +8999,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9707
8999
|
*/
|
|
9708
9000
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllTriggers200Response>;
|
|
9709
9001
|
/**
|
|
9710
|
-
* <!-- theme: danger -->
|
|
9002
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9711
9003
|
* @summary Get Program Run
|
|
9712
9004
|
* @param {string} run
|
|
9713
9005
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9714
9006
|
* @param {*} [options] Override http request option.
|
|
9715
9007
|
* @throws {RequiredError}
|
|
9716
9008
|
*/
|
|
9717
|
-
|
|
9009
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject>;
|
|
9718
9010
|
/**
|
|
9719
9011
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9720
9012
|
* @summary Get Trigger
|
|
@@ -9743,15 +9035,15 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9743
9035
|
*/
|
|
9744
9036
|
export declare class ProgramOperatorApi extends BaseAPI {
|
|
9745
9037
|
/**
|
|
9746
|
-
* <!-- theme: danger -->
|
|
9038
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
|
|
9747
9039
|
* @summary Run Program from Library
|
|
9748
9040
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9749
|
-
* @param {
|
|
9041
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9750
9042
|
* @param {*} [options] Override http request option.
|
|
9751
9043
|
* @throws {RequiredError}
|
|
9752
9044
|
* @memberof ProgramOperatorApi
|
|
9753
9045
|
*/
|
|
9754
|
-
|
|
9046
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProgramOperatorRun200Response, any>>;
|
|
9755
9047
|
/**
|
|
9756
9048
|
* <!-- 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.
|
|
9757
9049
|
* @summary Create Trigger
|
|
@@ -9773,7 +9065,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9773
9065
|
*/
|
|
9774
9066
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9775
9067
|
/**
|
|
9776
|
-
* <!-- theme: danger -->
|
|
9068
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
9777
9069
|
* @summary Get All Program Runs
|
|
9778
9070
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9779
9071
|
* @param {string} [state]
|
|
@@ -9781,7 +9073,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9781
9073
|
* @throws {RequiredError}
|
|
9782
9074
|
* @memberof ProgramOperatorApi
|
|
9783
9075
|
*/
|
|
9784
|
-
|
|
9076
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramOperatorRuns200Response, any>>;
|
|
9785
9077
|
/**
|
|
9786
9078
|
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
|
|
9787
9079
|
* @summary Get All Triggers
|
|
@@ -9792,7 +9084,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9792
9084
|
*/
|
|
9793
9085
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllTriggers200Response, any>>;
|
|
9794
9086
|
/**
|
|
9795
|
-
* <!-- theme: danger -->
|
|
9087
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9796
9088
|
* @summary Get Program Run
|
|
9797
9089
|
* @param {string} run
|
|
9798
9090
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -9800,7 +9092,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9800
9092
|
* @throws {RequiredError}
|
|
9801
9093
|
* @memberof ProgramOperatorApi
|
|
9802
9094
|
*/
|
|
9803
|
-
|
|
9095
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunObject, any>>;
|
|
9804
9096
|
/**
|
|
9805
9097
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9806
9098
|
* @summary Get Trigger
|
|
@@ -10842,6 +10134,192 @@ export declare class StoreObjectApi extends BaseAPI {
|
|
|
10842
10134
|
[key: string]: string;
|
|
10843
10135
|
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10844
10136
|
}
|
|
10137
|
+
/**
|
|
10138
|
+
* StoreProgramApi - axios parameter creator
|
|
10139
|
+
* @export
|
|
10140
|
+
*/
|
|
10141
|
+
export declare const StoreProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10142
|
+
/**
|
|
10143
|
+
* Deletes the program. This action is irreversible.
|
|
10144
|
+
* @summary Delete Program
|
|
10145
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10146
|
+
* @param {string} program
|
|
10147
|
+
* @param {*} [options] Override http request option.
|
|
10148
|
+
* @throws {RequiredError}
|
|
10149
|
+
*/
|
|
10150
|
+
deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10151
|
+
/**
|
|
10152
|
+
* Returns the content of the program.
|
|
10153
|
+
* @summary Get Program
|
|
10154
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10155
|
+
* @param {string} program
|
|
10156
|
+
* @param {*} [options] Override http request option.
|
|
10157
|
+
* @throws {RequiredError}
|
|
10158
|
+
*/
|
|
10159
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10160
|
+
/**
|
|
10161
|
+
* Returns a list of all the stored programs.
|
|
10162
|
+
* @summary List all Programs
|
|
10163
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10164
|
+
* @param {*} [options] Override http request option.
|
|
10165
|
+
* @throws {RequiredError}
|
|
10166
|
+
*/
|
|
10167
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10168
|
+
/**
|
|
10169
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10170
|
+
* @summary Store Program
|
|
10171
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10172
|
+
* @param {string} program
|
|
10173
|
+
* @param {string} body
|
|
10174
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10175
|
+
* @param {*} [options] Override http request option.
|
|
10176
|
+
* @throws {RequiredError}
|
|
10177
|
+
*/
|
|
10178
|
+
storeProgram: (cell: string, program: string, body: string, xMetadata?: {
|
|
10179
|
+
[key: string]: string;
|
|
10180
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10181
|
+
};
|
|
10182
|
+
/**
|
|
10183
|
+
* StoreProgramApi - functional programming interface
|
|
10184
|
+
* @export
|
|
10185
|
+
*/
|
|
10186
|
+
export declare const StoreProgramApiFp: (configuration?: Configuration) => {
|
|
10187
|
+
/**
|
|
10188
|
+
* Deletes the program. This action is irreversible.
|
|
10189
|
+
* @summary Delete Program
|
|
10190
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10191
|
+
* @param {string} program
|
|
10192
|
+
* @param {*} [options] Override http request option.
|
|
10193
|
+
* @throws {RequiredError}
|
|
10194
|
+
*/
|
|
10195
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10196
|
+
/**
|
|
10197
|
+
* Returns the content of the program.
|
|
10198
|
+
* @summary Get Program
|
|
10199
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10200
|
+
* @param {string} program
|
|
10201
|
+
* @param {*} [options] Override http request option.
|
|
10202
|
+
* @throws {RequiredError}
|
|
10203
|
+
*/
|
|
10204
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
10205
|
+
/**
|
|
10206
|
+
* Returns a list of all the stored programs.
|
|
10207
|
+
* @summary List all Programs
|
|
10208
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10209
|
+
* @param {*} [options] Override http request option.
|
|
10210
|
+
* @throws {RequiredError}
|
|
10211
|
+
*/
|
|
10212
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
10213
|
+
/**
|
|
10214
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10215
|
+
* @summary Store Program
|
|
10216
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10217
|
+
* @param {string} program
|
|
10218
|
+
* @param {string} body
|
|
10219
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10220
|
+
* @param {*} [options] Override http request option.
|
|
10221
|
+
* @throws {RequiredError}
|
|
10222
|
+
*/
|
|
10223
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10224
|
+
[key: string]: string;
|
|
10225
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10226
|
+
};
|
|
10227
|
+
/**
|
|
10228
|
+
* StoreProgramApi - factory interface
|
|
10229
|
+
* @export
|
|
10230
|
+
*/
|
|
10231
|
+
export declare const StoreProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10232
|
+
/**
|
|
10233
|
+
* Deletes the program. This action is irreversible.
|
|
10234
|
+
* @summary Delete Program
|
|
10235
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10236
|
+
* @param {string} program
|
|
10237
|
+
* @param {*} [options] Override http request option.
|
|
10238
|
+
* @throws {RequiredError}
|
|
10239
|
+
*/
|
|
10240
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10241
|
+
/**
|
|
10242
|
+
* Returns the content of the program.
|
|
10243
|
+
* @summary Get Program
|
|
10244
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10245
|
+
* @param {string} program
|
|
10246
|
+
* @param {*} [options] Override http request option.
|
|
10247
|
+
* @throws {RequiredError}
|
|
10248
|
+
*/
|
|
10249
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
10250
|
+
/**
|
|
10251
|
+
* Returns a list of all the stored programs.
|
|
10252
|
+
* @summary List all Programs
|
|
10253
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10254
|
+
* @param {*} [options] Override http request option.
|
|
10255
|
+
* @throws {RequiredError}
|
|
10256
|
+
*/
|
|
10257
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
10258
|
+
/**
|
|
10259
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10260
|
+
* @summary Store Program
|
|
10261
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10262
|
+
* @param {string} program
|
|
10263
|
+
* @param {string} body
|
|
10264
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10265
|
+
* @param {*} [options] Override http request option.
|
|
10266
|
+
* @throws {RequiredError}
|
|
10267
|
+
*/
|
|
10268
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10269
|
+
[key: string]: string;
|
|
10270
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10271
|
+
};
|
|
10272
|
+
/**
|
|
10273
|
+
* StoreProgramApi - object-oriented interface
|
|
10274
|
+
* @export
|
|
10275
|
+
* @class StoreProgramApi
|
|
10276
|
+
* @extends {BaseAPI}
|
|
10277
|
+
*/
|
|
10278
|
+
export declare class StoreProgramApi extends BaseAPI {
|
|
10279
|
+
/**
|
|
10280
|
+
* Deletes the program. This action is irreversible.
|
|
10281
|
+
* @summary Delete Program
|
|
10282
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10283
|
+
* @param {string} program
|
|
10284
|
+
* @param {*} [options] Override http request option.
|
|
10285
|
+
* @throws {RequiredError}
|
|
10286
|
+
* @memberof StoreProgramApi
|
|
10287
|
+
*/
|
|
10288
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10289
|
+
/**
|
|
10290
|
+
* Returns the content of the program.
|
|
10291
|
+
* @summary Get Program
|
|
10292
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10293
|
+
* @param {string} program
|
|
10294
|
+
* @param {*} [options] Override http request option.
|
|
10295
|
+
* @throws {RequiredError}
|
|
10296
|
+
* @memberof StoreProgramApi
|
|
10297
|
+
*/
|
|
10298
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
10299
|
+
/**
|
|
10300
|
+
* Returns a list of all the stored programs.
|
|
10301
|
+
* @summary List all Programs
|
|
10302
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10303
|
+
* @param {*} [options] Override http request option.
|
|
10304
|
+
* @throws {RequiredError}
|
|
10305
|
+
* @memberof StoreProgramApi
|
|
10306
|
+
*/
|
|
10307
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
10308
|
+
/**
|
|
10309
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10310
|
+
* @summary Store Program
|
|
10311
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10312
|
+
* @param {string} program
|
|
10313
|
+
* @param {string} body
|
|
10314
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10315
|
+
* @param {*} [options] Override http request option.
|
|
10316
|
+
* @throws {RequiredError}
|
|
10317
|
+
* @memberof StoreProgramApi
|
|
10318
|
+
*/
|
|
10319
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10320
|
+
[key: string]: string;
|
|
10321
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10322
|
+
}
|
|
10845
10323
|
/**
|
|
10846
10324
|
* SystemApi - axios parameter creator
|
|
10847
10325
|
* @export
|