@wandelbots/nova-api 25.6.0-dev.41 → 25.6.0-dev.42

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.
Files changed (5) hide show
  1. package/package.json +1 -1
  2. package/v2/api.d.ts +39 -775
  3. package/v2/api.js +933 -1929
  4. package/v2/api.js.map +1 -1
  5. package/v2/api.ts +879 -2223
package/v2/api.d.ts CHANGED
@@ -688,7 +688,13 @@ export type Comparator = typeof Comparator[keyof typeof Comparator];
688
688
  * Result of a backup operation.
689
689
  * @export
690
690
  */
691
- export type ConfigurationArchiveStatus = ConfigurationArchiveStatusCreating | ConfigurationArchiveStatusError | ConfigurationArchiveStatusSuccess;
691
+ export type ConfigurationArchiveStatus = {
692
+ status: 'creating';
693
+ } & ConfigurationArchiveStatusCreating | {
694
+ status: 'error';
695
+ } & ConfigurationArchiveStatusError | {
696
+ status: 'success';
697
+ } & ConfigurationArchiveStatusSuccess;
692
698
  /**
693
699
  *
694
700
  * @export
@@ -1394,19 +1400,6 @@ export interface HTTPValidationError {
1394
1400
  */
1395
1401
  'detail'?: Array<ValidationError>;
1396
1402
  }
1397
- /**
1398
- *
1399
- * @export
1400
- * @interface HTTPValidationError2
1401
- */
1402
- export interface HTTPValidationError2 {
1403
- /**
1404
- *
1405
- * @type {Array<ValidationError2>}
1406
- * @memberof HTTPValidationError2
1407
- */
1408
- 'detail'?: Array<ValidationError2>;
1409
- }
1410
1403
  /**
1411
1404
  * Input/Output boolean value representation.
1412
1405
  * @export
@@ -2706,31 +2699,6 @@ export interface MotionGroupStateJointLimitReached {
2706
2699
  */
2707
2700
  'limit_reached': Array<boolean>;
2708
2701
  }
2709
- /**
2710
- * Collection of information on the current state of the robot.
2711
- * @export
2712
- * @interface MotionState
2713
- */
2714
- export interface MotionState {
2715
- /**
2716
- * Unique identifier of the motion group that executed the program
2717
- * @type {string}
2718
- * @memberof MotionState
2719
- */
2720
- 'motion_group_id'?: string;
2721
- /**
2722
- * Parameters of the path that was executed
2723
- * @type {number}
2724
- * @memberof MotionState
2725
- */
2726
- 'path_parameters'?: number;
2727
- /**
2728
- *
2729
- * @type {RobotState}
2730
- * @memberof MotionState
2731
- */
2732
- 'state': RobotState;
2733
- }
2734
2702
  /**
2735
2703
  * Error message in case an error occurs during movement execution.
2736
2704
  * @export
@@ -3389,166 +3357,6 @@ export interface Pose {
3389
3357
  */
3390
3358
  'orientation'?: Array<number>;
3391
3359
  }
