@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/v2/api.d.ts CHANGED
@@ -912,76 +912,6 @@ export interface CoordinateSystems {
912
912
  */
913
913
  'coordinate_systems': Array<CoordinateSystem>;
914
914
  }
915
- /**
916
- *
917
- * @export
918
- * @interface CreateProgramOperatorRun200Response
919
- */
920
- export interface CreateProgramOperatorRun200Response {
921
- /**
922
- * The identifier of the program run for further inspection of the running program.
923
- * @type {string}
924
- * @memberof CreateProgramOperatorRun200Response
925
- */
926
- 'id'?: string;
927
- }
928
- /**
929
- *
930
- * @export
931
- * @interface CreateProgramOperatorRunRequest
932
- */
933
- export interface CreateProgramOperatorRunRequest {
934
- /**
935
- * The identifier of the program stored in the program library.
936
- * @type {string}
937
- * @memberof CreateProgramOperatorRunRequest
938
- */
939
- 'program_id': string;
940
- }
941
- /**
942
- *
943
- * @export
944
- * @interface CreateTrigger200Response
945
- */
946
- export interface CreateTrigger200Response {
947
- /**
948
- * The identifier of the created trigger.
949
- * @type {string}
950
- * @memberof CreateTrigger200Response
951
- */
952
- 'id'?: string;
953
- }
954
- /**
955
- *
956
- * @export
957
- * @interface CreateTriggerRequest
958
- */
959
- export interface CreateTriggerRequest {
960
- /**
961
- * The identifier of the program to run when the trigger condition is met.
962
- * @type {string}
963
- * @memberof CreateTriggerRequest
964
- */
965
- 'program_id': string;
966
- /**
967
- * Indicated whether the trigger is enabled or not.
968
- * @type {boolean}
969
- * @memberof CreateTriggerRequest
970
- */
971
- 'enabled': boolean;
972
- /**
973
- *
974
- * @type {TriggerType}
975
- * @memberof CreateTriggerRequest
976
- */
977
- 'type': TriggerType;
978
- /**
979
- *
980
- * @type {OpcuaNodeValueTriggerConfig}
981
- * @memberof CreateTriggerRequest
982
- */
983
- 'config'?: OpcuaNodeValueTriggerConfig;
984
- }
985
915
  /**
986
916
  *
987
917
  * @export
@@ -1348,32 +1278,6 @@ export declare const FloatValueValueTypeEnum: {
1348
1278
  readonly Float: "float";
1349
1279
  };
1350
1280
  export type FloatValueValueTypeEnum = typeof FloatValueValueTypeEnum[keyof typeof FloatValueValueTypeEnum];
1351
- /**
1352
- *
1353
- * @export
1354
- * @interface GetAllProgramOperatorRuns200Response
1355
- */
1356
- export interface GetAllProgramOperatorRuns200Response {
1357
- /**
1358
- *
1359
- * @type {Array<ProgramRunObject>}
1360
- * @memberof GetAllProgramOperatorRuns200Response
1361
- */
1362
- 'program_runs'?: Array<ProgramRunObject>;
1363
- }
1364
- /**
1365
- *
1366
- * @export
1367
- * @interface GetAllTriggers200Response
1368
- */
1369
- export interface GetAllTriggers200Response {
1370
- /**
1371
- *
1372
- * @type {Array<TriggerObject>}
1373
- * @memberof GetAllTriggers200Response
1374
- */
1375
- 'triggers'?: Array<TriggerObject>;
1376
- }
1377
1281
  /**
1378
1282
  *
1379
1283
  * @export
@@ -1910,7 +1814,7 @@ export interface InvalidDofInvalidDof {
1910
1814
  */
