@wandelbots/nova-api 25.5.0-dev.2 → 25.5.0-dev.20
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 +58 -3
- package/v1/api.js.map +1 -1
- package/v1/api.ts +59 -3
- package/v2/api.d.ts +479 -1018
- package/v2/api.js +1676 -2114
- package/v2/api.js.map +1 -1
- package/v2/api.ts +1946 -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
|
|
@@ -3867,19 +3683,6 @@ export declare const OrientationType: {
|
|
|
3867
3683
|
readonly EulerAnglesExtrinsicZxy: "EULER_ANGLES_EXTRINSIC_ZXY";
|
|
3868
3684
|
};
|
|
3869
3685
|
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
3686
|
/**
|
|
3884
3687
|
* 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
3688
|
* @export
|
|
@@ -4376,19 +4179,6 @@ export interface PlaybackSpeedResponsePlaybackSpeedResponse {
|
|
|
4376
4179
|
*/
|
|
4377
4180
|
'requested_value': number;
|
|
4378
4181
|
}
|
|
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
4182
|
/**
|
|
4393
4183
|
* 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
4184
|
* @export
|
|
@@ -4434,116 +4224,102 @@ export interface PoseInCoordinateSystem {
|
|
|
4434
4224
|
'coordinate_system'?: string;
|
|
4435
4225
|
}
|
|
4436
4226
|
/**
|
|
4437
|
-
*
|
|
4227
|
+
*
|
|
4438
4228
|
* @export
|
|
4439
|
-
* @interface
|
|
4229
|
+
* @interface ProgramRequest
|
|
4440
4230
|
*/
|
|
4441
|
-
export interface
|
|
4442
|
-
/**
|
|
4443
|
-
* The unique identifier of the program.
|
|
4444
|
-
* @type {string}
|
|
4445
|
-
* @memberof ProgramMetadata
|
|
4446
|
-
*/
|
|
4447
|
-
'id': string;
|
|
4231
|
+
export interface ProgramRequest {
|
|
4448
4232
|
/**
|
|
4449
|
-
*
|
|
4233
|
+
*
|
|
4450
4234
|
* @type {string}
|
|
4451
|
-
* @memberof
|
|
4235
|
+
* @memberof ProgramRequest
|
|
4452
4236
|
*/
|
|
4453
|
-
'
|
|
4237
|
+
'program': string;
|
|
4454
4238
|
/**
|
|
4455
|
-
*
|
|
4239
|
+
* Identifier of the default robot to use for execution
|
|
4456
4240
|
* @type {string}
|
|
4457
|
-
* @memberof
|
|
4241
|
+
* @memberof ProgramRequest
|
|
4458
4242
|
*/
|
|
4459
|
-
'
|
|
4243
|
+
'default_robot'?: string;
|
|
4460
4244
|
/**
|
|
4461
|
-
*
|
|
4245
|
+
* Identifier of the default TCP to use for execution
|
|
4462
4246
|
* @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
|
|
4247
|
+
* @memberof ProgramRequest
|
|
4470
4248
|
*/
|
|
4471
|
-
'
|
|
4249
|
+
'default_tcp'?: string;
|
|
4472
4250
|
/**
|
|
4473
|
-
*
|
|
4474
|
-
* @type {
|
|
4475
|
-
* @memberof
|
|
4251
|
+
* Initial arguments that are available within the program
|
|
4252
|
+
* @type {object}
|
|
4253
|
+
* @memberof ProgramRequest
|
|
4476
4254
|
*/
|
|
4477
|
-
'
|
|
4255
|
+
'run_args'?: object;
|
|
4478
4256
|
}
|
|
4479
4257
|
/**
|
|
4480
|
-
*
|
|
4258
|
+
* Holds the state of a program run.
|
|
4481
4259
|
* @export
|
|
4482
4260
|
* @interface ProgramRun
|
|
4483
4261
|
*/
|
|
4484
4262
|
export interface ProgramRun {
|
|
4485
4263
|
/**
|
|
4486
|
-
*
|
|
4264
|
+
* Unique id of the program run
|
|
4487
4265
|
* @type {string}
|
|
4488
4266
|
* @memberof ProgramRun
|
|
4489
4267
|
*/
|
|
4490
4268
|
'id': string;
|
|
4491
4269
|
/**
|
|
4492
|
-
*
|
|
4270
|
+
* State of the program run
|
|
4493
4271
|
* @type {ProgramRunState}
|
|
4494
4272
|
* @memberof ProgramRun
|
|
4495
4273
|
*/
|
|
4496
4274
|
'state': ProgramRunState;
|
|
4497
4275
|
/**
|
|
4498
|
-
*
|
|
4276
|
+
* Logs of the program run
|
|
4499
4277
|
* @type {string}
|
|
4500
4278
|
* @memberof ProgramRun
|
|
4501
4279
|
*/
|
|
4502
4280
|
'logs'?: string;
|
|
4503
4281
|
/**
|
|
4504
|
-
*
|
|
4282
|
+
* Stdout of the program run
|
|
4505
4283
|
* @type {string}
|
|
4506
4284
|
* @memberof ProgramRun
|
|
4507
4285
|
*/
|
|
4508
4286
|
'stdout'?: string;
|
|
4509
4287
|
/**
|
|
4510
|
-
*
|
|
4511
|
-
* @type {
|
|
4288
|
+
* Stores runtime variables of the run
|
|
4289
|
+
* @type {object}
|
|
4512
4290
|
* @memberof ProgramRun
|
|
4513
4291
|
*/
|
|
4514
|
-
'store'?:
|
|
4515
|
-
[key: string]: StoreValue;
|
|
4516
|
-
};
|
|
4292
|
+
'store'?: object;
|
|
4517
4293
|
/**
|
|
4518
|
-
*
|
|
4294
|
+
* Error message of the program run, if any
|
|
4519
4295
|
* @type {string}
|
|
4520
4296
|
* @memberof ProgramRun
|
|
4521
4297
|
*/
|
|
4522
|
-
'error'?: string
|
|
4298
|
+
'error'?: string;
|
|
4523
4299
|
/**
|
|
4524
|
-
*
|
|
4300
|
+
* Traceback of the program run, if any
|
|
4525
4301
|
* @type {string}
|
|
4526
4302
|
* @memberof ProgramRun
|
|
4527
4303
|
*/
|
|
4528
|
-
'traceback'?: string
|
|
4304
|
+
'traceback'?: string;
|
|
4529
4305
|
/**
|
|
4530
|
-
*
|
|
4306
|
+
* Start time of the program run
|
|
4531
4307
|
* @type {number}
|
|
4532
4308
|
* @memberof ProgramRun
|
|
4533
4309
|
*/
|
|
4534
|
-
'start_time'?: number
|
|
4310
|
+
'start_time'?: number;
|
|
4535
4311
|
/**
|
|
4536
|
-
*
|
|
4312
|
+
* End time of the program run
|
|
4537
4313
|
* @type {number}
|
|
4538
4314
|
* @memberof ProgramRun
|
|
4539
4315
|
*/
|
|
4540
|
-
'end_time'?: number
|
|
4316
|
+
'end_time'?: number;
|
|
4541
4317
|
/**
|
|
4542
|
-
*
|
|
4543
|
-
* @type {Array<
|
|
4318
|
+
* Execution results of the program run
|
|
4319
|
+
* @type {Array<ProgramRunResult>}
|
|
4544
4320
|
* @memberof ProgramRun
|
|
4545
4321
|
*/
|
|
4546
|
-
'execution_results'?: Array<
|
|
4322
|
+
'execution_results'?: Array<ProgramRunResult>;
|
|
4547
4323
|
}
|
|
4548
4324
|
/**
|
|
4549
4325
|
*
|
|
@@ -4591,93 +4367,60 @@ export interface ProgramRunObject {
|
|
|
4591
4367
|
/**
|
|
4592
4368
|
*
|
|
4593
4369
|
* @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
|
|
4370
|
+
* @interface ProgramRunReference
|
|
4608
4371
|
*/
|
|
4609
|
-
export interface
|
|
4372
|
+
export interface ProgramRunReference {
|
|
4610
4373
|
/**
|
|
4611
4374
|
*
|
|
4612
4375
|
* @type {string}
|
|
4613
|
-
* @memberof
|
|
4376
|
+
* @memberof ProgramRunReference
|
|
4614
4377
|
*/
|
|
4615
4378
|
'id': string;
|
|
4616
4379
|
/**
|
|
4617
4380
|
*
|
|
4618
4381
|
* @type {ProgramRunState}
|
|
4619
|
-
* @memberof
|
|
4382
|
+
* @memberof ProgramRunReference
|
|
4620
4383
|
*/
|
|
4621
4384
|
'state': ProgramRunState;
|
|
4622
4385
|
}
|
|
4623
4386
|
/**
|
|
4624
|
-
*
|
|
4387
|
+
* 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
4388
|
* @export
|
|
4626
|
-
* @interface
|
|
4389
|
+
* @interface ProgramRunResult
|
|
4627
4390
|
*/
|
|
4628
|
-
export interface
|
|
4391
|
+
export interface ProgramRunResult {
|
|
4629
4392
|
/**
|
|
4630
|
-
*
|
|
4631
|
-
* @type {
|
|
4632
|
-
* @memberof
|
|
4633
|
-
*/
|
|
4634
|
-
'position': Array<any>;
|
|
4635
|
-
/**
|
|
4636
|
-
*
|
|
4637
|
-
* @type {Array<any>}
|
|
4638
|
-
* @memberof PyjectoryDatatypesCorePose
|
|
4393
|
+
* Unique id of the motion group that was executed
|
|
4394
|
+
* @type {string}
|
|
4395
|
+
* @memberof ProgramRunResult
|
|
4639
4396
|
*/
|
|
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 {
|
|
4397
|
+
'motion_group_id': string;
|
|
4648
4398
|
/**
|
|
4649
|
-
*
|
|
4650
|
-
* @type {
|
|
4651
|
-
* @memberof
|
|
4399
|
+
* Total execution duration of the motion group
|
|
4400
|
+
* @type {number}
|
|
4401
|
+
* @memberof ProgramRunResult
|
|
4652
4402
|
*/
|
|
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 {
|
|
4403
|
+
'motion_duration': number;
|
|
4661
4404
|
/**
|
|
4662
|
-
*
|
|
4663
|
-
* @type {Array<
|
|
4664
|
-
* @memberof
|
|
4405
|
+
* Paths of the motion group as list of Path objects
|
|
4406
|
+
* @type {Array<Array<RobotState>>}
|
|
4407
|
+
* @memberof ProgramRunResult
|
|
4665
4408
|
*/
|
|
4666
|
-
'
|
|
4409
|
+
'paths': Array<Array<RobotState>>;
|
|
4667
4410
|
}
|
|
4668
4411
|
/**
|
|
4669
|
-
*
|
|
4412
|
+
*
|
|
4670
4413
|
* @export
|
|
4671
|
-
* @
|
|
4414
|
+
* @enum {string}
|
|
4672
4415
|
*/
|
|
4673
|
-
export
|
|
4674
|
-
|
|
4675
|
-
|
|
4676
|
-
|
|
4677
|
-
|
|
4678
|
-
|
|
4679
|
-
|
|
4680
|
-
|
|
4416
|
+
export declare const ProgramRunState: {
|
|
4417
|
+
readonly NotStarted: "not started";
|
|
4418
|
+
readonly Running: "running";
|
|
4419
|
+
readonly Completed: "completed";
|
|
4420
|
+
readonly Failed: "failed";
|
|
4421
|
+
readonly Stopped: "stopped";
|
|
4422
|
+
};
|
|
4423
|
+
export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
|
|
4681
4424
|
/**
|
|
4682
4425
|
* Defines an x-y plane with finite size.
|
|
4683
4426
|
* @export
|
|
@@ -4796,48 +4539,6 @@ export declare const ReleaseChannel: {
|
|
|
4796
4539
|
readonly Next: "next";
|
|
4797
4540
|
};
|
|
4798
4541
|
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
4542
|
/**
|
|
4842
4543
|
* The configuration of a physical or virtual robot controller.
|
|
4843
4544
|
* @export
|
|
@@ -4925,23 +4626,23 @@ export interface RobotLinkGeometry {
|
|
|
4925
4626
|
'geometry': Geometry;
|
|
4926
4627
|
}
|
|
4927
4628
|
/**
|
|
4928
|
-
* Collection of information on the current state of the robot
|
|
4629
|
+
* Collection of information on the current state of the robot.
|
|
4929
4630
|
* @export
|
|
4930
4631
|
* @interface RobotState
|
|
4931
4632
|
*/
|
|
4932
4633
|
export interface RobotState {
|
|
4933
4634
|
/**
|
|
4934
4635
|
*
|
|
4935
|
-
* @type {
|
|
4636
|
+
* @type {Pose}
|
|
4936
4637
|
* @memberof RobotState
|
|
4937
4638
|
*/
|
|
4938
|
-
'pose':
|
|
4639
|
+
'pose': Pose;
|
|
4939
4640
|
/**
|
|
4940
4641
|
*
|
|
4941
4642
|
* @type {Array<number>}
|
|
4942
4643
|
* @memberof RobotState
|
|
4943
4644
|
*/
|
|
4944
|
-
'joints'?: Array<number
|
|
4645
|
+
'joints'?: Array<number>;
|
|
4945
4646
|
}
|
|
4946
4647
|
/**
|
|
4947
4648
|
* 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 +4904,18 @@ export interface SafetyZoneLimits {
|
|
|
5203
4904
|
*/
|
|
5204
4905
|
'limits': PlanningLimits;
|
|
5205
4906
|
}
|
|
4907
|
+
/**
|
|
4908
|
+
*
|
|
4909
|
+
* @export
|
|
4910
|
+
* @enum {string}
|
|
4911
|
+
*/
|
|
4912
|
+
export declare const ServiceGroup: {
|
|
4913
|
+
readonly SystemService: "SystemService";
|
|
4914
|
+
readonly CellService: "CellService";
|
|
4915
|
+
readonly RobotController: "RobotController";
|
|
4916
|
+
readonly App: "App";
|
|
4917
|
+
};
|
|
4918
|
+
export type ServiceGroup = typeof ServiceGroup[keyof typeof ServiceGroup];
|
|
5206
4919
|
/**
|
|
5207
4920
|
*
|
|
5208
4921
|
* @export
|
|
@@ -5215,6 +4928,12 @@ export interface ServiceStatus {
|
|
|
5215
4928
|
* @memberof ServiceStatus
|
|
5216
4929
|
*/
|
|
5217
4930
|
'service': string;
|
|
4931
|
+
/**
|
|
4932
|
+
*
|
|
4933
|
+
* @type {ServiceGroup}
|
|
4934
|
+
* @memberof ServiceStatus
|
|
4935
|
+
*/
|
|
4936
|
+
'group': ServiceGroup;
|
|
5218
4937
|
/**
|
|
5219
4938
|
*
|
|
5220
4939
|
* @type {ServiceStatusStatus}
|
|
@@ -5502,60 +5221,17 @@ export interface StartOnIO {
|
|
|
5502
5221
|
'comparator': Comparator;
|
|
5503
5222
|
}
|
|
5504
5223
|
/**
|
|
5505
|
-
*
|
|
5224
|
+
* Representing a robot pose in operational space aware of a configured TCP.
|
|
5506
5225
|
* @export
|
|
5507
|
-
* @interface
|
|
5226
|
+
* @interface TcpPose
|
|
5508
5227
|
*/
|
|
5509
|
-
export interface
|
|
5228
|
+
export interface TcpPose {
|
|
5510
5229
|
/**
|
|
5511
|
-
*
|
|
5512
|
-
* @type {Array<
|
|
5513
|
-
* @memberof
|
|
5230
|
+
* A three-dimensional vector [x, y, z] with double precision.
|
|
5231
|
+
* @type {Array<number>}
|
|
5232
|
+
* @memberof TcpPose
|
|
5514
5233
|
*/
|
|
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>;
|
|
5234
|
+
'position': Array<number>;
|
|
5559
5235
|
/**
|
|
5560
5236
|
* A three-dimensional vector [x, y, z] with double precision.
|
|
5561
5237
|
* @type {Array<number>}
|
|
@@ -5717,6 +5393,12 @@ export interface TrajectoryData {
|
|
|
5717
5393
|
* @memberof TrajectoryData
|
|
5718
5394
|
*/
|
|
5719
5395
|
'message_type': TrajectoryDataMessageTypeEnum;
|
|
5396
|
+
/**
|
|
5397
|
+
* Identifier of the motion-group.
|
|
5398
|
+
* @type {string}
|
|
5399
|
+
* @memberof TrajectoryData
|
|
5400
|
+
*/
|
|
5401
|
+
'motion_group'?: string;
|
|
5720
5402
|
/**
|
|
5721
5403
|
* The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps.
|
|
5722
5404
|
* @type {JointTrajectory}
|
|
@@ -5875,31 +5557,6 @@ export interface UpdateNovaVersionRequest {
|
|
|
5875
5557
|
*/
|
|
5876
5558
|
'channel': ReleaseChannel;
|
|
5877
5559
|
}
|
|
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
5560
|
/**
|
|
5904
5561
|
*
|
|
5905
5562
|
* @export
|
|
@@ -5953,10 +5610,33 @@ export interface ValidationError {
|
|
|
5953
5610
|
/**
|
|
5954
5611
|
*
|
|
5955
5612
|
* @export
|
|
5956
|
-
* @interface
|
|
5613
|
+
* @interface ValidationError2
|
|
5957
5614
|
*/
|
|
5958
|
-
export interface
|
|
5615
|
+
export interface ValidationError2 {
|
|
5616
|
+
/**
|
|
5617
|
+
*
|
|
5618
|
+
* @type {Array<number>}
|
|
5619
|
+
* @memberof ValidationError2
|
|
5620
|
+
*/
|
|
5621
|
+
'loc': Array<number>;
|
|
5622
|
+
/**
|
|
5623
|
+
*
|
|
5624
|
+
* @type {string}
|
|
5625
|
+
* @memberof ValidationError2
|
|
5626
|
+
*/
|
|
5627
|
+
'msg': string;
|
|
5628
|
+
/**
|
|
5629
|
+
*
|
|
5630
|
+
* @type {string}
|
|
5631
|
+
* @memberof ValidationError2
|
|
5632
|
+
*/
|
|
5633
|
+
'type': string;
|
|
5959
5634
|
}
|
|
5635
|
+
/**
|
|
5636
|
+
* @type ValidationErrorLocInner
|
|
5637
|
+
* @export
|
|
5638
|
+
*/
|
|
5639
|
+
export type ValidationErrorLocInner = number | string;
|
|
5960
5640
|
/**
|
|
5961
5641
|
* A generic representation of a version number.
|
|
5962
5642
|
* @export
|
|
@@ -8788,76 +8468,75 @@ export declare class MotionGroupKinematicsApi extends BaseAPI {
|
|
|
8788
8468
|
*/
|
|
8789
8469
|
export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8790
8470
|
/**
|
|
8791
|
-
* This endpoint accepts a program
|
|
8792
|
-
* @summary Create
|
|
8471
|
+
* 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.
|
|
8472
|
+
* @summary Create program run
|
|
8793
8473
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8794
|
-
* @param {
|
|
8474
|
+
* @param {ProgramRequest} programRequest
|
|
8795
8475
|
* @param {*} [options] Override http request option.
|
|
8796
8476
|
* @throws {RequiredError}
|
|
8797
8477
|
*/
|
|
8798
|
-
|
|
8478
|
+
createProgramRun: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8799
8479
|
/**
|
|
8800
|
-
* Execute a program
|
|
8801
|
-
* @summary Execute
|
|
8480
|
+
* 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.
|
|
8481
|
+
* @summary Execute program
|
|
8802
8482
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8803
|
-
* @param {
|
|
8483
|
+
* @param {ProgramRequest} programRequest
|
|
8804
8484
|
* @param {*} [options] Override http request option.
|
|
8805
8485
|
* @throws {RequiredError}
|
|
8806
8486
|
*/
|
|
8807
|
-
executeProgram: (cell: string,
|
|
8487
|
+
executeProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8808
8488
|
/**
|
|
8809
|
-
* Returns information about a program currently executed.
|
|
8810
|
-
* @summary Get
|
|
8489
|
+
* 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, ...
|
|
8490
|
+
* @summary Get program run
|
|
8811
8491
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8812
|
-
* @param {string}
|
|
8492
|
+
* @param {string} run
|
|
8813
8493
|
* @param {*} [options] Override http request option.
|
|
8814
8494
|
* @throws {RequiredError}
|
|
8815
8495
|
*/
|
|
8816
|
-
|
|
8496
|
+
getProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8817
8497
|
/**
|
|
8818
|
-
* Get details about all existing
|
|
8819
|
-
* @summary List
|
|
8498
|
+
* Get details about all existing runs
|
|
8499
|
+
* @summary List programs
|
|
8820
8500
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8821
8501
|
* @param {*} [options] Override http request option.
|
|
8822
8502
|
* @throws {RequiredError}
|
|
8823
8503
|
*/
|
|
8824
|
-
|
|
8504
|
+
getProgramRuns: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8825
8505
|
/**
|
|
8826
|
-
*
|
|
8827
|
-
* @summary
|
|
8506
|
+
* Simulate a program given as text/plain
|
|
8507
|
+
* @summary Simulate program
|
|
8828
8508
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8829
|
-
* @param {
|
|
8509
|
+
* @param {ProgramRequest} programRequest
|
|
8830
8510
|
* @param {*} [options] Override http request option.
|
|
8831
8511
|
* @throws {RequiredError}
|
|
8832
8512
|
*/
|
|
8833
|
-
|
|
8513
|
+
simulateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8834
8514
|
/**
|
|
8835
|
-
*
|
|
8836
|
-
* @summary
|
|
8515
|
+
* Stop all runs
|
|
8516
|
+
* @summary Stop all programs
|
|
8837
8517
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8838
|
-
* @param {Request} request
|
|
8839
|
-
* @param {string} [identifier]
|
|
8840
8518
|
* @param {*} [options] Override http request option.
|
|
8841
8519
|
* @throws {RequiredError}
|
|
8842
8520
|
*/
|
|
8843
|
-
|
|
8521
|
+
stopAllPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8844
8522
|
/**
|
|
8845
|
-
* Stop
|
|
8846
|
-
* @summary Stop
|
|
8523
|
+
* Stop a specific program run.
|
|
8524
|
+
* @summary Stop program run
|
|
8847
8525
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8526
|
+
* @param {string} run
|
|
8848
8527
|
* @param {*} [options] Override http request option.
|
|
8849
8528
|
* @throws {RequiredError}
|
|
8850
8529
|
*/
|
|
8851
|
-
|
|
8530
|
+
stopProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8852
8531
|
/**
|
|
8853
|
-
*
|
|
8854
|
-
* @summary
|
|
8532
|
+
* Validate a program
|
|
8533
|
+
* @summary Validate program
|
|
8855
8534
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8856
|
-
* @param {
|
|
8535
|
+
* @param {ProgramRequest} programRequest
|
|
8857
8536
|
* @param {*} [options] Override http request option.
|
|
8858
8537
|
* @throws {RequiredError}
|
|
8859
8538
|
*/
|
|
8860
|
-
|
|
8539
|
+
validateProgram: (cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8861
8540
|
};
|
|
8862
8541
|
/**
|
|
8863
8542
|
* ProgramApi - functional programming interface
|
|
@@ -8865,76 +8544,75 @@ export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8865
8544
|
*/
|
|
8866
8545
|
export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
8867
8546
|
/**
|
|
8868
|
-
* This endpoint accepts a program
|
|
8869
|
-
* @summary Create
|
|
8547
|
+
* 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.
|
|
8548
|
+
* @summary Create program run
|
|
8870
8549
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8871
|
-
* @param {
|
|
8550
|
+
* @param {ProgramRequest} programRequest
|
|
8872
8551
|
* @param {*} [options] Override http request option.
|
|
8873
8552
|
* @throws {RequiredError}
|
|
8874
8553
|
*/
|
|
8875
|
-
|
|
8554
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>>;
|
|
8876
8555
|
/**
|
|
8877
|
-
* Execute a program
|
|
8878
|
-
* @summary Execute
|
|
8556
|
+
* 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.
|
|
8557
|
+
* @summary Execute program
|
|
8879
8558
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8880
|
-
* @param {
|
|
8559
|
+
* @param {ProgramRequest} programRequest
|
|
8881
8560
|
* @param {*} [options] Override http request option.
|
|
8882
8561
|
* @throws {RequiredError}
|
|
8883
8562
|
*/
|
|
8884
|
-
executeProgram(cell: string,
|
|
8563
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8885
8564
|
/**
|
|
8886
|
-
* Returns information about a program currently executed.
|
|
8887
|
-
* @summary Get
|
|
8565
|
+
* 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, ...
|
|
8566
|
+
* @summary Get program run
|
|
8888
8567
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8889
|
-
* @param {string}
|
|
8568
|
+
* @param {string} run
|
|
8890
8569
|
* @param {*} [options] Override http request option.
|
|
8891
8570
|
* @throws {RequiredError}
|
|
8892
8571
|
*/
|
|
8893
|
-
|
|
8572
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8894
8573
|
/**
|
|
8895
|
-
* Get details about all existing
|
|
8896
|
-
* @summary List
|
|
8574
|
+
* Get details about all existing runs
|
|
8575
|
+
* @summary List programs
|
|
8897
8576
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8898
8577
|
* @param {*} [options] Override http request option.
|
|
8899
8578
|
* @throws {RequiredError}
|
|
8900
8579
|
*/
|
|
8901
|
-
|
|
8580
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>>;
|
|
8902
8581
|
/**
|
|
8903
|
-
*
|
|
8904
|
-
* @summary
|
|
8582
|
+
* Simulate a program given as text/plain
|
|
8583
|
+
* @summary Simulate program
|
|
8905
8584
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8906
|
-
* @param {
|
|
8585
|
+
* @param {ProgramRequest} programRequest
|
|
8907
8586
|
* @param {*} [options] Override http request option.
|
|
8908
8587
|
* @throws {RequiredError}
|
|
8909
8588
|
*/
|
|
8910
|
-
|
|
8589
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
|
|
8911
8590
|
/**
|
|
8912
|
-
*
|
|
8913
|
-
* @summary
|
|
8591
|
+
* Stop all runs
|
|
8592
|
+
* @summary Stop all programs
|
|
8914
8593
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8915
|
-
* @param {Request} request
|
|
8916
|
-
* @param {string} [identifier]
|
|
8917
8594
|
* @param {*} [options] Override http request option.
|
|
8918
8595
|
* @throws {RequiredError}
|
|
8919
8596
|
*/
|
|
8920
|
-
|
|
8597
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8921
8598
|
/**
|
|
8922
|
-
* Stop
|
|
8923
|
-
* @summary Stop
|
|
8599
|
+
* Stop a specific program run.
|
|
8600
|
+
* @summary Stop program run
|
|
8924
8601
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8602
|
+
* @param {string} run
|
|
8925
8603
|
* @param {*} [options] Override http request option.
|
|
8926
8604
|
* @throws {RequiredError}
|
|
8927
8605
|
*/
|
|
8928
|
-
|
|
8606
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8929
8607
|
/**
|
|
8930
|
-
*
|
|
8931
|
-
* @summary
|
|
8608
|
+
* Validate a program
|
|
8609
|
+
* @summary Validate program
|
|
8932
8610
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8933
|
-
* @param {
|
|
8611
|
+
* @param {ProgramRequest} programRequest
|
|
8934
8612
|
* @param {*} [options] Override http request option.
|
|
8935
8613
|
* @throws {RequiredError}
|
|
8936
8614
|
*/
|
|
8937
|
-
|
|
8615
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8938
8616
|
};
|
|
8939
8617
|
/**
|
|
8940
8618
|
* ProgramApi - factory interface
|
|
@@ -8942,76 +8620,75 @@ export declare const ProgramApiFp: (configuration?: Configuration) => {
|
|
|
8942
8620
|
*/
|
|
8943
8621
|
export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8944
8622
|
/**
|
|
8945
|
-
* This endpoint accepts a program
|
|
8946
|
-
* @summary Create
|
|
8623
|
+
* 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.
|
|
8624
|
+
* @summary Create program run
|
|
8947
8625
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8948
|
-
* @param {
|
|
8626
|
+
* @param {ProgramRequest} programRequest
|
|
8949
8627
|
* @param {*} [options] Override http request option.
|
|
8950
8628
|
* @throws {RequiredError}
|
|
8951
8629
|
*/
|
|
8952
|
-
|
|
8630
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference>;
|
|
8953
8631
|
/**
|
|
8954
|
-
* Execute a program
|
|
8955
|
-
* @summary Execute
|
|
8632
|
+
* 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.
|
|
8633
|
+
* @summary Execute program
|
|
8956
8634
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8957
|
-
* @param {
|
|
8635
|
+
* @param {ProgramRequest} programRequest
|
|
8958
8636
|
* @param {*} [options] Override http request option.
|
|
8959
8637
|
* @throws {RequiredError}
|
|
8960
8638
|
*/
|
|
8961
|
-
executeProgram(cell: string,
|
|
8639
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8962
8640
|
/**
|
|
8963
|
-
* Returns information about a program currently executed.
|
|
8964
|
-
* @summary Get
|
|
8641
|
+
* 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, ...
|
|
8642
|
+
* @summary Get program run
|
|
8965
8643
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8966
|
-
* @param {string}
|
|
8644
|
+
* @param {string} run
|
|
8967
8645
|
* @param {*} [options] Override http request option.
|
|
8968
8646
|
* @throws {RequiredError}
|
|
8969
8647
|
*/
|
|
8970
|
-
|
|
8648
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8971
8649
|
/**
|
|
8972
|
-
* Get details about all existing
|
|
8973
|
-
* @summary List
|
|
8650
|
+
* Get details about all existing runs
|
|
8651
|
+
* @summary List programs
|
|
8974
8652
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8975
8653
|
* @param {*} [options] Override http request option.
|
|
8976
8654
|
* @throws {RequiredError}
|
|
8977
8655
|
*/
|
|
8978
|
-
|
|
8656
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>>;
|
|
8979
8657
|
/**
|
|
8980
|
-
*
|
|
8981
|
-
* @summary
|
|
8658
|
+
* Simulate a program given as text/plain
|
|
8659
|
+
* @summary Simulate program
|
|
8982
8660
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8983
|
-
* @param {
|
|
8661
|
+
* @param {ProgramRequest} programRequest
|
|
8984
8662
|
* @param {*} [options] Override http request option.
|
|
8985
8663
|
* @throws {RequiredError}
|
|
8986
8664
|
*/
|
|
8987
|
-
|
|
8665
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
|
|
8988
8666
|
/**
|
|
8989
|
-
*
|
|
8990
|
-
* @summary
|
|
8667
|
+
* Stop all runs
|
|
8668
|
+
* @summary Stop all programs
|
|
8991
8669
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8992
|
-
* @param {Request} request
|
|
8993
|
-
* @param {string} [identifier]
|
|
8994
8670
|
* @param {*} [options] Override http request option.
|
|
8995
8671
|
* @throws {RequiredError}
|
|
8996
8672
|
*/
|
|
8997
|
-
|
|
8673
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8998
8674
|
/**
|
|
8999
|
-
* Stop
|
|
9000
|
-
* @summary Stop
|
|
8675
|
+
* Stop a specific program run.
|
|
8676
|
+
* @summary Stop program run
|
|
9001
8677
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8678
|
+
* @param {string} run
|
|
9002
8679
|
* @param {*} [options] Override http request option.
|
|
9003
8680
|
* @throws {RequiredError}
|
|
9004
8681
|
*/
|
|
9005
|
-
|
|
8682
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9006
8683
|
/**
|
|
9007
|
-
*
|
|
9008
|
-
* @summary
|
|
8684
|
+
* Validate a program
|
|
8685
|
+
* @summary Validate program
|
|
9009
8686
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9010
|
-
* @param {
|
|
8687
|
+
* @param {ProgramRequest} programRequest
|
|
9011
8688
|
* @param {*} [options] Override http request option.
|
|
9012
8689
|
* @throws {RequiredError}
|
|
9013
8690
|
*/
|
|
9014
|
-
|
|
8691
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9015
8692
|
};
|
|
9016
8693
|
/**
|
|
9017
8694
|
* ProgramApi - object-oriented interface
|
|
@@ -9021,485 +8698,83 @@ export declare const ProgramApiFactory: (configuration?: Configuration, basePath
|
|
|
9021
8698
|
*/
|
|
9022
8699
|
export declare class ProgramApi extends BaseAPI {
|
|
9023
8700
|
/**
|
|
9024
|
-
* This endpoint accepts a program
|
|
9025
|
-
* @summary Create
|
|
8701
|
+
* 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.
|
|
8702
|
+
* @summary Create program run
|
|
9026
8703
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9027
|
-
* @param {
|
|
8704
|
+
* @param {ProgramRequest} programRequest
|
|
9028
8705
|
* @param {*} [options] Override http request option.
|
|
9029
8706
|
* @throws {RequiredError}
|
|
9030
8707
|
* @memberof ProgramApi
|
|
9031
8708
|
*/
|
|
9032
|
-
|
|
8709
|
+
createProgramRun(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference, any>>;
|
|
9033
8710
|
/**
|
|
9034
|
-
* Execute a program
|
|
9035
|
-
* @summary Execute
|
|
8711
|
+
* 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.
|
|
8712
|
+
* @summary Execute program
|
|
9036
8713
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9037
|
-
* @param {
|
|
8714
|
+
* @param {ProgramRequest} programRequest
|
|
9038
8715
|
* @param {*} [options] Override http request option.
|
|
9039
8716
|
* @throws {RequiredError}
|
|
9040
8717
|
* @memberof ProgramApi
|
|
9041
8718
|
*/
|
|
9042
|
-
executeProgram(cell: string,
|
|
8719
|
+
executeProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9043
8720
|
/**
|
|
9044
|
-
* Returns information about a program currently executed.
|
|
9045
|
-
* @summary Get
|
|
8721
|
+
* 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, ...
|
|
8722
|
+
* @summary Get program run
|
|
9046
8723
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9047
|
-
* @param {string}
|
|
8724
|
+
* @param {string} run
|
|
9048
8725
|
* @param {*} [options] Override http request option.
|
|
9049
8726
|
* @throws {RequiredError}
|
|
9050
8727
|
* @memberof ProgramApi
|
|
9051
8728
|
*/
|
|
9052
|
-
|
|
8729
|
+
getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9053
8730
|
/**
|
|
9054
|
-
* Get details about all existing
|
|
9055
|
-
* @summary List
|
|
8731
|
+
* Get details about all existing runs
|
|
8732
|
+
* @summary List programs
|
|
9056
8733
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9057
8734
|
* @param {*} [options] Override http request option.
|
|
9058
8735
|
* @throws {RequiredError}
|
|
9059
8736
|
* @memberof ProgramApi
|
|
9060
8737
|
*/
|
|
9061
|
-
|
|
8738
|
+
getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference[], any>>;
|
|
9062
8739
|
/**
|
|
9063
|
-
*
|
|
9064
|
-
* @summary
|
|
8740
|
+
* Simulate a program given as text/plain
|
|
8741
|
+
* @summary Simulate program
|
|
9065
8742
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9066
|
-
* @param {
|
|
8743
|
+
* @param {ProgramRequest} programRequest
|
|
9067
8744
|
* @param {*} [options] Override http request option.
|
|
9068
8745
|
* @throws {RequiredError}
|
|
9069
8746
|
* @memberof ProgramApi
|
|
9070
8747
|
*/
|
|
9071
|
-
|
|
8748
|
+
simulateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
|
|
9072
8749
|
/**
|
|
9073
|
-
*
|
|
9074
|
-
* @summary
|
|
8750
|
+
* Stop all runs
|
|
8751
|
+
* @summary Stop all programs
|
|
9075
8752
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9076
|
-
* @param {Request} request
|
|
9077
|
-
* @param {string} [identifier]
|
|
9078
8753
|
* @param {*} [options] Override http request option.
|
|
9079
8754
|
* @throws {RequiredError}
|
|
9080
8755
|
* @memberof ProgramApi
|
|
9081
8756
|
*/
|
|
9082
|
-
|
|
8757
|
+
stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9083
8758
|
/**
|
|
9084
|
-
* Stop
|
|
9085
|
-
* @summary Stop
|
|
8759
|
+
* Stop a specific program run.
|
|
8760
|
+
* @summary Stop program run
|
|
9086
8761
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8762
|
+
* @param {string} run
|
|
9087
8763
|
* @param {*} [options] Override http request option.
|
|
9088
8764
|
* @throws {RequiredError}
|
|
9089
8765
|
* @memberof ProgramApi
|
|
9090
8766
|
*/
|
|
9091
|
-
|
|
8767
|
+
stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9092
8768
|
/**
|
|
9093
|
-
*
|
|
9094
|
-
* @summary
|
|
8769
|
+
* Validate a program
|
|
8770
|
+
* @summary Validate program
|
|
9095
8771
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9096
|
-
* @param {
|
|
8772
|
+
* @param {ProgramRequest} programRequest
|
|
9097
8773
|
* @param {*} [options] Override http request option.
|
|
9098
8774
|
* @throws {RequiredError}
|
|
9099
8775
|
* @memberof ProgramApi
|
|
9100
8776
|
*/
|
|
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>>;
|
|
8777
|
+
validateProgram(cell: string, programRequest: ProgramRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9503
8778
|
}
|
|
9504
8779
|
/**
|
|
9505
8780
|
* ProgramOperatorApi - axios parameter creator
|
|
@@ -9507,14 +8782,14 @@ export declare class ProgramLibraryMetadataApi extends BaseAPI {
|
|
|
9507
8782
|
*/
|
|
9508
8783
|
export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9509
8784
|
/**
|
|
9510
|
-
* <!-- theme: danger -->
|
|
8785
|
+
* <!-- 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
8786
|
* @summary Run Program from Library
|
|
9512
8787
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9513
|
-
* @param {
|
|
8788
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9514
8789
|
* @param {*} [options] Override http request option.
|
|
9515
8790
|
* @throws {RequiredError}
|
|
9516
8791
|
*/
|
|
9517
|
-
|
|
8792
|
+
createProgramOperatorRun: (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9518
8793
|
/**
|
|
9519
8794
|
* <!-- 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
8795
|
* @summary Create Trigger
|
|
@@ -9534,14 +8809,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9534
8809
|
*/
|
|
9535
8810
|
deleteTrigger: (trigger: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9536
8811
|
/**
|
|
9537
|
-
* <!-- theme: danger -->
|
|
8812
|
+
* <!-- 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
8813
|
* @summary Get All Program Runs
|
|
9539
8814
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9540
8815
|
* @param {string} [state]
|
|
9541
8816
|
* @param {*} [options] Override http request option.
|
|
9542
8817
|
* @throws {RequiredError}
|
|
9543
8818
|
*/
|
|
9544
|
-
|
|
8819
|
+
getAllProgramOperatorRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9545
8820
|
/**
|
|
9546
8821
|
* <!-- 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
8822
|
* @summary Get All Triggers
|
|
@@ -9551,14 +8826,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9551
8826
|
*/
|
|
9552
8827
|
getAllTriggers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9553
8828
|
/**
|
|
9554
|
-
* <!-- theme: danger -->
|
|
8829
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9555
8830
|
* @summary Get Program Run
|
|
9556
8831
|
* @param {string} run
|
|
9557
8832
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9558
8833
|
* @param {*} [options] Override http request option.
|
|
9559
8834
|
* @throws {RequiredError}
|
|
9560
8835
|
*/
|
|
9561
|
-
|
|
8836
|
+
getProgramOperatorRun: (run: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9562
8837
|
/**
|
|
9563
8838
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9564
8839
|
* @summary Get Trigger
|
|
@@ -9585,14 +8860,14 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
|
|
|
9585
8860
|
*/
|
|
9586
8861
|
export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
9587
8862
|
/**
|
|
9588
|
-
* <!-- theme: danger -->
|
|
8863
|
+
* <!-- 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
8864
|
* @summary Run Program from Library
|
|
9590
8865
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9591
|
-
* @param {
|
|
8866
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9592
8867
|
* @param {*} [options] Override http request option.
|
|
9593
8868
|
* @throws {RequiredError}
|
|
9594
8869
|
*/
|
|
9595
|
-
|
|
8870
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>>;
|
|
9596
8871
|
/**
|
|
9597
8872
|
* <!-- 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
8873
|
* @summary Create Trigger
|
|
@@ -9612,14 +8887,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9612
8887
|
*/
|
|
9613
8888
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
9614
8889
|
/**
|
|
9615
|
-
* <!-- theme: danger -->
|
|
8890
|
+
* <!-- 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
8891
|
* @summary Get All Program Runs
|
|
9617
8892
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9618
8893
|
* @param {string} [state]
|
|
9619
8894
|
* @param {*} [options] Override http request option.
|
|
9620
8895
|
* @throws {RequiredError}
|
|
9621
8896
|
*/
|
|
9622
|
-
|
|
8897
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>>;
|
|
9623
8898
|
/**
|
|
9624
8899
|
* <!-- 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
8900
|
* @summary Get All Triggers
|
|
@@ -9629,14 +8904,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9629
8904
|
*/
|
|
9630
8905
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllTriggers200Response>>;
|
|
9631
8906
|
/**
|
|
9632
|
-
* <!-- theme: danger -->
|
|
8907
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9633
8908
|
* @summary Get Program Run
|
|
9634
8909
|
* @param {string} run
|
|
9635
8910
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9636
8911
|
* @param {*} [options] Override http request option.
|
|
9637
8912
|
* @throws {RequiredError}
|
|
9638
8913
|
*/
|
|
9639
|
-
|
|
8914
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>>;
|
|
9640
8915
|
/**
|
|
9641
8916
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9642
8917
|
* @summary Get Trigger
|
|
@@ -9663,14 +8938,14 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
|
|
|
9663
8938
|
*/
|
|
9664
8939
|
export declare const ProgramOperatorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9665
8940
|
/**
|
|
9666
|
-
* <!-- theme: danger -->
|
|
8941
|
+
* <!-- 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
8942
|
* @summary Run Program from Library
|
|
9668
8943
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9669
|
-
* @param {
|
|
8944
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9670
8945
|
* @param {*} [options] Override http request option.
|
|
9671
8946
|
* @throws {RequiredError}
|
|
9672
8947
|
*/
|
|
9673
|
-
|
|
8948
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response>;
|
|
9674
8949
|
/**
|
|
9675
8950
|
* <!-- 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
8951
|
* @summary Create Trigger
|
|
@@ -9690,14 +8965,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9690
8965
|
*/
|
|
9691
8966
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
9692
8967
|
/**
|
|
9693
|
-
* <!-- theme: danger -->
|
|
8968
|
+
* <!-- 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
8969
|
* @summary Get All Program Runs
|
|
9695
8970
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9696
8971
|
* @param {string} [state]
|
|
9697
8972
|
* @param {*} [options] Override http request option.
|
|
9698
8973
|
* @throws {RequiredError}
|
|
9699
8974
|
*/
|
|
9700
|
-
|
|
8975
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response>;
|
|
9701
8976
|
/**
|
|
9702
8977
|
* <!-- 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
8978
|
* @summary Get All Triggers
|
|
@@ -9707,14 +8982,14 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9707
8982
|
*/
|
|
9708
8983
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllTriggers200Response>;
|
|
9709
8984
|
/**
|
|
9710
|
-
* <!-- theme: danger -->
|
|
8985
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9711
8986
|
* @summary Get Program Run
|
|
9712
8987
|
* @param {string} run
|
|
9713
8988
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9714
8989
|
* @param {*} [options] Override http request option.
|
|
9715
8990
|
* @throws {RequiredError}
|
|
9716
8991
|
*/
|
|
9717
|
-
|
|
8992
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject>;
|
|
9718
8993
|
/**
|
|
9719
8994
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9720
8995
|
* @summary Get Trigger
|
|
@@ -9743,15 +9018,15 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
|
|
|
9743
9018
|
*/
|
|
9744
9019
|
export declare class ProgramOperatorApi extends BaseAPI {
|
|
9745
9020
|
/**
|
|
9746
|
-
* <!-- theme: danger -->
|
|
9021
|
+
* <!-- 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
9022
|
* @summary Run Program from Library
|
|
9748
9023
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9749
|
-
* @param {
|
|
9024
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
9750
9025
|
* @param {*} [options] Override http request option.
|
|
9751
9026
|
* @throws {RequiredError}
|
|
9752
9027
|
* @memberof ProgramOperatorApi
|
|
9753
9028
|
*/
|
|
9754
|
-
|
|
9029
|
+
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProgramOperatorRun200Response, any>>;
|
|
9755
9030
|
/**
|
|
9756
9031
|
* <!-- 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
9032
|
* @summary Create Trigger
|
|
@@ -9773,7 +9048,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9773
9048
|
*/
|
|
9774
9049
|
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
9775
9050
|
/**
|
|
9776
|
-
* <!-- theme: danger -->
|
|
9051
|
+
* <!-- 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
9052
|
* @summary Get All Program Runs
|
|
9778
9053
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9779
9054
|
* @param {string} [state]
|
|
@@ -9781,7 +9056,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9781
9056
|
* @throws {RequiredError}
|
|
9782
9057
|
* @memberof ProgramOperatorApi
|
|
9783
9058
|
*/
|
|
9784
|
-
|
|
9059
|
+
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramOperatorRuns200Response, any>>;
|
|
9785
9060
|
/**
|
|
9786
9061
|
* <!-- 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
9062
|
* @summary Get All Triggers
|
|
@@ -9792,7 +9067,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9792
9067
|
*/
|
|
9793
9068
|
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllTriggers200Response, any>>;
|
|
9794
9069
|
/**
|
|
9795
|
-
* <!-- theme: danger -->
|
|
9070
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
9796
9071
|
* @summary Get Program Run
|
|
9797
9072
|
* @param {string} run
|
|
9798
9073
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -9800,7 +9075,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
|
|
|
9800
9075
|
* @throws {RequiredError}
|
|
9801
9076
|
* @memberof ProgramOperatorApi
|
|
9802
9077
|
*/
|
|
9803
|
-
|
|
9078
|
+
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunObject, any>>;
|
|
9804
9079
|
/**
|
|
9805
9080
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
9806
9081
|
* @summary Get Trigger
|
|
@@ -10842,6 +10117,192 @@ export declare class StoreObjectApi extends BaseAPI {
|
|
|
10842
10117
|
[key: string]: string;
|
|
10843
10118
|
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10844
10119
|
}
|
|
10120
|
+
/**
|
|
10121
|
+
* StoreProgramApi - axios parameter creator
|
|
10122
|
+
* @export
|
|
10123
|
+
*/
|
|
10124
|
+
export declare const StoreProgramApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
10125
|
+
/**
|
|
10126
|
+
* Deletes the program. This action is irreversible.
|
|
10127
|
+
* @summary Delete Program
|
|
10128
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10129
|
+
* @param {string} program
|
|
10130
|
+
* @param {*} [options] Override http request option.
|
|
10131
|
+
* @throws {RequiredError}
|
|
10132
|
+
*/
|
|
10133
|
+
deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10134
|
+
/**
|
|
10135
|
+
* Returns the content of the program.
|
|
10136
|
+
* @summary Get Program
|
|
10137
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10138
|
+
* @param {string} program
|
|
10139
|
+
* @param {*} [options] Override http request option.
|
|
10140
|
+
* @throws {RequiredError}
|
|
10141
|
+
*/
|
|
10142
|
+
getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10143
|
+
/**
|
|
10144
|
+
* Returns a list of all the stored programs.
|
|
10145
|
+
* @summary List all Programs
|
|
10146
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10147
|
+
* @param {*} [options] Override http request option.
|
|
10148
|
+
* @throws {RequiredError}
|
|
10149
|
+
*/
|
|
10150
|
+
listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10151
|
+
/**
|
|
10152
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10153
|
+
* @summary Store Program
|
|
10154
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10155
|
+
* @param {string} program
|
|
10156
|
+
* @param {string} body
|
|
10157
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10158
|
+
* @param {*} [options] Override http request option.
|
|
10159
|
+
* @throws {RequiredError}
|
|
10160
|
+
*/
|
|
10161
|
+
storeProgram: (cell: string, program: string, body: string, xMetadata?: {
|
|
10162
|
+
[key: string]: string;
|
|
10163
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10164
|
+
};
|
|
10165
|
+
/**
|
|
10166
|
+
* StoreProgramApi - functional programming interface
|
|
10167
|
+
* @export
|
|
10168
|
+
*/
|
|
10169
|
+
export declare const StoreProgramApiFp: (configuration?: Configuration) => {
|
|
10170
|
+
/**
|
|
10171
|
+
* Deletes the program. This action is irreversible.
|
|
10172
|
+
* @summary Delete Program
|
|
10173
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10174
|
+
* @param {string} program
|
|
10175
|
+
* @param {*} [options] Override http request option.
|
|
10176
|
+
* @throws {RequiredError}
|
|
10177
|
+
*/
|
|
10178
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10179
|
+
/**
|
|
10180
|
+
* Returns the content of the program.
|
|
10181
|
+
* @summary Get Program
|
|
10182
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10183
|
+
* @param {string} program
|
|
10184
|
+
* @param {*} [options] Override http request option.
|
|
10185
|
+
* @throws {RequiredError}
|
|
10186
|
+
*/
|
|
10187
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
10188
|
+
/**
|
|
10189
|
+
* Returns a list of all the stored programs.
|
|
10190
|
+
* @summary List all Programs
|
|
10191
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10192
|
+
* @param {*} [options] Override http request option.
|
|
10193
|
+
* @throws {RequiredError}
|
|
10194
|
+
*/
|
|
10195
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
10196
|
+
/**
|
|
10197
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10198
|
+
* @summary Store Program
|
|
10199
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10200
|
+
* @param {string} program
|
|
10201
|
+
* @param {string} body
|
|
10202
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10203
|
+
* @param {*} [options] Override http request option.
|
|
10204
|
+
* @throws {RequiredError}
|
|
10205
|
+
*/
|
|
10206
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10207
|
+
[key: string]: string;
|
|
10208
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
10209
|
+
};
|
|
10210
|
+
/**
|
|
10211
|
+
* StoreProgramApi - factory interface
|
|
10212
|
+
* @export
|
|
10213
|
+
*/
|
|
10214
|
+
export declare const StoreProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
10215
|
+
/**
|
|
10216
|
+
* Deletes the program. This action is irreversible.
|
|
10217
|
+
* @summary Delete Program
|
|
10218
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10219
|
+
* @param {string} program
|
|
10220
|
+
* @param {*} [options] Override http request option.
|
|
10221
|
+
* @throws {RequiredError}
|
|
10222
|
+
*/
|
|
10223
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10224
|
+
/**
|
|
10225
|
+
* Returns the content of the program.
|
|
10226
|
+
* @summary Get Program
|
|
10227
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10228
|
+
* @param {string} program
|
|
10229
|
+
* @param {*} [options] Override http request option.
|
|
10230
|
+
* @throws {RequiredError}
|
|
10231
|
+
*/
|
|
10232
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
10233
|
+
/**
|
|
10234
|
+
* Returns a list of all the stored programs.
|
|
10235
|
+
* @summary List all Programs
|
|
10236
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10237
|
+
* @param {*} [options] Override http request option.
|
|
10238
|
+
* @throws {RequiredError}
|
|
10239
|
+
*/
|
|
10240
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
10241
|
+
/**
|
|
10242
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10243
|
+
* @summary Store Program
|
|
10244
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10245
|
+
* @param {string} program
|
|
10246
|
+
* @param {string} body
|
|
10247
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10248
|
+
* @param {*} [options] Override http request option.
|
|
10249
|
+
* @throws {RequiredError}
|
|
10250
|
+
*/
|
|
10251
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10252
|
+
[key: string]: string;
|
|
10253
|
+
}, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
10254
|
+
};
|
|
10255
|
+
/**
|
|
10256
|
+
* StoreProgramApi - object-oriented interface
|
|
10257
|
+
* @export
|
|
10258
|
+
* @class StoreProgramApi
|
|
10259
|
+
* @extends {BaseAPI}
|
|
10260
|
+
*/
|
|
10261
|
+
export declare class StoreProgramApi extends BaseAPI {
|
|
10262
|
+
/**
|
|
10263
|
+
* Deletes the program. This action is irreversible.
|
|
10264
|
+
* @summary Delete Program
|
|
10265
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10266
|
+
* @param {string} program
|
|
10267
|
+
* @param {*} [options] Override http request option.
|
|
10268
|
+
* @throws {RequiredError}
|
|
10269
|
+
* @memberof StoreProgramApi
|
|
10270
|
+
*/
|
|
10271
|
+
deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10272
|
+
/**
|
|
10273
|
+
* Returns the content of the program.
|
|
10274
|
+
* @summary Get Program
|
|
10275
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10276
|
+
* @param {string} program
|
|
10277
|
+
* @param {*} [options] Override http request option.
|
|
10278
|
+
* @throws {RequiredError}
|
|
10279
|
+
* @memberof StoreProgramApi
|
|
10280
|
+
*/
|
|
10281
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
10282
|
+
/**
|
|
10283
|
+
* Returns a list of all the stored programs.
|
|
10284
|
+
* @summary List all Programs
|
|
10285
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10286
|
+
* @param {*} [options] Override http request option.
|
|
10287
|
+
* @throws {RequiredError}
|
|
10288
|
+
* @memberof StoreProgramApi
|
|
10289
|
+
*/
|
|
10290
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
10291
|
+
/**
|
|
10292
|
+
* Stores the content of the program. If the program exists, the operation overwrites the content.
|
|
10293
|
+
* @summary Store Program
|
|
10294
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10295
|
+
* @param {string} program
|
|
10296
|
+
* @param {string} body
|
|
10297
|
+
* @param {{ [key: string]: string; }} [xMetadata]
|
|
10298
|
+
* @param {*} [options] Override http request option.
|
|
10299
|
+
* @throws {RequiredError}
|
|
10300
|
+
* @memberof StoreProgramApi
|
|
10301
|
+
*/
|
|
10302
|
+
storeProgram(cell: string, program: string, body: string, xMetadata?: {
|
|
10303
|
+
[key: string]: string;
|
|
10304
|
+
}, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
10305
|
+
}
|
|
10845
10306
|
/**
|
|
10846
10307
|
* SystemApi - axios parameter creator
|
|
10847
10308
|
* @export
|