3392
- /**
3393
- * A program is a collection of instructions that are executed in the robot cell.
3394
- * @export
3395
- * @interface Program
3396
- */
3397
- export interface Program {
3398
- /**
3399
- *
3400
- * @type {string}
3401
- * @memberof Program
3402
- */
3403
- 'content': string;
3404
- /**
3405
- * Defines the program type, e.g. Python and Wandelscript.
3406
- * @type {string}
3407
- * @memberof Program
3408
- */
3409
- 'program_type': ProgramProgramTypeEnum;
3410
- }
3411
- export declare const ProgramProgramTypeEnum: {
3412
- readonly Python: "PYTHON";
3413
- readonly Wandelscript: "WANDELSCRIPT";
3414
- };
3415
- export type ProgramProgramTypeEnum = typeof ProgramProgramTypeEnum[keyof typeof ProgramProgramTypeEnum];
3416
- /**
3417
- * Holds the state of a program run.
3418
- * @export
3419
- * @interface ProgramRun
3420
- */
3421
- export interface ProgramRun {
3422
- /**
3423
- * Unique identifier of the program run
3424
- * @type {string}
3425
- * @memberof ProgramRun
3426
- */
3427
- 'id': string;
3428
- /**
3429
- * State of the program run
3430
- * @type {ProgramRunState}
3431
- * @memberof ProgramRun
3432
- */
3433
- 'state': ProgramRunState;
3434
- /**
3435
- * Logs of the program run
3436
- * @type {string}
3437
- * @memberof ProgramRun
3438
- */
3439
- 'logs'?: string;
3440
- /**
3441
- * Stdout of the program run
3442
- * @type {string}
3443
- * @memberof ProgramRun
3444
- */
3445
- 'stdout'?: string;
3446
- /**
3447
- * Stderr of the program run
3448
- * @type {string}
3449
- * @memberof ProgramRun
3450
- */
3451
- 'stderr'?: string;
3452
- /**
3453
- * Error message of the program run, if any
3454
- * @type {string}
3455
- * @memberof ProgramRun
3456
- */
3457
- 'error'?: string;
3458
- /**
3459
- * Traceback of the program run, if any
3460
- * @type {string}
3461
- * @memberof ProgramRun
3462
- */
3463
- 'traceback'?: string;
3464
- /**
3465
- * Start time of the program run
3466
- * @type {string}
3467
- * @memberof ProgramRun
3468
- */
3469
- 'start_time'?: string;
3470
- /**
3471
- * End time of the program run
3472
- * @type {string}
3473
- * @memberof ProgramRun
3474
- */
3475
- 'end_time'?: string;
3476
- /**
3477
- * Paths executed by the motion group
3478
- * @type {Array<Array<MotionState>>}
3479
- * @memberof ProgramRun
3480
- */
3481
- 'execution_results'?: Array<Array<MotionState>>;
3482
- /**
3483
- * Result of the executed program. Content depends on the program type.
3484
- * @type {object}
3485
- * @memberof ProgramRun
3486
- */
3487
- 'result'?: object;
3488
- }
3489
- /**
3490
- * Reference to an executed program.
3491
- * @export
3492
- * @interface ProgramRunReference
3493
- */
3494
- export interface ProgramRunReference {
3495
- /**
3496
- *
3497
- * @type {string}
3498
- * @memberof ProgramRunReference
3499
- */
3500
- 'id': string;
3501
- /**
3502
- *
3503
- * @type {ProgramRunState}
3504
- * @memberof ProgramRunReference
3505
- */
3506
- 'state': ProgramRunState;
3507
- }
3508
- /**
3509
- * Request model for running a program
3510
- * @export
3511
- * @interface ProgramRunRequest
3512
- */
3513
- export interface ProgramRunRequest {
3514
- /**
3515
- *
3516
- * @type {Program}
3517
- * @memberof ProgramRunRequest
3518
- */
3519
- 'program': Program;
3520
- /**
3521
- * Identifier of default robot to use for execution
3522
- * @type {string}
3523
- * @memberof ProgramRunRequest
3524
- */
3525
- 'default_robot'?: string;
3526
- /**
3527
- * Identifier of default TCP to use for execution
3528
- * @type {string}
3529
- * @memberof ProgramRunRequest
3530
- */
3531
- 'default_tcp'?: string;
3532
- /**
3533
- * Initial arguments that are available within the program
3534
- * @type {object}
3535
- * @memberof ProgramRunRequest
3536
- */
3537
- 'run_args'?: object;
3538
- }
3539
- /**
3540
- * The state of a program run.
3541
- * @export
3542
- * @enum {string}
3543
- */
3544
- export declare const ProgramRunState: {
3545
- readonly NotStarted: "NOT_STARTED";
3546
- readonly Running: "RUNNING";
3547
- readonly Completed: "COMPLETED";
3548
- readonly Failed: "FAILED";
3549
- readonly Stopped: "STOPPED";
3550
- };
3551
- export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
3552
3360
  /**
3553
3361
  * Defines an x/y-plane with finite size. Centred around the z-axis.
3554
3362
  * @export
@@ -3747,25 +3555,6 @@ export interface RobotSetup {
3747
3555
  [key: string]: SingleMotionGroupCollisionScene;
3748
3556
  };
3749
3557
  }
3750
- /**
3751
- * Collection of information on the current state of the robot.
3752
- * @export
3753
- * @interface RobotState
3754
- */
3755
- export interface RobotState {
3756
- /**
3757
- *
3758
- * @type {Pose}
3759
- * @memberof RobotState
3760
- */
3761
- 'pose': Pose;
3762
- /**
3763
- *
3764
- * @type {Array<number>}
3765
- * @memberof RobotState
3766
- */
3767
- 'joints'?: Array<number>;
3768
- }
3769
3558
  /**
3770
3559
  * The system mode of the robot system. ### ROBOT_SYSTEM_MODE_UNDEFINED Indicates that the robot controller is currently performing a mode transition. ### ROBOT_SYSTEM_MODE_DISCONNECT There is no communication with the robot controller at all. All connections are closed. No command is sent to the robot controller while in this mode. No input/output interaction is possible in this mode! All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_MONITOR A connection to the robot controller is established to only read the robot controller state. No command is sent to the robot controller while in this mode. It is possible to receive input/output information. All move requests will be rejected in this mode! ### ROBOT_SYSTEM_MODE_CONTROL An active connection is established with the robot controller and the robot system is cyclic commanded to stay in its actual position. The robot controller state is received in the cycle time of the robot controller. Requests via the MotionService and JoggingService will be processed and executed in this mode. Input/Output interaction is possible in this mode! **In this mode the robot system can be commanded to move.** ### ROBOT_SYSTEM_MODE_FREE_DRIVE Like ROBOT_SYSTEM_MODE_MONITOR a connection to the robot controller is established to only read the robot controller state. The difference is that the motion groups can be moved by the user (Free Drive). Thus, the servo motors are turned on. All move requests will be rejected in this mode! **This mode is not supported by every robot!** Use [getSupportedModes](getSupportedModes) to evaluate if the device support free drive.
3771
3560
  * @export
@@ -4495,31 +4284,6 @@ export interface ValidationError {
4495
4284
  */