1911
1815
  export interface InverseKinematicsRequest {
1912
1816
  /**
1913
- * The data to assemble the robot setup can be retrieved from [getPlanningParameters](getPlanningParameters) endpoint.
1817
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
1914
1818
  * @type {RobotSetup}
1915
1819
  * @memberof InverseKinematicsRequest
1916
1820
  */
@@ -2482,6 +2386,85 @@ export interface MotionGroupBehaviorGetter {
2482
2386
  */
2483
2387
  'behavior': Behavior;
2484
2388
  }
2389
+ /**
2390
+ * The configuration of a motion-group used for motion planning.
2391
+ * @export
2392
+ * @interface MotionGroupDescription
2393
+ */
2394
+ export interface MotionGroupDescription {
2395
+ /**
2396
+ * String identifiying the model of a motion group.
2397
+ * @type {string}
2398
+ * @memberof MotionGroupDescription
2399
+ */
2400
+ 'motion_group_type': string;
2401
+ /**
2402
+ * The offset from the world frame to the motion group base.
2403
+ * @type {Pose}
2404
+ * @memberof MotionGroupDescription
2405
+ */
2406
+ 'mounting': Pose;
2407
+ /**
2408
+ * Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
2409
+ * @type {{ [key: string]: TcpOffset; }}
2410
+ * @memberof MotionGroupDescription
2411
+ */
2412
+ 'tcps': {
2413
+ [key: string]: TcpOffset;
2414
+ };
2415
+ /**
2416
+ * A collection of identifiable colliders.
2417
+ * @type {{ [key: string]: Collider; }}
2418
+ * @memberof MotionGroupDescription
2419
+ */
2420
+ 'safety_zones'?: {
2421
+ [key: string]: Collider;
2422
+ };
2423
+ /**
2424
+ * 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.
2425
+ * @type {Array<{ [key: string]: Collider; }>}
2426
+ * @memberof MotionGroupDescription
2427
+ */
2428
+ 'safety_link_colliders'?: Array<{
2429
+ [key: string]: Collider;
2430
+ }>;
2431
+ /**
2432
+ * 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.
2433
+ * @type {{ [key: string]: { [key: string]: Collider; }; }}
2434
+ * @memberof MotionGroupDescription
2435
+ */
2436
+ 'safety_tool_colliders'?: {
2437
+ [key: string]: {
2438
+ [key: string]: Collider;
2439
+ };
2440
+ };
2441
+ /**
2442
+ *
2443
+ * @type {PlanningLimits}
2444
+ * @memberof MotionGroupDescription
2445
+ */
2446
+ 'global_limits': PlanningLimits;
2447
+ /**
2448
+ * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
2449
+ * @type {{ [key: string]: Payload; }}
2450
+ * @memberof MotionGroupDescription
2451
+ */
2452
+ 'payloads'?: {
2453
+ [key: string]: Payload;
2454
+ };
2455
+ /**
2456
+ * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
2457
+ * @type {number}
2458
+ * @memberof MotionGroupDescription
2459
+ */
2460
+ 'cycle_time'?: number;
2461
+ /**
2462
+ * The DH parameters describing the motion group geometry, starting from base.
2463
+ * @type {Array<DHParameter>}
2464
+ * @memberof MotionGroupDescription
2465
+ */
2466
+ 'dh_parameters'?: Array<DHParameter>;
2467
+ }
2485
2468
  /**
2486
2469
  *
2487
2470
  * @export
@@ -2948,37 +2931,6 @@ export interface OpMode {
2948
2931
  */
2949
2932
  'mode': OperationMode;
2950
2933
  }
2951
- /**
2952
- * 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.
2953
- * @export
2954
- * @interface OpcuaNodeValueTriggerConfig
2955
- */
2956
- export interface OpcuaNodeValueTriggerConfig {
2957
- /**
2958
- * Url of the OPC UA server.
2959
- * @type {string}
2960
- * @memberof OpcuaNodeValueTriggerConfig
2961
- */
2962
- 'host': string;
2963
- /**
2964
- * Identifier of the OPC UA node to monitor.
2965
- * @type {string}
2966
- * @memberof OpcuaNodeValueTriggerConfig
2967
- */
2968
- 'node_id': string;
2969
- /**
2970
- *
2971
- * @type {OpcuaNodeValueTriggerConfigNodeValue}
2972
- * @memberof OpcuaNodeValueTriggerConfig
2973
- */
2974
- 'node_value': OpcuaNodeValueTriggerConfigNodeValue;
2975
- }
2976
- /**
2977
- * @type OpcuaNodeValueTriggerConfigNodeValue
2978
- * Value to trigger the program when matched.
2979
- * @export
2980
- */
2981
- export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
2982
2934
  /**
2983
2935
  * The operating state.
2984
2936
  * @export
@@ -3304,7 +3256,7 @@ export type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | Feed
3304
3256
  */
