@wandelbots/nova-api 25.6.0-dev.27 → 25.6.0-dev.29
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/v2/api.d.ts +93 -674
- package/v2/api.js +19 -672
- package/v2/api.js.map +1 -1
- package/v2/api.ts +90 -1076
package/v2/api.ts
CHANGED
|
@@ -924,78 +924,6 @@ export interface CoordinateSystems {
|
|
|
924
924
|
*/
|
|
925
925
|
'coordinate_systems': Array<CoordinateSystem>;
|
|
926
926
|
}
|
|
927
|
-
/**
|
|
928
|
-
*
|
|
929
|
-
* @export
|
|
930
|
-
* @interface CreateProgramOperatorRun200Response
|
|
931
|
-
*/
|
|
932
|
-
export interface CreateProgramOperatorRun200Response {
|
|
933
|
-
/**
|
|
934
|
-
* The identifier of the program run for further inspection of the running program.
|
|
935
|
-
* @type {string}
|
|
936
|
-
* @memberof CreateProgramOperatorRun200Response
|
|
937
|
-
*/
|
|
938
|
-
'id'?: string;
|
|
939
|
-
}
|
|
940
|
-
/**
|
|
941
|
-
*
|
|
942
|
-
* @export
|
|
943
|
-
* @interface CreateProgramOperatorRunRequest
|
|
944
|
-
*/
|
|
945
|
-
export interface CreateProgramOperatorRunRequest {
|
|
946
|
-
/**
|
|
947
|
-
* The identifier of the program stored in the program library.
|
|
948
|
-
* @type {string}
|
|
949
|
-
* @memberof CreateProgramOperatorRunRequest
|
|
950
|
-
*/
|
|
951
|
-
'program_id': string;
|
|
952
|
-
}
|
|
953
|
-
/**
|
|
954
|
-
*
|
|
955
|
-
* @export
|
|
956
|
-
* @interface CreateTrigger200Response
|
|
957
|
-
*/
|
|
958
|
-
export interface CreateTrigger200Response {
|
|
959
|
-
/**
|
|
960
|
-
* The identifier of the created trigger.
|
|
961
|
-
* @type {string}
|
|
962
|
-
* @memberof CreateTrigger200Response
|
|
963
|
-
*/
|
|
964
|
-
'id'?: string;
|
|
965
|
-
}
|
|
966
|
-
/**
|
|
967
|
-
*
|
|
968
|
-
* @export
|
|
969
|
-
* @interface CreateTriggerRequest
|
|
970
|
-
*/
|
|
971
|
-
export interface CreateTriggerRequest {
|
|
972
|
-
/**
|
|
973
|
-
* The identifier of the program to run when the trigger condition is met.
|
|
974
|
-
* @type {string}
|
|
975
|
-
* @memberof CreateTriggerRequest
|
|
976
|
-
*/
|
|
977
|
-
'program_id': string;
|
|
978
|
-
/**
|
|
979
|
-
* Indicated whether the trigger is enabled or not.
|
|
980
|
-
* @type {boolean}
|
|
981
|
-
* @memberof CreateTriggerRequest
|
|
982
|
-
*/
|
|
983
|
-
'enabled': boolean;
|
|
984
|
-
/**
|
|
985
|
-
*
|
|
986
|
-
* @type {TriggerType}
|
|
987
|
-
* @memberof CreateTriggerRequest
|
|
988
|
-
*/
|
|
989
|
-
'type': TriggerType;
|
|
990
|
-
/**
|
|
991
|
-
*
|
|
992
|
-
* @type {OpcuaNodeValueTriggerConfig}
|
|
993
|
-
* @memberof CreateTriggerRequest
|
|
994
|
-
*/
|
|
995
|
-
'config'?: OpcuaNodeValueTriggerConfig;
|
|
996
|
-
}
|
|
997
|
-
|
|
998
|
-
|
|
999
927
|
/**
|
|
1000
928
|
*
|
|
1001
929
|
* @export
|
|
@@ -1391,32 +1319,6 @@ export const FloatValueValueTypeEnum = {
|
|
|
1391
1319
|
|
|
1392
1320
|
export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeof FloatValueValueTypeEnum];
|
|
1393
1321
|
|
|
1394
|
-
/**
|
|
1395
|
-
*
|
|
1396
|
-
* @export
|
|
1397
|
-
* @interface GetAllProgramOperatorRuns200Response
|
|
1398
|
-
*/
|
|
1399
|
-
export interface GetAllProgramOperatorRuns200Response {
|
|
1400
|
-
/**
|
|
1401
|
-
*
|
|
1402
|
-
* @type {Array<ProgramRunObject>}
|
|
1403
|
-
* @memberof GetAllProgramOperatorRuns200Response
|
|
1404
|
-
*/
|
|
1405
|
-
'program_runs'?: Array<ProgramRunObject>;
|
|
1406
|
-
}
|
|
1407
|
-
/**
|
|
1408
|
-
*
|
|
1409
|
-
* @export
|
|
1410
|
-
* @interface GetAllTriggers200Response
|
|
1411
|
-
*/
|
|
1412
|
-
export interface GetAllTriggers200Response {
|
|
1413
|
-
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @type {Array<TriggerObject>}
|
|
1416
|
-
* @memberof GetAllTriggers200Response
|
|
1417
|
-
*/
|
|
1418
|
-
'triggers'?: Array<TriggerObject>;
|
|
1419
|
-
}
|
|
1420
1322
|
/**
|
|
1421
1323
|
*
|
|
1422
1324
|
* @export
|
|
@@ -1970,7 +1872,7 @@ export interface InvalidDofInvalidDof {
|
|
|
1970
1872
|
*/
|
|
1971
1873
|
export interface InverseKinematicsRequest {
|
|
1972
1874
|
/**
|
|
1973
|
-
* The data to assemble the robot setup can be retrieved from [
|
|
1875
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
1974
1876
|
* @type {RobotSetup}
|
|
1975
1877
|
* @memberof InverseKinematicsRequest
|
|
1976
1878
|
*/
|
|
@@ -2559,6 +2461,73 @@ export interface MotionGroupBehaviorGetter {
|
|
|
2559
2461
|
}
|
|
2560
2462
|
|
|
2561
2463
|
|
|
2464
|
+
/**
|
|
2465
|
+
* The configuration of a motion-group used for motion planning.
|
|
2466
|
+
* @export
|
|
2467
|
+
* @interface MotionGroupDescription
|
|
2468
|
+
*/
|
|
2469
|
+
export interface MotionGroupDescription {
|
|
2470
|
+
/**
|
|
2471
|
+
* String identifiying the model of a motion group.
|
|
2472
|
+
* @type {string}
|
|
2473
|
+
* @memberof MotionGroupDescription
|
|
2474
|
+
*/
|
|
2475
|
+
'motion_group_type': string;
|
|
2476
|
+
/**
|
|
2477
|
+
* The offset from the world frame to the motion group base.
|
|
2478
|
+
* @type {Pose}
|
|
2479
|
+
* @memberof MotionGroupDescription
|
|
2480
|
+
*/
|
|
2481
|
+
'mounting': Pose;
|
|
2482
|
+
/**
|
|
2483
|
+
* Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
|
|
2484
|
+
* @type {{ [key: string]: TcpOffset; }}
|
|
2485
|
+
* @memberof MotionGroupDescription
|
|
2486
|
+
*/
|
|
2487
|
+
'tcps': { [key: string]: TcpOffset; };
|
|
2488
|
+
/**
|
|
2489
|
+
* A collection of identifiable colliders.
|
|
2490
|
+
* @type {{ [key: string]: Collider; }}
|
|
2491
|
+
* @memberof MotionGroupDescription
|
|
2492
|
+
*/
|
|
2493
|
+
'safety_zones'?: { [key: string]: Collider; };
|
|
2494
|
+
/**
|
|
2495
|
+
* The shape of the MotionGroups links to validate against safety zones. Indexed along the kinematic chain, starting with a static base shape before first joint.
|
|
2496
|
+
* @type {Array<{ [key: string]: Collider; }>}
|
|
2497
|
+
* @memberof MotionGroupDescription
|
|
2498
|
+
*/
|
|
2499
|
+
'safety_link_colliders'?: Array<{ [key: string]: Collider; }>;
|
|
2500
|
+
/**
|
|
2501
|
+
* Maps a TCP name to its tool collider. Key must be a TCP identifier. Values are ColliderDictionaries that make up the shape of one tool to validate against safety zones.
|
|
2502
|
+
* @type {{ [key: string]: { [key: string]: Collider; }; }}
|
|
2503
|
+
* @memberof MotionGroupDescription
|
|
2504
|
+
*/
|
|
2505
|
+
'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
|
|
2506
|
+
/**
|
|
2507
|
+
*
|
|
2508
|
+
* @type {PlanningLimits}
|
|
2509
|
+
* @memberof MotionGroupDescription
|
|
2510
|
+
*/
|
|
2511
|
+
'global_limits': PlanningLimits;
|
|
2512
|
+
/**
|
|
2513
|
+
* Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
|
|
2514
|
+
* @type {{ [key: string]: Payload; }}
|
|
2515
|
+
* @memberof MotionGroupDescription
|
|
2516
|
+
*/
|
|
2517
|
+
'payloads'?: { [key: string]: Payload; };
|
|
2518
|
+
/**
|
|
2519
|
+
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
2520
|
+
* @type {number}
|
|
2521
|
+
* @memberof MotionGroupDescription
|
|
2522
|
+
*/
|
|
2523
|
+
'cycle_time'?: number;
|
|
2524
|
+
/**
|
|
2525
|
+
* The DH parameters describing the motion group geometry, starting from base.
|
|
2526
|
+
* @type {Array<DHParameter>}
|
|
2527
|
+
* @memberof MotionGroupDescription
|
|
2528
|
+
*/
|
|
2529
|
+
'dh_parameters'?: Array<DHParameter>;
|
|
2530
|
+
}
|
|
2562
2531
|
/**
|
|
2563
2532
|
*
|
|
2564
2533
|
* @export
|
|
@@ -3027,38 +2996,6 @@ export interface OpMode {
|
|
|
3027
2996
|
}
|
|
3028
2997
|
|
|
3029
2998
|
|
|
3030
|
-
/**
|
|
3031
|
-
* Configuration for an OPC UA node value trigger. When the specified node has the specified value the trigger condition is met and the program is executed.
|
|
3032
|
-
* @export
|
|
3033
|
-
* @interface OpcuaNodeValueTriggerConfig
|
|
3034
|
-
*/
|
|
3035
|
-
export interface OpcuaNodeValueTriggerConfig {
|
|
3036
|
-
/**
|
|
3037
|
-
* Url of the OPC UA server.
|
|
3038
|
-
* @type {string}
|
|
3039
|
-
* @memberof OpcuaNodeValueTriggerConfig
|
|
3040
|
-
*/
|
|
3041
|
-
'host': string;
|
|
3042
|
-
/**
|
|
3043
|
-
* Identifier of the OPC UA node to monitor.
|
|
3044
|
-
* @type {string}
|
|
3045
|
-
* @memberof OpcuaNodeValueTriggerConfig
|
|
3046
|
-
*/
|
|
3047
|
-
'node_id': string;
|
|
3048
|
-
/**
|
|
3049
|
-
*
|
|
3050
|
-
* @type {OpcuaNodeValueTriggerConfigNodeValue}
|
|
3051
|
-
* @memberof OpcuaNodeValueTriggerConfig
|
|
3052
|
-
*/
|
|
3053
|
-
'node_value': OpcuaNodeValueTriggerConfigNodeValue;
|
|
3054
|
-
}
|
|
3055
|
-
/**
|
|
3056
|
-
* @type OpcuaNodeValueTriggerConfigNodeValue
|
|
3057
|
-
* Value to trigger the program when matched.
|
|
3058
|
-
* @export
|
|
3059
|
-
*/
|
|
3060
|
-
export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
|
|
3061
|
-
|
|
3062
2999
|
/**
|
|
3063
3000
|
* The operating state.
|
|
3064
3001
|
* @export
|
|
@@ -3417,7 +3354,7 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
|
|
|
3417
3354
|
*/
|
|
3418
3355
|
export interface PlanTrajectoryRequest {
|
|
3419
3356
|
/**
|
|
3420
|
-
* The data to assemble the robot setup can be retrieved from [
|
|
3357
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
3421
3358
|
* @type {RobotSetup}
|
|
3422
3359
|
* @memberof PlanTrajectoryRequest
|
|
3423
3360
|
*/
|
|
@@ -3572,73 +3509,6 @@ export interface PlanningLimitsLimitRange {
|
|
|
3572
3509
|
*/
|
|
3573
3510
|
'upper_limit': number;
|
|
3574
3511
|
}
|
|
3575
|
-
/**
|
|
3576
|
-
* The configuration of a motion-group used for motion planning.
|
|
3577
|
-
* @export
|
|
3578
|
-
* @interface PlanningParameters
|
|
3579
|
-
*/
|
|
3580
|
-
export interface PlanningParameters {
|
|
3581
|
-
/**
|
|
3582
|
-
* String identifiying the model of a motion group.
|
|
3583
|
-
* @type {string}
|
|
3584
|
-
* @memberof PlanningParameters
|
|
3585
|
-
*/
|
|
3586
|
-
'motion_group_type': string;
|
|
3587
|
-
/**
|
|
3588
|
-
* The offset from the world frame to the motion group base.
|
|
3589
|
-
* @type {Pose}
|
|
3590
|
-
* @memberof PlanningParameters
|
|
3591
|
-
*/
|
|
3592
|
-
'mounting': Pose;
|
|
3593
|
-
/**
|
|
3594
|
-
* Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
|
|
3595
|
-
* @type {{ [key: string]: TcpOffset; }}
|
|
3596
|
-
* @memberof PlanningParameters
|
|
3597
|
-
*/
|
|
3598
|
-
'tcps': { [key: string]: TcpOffset; };
|
|
3599
|
-
/**
|
|
3600
|
-
* A collection of identifiable colliders.
|
|
3601
|
-
* @type {{ [key: string]: Collider; }}
|
|
3602
|
-
* @memberof PlanningParameters
|
|
3603
|
-
*/
|
|
3604
|
-
'safety_zones'?: { [key: string]: Collider; };
|
|
3605
|
-
/**
|
|
3606
|
-
* The shape of the MotionGroups links to validate against safety zones. Indexed along the kinematic chain, starting with a static base shape before first joint.
|
|
3607
|
-
* @type {Array<{ [key: string]: Collider; }>}
|
|
3608
|
-
* @memberof PlanningParameters
|
|
3609
|
-
*/
|
|
3610
|
-
'safety_link_colliders'?: Array<{ [key: string]: Collider; }>;
|
|
3611
|
-
/**
|
|
3612
|
-
* Maps a TCP name to its tool collider. Key must be a TCP identifier. Values are ColliderDictionaries that make up the shape of one tool to validate against safety zones.
|
|
3613
|
-
* @type {{ [key: string]: { [key: string]: Collider; }; }}
|
|
3614
|
-
* @memberof PlanningParameters
|
|
3615
|
-
*/
|
|
3616
|
-
'safety_tool_colliders'?: { [key: string]: { [key: string]: Collider; }; };
|
|
3617
|
-
/**
|
|
3618
|
-
*
|
|
3619
|
-
* @type {PlanningLimits}
|
|
3620
|
-
* @memberof PlanningParameters
|
|
3621
|
-
*/
|
|
3622
|
-
'global_limits': PlanningLimits;
|
|
3623
|
-
/**
|
|
3624
|
-
* Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
|
|
3625
|
-
* @type {{ [key: string]: Payload; }}
|
|
3626
|
-
* @memberof PlanningParameters
|
|
3627
|
-
*/
|
|
3628
|
-
'payloads'?: { [key: string]: Payload; };
|
|
3629
|
-
/**
|
|
3630
|
-
* [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
|
|
3631
|
-
* @type {number}
|
|
3632
|
-
* @memberof PlanningParameters
|
|
3633
|
-
*/
|
|
3634
|
-
'cycle_time'?: number;
|
|
3635
|
-
/**
|
|
3636
|
-
* The DH parameters describing the motion group geometry, starting from base.
|
|
3637
|
-
* @type {Array<DHParameter>}
|
|
3638
|
-
* @memberof PlanningParameters
|
|
3639
|
-
*/
|
|
3640
|
-
'dh_parameters'?: Array<DHParameter>;
|
|
3641
|
-
}
|
|
3642
3512
|
/**
|
|
3643
3513
|
* Sets velocity for executed movements of the motion, in percent. Send after initializing the connection with InitializeMovementRequest.
|
|
3644
3514
|
* @export
|
|
@@ -3812,49 +3682,6 @@ export interface ProgramRun {
|
|
|
3812
3682
|
}
|
|
3813
3683
|
|
|
3814
3684
|
|
|
3815
|
-
/**
|
|
3816
|
-
*
|
|
3817
|
-
* @export
|
|
3818
|
-
* @interface ProgramRunObject
|
|
3819
|
-
*/
|
|
3820
|
-
export interface ProgramRunObject {
|
|
3821
|
-
/**
|
|
3822
|
-
* The identifier of the program run.
|
|
3823
|
-
* @type {string}
|
|
3824
|
-
* @memberof ProgramRunObject
|
|
3825
|
-
*/
|
|
3826
|
-
'id': string;
|
|
3827
|
-
/**
|
|
3828
|
-
* The identifier of the program stored in the program library.
|
|
3829
|
-
* @type {string}
|
|
3830
|
-
* @memberof ProgramRunObject
|
|
3831
|
-
*/
|
|
3832
|
-
'program_id': string;
|
|
3833
|
-
/**
|
|
3834
|
-
* The status of the program run which shows which state the program run is currently is in.
|
|
3835
|
-
* @type {string}
|
|
3836
|
-
* @memberof ProgramRunObject
|
|
3837
|
-
*/
|
|
3838
|
-
'status': string;
|
|
3839
|
-
/**
|
|
3840
|
-
* The output of the program run, which provides the output generate while running the program.
|
|
3841
|
-
* @type {string}
|
|
3842
|
-
* @memberof ProgramRunObject
|
|
3843
|
-
*/
|
|
3844
|
-
'program_output'?: string;
|
|
3845
|
-
/**
|
|
3846
|
-
* ISO 8601 date-time format when the program run was created.
|
|
3847
|
-
* @type {string}
|
|
3848
|
-
* @memberof ProgramRunObject
|
|
3849
|
-
*/
|
|
3850
|
-
'created_at': string;
|
|
3851
|
-
/**
|
|
3852
|
-
* ISO 8601 date-time format when the program run was last updated.
|
|
3853
|
-
* @type {string}
|
|
3854
|
-
* @memberof ProgramRunObject
|
|
3855
|
-
*/
|
|
3856
|
-
'last_updated_at': string;
|
|
3857
|
-
}
|
|
3858
3685
|
/**
|
|
3859
3686
|
* Reference to an executed program.
|
|
3860
3687
|
* @export
|
|
@@ -4773,76 +4600,6 @@ export const TrajectoryIdMessageTypeEnum = {
|
|
|
4773
4600
|
|
|
4774
4601
|
export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
|
|
4775
4602
|
|
|
4776
|
-
/**
|
|
4777
|
-
*
|
|
4778
|
-
* @export
|
|
4779
|
-
* @interface TriggerObject
|
|
4780
|
-
*/
|
|
4781
|
-
export interface TriggerObject {
|
|
4782
|
-
/**
|
|
4783
|
-
* The identifier of the trigger.
|
|
4784
|
-
* @type {string}
|
|
4785
|
-
* @memberof TriggerObject
|
|
4786
|
-
*/
|
|
4787
|
-
'id'?: string;
|
|
4788
|
-
/**
|
|
4789
|
-
* The identifier of the program to run when the trigger condition is met.
|
|
4790
|
-
* @type {string}
|
|
4791
|
-
* @memberof TriggerObject
|
|
4792
|
-
*/
|
|
4793
|
-
'program_id': string;
|
|
4794
|
-
/**
|
|
4795
|
-
* Indicates whether the trigger is enabled or not.
|
|
4796
|
-
* @type {boolean}
|
|
4797
|
-
* @memberof TriggerObject
|
|
4798
|
-
*/
|
|
4799
|
-
'enabled': boolean;
|
|
4800
|
-
/**
|
|
4801
|
-
*
|
|
4802
|
-
* @type {TriggerType}
|
|
4803
|
-
* @memberof TriggerObject
|
|
4804
|
-
*/
|
|
4805
|
-
'type': TriggerType;
|
|
4806
|
-
/**
|
|
4807
|
-
*
|
|
4808
|
-
* @type {OpcuaNodeValueTriggerConfig}
|
|
4809
|
-
* @memberof TriggerObject
|
|
4810
|
-
*/
|
|
4811
|
-
'config': OpcuaNodeValueTriggerConfig;
|
|
4812
|
-
/**
|
|
4813
|
-
* ISO 8601 date-time format when the trigger was created.
|
|
4814
|
-
* @type {string}
|
|
4815
|
-
* @memberof TriggerObject
|
|
4816
|
-
*/
|
|
4817
|
-
'created_at': string;
|
|
4818
|
-
/**
|
|
4819
|
-
* ISO 8601 date-time format when the trigger was last updated.
|
|
4820
|
-
* @type {string}
|
|
4821
|
-
* @memberof TriggerObject
|
|
4822
|
-
*/
|
|
4823
|
-
'last_updated_at': string;
|
|
4824
|
-
/**
|
|
4825
|
-
* The program runs that were triggered by this trigger.
|
|
4826
|
-
* @type {Array<string>}
|
|
4827
|
-
* @memberof TriggerObject
|
|
4828
|
-
*/
|
|
4829
|
-
'program_runs'?: Array<string>;
|
|
4830
|
-
}
|
|
4831
|
-
|
|
4832
|
-
|
|
4833
|
-
/**
|
|
4834
|
-
* The type of the trigger.
|
|
4835
|
-
* @export
|
|
4836
|
-
* @enum {string}
|
|
4837
|
-
*/
|
|
4838
|
-
|
|
4839
|
-
export const TriggerType = {
|
|
4840
|
-
OpcuaNodeValue: 'opcua_node_value'
|
|
4841
|
-
} as const;
|
|
4842
|
-
|
|
4843
|
-
export type TriggerType = typeof TriggerType[keyof typeof TriggerType];
|
|
4844
|
-
|
|
4845
|
-
|
|
4846
4603
|
/**
|
|
4847
4604
|
* The unit of input/output value.
|
|
4848
4605
|
* @export
|
|
@@ -4909,34 +4666,9 @@ export interface UpdateNovaVersionRequest {
|
|
|
4909
4666
|
/**
|
|
4910
4667
|
*
|
|
4911
4668
|
* @export
|
|
4912
|
-
* @interface
|
|
4669
|
+
* @interface ValidationError
|
|
4913
4670
|
*/
|
|
4914
|
-
export interface
|
|
4915
|
-
/**
|
|
4916
|
-
* The identifier of the program to run when the trigger condition is met.
|
|
4917
|
-
* @type {string}
|
|
4918
|
-
* @memberof UpdateTriggerRequest
|
|
4919
|
-
*/
|
|
4920
|
-
'program_id'?: string;
|
|
4921
|
-
/**
|
|
4922
|
-
* Whether the trigger is enabled or not.
|
|
4923
|
-
* @type {boolean}
|
|
4924
|
-
* @memberof UpdateTriggerRequest
|
|
4925
|
-
*/
|
|
4926
|
-
'enabled'?: boolean;
|
|
4927
|
-
/**
|
|
4928
|
-
*
|
|
4929
|
-
* @type {OpcuaNodeValueTriggerConfig}
|
|
4930
|
-
* @memberof UpdateTriggerRequest
|
|
4931
|
-
*/
|
|
4932
|
-
'config'?: OpcuaNodeValueTriggerConfig;
|
|
4933
|
-
}
|
|
4934
|
-
/**
|
|
4935
|
-
*
|
|
4936
|
-
* @export
|
|
4937
|
-
* @interface ValidationError
|
|
4938
|
-
*/
|
|
4939
|
-
export interface ValidationError {
|
|
4671
|
+
export interface ValidationError {
|
|
4940
4672
|
/**
|
|
4941
4673
|
*
|
|
4942
4674
|
* @type {Array<ValidationErrorLocInner>}
|
|
@@ -9199,19 +8931,19 @@ export const MotionGroupApiAxiosParamCreator = function (configuration?: Configu
|
|
|
9199
8931
|
};
|
|
9200
8932
|
},
|
|
9201
8933
|
/**
|
|
9202
|
-
* Get the
|
|
9203
|
-
* @summary
|
|
8934
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
8935
|
+
* @summary Description
|
|
9204
8936
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9205
8937
|
* @param {string} motionGroup The motion-group identifier.
|
|
9206
8938
|
* @param {*} [options] Override http request option.
|
|
9207
8939
|
* @throws {RequiredError}
|
|
9208
8940
|
*/
|
|
9209
|
-
|
|
8941
|
+
getMotionGroupDescription: async (cell: string, motionGroup: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9210
8942
|
// verify required parameter 'cell' is not null or undefined
|
|
9211
|
-
assertParamExists('
|
|
8943
|
+
assertParamExists('getMotionGroupDescription', 'cell', cell)
|
|
9212
8944
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
9213
|
-
assertParamExists('
|
|
9214
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/
|
|
8945
|
+
assertParamExists('getMotionGroupDescription', 'motionGroup', motionGroup)
|
|
8946
|
+
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/description`
|
|
9215
8947
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
9216
8948
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
9217
8949
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -9326,17 +9058,17 @@ export const MotionGroupApiFp = function(configuration?: Configuration) {
|
|
|
9326
9058
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9327
9059
|
},
|
|
9328
9060
|
/**
|
|
9329
|
-
* Get the
|
|
9330
|
-
* @summary
|
|
9061
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
9062
|
+
* @summary Description
|
|
9331
9063
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9332
9064
|
* @param {string} motionGroup The motion-group identifier.
|
|
9333
9065
|
* @param {*} [options] Override http request option.
|
|
9334
9066
|
* @throws {RequiredError}
|
|
9335
9067
|
*/
|
|
9336
|
-
async
|
|
9337
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
9068
|
+
async getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>> {
|
|
9069
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, motionGroup, options);
|
|
9338
9070
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9339
|
-
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.
|
|
9071
|
+
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getMotionGroupDescription']?.[localVarOperationServerIndex]?.url;
|
|
9340
9072
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9341
9073
|
},
|
|
9342
9074
|
/**
|
|
@@ -9378,15 +9110,15 @@ export const MotionGroupApiFactory = function (configuration?: Configuration, ba
|
|
|
9378
9110
|
return localVarFp.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
9379
9111
|
},
|
|
9380
9112
|
/**
|
|
9381
|
-
* Get the
|
|
9382
|
-
* @summary
|
|
9113
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
9114
|
+
* @summary Description
|
|
9383
9115
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9384
9116
|
* @param {string} motionGroup The motion-group identifier.
|
|
9385
9117
|
* @param {*} [options] Override http request option.
|
|
9386
9118
|
* @throws {RequiredError}
|
|
9387
9119
|
*/
|
|
9388
|
-
|
|
9389
|
-
return localVarFp.
|
|
9120
|
+
getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription> {
|
|
9121
|
+
return localVarFp.getMotionGroupDescription(cell, motionGroup, options).then((request) => request(axios, basePath));
|
|
9390
9122
|
},
|
|
9391
9123
|
/**
|
|
9392
9124
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
@@ -9426,16 +9158,16 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
9426
9158
|
}
|
|
9427
9159
|
|
|
9428
9160
|
/**
|
|
9429
|
-
* Get the
|
|
9430
|
-
* @summary
|
|
9161
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
9162
|
+
* @summary Description
|
|
9431
9163
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9432
9164
|
* @param {string} motionGroup The motion-group identifier.
|
|
9433
9165
|
* @param {*} [options] Override http request option.
|
|
9434
9166
|
* @throws {RequiredError}
|
|
9435
9167
|
* @memberof MotionGroupApi
|
|
9436
9168
|
*/
|
|
9437
|
-
public
|
|
9438
|
-
return MotionGroupApiFp(this.configuration).
|
|
9169
|
+
public getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig) {
|
|
9170
|
+
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
9439
9171
|
}
|
|
9440
9172
|
|
|
9441
9173
|
/**
|
|
@@ -10161,724 +9893,6 @@ export class ProgramApi extends BaseAPI {
|
|
|
10161
9893
|
|
|
10162
9894
|
|
|
10163
9895
|
|
|
10164
|
-
/**
|
|
10165
|
-
* ProgramOperatorApi - axios parameter creator
|
|
10166
|
-
* @export
|
|
10167
|
-
*/
|
|
10168
|
-
export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
10169
|
-
return {
|
|
10170
|
-
/**
|
|
10171
|
-
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
10172
|
-
* @summary Run Program from Library
|
|
10173
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10174
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
10175
|
-
* @param {*} [options] Override http request option.
|
|
10176
|
-
* @throws {RequiredError}
|
|
10177
|
-
*/
|
|
10178
|
-
createProgramOperatorRun: async (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10179
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10180
|
-
assertParamExists('createProgramOperatorRun', 'cell', cell)
|
|
10181
|
-
// verify required parameter 'createProgramOperatorRunRequest' is not null or undefined
|
|
10182
|
-
assertParamExists('createProgramOperatorRun', 'createProgramOperatorRunRequest', createProgramOperatorRunRequest)
|
|
10183
|
-
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
10184
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10185
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10186
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10187
|
-
let baseOptions;
|
|
10188
|
-
if (configuration) {
|
|
10189
|
-
baseOptions = configuration.baseOptions;
|
|
10190
|
-
}
|
|
10191
|
-
|
|
10192
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
10193
|
-
const localVarHeaderParameter = {} as any;
|
|
10194
|
-
const localVarQueryParameter = {} as any;
|
|
10195
|
-
|
|
10196
|
-
// authentication BasicAuth required
|
|
10197
|
-
// http basic authentication required
|
|
10198
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10199
|
-
|
|
10200
|
-
// authentication BearerAuth required
|
|
10201
|
-
// http bearer authentication required
|
|
10202
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10203
|
-
|
|
10204
|
-
|
|
10205
|
-
|
|
10206
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10207
|
-
|
|
10208
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10209
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10210
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10211
|
-
localVarRequestOptions.data = serializeDataIfNeeded(createProgramOperatorRunRequest, localVarRequestOptions, configuration)
|
|
10212
|
-
|
|
10213
|
-
return {
|
|
10214
|
-
url: toPathString(localVarUrlObj),
|
|
10215
|
-
options: localVarRequestOptions,
|
|
10216
|
-
};
|
|
10217
|
-
},
|
|
10218
|
-
/**
|
|
10219
|
-
* <!-- 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.
|
|
10220
|
-
* @summary Create Trigger
|
|
10221
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10222
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
10223
|
-
* @param {*} [options] Override http request option.
|
|
10224
|
-
* @throws {RequiredError}
|
|
10225
|
-
*/
|
|
10226
|
-
createTrigger: async (cell: string, createTriggerRequest: CreateTriggerRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10227
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10228
|
-
assertParamExists('createTrigger', 'cell', cell)
|
|
10229
|
-
// verify required parameter 'createTriggerRequest' is not null or undefined
|
|
10230
|
-
assertParamExists('createTrigger', 'createTriggerRequest', createTriggerRequest)
|
|
10231
|
-
const localVarPath = `/cells/{cell}/operator/triggers`
|
|
10232
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10233
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10234
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10235
|
-
let baseOptions;
|
|
10236
|
-
if (configuration) {
|
|
10237
|
-
baseOptions = configuration.baseOptions;
|
|
10238
|
-
}
|
|
10239
|
-
|
|
10240
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
10241
|
-
const localVarHeaderParameter = {} as any;
|
|
10242
|
-
const localVarQueryParameter = {} as any;
|
|
10243
|
-
|
|
10244
|
-
// authentication BasicAuth required
|
|
10245
|
-
// http basic authentication required
|
|
10246
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10247
|
-
|
|
10248
|
-
// authentication BearerAuth required
|
|
10249
|
-
// http bearer authentication required
|
|
10250
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10251
|
-
|
|
10252
|
-
|
|
10253
|
-
|
|
10254
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10255
|
-
|
|
10256
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10257
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10258
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10259
|
-
localVarRequestOptions.data = serializeDataIfNeeded(createTriggerRequest, localVarRequestOptions, configuration)
|
|
10260
|
-
|
|
10261
|
-
return {
|
|
10262
|
-
url: toPathString(localVarUrlObj),
|
|
10263
|
-
options: localVarRequestOptions,
|
|
10264
|
-
};
|
|
10265
|
-
},
|
|
10266
|
-
/**
|
|
10267
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
10268
|
-
* @summary Delete Trigger
|
|
10269
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10270
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10271
|
-
* @param {*} [options] Override http request option.
|
|
10272
|
-
* @throws {RequiredError}
|
|
10273
|
-
*/
|
|
10274
|
-
deleteTrigger: async (trigger: string, cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10275
|
-
// verify required parameter 'trigger' is not null or undefined
|
|
10276
|
-
assertParamExists('deleteTrigger', 'trigger', trigger)
|
|
10277
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10278
|
-
assertParamExists('deleteTrigger', 'cell', cell)
|
|
10279
|
-
const localVarPath = `/cells/{cell}/operator/triggers/{trigger}`
|
|
10280
|
-
.replace(`{${"trigger"}}`, encodeURIComponent(String(trigger)))
|
|
10281
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10282
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10283
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10284
|
-
let baseOptions;
|
|
10285
|
-
if (configuration) {
|
|
10286
|
-
baseOptions = configuration.baseOptions;
|
|
10287
|
-
}
|
|
10288
|
-
|
|
10289
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
10290
|
-
const localVarHeaderParameter = {} as any;
|
|
10291
|
-
const localVarQueryParameter = {} as any;
|
|
10292
|
-
|
|
10293
|
-
// authentication BasicAuth required
|
|
10294
|
-
// http basic authentication required
|
|
10295
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10296
|
-
|
|
10297
|
-
// authentication BearerAuth required
|
|
10298
|
-
// http bearer authentication required
|
|
10299
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10300
|
-
|
|
10301
|
-
|
|
10302
|
-
|
|
10303
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10304
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10305
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10306
|
-
|
|
10307
|
-
return {
|
|
10308
|
-
url: toPathString(localVarUrlObj),
|
|
10309
|
-
options: localVarRequestOptions,
|
|
10310
|
-
};
|
|
10311
|
-
},
|
|
10312
|
-
/**
|
|
10313
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
10314
|
-
* @summary Get All Program Runs
|
|
10315
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10316
|
-
* @param {string} [state]
|
|
10317
|
-
* @param {*} [options] Override http request option.
|
|
10318
|
-
* @throws {RequiredError}
|
|
10319
|
-
*/
|
|
10320
|
-
getAllProgramOperatorRuns: async (cell: string, state?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10321
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10322
|
-
assertParamExists('getAllProgramOperatorRuns', 'cell', cell)
|
|
10323
|
-
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
10324
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10325
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10326
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10327
|
-
let baseOptions;
|
|
10328
|
-
if (configuration) {
|
|
10329
|
-
baseOptions = configuration.baseOptions;
|
|
10330
|
-
}
|
|
10331
|
-
|
|
10332
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
10333
|
-
const localVarHeaderParameter = {} as any;
|
|
10334
|
-
const localVarQueryParameter = {} as any;
|
|
10335
|
-
|
|
10336
|
-
// authentication BasicAuth required
|
|
10337
|
-
// http basic authentication required
|
|
10338
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10339
|
-
|
|
10340
|
-
// authentication BearerAuth required
|
|
10341
|
-
// http bearer authentication required
|
|
10342
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10343
|
-
|
|
10344
|
-
if (state !== undefined) {
|
|
10345
|
-
localVarQueryParameter['state'] = state;
|
|
10346
|
-
}
|
|
10347
|
-
|
|
10348
|
-
|
|
10349
|
-
|
|
10350
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10351
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10352
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10353
|
-
|
|
10354
|
-
return {
|
|
10355
|
-
url: toPathString(localVarUrlObj),
|
|
10356
|
-
options: localVarRequestOptions,
|
|
10357
|
-
};
|
|
10358
|
-
},
|
|
10359
|
-
/**
|
|
10360
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
10361
|
-
* @summary Get All Triggers
|
|
10362
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10363
|
-
* @param {*} [options] Override http request option.
|
|
10364
|
-
* @throws {RequiredError}
|
|
10365
|
-
*/
|
|
10366
|
-
getAllTriggers: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10367
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10368
|
-
assertParamExists('getAllTriggers', 'cell', cell)
|
|
10369
|
-
const localVarPath = `/cells/{cell}/operator/triggers`
|
|
10370
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10371
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10372
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10373
|
-
let baseOptions;
|
|
10374
|
-
if (configuration) {
|
|
10375
|
-
baseOptions = configuration.baseOptions;
|
|
10376
|
-
}
|
|
10377
|
-
|
|
10378
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
10379
|
-
const localVarHeaderParameter = {} as any;
|
|
10380
|
-
const localVarQueryParameter = {} as any;
|
|
10381
|
-
|
|
10382
|
-
// authentication BasicAuth required
|
|
10383
|
-
// http basic authentication required
|
|
10384
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10385
|
-
|
|
10386
|
-
// authentication BearerAuth required
|
|
10387
|
-
// http bearer authentication required
|
|
10388
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10389
|
-
|
|
10390
|
-
|
|
10391
|
-
|
|
10392
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10393
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10394
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10395
|
-
|
|
10396
|
-
return {
|
|
10397
|
-
url: toPathString(localVarUrlObj),
|
|
10398
|
-
options: localVarRequestOptions,
|
|
10399
|
-
};
|
|
10400
|
-
},
|
|
10401
|
-
/**
|
|
10402
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
10403
|
-
* @summary Get Program Run
|
|
10404
|
-
* @param {string} run
|
|
10405
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10406
|
-
* @param {*} [options] Override http request option.
|
|
10407
|
-
* @throws {RequiredError}
|
|
10408
|
-
*/
|
|
10409
|
-
getProgramOperatorRun: async (run: string, cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10410
|
-
// verify required parameter 'run' is not null or undefined
|
|
10411
|
-
assertParamExists('getProgramOperatorRun', 'run', run)
|
|
10412
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10413
|
-
assertParamExists('getProgramOperatorRun', 'cell', cell)
|
|
10414
|
-
const localVarPath = `/cells/{cell}/operator/programs/runs/{run}`
|
|
10415
|
-
.replace(`{${"run"}}`, encodeURIComponent(String(run)))
|
|
10416
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10417
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10418
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10419
|
-
let baseOptions;
|
|
10420
|
-
if (configuration) {
|
|
10421
|
-
baseOptions = configuration.baseOptions;
|
|
10422
|
-
}
|
|
10423
|
-
|
|
10424
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
10425
|
-
const localVarHeaderParameter = {} as any;
|
|
10426
|
-
const localVarQueryParameter = {} as any;
|
|
10427
|
-
|
|
10428
|
-
// authentication BasicAuth required
|
|
10429
|
-
// http basic authentication required
|
|
10430
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10431
|
-
|
|
10432
|
-
// authentication BearerAuth required
|
|
10433
|
-
// http bearer authentication required
|
|
10434
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10435
|
-
|
|
10436
|
-
|
|
10437
|
-
|
|
10438
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10439
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10440
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10441
|
-
|
|
10442
|
-
return {
|
|
10443
|
-
url: toPathString(localVarUrlObj),
|
|
10444
|
-
options: localVarRequestOptions,
|
|
10445
|
-
};
|
|
10446
|
-
},
|
|
10447
|
-
/**
|
|
10448
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
10449
|
-
* @summary Get Trigger
|
|
10450
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10451
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10452
|
-
* @param {*} [options] Override http request option.
|
|
10453
|
-
* @throws {RequiredError}
|
|
10454
|
-
*/
|
|
10455
|
-
getTrigger: async (trigger: string, cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10456
|
-
// verify required parameter 'trigger' is not null or undefined
|
|
10457
|
-
assertParamExists('getTrigger', 'trigger', trigger)
|
|
10458
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10459
|
-
assertParamExists('getTrigger', 'cell', cell)
|
|
10460
|
-
const localVarPath = `/cells/{cell}/operator/triggers/{trigger}`
|
|
10461
|
-
.replace(`{${"trigger"}}`, encodeURIComponent(String(trigger)))
|
|
10462
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10463
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10464
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10465
|
-
let baseOptions;
|
|
10466
|
-
if (configuration) {
|
|
10467
|
-
baseOptions = configuration.baseOptions;
|
|
10468
|
-
}
|
|
10469
|
-
|
|
10470
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
10471
|
-
const localVarHeaderParameter = {} as any;
|
|
10472
|
-
const localVarQueryParameter = {} as any;
|
|
10473
|
-
|
|
10474
|
-
// authentication BasicAuth required
|
|
10475
|
-
// http basic authentication required
|
|
10476
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10477
|
-
|
|
10478
|
-
// authentication BearerAuth required
|
|
10479
|
-
// http bearer authentication required
|
|
10480
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10481
|
-
|
|
10482
|
-
|
|
10483
|
-
|
|
10484
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10485
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10486
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10487
|
-
|
|
10488
|
-
return {
|
|
10489
|
-
url: toPathString(localVarUrlObj),
|
|
10490
|
-
options: localVarRequestOptions,
|
|
10491
|
-
};
|
|
10492
|
-
},
|
|
10493
|
-
/**
|
|
10494
|
-
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
10495
|
-
* @summary Update Trigger
|
|
10496
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10497
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10498
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
10499
|
-
* @param {*} [options] Override http request option.
|
|
10500
|
-
* @throws {RequiredError}
|
|
10501
|
-
*/
|
|
10502
|
-
updateTrigger: async (trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10503
|
-
// verify required parameter 'trigger' is not null or undefined
|
|
10504
|
-
assertParamExists('updateTrigger', 'trigger', trigger)
|
|
10505
|
-
// verify required parameter 'cell' is not null or undefined
|
|
10506
|
-
assertParamExists('updateTrigger', 'cell', cell)
|
|
10507
|
-
// verify required parameter 'updateTriggerRequest' is not null or undefined
|
|
10508
|
-
assertParamExists('updateTrigger', 'updateTriggerRequest', updateTriggerRequest)
|
|
10509
|
-
const localVarPath = `/cells/{cell}/operator/triggers/{trigger}`
|
|
10510
|
-
.replace(`{${"trigger"}}`, encodeURIComponent(String(trigger)))
|
|
10511
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
10512
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10513
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10514
|
-
let baseOptions;
|
|
10515
|
-
if (configuration) {
|
|
10516
|
-
baseOptions = configuration.baseOptions;
|
|
10517
|
-
}
|
|
10518
|
-
|
|
10519
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
10520
|
-
const localVarHeaderParameter = {} as any;
|
|
10521
|
-
const localVarQueryParameter = {} as any;
|
|
10522
|
-
|
|
10523
|
-
// authentication BasicAuth required
|
|
10524
|
-
// http basic authentication required
|
|
10525
|
-
setBasicAuthToObject(localVarRequestOptions, configuration)
|
|
10526
|
-
|
|
10527
|
-
// authentication BearerAuth required
|
|
10528
|
-
// http bearer authentication required
|
|
10529
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
10530
|
-
|
|
10531
|
-
|
|
10532
|
-
|
|
10533
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10534
|
-
|
|
10535
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10536
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10537
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10538
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateTriggerRequest, localVarRequestOptions, configuration)
|
|
10539
|
-
|
|
10540
|
-
return {
|
|
10541
|
-
url: toPathString(localVarUrlObj),
|
|
10542
|
-
options: localVarRequestOptions,
|
|
10543
|
-
};
|
|
10544
|
-
},
|
|
10545
|
-
}
|
|
10546
|
-
};
|
|
10547
|
-
|
|
10548
|
-
/**
|
|
10549
|
-
* ProgramOperatorApi - functional programming interface
|
|
10550
|
-
* @export
|
|
10551
|
-
*/
|
|
10552
|
-
export const ProgramOperatorApiFp = function(configuration?: Configuration) {
|
|
10553
|
-
const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration)
|
|
10554
|
-
return {
|
|
10555
|
-
/**
|
|
10556
|
-
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
10557
|
-
* @summary Run Program from Library
|
|
10558
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10559
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
10560
|
-
* @param {*} [options] Override http request option.
|
|
10561
|
-
* @throws {RequiredError}
|
|
10562
|
-
*/
|
|
10563
|
-
async createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>> {
|
|
10564
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options);
|
|
10565
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10566
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
10567
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10568
|
-
},
|
|
10569
|
-
/**
|
|
10570
|
-
* <!-- 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.
|
|
10571
|
-
* @summary Create Trigger
|
|
10572
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10573
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
10574
|
-
* @param {*} [options] Override http request option.
|
|
10575
|
-
* @throws {RequiredError}
|
|
10576
|
-
*/
|
|
10577
|
-
async createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTrigger200Response>> {
|
|
10578
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createTrigger(cell, createTriggerRequest, options);
|
|
10579
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10580
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createTrigger']?.[localVarOperationServerIndex]?.url;
|
|
10581
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10582
|
-
},
|
|
10583
|
-
/**
|
|
10584
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
10585
|
-
* @summary Delete Trigger
|
|
10586
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10587
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10588
|
-
* @param {*} [options] Override http request option.
|
|
10589
|
-
* @throws {RequiredError}
|
|
10590
|
-
*/
|
|
10591
|
-
async deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
10592
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrigger(trigger, cell, options);
|
|
10593
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10594
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.deleteTrigger']?.[localVarOperationServerIndex]?.url;
|
|
10595
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10596
|
-
},
|
|
10597
|
-
/**
|
|
10598
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
10599
|
-
* @summary Get All Program Runs
|
|
10600
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10601
|
-
* @param {string} [state]
|
|
10602
|
-
* @param {*} [options] Override http request option.
|
|
10603
|
-
* @throws {RequiredError}
|
|
10604
|
-
*/
|
|
10605
|
-
async getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>> {
|
|
10606
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramOperatorRuns(cell, state, options);
|
|
10607
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10608
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramOperatorRuns']?.[localVarOperationServerIndex]?.url;
|
|
10609
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10610
|
-
},
|
|
10611
|
-
/**
|
|
10612
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
10613
|
-
* @summary Get All Triggers
|
|
10614
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10615
|
-
* @param {*} [options] Override http request option.
|
|
10616
|
-
* @throws {RequiredError}
|
|
10617
|
-
*/
|
|
10618
|
-
async getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllTriggers200Response>> {
|
|
10619
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllTriggers(cell, options);
|
|
10620
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10621
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllTriggers']?.[localVarOperationServerIndex]?.url;
|
|
10622
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10623
|
-
},
|
|
10624
|
-
/**
|
|
10625
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
10626
|
-
* @summary Get Program Run
|
|
10627
|
-
* @param {string} run
|
|
10628
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10629
|
-
* @param {*} [options] Override http request option.
|
|
10630
|
-
* @throws {RequiredError}
|
|
10631
|
-
*/
|
|
10632
|
-
async getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>> {
|
|
10633
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramOperatorRun(run, cell, options);
|
|
10634
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10635
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
10636
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10637
|
-
},
|
|
10638
|
-
/**
|
|
10639
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
10640
|
-
* @summary Get Trigger
|
|
10641
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10642
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10643
|
-
* @param {*} [options] Override http request option.
|
|
10644
|
-
* @throws {RequiredError}
|
|
10645
|
-
*/
|
|
10646
|
-
async getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerObject>> {
|
|
10647
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrigger(trigger, cell, options);
|
|
10648
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10649
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getTrigger']?.[localVarOperationServerIndex]?.url;
|
|
10650
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10651
|
-
},
|
|
10652
|
-
/**
|
|
10653
|
-
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
10654
|
-
* @summary Update Trigger
|
|
10655
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10656
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10657
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
10658
|
-
* @param {*} [options] Override http request option.
|
|
10659
|
-
* @throws {RequiredError}
|
|
10660
|
-
*/
|
|
10661
|
-
async updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerObject>> {
|
|
10662
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateTrigger(trigger, cell, updateTriggerRequest, options);
|
|
10663
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10664
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.updateTrigger']?.[localVarOperationServerIndex]?.url;
|
|
10665
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10666
|
-
},
|
|
10667
|
-
}
|
|
10668
|
-
};
|
|
10669
|
-
|
|
10670
|
-
/**
|
|
10671
|
-
* ProgramOperatorApi - factory interface
|
|
10672
|
-
* @export
|
|
10673
|
-
*/
|
|
10674
|
-
export const ProgramOperatorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
10675
|
-
const localVarFp = ProgramOperatorApiFp(configuration)
|
|
10676
|
-
return {
|
|
10677
|
-
/**
|
|
10678
|
-
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
10679
|
-
* @summary Run Program from Library
|
|
10680
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10681
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
10682
|
-
* @param {*} [options] Override http request option.
|
|
10683
|
-
* @throws {RequiredError}
|
|
10684
|
-
*/
|
|
10685
|
-
createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response> {
|
|
10686
|
-
return localVarFp.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(axios, basePath));
|
|
10687
|
-
},
|
|
10688
|
-
/**
|
|
10689
|
-
* <!-- 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.
|
|
10690
|
-
* @summary Create Trigger
|
|
10691
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10692
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
10693
|
-
* @param {*} [options] Override http request option.
|
|
10694
|
-
* @throws {RequiredError}
|
|
10695
|
-
*/
|
|
10696
|
-
createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateTrigger200Response> {
|
|
10697
|
-
return localVarFp.createTrigger(cell, createTriggerRequest, options).then((request) => request(axios, basePath));
|
|
10698
|
-
},
|
|
10699
|
-
/**
|
|
10700
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
10701
|
-
* @summary Delete Trigger
|
|
10702
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10703
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10704
|
-
* @param {*} [options] Override http request option.
|
|
10705
|
-
* @throws {RequiredError}
|
|
10706
|
-
*/
|
|
10707
|
-
deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
10708
|
-
return localVarFp.deleteTrigger(trigger, cell, options).then((request) => request(axios, basePath));
|
|
10709
|
-
},
|
|
10710
|
-
/**
|
|
10711
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
10712
|
-
* @summary Get All Program Runs
|
|
10713
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10714
|
-
* @param {string} [state]
|
|
10715
|
-
* @param {*} [options] Override http request option.
|
|
10716
|
-
* @throws {RequiredError}
|
|
10717
|
-
*/
|
|
10718
|
-
getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response> {
|
|
10719
|
-
return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
|
|
10720
|
-
},
|
|
10721
|
-
/**
|
|
10722
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
10723
|
-
* @summary Get All Triggers
|
|
10724
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10725
|
-
* @param {*} [options] Override http request option.
|
|
10726
|
-
* @throws {RequiredError}
|
|
10727
|
-
*/
|
|
10728
|
-
getAllTriggers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllTriggers200Response> {
|
|
10729
|
-
return localVarFp.getAllTriggers(cell, options).then((request) => request(axios, basePath));
|
|
10730
|
-
},
|
|
10731
|
-
/**
|
|
10732
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
10733
|
-
* @summary Get Program Run
|
|
10734
|
-
* @param {string} run
|
|
10735
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10736
|
-
* @param {*} [options] Override http request option.
|
|
10737
|
-
* @throws {RequiredError}
|
|
10738
|
-
*/
|
|
10739
|
-
getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject> {
|
|
10740
|
-
return localVarFp.getProgramOperatorRun(run, cell, options).then((request) => request(axios, basePath));
|
|
10741
|
-
},
|
|
10742
|
-
/**
|
|
10743
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
10744
|
-
* @summary Get Trigger
|
|
10745
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10746
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10747
|
-
* @param {*} [options] Override http request option.
|
|
10748
|
-
* @throws {RequiredError}
|
|
10749
|
-
*/
|
|
10750
|
-
getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<TriggerObject> {
|
|
10751
|
-
return localVarFp.getTrigger(trigger, cell, options).then((request) => request(axios, basePath));
|
|
10752
|
-
},
|
|
10753
|
-
/**
|
|
10754
|
-
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
10755
|
-
* @summary Update Trigger
|
|
10756
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10757
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10758
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
10759
|
-
* @param {*} [options] Override http request option.
|
|
10760
|
-
* @throws {RequiredError}
|
|
10761
|
-
*/
|
|
10762
|
-
updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): AxiosPromise<TriggerObject> {
|
|
10763
|
-
return localVarFp.updateTrigger(trigger, cell, updateTriggerRequest, options).then((request) => request(axios, basePath));
|
|
10764
|
-
},
|
|
10765
|
-
};
|
|
10766
|
-
};
|
|
10767
|
-
|
|
10768
|
-
/**
|
|
10769
|
-
* ProgramOperatorApi - object-oriented interface
|
|
10770
|
-
* @export
|
|
10771
|
-
* @class ProgramOperatorApi
|
|
10772
|
-
* @extends {BaseAPI}
|
|
10773
|
-
*/
|
|
10774
|
-
export class ProgramOperatorApi extends BaseAPI {
|
|
10775
|
-
/**
|
|
10776
|
-
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
10777
|
-
* @summary Run Program from Library
|
|
10778
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10779
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
10780
|
-
* @param {*} [options] Override http request option.
|
|
10781
|
-
* @throws {RequiredError}
|
|
10782
|
-
* @memberof ProgramOperatorApi
|
|
10783
|
-
*/
|
|
10784
|
-
public createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) {
|
|
10785
|
-
return ProgramOperatorApiFp(this.configuration).createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10786
|
-
}
|
|
10787
|
-
|
|
10788
|
-
/**
|
|
10789
|
-
* <!-- 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.
|
|
10790
|
-
* @summary Create Trigger
|
|
10791
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10792
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
10793
|
-
* @param {*} [options] Override http request option.
|
|
10794
|
-
* @throws {RequiredError}
|
|
10795
|
-
* @memberof ProgramOperatorApi
|
|
10796
|
-
*/
|
|
10797
|
-
public createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig) {
|
|
10798
|
-
return ProgramOperatorApiFp(this.configuration).createTrigger(cell, createTriggerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10799
|
-
}
|
|
10800
|
-
|
|
10801
|
-
/**
|
|
10802
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
10803
|
-
* @summary Delete Trigger
|
|
10804
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10805
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10806
|
-
* @param {*} [options] Override http request option.
|
|
10807
|
-
* @throws {RequiredError}
|
|
10808
|
-
* @memberof ProgramOperatorApi
|
|
10809
|
-
*/
|
|
10810
|
-
public deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig) {
|
|
10811
|
-
return ProgramOperatorApiFp(this.configuration).deleteTrigger(trigger, cell, options).then((request) => request(this.axios, this.basePath));
|
|
10812
|
-
}
|
|
10813
|
-
|
|
10814
|
-
/**
|
|
10815
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
10816
|
-
* @summary Get All Program Runs
|
|
10817
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10818
|
-
* @param {string} [state]
|
|
10819
|
-
* @param {*} [options] Override http request option.
|
|
10820
|
-
* @throws {RequiredError}
|
|
10821
|
-
* @memberof ProgramOperatorApi
|
|
10822
|
-
*/
|
|
10823
|
-
public getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig) {
|
|
10824
|
-
return ProgramOperatorApiFp(this.configuration).getAllProgramOperatorRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
|
|
10825
|
-
}
|
|
10826
|
-
|
|
10827
|
-
/**
|
|
10828
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
10829
|
-
* @summary Get All Triggers
|
|
10830
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10831
|
-
* @param {*} [options] Override http request option.
|
|
10832
|
-
* @throws {RequiredError}
|
|
10833
|
-
* @memberof ProgramOperatorApi
|
|
10834
|
-
*/
|
|
10835
|
-
public getAllTriggers(cell: string, options?: RawAxiosRequestConfig) {
|
|
10836
|
-
return ProgramOperatorApiFp(this.configuration).getAllTriggers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
10837
|
-
}
|
|
10838
|
-
|
|
10839
|
-
/**
|
|
10840
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
10841
|
-
* @summary Get Program Run
|
|
10842
|
-
* @param {string} run
|
|
10843
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10844
|
-
* @param {*} [options] Override http request option.
|
|
10845
|
-
* @throws {RequiredError}
|
|
10846
|
-
* @memberof ProgramOperatorApi
|
|
10847
|
-
*/
|
|
10848
|
-
public getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig) {
|
|
10849
|
-
return ProgramOperatorApiFp(this.configuration).getProgramOperatorRun(run, cell, options).then((request) => request(this.axios, this.basePath));
|
|
10850
|
-
}
|
|
10851
|
-
|
|
10852
|
-
/**
|
|
10853
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
10854
|
-
* @summary Get Trigger
|
|
10855
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10856
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10857
|
-
* @param {*} [options] Override http request option.
|
|
10858
|
-
* @throws {RequiredError}
|
|
10859
|
-
* @memberof ProgramOperatorApi
|
|
10860
|
-
*/
|
|
10861
|
-
public getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig) {
|
|
10862
|
-
return ProgramOperatorApiFp(this.configuration).getTrigger(trigger, cell, options).then((request) => request(this.axios, this.basePath));
|
|
10863
|
-
}
|
|
10864
|
-
|
|
10865
|
-
/**
|
|
10866
|
-
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
10867
|
-
* @summary Update Trigger
|
|
10868
|
-
* @param {string} trigger The identifier of the trigger.
|
|
10869
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10870
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
10871
|
-
* @param {*} [options] Override http request option.
|
|
10872
|
-
* @throws {RequiredError}
|
|
10873
|
-
* @memberof ProgramOperatorApi
|
|
10874
|
-
*/
|
|
10875
|
-
public updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig) {
|
|
10876
|
-
return ProgramOperatorApiFp(this.configuration).updateTrigger(trigger, cell, updateTriggerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10877
|
-
}
|
|
10878
|
-
}
|
|
10879
|
-
|
|
10880
|
-
|
|
10881
|
-
|
|
10882
9896
|
/**
|
|
10883
9897
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
10884
9898
|
* @export
|