4496
4285
  'type': string;
4497
4286
  }
4498
- /**
4499
- * A validation error of a program.
4500
- * @export
4501
- * @interface ValidationError2
4502
- */
4503
- export interface ValidationError2 {
4504
- /**
4505
- *
4506
- * @type {Array<number>}
4507
- * @memberof ValidationError2
4508
- */
4509
- 'loc': Array<number>;
4510
- /**
4511
- *
4512
- * @type {string}
4513
- * @memberof ValidationError2
4514
- */
4515
- 'msg': string;
4516
- /**
4517
- *
4518
- * @type {string}
4519
- * @memberof ValidationError2
4520
- */
4521
- 'type': string;
4522
- }
4523
4287
  /**
4524
4288
  * @type ValidationErrorLocInner
4525
4289
  * @export
@@ -6638,320 +6402,6 @@ export declare class MotionGroupModelsApi extends BaseAPI {
6638
6402
  */
6639
6403
  getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
6640
6404
  }
6641
- /**
6642
- * ProgramApi - axios parameter creator
6643
- * @export
6644
- */
6645
- export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
6646
- /**
6647
- * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
6648
- * @summary Create program run
6649
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6650
- * @param {ProgramRunRequest} programRunRequest
6651
- * @param {*} [options] Override http request option.
6652
- * @throws {RequiredError}
6653
- */
6654
- createProgramRun: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6655
- /**
6656
- * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
6657
- * @summary Execute program
6658
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6659
- * @param {ProgramRunRequest} programRunRequest
6660
- * @param {*} [options] Override http request option.
6661
- * @throws {RequiredError}
6662
- */
6663
- executeProgram: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6664
- /**
6665
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
6666
- * @summary Get program run
6667
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6668
- * @param {string} run
6669
- * @param {*} [options] Override http request option.
6670
- * @throws {RequiredError}
6671
- */
6672
- getProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6673
- /**
6674
- * Get details about all existing runs
6675
- * @summary List programs
6676
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6677
- * @param {*} [options] Override http request option.
6678
- * @throws {RequiredError}
6679
- */
6680
- getProgramRuns: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6681
- /**
6682
- * Simulate a program given as text/plain
6683
- * @summary Simulate program
6684
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6685
- * @param {ProgramRunRequest} programRunRequest
6686
- * @param {*} [options] Override http request option.
6687
- * @throws {RequiredError}
6688
- */
6689
- simulateProgram: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6690
- /**
6691
- * Stop all runs
6692
- * @summary Stop all programs
6693
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6694
- * @param {*} [options] Override http request option.
6695
- * @throws {RequiredError}
6696
- */
6697
- stopAllPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6698
- /**
6699
- * Stop a specific program run.
6700
- * @summary Stop program run
6701
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6702
- * @param {string} run
6703
- * @param {*} [options] Override http request option.
6704
- * @throws {RequiredError}
6705
- */
6706
- stopProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6707
- /**
6708
- * Validate a program
6709
- * @summary Validate program
6710
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6711
- * @param {ProgramRunRequest} programRunRequest
6712
- * @param {*} [options] Override http request option.
6713
- * @throws {RequiredError}
6714
- */
6715
- validateProgram: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6716
- };
6717
- /**
6718
- * ProgramApi - functional programming interface
6719
- * @export
6720
- */
6721
- export declare const ProgramApiFp: (configuration?: Configuration) => {
6722
- /**
6723
- * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
6724
- * @summary Create program run
6725
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6726
- * @param {ProgramRunRequest} programRunRequest
6727
- * @param {*} [options] Override http request option.
6728
- * @throws {RequiredError}
6729
- */
6730
- createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>>;
6731
- /**
6732
- * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
6733
- * @summary Execute program
6734
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6735
- * @param {ProgramRunRequest} programRunRequest
6736
- * @param {*} [options] Override http request option.
6737
- * @throws {RequiredError}
6738
- */
6739
- executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
6740
- /**
6741
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
6742
- * @summary Get program run
6743
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6744
- * @param {string} run
6745
- * @param {*} [options] Override http request option.
6746
- * @throws {RequiredError}
6747
- */
6748
- getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
6749
- /**
6750
- * Get details about all existing runs
6751
- * @summary List programs
6752
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6753
- * @param {*} [options] Override http request option.
6754
- * @throws {RequiredError}
6755
- */
6756
- getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>>;
6757
- /**
6758
- * Simulate a program given as text/plain
6759
- * @summary Simulate program
6760
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6761
- * @param {ProgramRunRequest} programRunRequest
6762
- * @param {*} [options] Override http request option.
6763
- * @throws {RequiredError}
6764
- */
6765
- simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
6766
- /**
6767
- * Stop all runs
6768
- * @summary Stop all programs
6769
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6770
- * @param {*} [options] Override http request option.
6771
- * @throws {RequiredError}
6772
- */
6773
- stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6774
- /**
6775
- * Stop a specific program run.
6776
- * @summary Stop program run
6777
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6778
- * @param {string} run
6779
- * @param {*} [options] Override http request option.
6780
- * @throws {RequiredError}
6781
- */
6782
- stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6783
- /**
6784
- * Validate a program
6785
- * @summary Validate program
6786
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6787
- * @param {ProgramRunRequest} programRunRequest
6788
- * @param {*} [options] Override http request option.
6789
- * @throws {RequiredError}
6790
- */
6791
- validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6792
- };
6793
- /**
6794
- * ProgramApi - factory interface
6795
- * @export
6796
- */
6797
- export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6798
- /**
6799
- * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
6800
- * @summary Create program run
6801
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6802
- * @param {ProgramRunRequest} programRunRequest
6803
- * @param {*} [options] Override http request option.
6804
- * @throws {RequiredError}
6805
- */
6806
- createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference>;
6807
- /**
6808
- * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
6809
- * @summary Execute program
6810
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6811
- * @param {ProgramRunRequest} programRunRequest
6812
- * @param {*} [options] Override http request option.
6813
- * @throws {RequiredError}
6814
- */
6815
- executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
6816
- /**
6817
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
6818
- * @summary Get program run
6819
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6820
- * @param {string} run
6821
- * @param {*} [options] Override http request option.
6822
- * @throws {RequiredError}
6823
- */
6824
- getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
6825
- /**
6826
- * Get details about all existing runs
6827
- * @summary List programs
6828
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6829
- * @param {*} [options] Override http request option.
6830
- * @throws {RequiredError}
6831
- */
6832
- getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>>;
6833
- /**
6834
- * Simulate a program given as text/plain
6835
- * @summary Simulate program
6836
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6837
- * @param {ProgramRunRequest} programRunRequest
6838
- * @param {*} [options] Override http request option.
6839
- * @throws {RequiredError}
6840
- */
6841
- simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
6842
- /**
6843
- * Stop all runs
6844
- * @summary Stop all programs
6845
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6846
- * @param {*} [options] Override http request option.
6847
- * @throws {RequiredError}
6848
- */
6849
- stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6850
- /**
6851
- * Stop a specific program run.
6852
- * @summary Stop program run
6853
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6854
- * @param {string} run
6855
- * @param {*} [options] Override http request option.
6856
- * @throws {RequiredError}
6857
- */
6858
- stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6859
- /**
6860
- * Validate a program
6861
- * @summary Validate program
6862
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6863
- * @param {ProgramRunRequest} programRunRequest
6864
- * @param {*} [options] Override http request option.
6865
- * @throws {RequiredError}
6866
- */
6867
- validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6868
- };
6869
- /**
6870
- * ProgramApi - object-oriented interface
6871
- * @export
6872
- * @class ProgramApi
6873
- * @extends {BaseAPI}
6874
- */
6875
- export declare class ProgramApi extends BaseAPI {
6876
- /**
6877
- * This endpoint accepts a program and if desired, initial arguments (in the form of a dict). The program will be executed asynchronously. It returns a program run reference which can be used to query the state of the program run. ## Receiving state updates Receive state updates of the program run via polling the `/programs/runs/{run_id}/` ### Via polling You can receive updates about the state of the program run by polling the `/programs/runs/{run_id}/` endpoint.
6878
- * @summary Create program run
6879
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
- * @param {ProgramRunRequest} programRunRequest
6881
- * @param {*} [options] Override http request option.
6882
- * @throws {RequiredError}
6883
- * @memberof ProgramApi
6884
- */
6885
- createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference, any>>;
6886
- /**
6887
- * Execute a program synchronously. The execute operation will be started from the current joint configuration of any addressed robot(s). Addressed robots have to be in control mode for the execute operation to succeed. A request to this endpoint will block this endpoint until the program has been executed, or until an error occurs. The executed movement is returned in case of a successful execution. Otherwise an error (e.g. out of reach, singularity), is returned.
6888
- * @summary Execute program
6889
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6890
- * @param {ProgramRunRequest} programRunRequest
6891
- * @param {*} [options] Override http request option.
6892
- * @throws {RequiredError}
6893
- * @memberof ProgramApi
6894
- */
6895
- executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
6896
- /**
6897
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected logs, .. When a program is running: Running status, current executed line, ...
6898
- * @summary Get program run
6899
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6900
- * @param {string} run
6901
- * @param {*} [options] Override http request option.
6902
- * @throws {RequiredError}
6903
- * @memberof ProgramApi
6904
- */
6905
- getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
6906
- /**
6907
- * Get details about all existing runs
6908
- * @summary List programs
6909
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6910
- * @param {*} [options] Override http request option.
6911
- * @throws {RequiredError}
6912
- * @memberof ProgramApi
6913
- */
6914
- getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference[], any>>;
6915
- /**
6916
- * Simulate a program given as text/plain
6917
- * @summary Simulate program
6918
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6919
- * @param {ProgramRunRequest} programRunRequest
6920
- * @param {*} [options] Override http request option.
6921
- * @throws {RequiredError}
6922
- * @memberof ProgramApi
6923
- */
6924
- simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
6925
- /**
6926
- * Stop all runs
6927
- * @summary Stop all programs
6928
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6929
- * @param {*} [options] Override http request option.
6930
- * @throws {RequiredError}
6931
- * @memberof ProgramApi
6932
- */
6933
- stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6934
- /**
6935
- * Stop a specific program run.
6936
- * @summary Stop program run
6937
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6938
- * @param {string} run
6939
- * @param {*} [options] Override http request option.
6940
- * @throws {RequiredError}
6941
- * @memberof ProgramApi
6942
- */
6943
- stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6944
- /**
6945
- * Validate a program
6946
- * @summary Validate program
6947
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6948
- * @param {ProgramRunRequest} programRunRequest
6949
- * @param {*} [options] Override http request option.
6950
- * @throws {RequiredError}
6951
- * @memberof ProgramApi
6952
- */
6953
- validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6954
- }
6955
6405
  /**
6956
6406
  * StoreCollisionComponentsApi - axios parameter creator
6957
6407
  * @export
@@ -7928,192 +7378,6 @@ export declare class StoreObjectApi extends BaseAPI {
7928
7378
  [key: string]: string;
7929
7379
  }, anyValue?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7930
7380
  }
7931
- /**
7932
- * StoreProgramApi - axios parameter creator
7933
- * @export
7934
- */
7935
- export declare const StoreProgramApiAxiosParamCreator: (configuration?: Configuration) => {
7936
- /**
7937
- * Deletes the program. This action is irreversible.
7938
- * @summary Delete Program
7939
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7940
- * @param {string} program
7941
- * @param {*} [options] Override http request option.
7942
- * @throws {RequiredError}
7943
- */
7944
- deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7945
- /**
7946
- * Returns the content of the program.
7947
- * @summary Get Program
7948
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7949
- * @param {string} program
7950
- * @param {*} [options] Override http request option.
7951
- * @throws {RequiredError}
7952
- */
7953
- getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7954
- /**
7955
- * Returns a list of all the stored programs.
7956
- * @summary List all Programs
7957
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7958
- * @param {*} [options] Override http request option.
7959
- * @throws {RequiredError}
7960
- */
7961
- listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7962
- /**
7963
- * Stores the content of the program. If the program exists, the operation overwrites the content.
7964
- * @summary Store Program
7965
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7966
- * @param {string} program
7967
- * @param {string} body
7968
- * @param {{ [key: string]: string; }} [xMetadata]
7969
- * @param {*} [options] Override http request option.
7970
- * @throws {RequiredError}
7971
- */
7972
- storeProgram: (cell: string, program: string, body: string, xMetadata?: {
7973
- [key: string]: string;
7974
- }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7975
- };
7976
- /**
7977
- * StoreProgramApi - functional programming interface
7978
- * @export
7979
- */
7980
- export declare const StoreProgramApiFp: (configuration?: Configuration) => {
7981
- /**
7982
- * Deletes the program. This action is irreversible.
7983
- * @summary Delete Program
7984
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7985
- * @param {string} program
7986
- * @param {*} [options] Override http request option.
7987
- * @throws {RequiredError}
7988
- */
7989
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7990
- /**
7991
- * Returns the content of the program.
7992
- * @summary Get Program
7993
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7994
- * @param {string} program
7995
- * @param {*} [options] Override http request option.
7996
- * @throws {RequiredError}
7997
- */
7998
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
7999
- /**
8000
- * Returns a list of all the stored programs.
8001
- * @summary List all Programs
8002
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8003
- * @param {*} [options] Override http request option.
8004
- * @throws {RequiredError}
8005
- */
8006
- listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
8007
- /**
8008
- * Stores the content of the program. If the program exists, the operation overwrites the content.
8009
- * @summary Store Program
8010
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8011
- * @param {string} program
8012
- * @param {string} body
8013
- * @param {{ [key: string]: string; }} [xMetadata]
8014
- * @param {*} [options] Override http request option.
8015
- * @throws {RequiredError}
8016
- */
8017
- storeProgram(cell: string, program: string, body: string, xMetadata?: {
8018
- [key: string]: string;
8019
- }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
8020
- };
8021
- /**
8022
- * StoreProgramApi - factory interface
8023
- * @export
8024
- */
8025
- export declare const StoreProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8026
- /**
8027
- * Deletes the program. This action is irreversible.
8028
- * @summary Delete Program
8029
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8030
- * @param {string} program
8031
- * @param {*} [options] Override http request option.
8032
- * @throws {RequiredError}
8033
- */
8034
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8035
- /**
8036
- * Returns the content of the program.
8037
- * @summary Get Program
8038
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8039
- * @param {string} program
8040
- * @param {*} [options] Override http request option.
8041
- * @throws {RequiredError}
8042
- */
8043
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
8044
- /**
8045
- * Returns a list of all the stored programs.
8046
- * @summary List all Programs
8047
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8048
- * @param {*} [options] Override http request option.
8049
- * @throws {RequiredError}
8050
- */
8051
- listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
8052
- /**
8053
- * Stores the content of the program. If the program exists, the operation overwrites the content.
8054
- * @summary Store Program
8055
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8056
- * @param {string} program
8057
- * @param {string} body
8058
- * @param {{ [key: string]: string; }} [xMetadata]
8059
- * @param {*} [options] Override http request option.
8060
- * @throws {RequiredError}
8061
- */
8062
- storeProgram(cell: string, program: string, body: string, xMetadata?: {
8063
- [key: string]: string;
8064
- }, options?: RawAxiosRequestConfig): AxiosPromise<void>;
8065
- };
8066
- /**
8067
- * StoreProgramApi - object-oriented interface
8068
- * @export
8069
- * @class StoreProgramApi
8070
- * @extends {BaseAPI}
8071
- */
8072
- export declare class StoreProgramApi extends BaseAPI {
8073
- /**
8074
- * Deletes the program. This action is irreversible.
8075
- * @summary Delete Program
8076
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8077
- * @param {string} program
8078
- * @param {*} [options] Override http request option.
8079
- * @throws {RequiredError}
8080
- * @memberof StoreProgramApi
8081
- */
8082
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8083
- /**
8084
- * Returns the content of the program.
8085
- * @summary Get Program
8086
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8087
- * @param {string} program
8088
- * @param {*} [options] Override http request option.
8089
- * @throws {RequiredError}
8090
- * @memberof StoreProgramApi
8091
- */
8092
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
8093
- /**
8094
- * Returns a list of all the stored programs.
8095
- * @summary List all Programs
8096
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8097
- * @param {*} [options] Override http request option.
8098
- * @throws {RequiredError}
8099
- * @memberof StoreProgramApi
8100
- */
8101
- listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
8102
- /**
8103
- * Stores the content of the program. If the program exists, the operation overwrites the content.
8104
- * @summary Store Program
8105
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8106
- * @param {string} program
8107
- * @param {string} body
8108
- * @param {{ [key: string]: string; }} [xMetadata]
8109
- * @param {*} [options] Override http request option.
8110
- * @throws {RequiredError}
8111
- * @memberof StoreProgramApi
8112
- */
8113
- storeProgram(cell: string, program: string, body: string, xMetadata?: {
8114
- [key: string]: string;
8115
- }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8116
- }
8117
7381
  /**
8118
7382
  * SystemApi - axios parameter creator
8119
7383
  * @export
@@ -8130,14 +7394,6 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
8130
7394
  backupConfiguration: (resources: Array<string>, metadata?: {
8131
7395
  [key: string]: string;
8132
7396
  }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8133
- /**
8134
- * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8135
- * @summary Retrieve Backup Status
8136
- * @param {string} operationId
8137
- * @param {*} [options] Override http request option.
8138
- * @throws {RequiredError}
8139
- */
8140
- backupConfigurationStatus: (operationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8141
7397
  /**
8142
7398
  * Check if a more recent Wandelbots NOVA Version is available.
8143
7399
  * @summary Check update
@@ -8146,6 +7402,14 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
8146
7402
  * @throws {RequiredError}
8147
7403
  */
8148
7404
  checkNovaVersionUpdate: (channel: ReleaseChannel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7405
+ /**
7406
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7407
+ * @summary Retrieve Backup Status
7408
+ * @param {string} operationId
7409
+ * @param {*} [options] Override http request option.
7410
+ * @throws {RequiredError}
7411
+ */
7412
+ getConfigurationBackupStatus: (operationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8149
7413
  /**
8150
7414
  * Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
8151
7415
  * @summary Download Diagnosis Package
@@ -8208,14 +7472,6 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
8208
7472
  backupConfiguration(resources: Array<string>, metadata?: {
8209
7473
  [key: string]: string;
8210
7474
  }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
8211
- /**
8212
- * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8213
- * @summary Retrieve Backup Status
8214
- * @param {string} operationId
8215
- * @param {*} [options] Override http request option.
8216
- * @throws {RequiredError}
8217
- */
8218
- backupConfigurationStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationArchiveStatus>>;
8219
7475
  /**
8220
7476
  * Check if a more recent Wandelbots NOVA Version is available.
8221
7477
  * @summary Check update
@@ -8224,6 +7480,14 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
8224
7480
  * @throws {RequiredError}
8225
7481
  */
8226
7482
  checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
7483
+ /**
7484
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7485
+ * @summary Retrieve Backup Status
7486
+ * @param {string} operationId
7487
+ * @param {*} [options] Override http request option.
7488
+ * @throws {RequiredError}
7489
+ */
7490
+ getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationArchiveStatus>>;
8227
7491
  /**
8228
7492
  * Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
8229
7493
  * @summary Download Diagnosis Package
@@ -8286,14 +7550,6 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
8286
7550
  backupConfiguration(resources: Array<string>, metadata?: {
8287
7551
  [key: string]: string;
8288
7552
  }, options?: RawAxiosRequestConfig): AxiosPromise<File>;
8289
- /**
8290
- * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8291
- * @summary Retrieve Backup Status
8292
- * @param {string} operationId
8293
- * @param {*} [options] Override http request option.
8294
- * @throws {RequiredError}
8295
- */
8296
- backupConfigurationStatus(operationId: string, options?: RawAxiosRequestConfig): AxiosPromise<ConfigurationArchiveStatus>;
8297
7553
  /**
8298
7554
  * Check if a more recent Wandelbots NOVA Version is available.
8299
7555
  * @summary Check update
@@ -8302,6 +7558,14 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
8302
7558
  * @throws {RequiredError}
8303
7559
  */
8304
7560
  checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): AxiosPromise<string>;
7561
+ /**
7562
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7563
+ * @summary Retrieve Backup Status
7564
+ * @param {string} operationId
7565
+ * @param {*} [options] Override http request option.
7566
+ * @throws {RequiredError}
7567
+ */
7568
+ getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): AxiosPromise<ConfigurationArchiveStatus>;
8305
7569
  /**
8306
7570
  * Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
8307
7571
  * @summary Download Diagnosis Package
@@ -8368,23 +7632,23 @@ export declare class SystemApi extends BaseAPI {
8368
7632
  [key: string]: string;
8369
7633
  }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
8370
7634
  /**
8371
- * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
8372
- * @summary Retrieve Backup Status
8373
- * @param {string} operationId
7635
+ * Check if a more recent Wandelbots NOVA Version is available.
7636
+ * @summary Check update
7637
+ * @param {ReleaseChannel} channel
8374
7638
  * @param {*} [options] Override http request option.
8375
7639
  * @throws {RequiredError}
8376
7640
  * @memberof SystemApi
8377
7641
  */
8378
- backupConfigurationStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationArchiveStatus, any>>;
7642
+ checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
8379
7643
  /**
8380
- * Check if a more recent Wandelbots NOVA Version is available.
8381
- * @summary Check update
8382
- * @param {ReleaseChannel} channel
7644
+ * Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
7645
+ * @summary Retrieve Backup Status
7646
+ * @param {string} operationId
8383
7647
  * @param {*} [options] Override http request option.
8384
7648
  * @throws {RequiredError}
8385
7649
  * @memberof SystemApi
8386
7650
  */
8387
- checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
7651
+ getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationArchiveStatus, any>>;
8388
7652
  /**
8389
7653
  * Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
8390
7654
  * @summary Download Diagnosis Package