3305
3257
  export interface PlanTrajectoryRequest {
3306
3258
  /**
3307
- * The data to assemble the robot setup can be retrieved from [getPlanningParameters](getPlanningParameters) endpoint.
3259
+ * The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
3308
3260
  * @type {RobotSetup}
3309
3261
  * @memberof PlanTrajectoryRequest
3310
3262
  */
@@ -3455,85 +3407,6 @@ export interface PlanningLimitsLimitRange {
3455
3407
  */
3456
3408
  'upper_limit': number;
3457
3409
  }
3458
- /**
3459
- * The configuration of a motion-group used for motion planning.
3460
- * @export
3461
- * @interface PlanningParameters
3462
- */
3463
- export interface PlanningParameters {
3464
- /**
3465
- * String identifiying the model of a motion group.
3466
- * @type {string}
3467
- * @memberof PlanningParameters
3468
- */
3469
- 'motion_group_type': string;
3470
- /**
3471
- * The offset from the world frame to the motion group base.
3472
- * @type {Pose}
3473
- * @memberof PlanningParameters
3474
- */
3475
- 'mounting': Pose;
3476
- /**
3477
- * Maps a TCP name to its offset relative to the flange coordinate system. Key must be a TCP identifier. Values are TcpOffsets.
3478
- * @type {{ [key: string]: TcpOffset; }}
3479
- * @memberof PlanningParameters
3480
- */
3481
- 'tcps': {
3482
- [key: string]: TcpOffset;
3483
- };
3484
- /**
3485
- * A collection of identifiable colliders.
3486
- * @type {{ [key: string]: Collider; }}
3487
- * @memberof PlanningParameters
3488
- */
3489
- 'safety_zones'?: {
3490
- [key: string]: Collider;
3491
- };
3492
- /**
3493
- * 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.
3494
- * @type {Array<{ [key: string]: Collider; }>}
3495
- * @memberof PlanningParameters
3496
- */
3497
- 'safety_link_colliders'?: Array<{
3498
- [key: string]: Collider;
3499
- }>;
3500
- /**
3501
- * 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.
3502
- * @type {{ [key: string]: { [key: string]: Collider; }; }}
3503
- * @memberof PlanningParameters
3504
- */
3505
- 'safety_tool_colliders'?: {
3506
- [key: string]: {
3507
- [key: string]: Collider;
3508
- };
3509
- };
3510
- /**
3511
- *
3512
- * @type {PlanningLimits}
3513
- * @memberof PlanningParameters
3514
- */
3515
- 'global_limits': PlanningLimits;
3516
- /**
3517
- * Maps a payload name to its configuration. Key must be a payload identifier. Values are payload objects.
3518
- * @type {{ [key: string]: Payload; }}
3519
- * @memberof PlanningParameters
3520
- */
3521
- 'payloads'?: {
3522
- [key: string]: Payload;
3523
- };
3524
- /**
3525
- * [ms] cycle time of the motion group controller. A trajectory for this motion group should be computed to this resolution.
3526
- * @type {number}
3527
- * @memberof PlanningParameters
3528
- */
3529
- 'cycle_time'?: number;
3530
- /**
3531
- * The DH parameters describing the motion group geometry, starting from base.
3532
- * @type {Array<DHParameter>}
3533
- * @memberof PlanningParameters
3534
- */
3535
- 'dh_parameters'?: Array<DHParameter>;
3536
- }
3537
3410
  /**
3538
3411
  * Sets velocity for executed movements of the motion, in percent. Send after initializing the connection with InitializeMovementRequest.
3539
3412
  * @export
@@ -3699,49 +3572,6 @@ export interface ProgramRun {
3699
3572
  */
3700
3573
  'result'?: object;
3701
3574
  }
3702
- /**
3703
- *
3704
- * @export
3705
- * @interface ProgramRunObject
3706
- */
3707
- export interface ProgramRunObject {
3708
- /**
3709
- * The identifier of the program run.
3710
- * @type {string}
3711
- * @memberof ProgramRunObject
3712
- */
3713
- 'id': string;
3714
- /**
3715
- * The identifier of the program stored in the program library.
3716
- * @type {string}
3717
- * @memberof ProgramRunObject
3718
- */
3719
- 'program_id': string;
3720
- /**
3721
- * The status of the program run which shows which state the program run is currently is in.
3722
- * @type {string}
3723
- * @memberof ProgramRunObject
3724
- */
3725
- 'status': string;
3726
- /**
3727
- * The output of the program run, which provides the output generate while running the program.
3728
- * @type {string}
3729
- * @memberof ProgramRunObject
3730
- */
3731
- 'program_output'?: string;
3732
- /**
3733
- * ISO 8601 date-time format when the program run was created.
3734
- * @type {string}
3735
- * @memberof ProgramRunObject
3736
- */
3737
- 'created_at': string;
3738
- /**
3739
- * ISO 8601 date-time format when the program run was last updated.
3740
- * @type {string}
3741
- * @memberof ProgramRunObject
3742
- */
3743
- 'last_updated_at': string;
3744
- }
3745
3575
  /**
3746
3576
  * Reference to an executed program.
3747
3577
  * @export
@@ -4588,70 +4418,6 @@ export declare const TrajectoryIdMessageTypeEnum: {
4588
4418
  readonly TrajectoryId: "TrajectoryId";
4589
4419
  };
4590
4420
  export type TrajectoryIdMessageTypeEnum = typeof TrajectoryIdMessageTypeEnum[keyof typeof TrajectoryIdMessageTypeEnum];
4591
- /**
4592
- *
4593
- * @export
4594
- * @interface TriggerObject
4595
- */
4596
- export interface TriggerObject {
4597
- /**
4598
- * The identifier of the trigger.
4599
- * @type {string}
4600
- * @memberof TriggerObject
4601
- */
4602
- 'id'?: string;
4603
- /**
4604
- * The identifier of the program to run when the trigger condition is met.
4605
- * @type {string}
4606
- * @memberof TriggerObject
4607
- */
4608
- 'program_id': string;
4609
- /**
4610
- * Indicates whether the trigger is enabled or not.
4611
- * @type {boolean}
4612
- * @memberof TriggerObject
4613
- */
4614
- 'enabled': boolean;
4615
- /**
4616
- *
4617
- * @type {TriggerType}
4618
- * @memberof TriggerObject
4619
- */
4620
- 'type': TriggerType;
4621
- /**
4622
- *
4623
- * @type {OpcuaNodeValueTriggerConfig}
4624
- * @memberof TriggerObject
4625
- */
4626
- 'config': OpcuaNodeValueTriggerConfig;
4627
- /**
4628
- * ISO 8601 date-time format when the trigger was created.
4629
- * @type {string}
4630
- * @memberof TriggerObject
4631
- */
4632
- 'created_at': string;
4633
- /**
4634
- * ISO 8601 date-time format when the trigger was last updated.
4635
- * @type {string}
4636
- * @memberof TriggerObject
4637
- */
4638
- 'last_updated_at': string;
4639
- /**
4640
- * The program runs that were triggered by this trigger.
4641
- * @type {Array<string>}
4642
- * @memberof TriggerObject
4643
- */
4644
- 'program_runs'?: Array<string>;
4645
- }
4646
- /**
4647
- * The type of the trigger.
4648
- * @export
4649
- * @enum {string}
4650
- */
4651
- export declare const TriggerType: {
4652
- readonly OpcuaNodeValue: "opcua_node_value";
4653
- };
4654
- export type TriggerType = typeof TriggerType[keyof typeof TriggerType];
4655
4421
  /**
4656
4422
  * The unit of input/output value.
4657
4423
  * @export
@@ -4706,31 +4472,6 @@ export interface UpdateNovaVersionRequest {
4706
4472
  */
4707
4473
  'channel': ReleaseChannel;
4708
4474
  }
4709
- /**
4710
- *
4711
- * @export
4712
- * @interface UpdateTriggerRequest
4713
- */
4714
- export interface UpdateTriggerRequest {
4715
- /**
4716
- * The identifier of the program to run when the trigger condition is met.
4717
- * @type {string}
4718
- * @memberof UpdateTriggerRequest
4719
- */
4720
- 'program_id'?: string;
4721
- /**
4722
- * Whether the trigger is enabled or not.
4723
- * @type {boolean}
4724
- * @memberof UpdateTriggerRequest
4725
- */
4726
- 'enabled'?: boolean;
4727
- /**
4728
- *
4729
- * @type {OpcuaNodeValueTriggerConfig}
4730
- * @memberof UpdateTriggerRequest
4731
- */
4732
- 'config'?: OpcuaNodeValueTriggerConfig;
4733
- }
4734
4475
  /**
4735
4476
  *
4736
4477
  * @export
@@ -6835,14 +6576,14 @@ export declare const MotionGroupApiAxiosParamCreator: (configuration?: Configura
6835
6576
  */
6836
6577
  getCurrentMotionGroupState: (cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6837
6578
  /**
6838
- * Get the complete set of parameters that can be passed to the motion-planner (incl. safety zones, limits etc.).
6839
- * @summary Planning Parameters
6579
+ * 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.
6580
+ * @summary Description
6840
6581
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6841
6582
  * @param {string} motionGroup The motion-group identifier.
6842
6583
  * @param {*} [options] Override http request option.
6843
6584
  * @throws {RequiredError}
6844
6585
  */
6845
- getPlanningParameters: (cell: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6586
+ getMotionGroupDescription: (cell: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6846
6587
  /**
6847
6588
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6848
6589
  * @summary Stream State
@@ -6871,14 +6612,14 @@ export declare const MotionGroupApiFp: (configuration?: Configuration) => {
6871
6612
  */
6872
6613
  getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupState>>;
6873
6614
  /**
6874
- * Get the complete set of parameters that can be passed to the motion-planner (incl. safety zones, limits etc.).
6875
- * @summary Planning Parameters
6615
+ * 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.
6616
+ * @summary Description
6876
6617
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6877
6618
  * @param {string} motionGroup The motion-group identifier.
6878
6619
  * @param {*} [options] Override http request option.
6879
6620
  * @throws {RequiredError}
6880
6621
  */
6881
- getPlanningParameters(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanningParameters>>;
6622
+ getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionGroupDescription>>;
6882
6623
  /**
6883
6624
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6884
6625
  * @summary Stream State
@@ -6907,14 +6648,14 @@ export declare const MotionGroupApiFactory: (configuration?: Configuration, base
6907
6648
  */
6908
6649
  getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupState>;
6909
6650
  /**
6910
- * Get the complete set of parameters that can be passed to the motion-planner (incl. safety zones, limits etc.).
6911
- * @summary Planning Parameters
6651
+ * 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.
6652
+ * @summary Description
6912
6653
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6913
6654
  * @param {string} motionGroup The motion-group identifier.
6914
6655
  * @param {*} [options] Override http request option.
6915
6656
  * @throws {RequiredError}
6916
6657
  */
6917
- getPlanningParameters(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<PlanningParameters>;
6658
+ getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionGroupDescription>;
6918
6659
  /**
6919
6660
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6920
6661
  * @summary Stream State
@@ -6946,15 +6687,15 @@ export declare class MotionGroupApi extends BaseAPI {
6946
6687
  */
6947
6688
  getCurrentMotionGroupState(cell: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
6948
6689
  /**
6949
- * Get the complete set of parameters that can be passed to the motion-planner (incl. safety zones, limits etc.).
6950
- * @summary Planning Parameters
6690
+ * 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.
6691
+ * @summary Description
6951
6692
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6952
6693
  * @param {string} motionGroup The motion-group identifier.
6953
6694
  * @param {*} [options] Override http request option.
6954
6695
  * @throws {RequiredError}
6955
6696
  * @memberof MotionGroupApi
6956
6697
  */
6957
- getPlanningParameters(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlanningParameters, any>>;
6698
+ getMotionGroupDescription(cell: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupDescription, any>>;
6958
6699
  /**
6959
6700
  * <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
6960
6701
  * @summary Stream State
@@ -7282,328 +7023,6 @@ export declare class ProgramApi extends BaseAPI {
7282
7023
  */
7283
7024
  validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7284
7025
  }
7285
- /**
7286
- * ProgramOperatorApi - axios parameter creator
7287
- * @export
7288
- */
7289
- export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Configuration) => {
7290
- /**
7291
- * <!-- 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.
7292
- * @summary Run Program from Library
7293
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7294
- * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
7295
- * @param {*} [options] Override http request option.
7296
- * @throws {RequiredError}
7297
- */
7298
- createProgramOperatorRun: (cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7299
- /**
7300
- * <!-- 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.
7301
- * @summary Create Trigger
7302
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7303
- * @param {CreateTriggerRequest} createTriggerRequest
7304
- * @param {*} [options] Override http request option.
7305
- * @throws {RequiredError}
7306
- */
7307
- createTrigger: (cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7308
- /**
7309
- * <!-- theme: danger --> > **Experimental** Delete an existing trigger.
7310
- * @summary Delete Trigger
7311
- * @param {string} trigger The identifier of the trigger.
7312
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7313
- * @param {*} [options] Override http request option.
7314
- * @throws {RequiredError}
7315
- */
7316
- deleteTrigger: (trigger: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7317
- /**
7318
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
7319
- * @summary Get All Program Runs
7320
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7321
- * @param {string} [state]
7322
- * @param {*} [options] Override http request option.
7323
- * @throws {RequiredError}
7324
- */
7325
- getAllProgramOperatorRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7326
- /**
7327
- * <!-- 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.
7328
- * @summary Get All Triggers
7329
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7330
- * @param {*} [options] Override http request option.
7331
- * @throws {RequiredError}
7332
- */
7333
- getAllTriggers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7334
- /**
7335
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
7336
- * @summary Get Program Run
7337
- * @param {string} run
7338
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7339
- * @param {*} [options] Override http request option.
7340
- * @throws {RequiredError}
7341
- */
7342
- getProgramOperatorRun: (run: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7343
- /**
7344
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
7345
- * @summary Get Trigger
7346
- * @param {string} trigger The identifier of the trigger.
7347
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7348
- * @param {*} [options] Override http request option.
7349
- * @throws {RequiredError}
7350
- */
7351
- getTrigger: (trigger: string, cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7352
- /**
7353
- * <!-- 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.
7354
- * @summary Update Trigger
7355
- * @param {string} trigger The identifier of the trigger.
7356
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7357
- * @param {UpdateTriggerRequest} updateTriggerRequest
7358
- * @param {*} [options] Override http request option.
7359
- * @throws {RequiredError}
7360
- */
7361
- updateTrigger: (trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7362
- };
7363
- /**
7364
- * ProgramOperatorApi - functional programming interface
7365
- * @export
7366
- */
7367
- export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
7368
- /**
7369
- * <!-- 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.
7370
- * @summary Run Program from Library
7371
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7372
- * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
7373
- * @param {*} [options] Override http request option.
7374
- * @throws {RequiredError}
7375
- */
7376
- createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProgramOperatorRun200Response>>;
7377
- /**
7378
- * <!-- 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.
7379
- * @summary Create Trigger
7380
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7381
- * @param {CreateTriggerRequest} createTriggerRequest
7382
- * @param {*} [options] Override http request option.
7383
- * @throws {RequiredError}
7384
- */
7385
- createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTrigger200Response>>;
7386
- /**
7387
- * <!-- theme: danger --> > **Experimental** Delete an existing trigger.
7388
- * @summary Delete Trigger
7389
- * @param {string} trigger The identifier of the trigger.
7390
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7391
- * @param {*} [options] Override http request option.
7392
- * @throws {RequiredError}
7393
- */
7394
- deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7395
- /**
7396
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
7397
- * @summary Get All Program Runs
7398
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7399
- * @param {string} [state]
7400
- * @param {*} [options] Override http request option.
7401
- * @throws {RequiredError}
7402
- */
7403
- getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>>;
7404
- /**
7405
- * <!-- 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.
7406
- * @summary Get All Triggers
7407
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7408
- * @param {*} [options] Override http request option.
7409
- * @throws {RequiredError}
7410
- */
7411
- getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllTriggers200Response>>;
7412
- /**
7413
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
7414
- * @summary Get Program Run
7415
- * @param {string} run
7416
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7417
- * @param {*} [options] Override http request option.
7418
- * @throws {RequiredError}
7419
- */
7420
- getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunObject>>;
7421
- /**
7422
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
7423
- * @summary Get Trigger
7424
- * @param {string} trigger The identifier of the trigger.
7425
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7426
- * @param {*} [options] Override http request option.
7427
- * @throws {RequiredError}
7428
- */
7429
- getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerObject>>;
7430
- /**
7431
- * <!-- 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.
7432
- * @summary Update Trigger
7433
- * @param {string} trigger The identifier of the trigger.
7434
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7435
- * @param {UpdateTriggerRequest} updateTriggerRequest
7436
- * @param {*} [options] Override http request option.
7437
- * @throws {RequiredError}
7438
- */
7439
- updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerObject>>;
7440
- };
7441
- /**
7442
- * ProgramOperatorApi - factory interface
7443
- * @export
7444
- */
7445
- export declare const ProgramOperatorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7446
- /**
7447
- * <!-- 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.
7448
- * @summary Run Program from Library
7449
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7450
- * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
7451
- * @param {*} [options] Override http request option.
7452
- * @throws {RequiredError}
7453
- */
7454
- createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateProgramOperatorRun200Response>;
7455
- /**
7456
- * <!-- 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.
7457
- * @summary Create Trigger
7458
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7459
- * @param {CreateTriggerRequest} createTriggerRequest
7460
- * @param {*} [options] Override http request option.
7461
- * @throws {RequiredError}
7462
- */
7463
- createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateTrigger200Response>;
7464
- /**
7465
- * <!-- theme: danger --> > **Experimental** Delete an existing trigger.
7466
- * @summary Delete Trigger
7467
- * @param {string} trigger The identifier of the trigger.
7468
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7469
- * @param {*} [options] Override http request option.
7470
- * @throws {RequiredError}
7471
- */
7472
- deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7473
- /**
7474
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
7475
- * @summary Get All Program Runs
7476
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7477
- * @param {string} [state]
7478
- * @param {*} [options] Override http request option.
7479
- * @throws {RequiredError}
7480
- */
7481
- getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response>;
7482
- /**
7483
- * <!-- 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.
7484
- * @summary Get All Triggers
7485
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7486
- * @param {*} [options] Override http request option.
7487
- * @throws {RequiredError}
7488
- */
7489
- getAllTriggers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllTriggers200Response>;
7490
- /**
7491
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
7492
- * @summary Get Program Run
7493
- * @param {string} run
7494
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7495
- * @param {*} [options] Override http request option.
7496
- * @throws {RequiredError}
7497
- */
7498
- getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunObject>;
7499
- /**
7500
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
7501
- * @summary Get Trigger
7502
- * @param {string} trigger The identifier of the trigger.
7503
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7504
- * @param {*} [options] Override http request option.
7505
- * @throws {RequiredError}
7506
- */
7507
- getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): AxiosPromise<TriggerObject>;
7508
- /**
7509
- * <!-- 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.
7510
- * @summary Update Trigger
7511
- * @param {string} trigger The identifier of the trigger.
7512
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7513
- * @param {UpdateTriggerRequest} updateTriggerRequest
7514
- * @param {*} [options] Override http request option.
7515
- * @throws {RequiredError}
7516
- */
7517
- updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): AxiosPromise<TriggerObject>;
7518
- };
7519
- /**
7520
- * ProgramOperatorApi - object-oriented interface
7521
- * @export
7522
- * @class ProgramOperatorApi
7523
- * @extends {BaseAPI}
7524
- */
7525
- export declare class ProgramOperatorApi extends BaseAPI {
7526
- /**
7527
- * <!-- 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.
7528
- * @summary Run Program from Library
7529
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7530
- * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
7531
- * @param {*} [options] Override http request option.
7532
- * @throws {RequiredError}
7533
- * @memberof ProgramOperatorApi
7534
- */
7535
- createProgramOperatorRun(cell: string, createProgramOperatorRunRequest: CreateProgramOperatorRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProgramOperatorRun200Response, any>>;
7536
- /**
7537
- * <!-- 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.
7538
- * @summary Create Trigger
7539
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7540
- * @param {CreateTriggerRequest} createTriggerRequest
7541
- * @param {*} [options] Override http request option.
7542
- * @throws {RequiredError}
7543
- * @memberof ProgramOperatorApi
7544
- */
7545
- createTrigger(cell: string, createTriggerRequest: CreateTriggerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTrigger200Response, any>>;
7546
- /**
7547
- * <!-- theme: danger --> > **Experimental** Delete an existing trigger.
7548
- * @summary Delete Trigger
7549
- * @param {string} trigger The identifier of the trigger.
7550
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7551
- * @param {*} [options] Override http request option.
7552
- * @throws {RequiredError}
7553
- * @memberof ProgramOperatorApi
7554
- */
7555
- deleteTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7556
- /**
7557
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
7558
- * @summary Get All Program Runs
7559
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7560
- * @param {string} [state]
7561
- * @param {*} [options] Override http request option.
7562
- * @throws {RequiredError}
7563
- * @memberof ProgramOperatorApi
7564
- */
7565
- getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramOperatorRuns200Response, any>>;
7566
- /**
7567
- * <!-- 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.
7568
- * @summary Get All Triggers
7569
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7570
- * @param {*} [options] Override http request option.
7571
- * @throws {RequiredError}
7572
- * @memberof ProgramOperatorApi
7573
- */
7574
- getAllTriggers(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllTriggers200Response, any>>;
7575
- /**
7576
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
7577
- * @summary Get Program Run
7578
- * @param {string} run
7579
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7580
- * @param {*} [options] Override http request option.
7581
- * @throws {RequiredError}
7582
- * @memberof ProgramOperatorApi
7583
- */
7584
- getProgramOperatorRun(run: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunObject, any>>;
7585
- /**
7586
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
7587
- * @summary Get Trigger
7588
- * @param {string} trigger The identifier of the trigger.
7589
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7590
- * @param {*} [options] Override http request option.
7591
- * @throws {RequiredError}
7592
- * @memberof ProgramOperatorApi
7593
- */
7594
- getTrigger(trigger: string, cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerObject, any>>;
7595
- /**
7596
- * <!-- 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.
7597
- * @summary Update Trigger
7598
- * @param {string} trigger The identifier of the trigger.
7599
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7600
- * @param {UpdateTriggerRequest} updateTriggerRequest
7601
- * @param {*} [options] Override http request option.
7602
- * @throws {RequiredError}
7603
- * @memberof ProgramOperatorApi
7604
- */
7605
- updateTrigger(trigger: string, cell: string, updateTriggerRequest: UpdateTriggerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerObject, any>>;
7606
- }
7607
7026
  /**
7608
7027
  * StoreCollisionComponentsApi - axios parameter creator
7609
7028
  * @export