@wandelbots/nova-api 25.6.0-dev.40 → 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 +108 -742
  3. package/v2/api.js +877 -1793
  4. package/v2/api.js.map +1 -1
  5. package/v2/api.ts +1169 -2354
package/v2/api.d.ts CHANGED
@@ -683,6 +683,81 @@ export declare const Comparator: {
683
683
  readonly ComparatorLessEqual: "COMPARATOR_LESS_EQUAL";
684
684
  };
685
685
  export type Comparator = typeof Comparator[keyof typeof Comparator];
686
+ /**
687
+ * @type ConfigurationArchiveStatus
688
+ * Result of a backup operation.
689
+ * @export
690
+ */
691
+ export type ConfigurationArchiveStatus = {
692
+ status: 'creating';
693
+ } & ConfigurationArchiveStatusCreating | {
694
+ status: 'error';
695
+ } & ConfigurationArchiveStatusError | {
696
+ status: 'success';
697
+ } & ConfigurationArchiveStatusSuccess;
698
+ /**
699
+ *
700
+ * @export
701
+ * @interface ConfigurationArchiveStatusCreating
702
+ */
703
+ export interface ConfigurationArchiveStatusCreating {
704
+ /**
705
+ * Backup is in progress.
706
+ * @type {string}
707
+ * @memberof ConfigurationArchiveStatusCreating
708
+ */
709
+ 'status': ConfigurationArchiveStatusCreatingStatusEnum;
710
+ /**
711
+ * Current completion ratio (0 – 1).
712
+ * @type {number}
713
+ * @memberof ConfigurationArchiveStatusCreating
714
+ */
715
+ 'progress': number;
716
+ }
717
+ export declare const ConfigurationArchiveStatusCreatingStatusEnum: {
718
+ readonly Creating: "creating";
719
+ };
720
+ export type ConfigurationArchiveStatusCreatingStatusEnum = typeof ConfigurationArchiveStatusCreatingStatusEnum[keyof typeof ConfigurationArchiveStatusCreatingStatusEnum];
721
+ /**
722
+ *
723
+ * @export
724
+ * @interface ConfigurationArchiveStatusError
725
+ */
726
+ export interface ConfigurationArchiveStatusError {
727
+ /**
728
+ *
729
+ * @type {string}
730
+ * @memberof ConfigurationArchiveStatusError
731
+ */
732
+ 'status': ConfigurationArchiveStatusErrorStatusEnum;
733
+ /**
734
+ * Human-readable explanation of the failure.
735
+ * @type {string}
736
+ * @memberof ConfigurationArchiveStatusError
737
+ */
738
+ 'message': string;
739
+ }
740
+ export declare const ConfigurationArchiveStatusErrorStatusEnum: {
741
+ readonly Error: "error";
742
+ };
743
+ export type ConfigurationArchiveStatusErrorStatusEnum = typeof ConfigurationArchiveStatusErrorStatusEnum[keyof typeof ConfigurationArchiveStatusErrorStatusEnum];
744
+ /**
745
+ *
746
+ * @export
747
+ * @interface ConfigurationArchiveStatusSuccess
748
+ */
749
+ export interface ConfigurationArchiveStatusSuccess {
750
+ /**
751
+ * Backup successfully created.
752
+ * @type {string}
753
+ * @memberof ConfigurationArchiveStatusSuccess
754
+ */
755
+ 'status': ConfigurationArchiveStatusSuccessStatusEnum;
756
+ }
757
+ export declare const ConfigurationArchiveStatusSuccessStatusEnum: {
758
+ readonly Success: "success";
759
+ };
760
+ export type ConfigurationArchiveStatusSuccessStatusEnum = typeof ConfigurationArchiveStatusSuccessStatusEnum[keyof typeof ConfigurationArchiveStatusSuccessStatusEnum];
686
761
  /**
687
762
  * Configuration resource object.
688
763
  * @export
@@ -1325,19 +1400,6 @@ export interface HTTPValidationError {
1325
1400
  */
1326
1401
  'detail'?: Array<ValidationError>;
1327
1402
  }
1328
- /**
1329
- *
1330
- * @export
1331
- * @interface HTTPValidationError2
1332
- */
1333
- export interface HTTPValidationError2 {
1334
- /**
1335
- *
1336
- * @type {Array<ValidationError2>}
1337
- * @memberof HTTPValidationError2
1338
- */
1339
- 'detail'?: Array<ValidationError2>;
1340
- }
1341
1403
  /**
1342
1404
  * Input/Output boolean value representation.
1343
1405
  * @export
@@ -2637,31 +2699,6 @@ export interface MotionGroupStateJointLimitReached {
2637
2699
  */
2638
2700
  'limit_reached': Array<boolean>;
2639
2701
  }
2640
- /**
2641
- * Collection of information on the current state of the robot.
2642
- * @export
2643
- * @interface MotionState
2644
- */
2645
- export interface MotionState {
2646
- /**
2647
- * Unique identifier of the motion group that executed the program
2648
- * @type {string}
2649
- * @memberof MotionState
2650
- */
2651
- 'motion_group_id'?: string;
2652
- /**
2653
- * Parameters of the path that was executed
2654
- * @type {number}
2655
- * @memberof MotionState
2656
- */
2657
- 'path_parameters'?: number;
2658
- /**
2659
- *
2660
- * @type {RobotState}
2661
- * @memberof MotionState
2662
- */
2663
- 'state': RobotState;
2664
- }
2665
2702
  /**
2666
2703
  * Error message in case an error occurs during movement execution.
2667
2704
  * @export
@@ -3320,166 +3357,6 @@ export interface Pose {
3320
3357
  */
3321
3358
  'orientation'?: Array<number>;
3322
3359
  }
3323
- /**
3324
- * A program is a collection of instructions that are executed in the robot cell.
3325
- * @export
3326
- * @interface Program
3327
- */
3328
- export interface Program {
3329
- /**
3330
- *
3331
- * @type {string}
3332
- * @memberof Program
3333
- */
3334
- 'content': string;
3335
- /**
3336
- * Defines the program type, e.g. Python and Wandelscript.
3337
- * @type {string}
3338
- * @memberof Program
3339
- */
3340
- 'program_type': ProgramProgramTypeEnum;
3341
- }
3342
- export declare const ProgramProgramTypeEnum: {
3343
- readonly Python: "PYTHON";
3344
- readonly Wandelscript: "WANDELSCRIPT";
3345
- };
3346
- export type ProgramProgramTypeEnum = typeof ProgramProgramTypeEnum[keyof typeof ProgramProgramTypeEnum];
3347
- /**
3348
- * Holds the state of a program run.
3349
- * @export
3350
- * @interface ProgramRun
3351
- */
3352
- export interface ProgramRun {
3353
- /**
3354
- * Unique identifier of the program run
3355
- * @type {string}
3356
- * @memberof ProgramRun
3357
- */
3358
- 'id': string;
3359
- /**
3360
- * State of the program run
3361
- * @type {ProgramRunState}
3362
- * @memberof ProgramRun
3363
- */
3364
- 'state': ProgramRunState;
3365
- /**
3366
- * Logs of the program run
3367
- * @type {string}
3368
- * @memberof ProgramRun
3369
- */
3370
- 'logs'?: string;
3371
- /**
3372
- * Stdout of the program run
3373
- * @type {string}
3374
- * @memberof ProgramRun
3375
- */
3376
- 'stdout'?: string;
3377
- /**
3378
- * Stderr of the program run
3379
- * @type {string}
3380
- * @memberof ProgramRun
3381
- */
3382
- 'stderr'?: string;
3383
- /**
3384
- * Error message of the program run, if any
3385
- * @type {string}
3386
- * @memberof ProgramRun
3387
- */
3388
- 'error'?: string;
3389
- /**
3390
- * Traceback of the program run, if any
3391
- * @type {string}
3392
- * @memberof ProgramRun
3393
- */
3394
- 'traceback'?: string;
3395
- /**
3396
- * Start time of the program run
3397
- * @type {string}
3398
- * @memberof ProgramRun
3399
- */
3400
- 'start_time'?: string;
3401
- /**
3402
- * End time of the program run
3403
- * @type {string}
3404
- * @memberof ProgramRun
3405
- */
3406
- 'end_time'?: string;
3407
- /**
3408
- * Paths executed by the motion group
3409
- * @type {Array<Array<MotionState>>}
3410
- * @memberof ProgramRun
3411
- */
3412
- 'execution_results'?: Array<Array<MotionState>>;
3413
- /**
3414
- * Result of the executed program. Content depends on the program type.
3415
- * @type {object}
3416
- * @memberof ProgramRun
3417
- */
3418
- 'result'?: object;
3419
- }
3420
- /**
3421
- * Reference to an executed program.
3422
- * @export
3423
- * @interface ProgramRunReference
3424
- */
3425
- export interface ProgramRunReference {
3426
- /**
3427
- *
3428
- * @type {string}
3429
- * @memberof ProgramRunReference
3430
- */
3431
- 'id': string;
3432
- /**
3433
- *
3434
- * @type {ProgramRunState}
3435
- * @memberof ProgramRunReference
3436
- */
3437
- 'state': ProgramRunState;
3438
- }
3439
- /**
3440
- * Request model for running a program
3441
- * @export
3442
- * @interface ProgramRunRequest
3443
- */
3444
- export interface ProgramRunRequest {
3445
- /**
3446
- *
3447
- * @type {Program}
3448
- * @memberof ProgramRunRequest
3449
- */
3450
- 'program': Program;
3451
- /**
3452
- * Identifier of default robot to use for execution
3453
- * @type {string}
3454
- * @memberof ProgramRunRequest
3455
- */
3456
- 'default_robot'?: string;
3457
- /**
3458
- * Identifier of default TCP to use for execution
3459
- * @type {string}
3460
- * @memberof ProgramRunRequest
3461
- */
3462
- 'default_tcp'?: string;
3463
- /**
3464
- * Initial arguments that are available within the program
3465
- * @type {object}
3466
- * @memberof ProgramRunRequest
3467
- */
3468
- 'run_args'?: object;
3469
- }
3470
- /**
3471
- * The state of a program run.
3472
- * @export
3473
- * @enum {string}
3474
- */
3475
- export declare const ProgramRunState: {
3476
- readonly NotStarted: "NOT_STARTED";
3477
- readonly Running: "RUNNING";
3478
- readonly Completed: "COMPLETED";
3479
- readonly Failed: "FAILED";
3480
- readonly Stopped: "STOPPED";
3481
- };
3482
- export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
3483
3360
  /**
3484
3361
  * Defines an x/y-plane with finite size. Centred around the z-axis.
3485
3362
  * @export
@@ -3678,25 +3555,6 @@ export interface RobotSetup {
3678
3555
  [key: string]: SingleMotionGroupCollisionScene;
3679
3556
  };
3680
3557
  }
3681
- /**
3682
- * Collection of information on the current state of the robot.
3683
- * @export
3684
- * @interface RobotState
3685
- */
3686
- export interface RobotState {
3687
- /**
3688
- *
3689
- * @type {Pose}
3690
- * @memberof RobotState
3691
- */
3692
- 'pose': Pose;
3693
- /**
3694
- *
3695
- * @type {Array<number>}
3696
- * @memberof RobotState
3697
- */
3698
- 'joints'?: Array<number>;
3699
- }
3700
3558
  /**
3701
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.
3702
3560
  * @export
@@ -4426,31 +4284,6 @@ export interface ValidationError {
4426
4284
  */
4427
4285
  'type': string;
4428
4286
  }
4429
- /**
4430
- * A validation error of a program.
4431
- * @export
4432
- * @interface ValidationError2
4433
- */
4434
- export interface ValidationError2 {
4435
- /**
4436
- *
4437
- * @type {Array<number>}
4438
- * @memberof ValidationError2
4439
- */
4440
- 'loc': Array<number>;
4441
- /**
4442
- *
4443
- * @type {string}
4444
- * @memberof ValidationError2
4445
- */
4446
- 'msg': string;
4447
- /**
4448
- *
4449
- * @type {string}
4450
- * @memberof ValidationError2
4451
- */
4452
- 'type': string;
4453
- }
4454
4287
  /**
4455
4288
  * @type ValidationErrorLocInner
4456
4289
  * @export
@@ -6569,320 +6402,6 @@ export declare class MotionGroupModelsApi extends BaseAPI {
6569
6402
  */
6570
6403
  getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
6571
6404
  }
6572
- /**
6573
- * ProgramApi - axios parameter creator
6574
- * @export
6575
- */
6576
- export declare const ProgramApiAxiosParamCreator: (configuration?: Configuration) => {
6577
- /**
6578
- * 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.
6579
- * @summary Create program run
6580
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6581
- * @param {ProgramRunRequest} programRunRequest
6582
- * @param {*} [options] Override http request option.
6583
- * @throws {RequiredError}
6584
- */
6585
- createProgramRun: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6586
- /**
6587
- * 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.
6588
- * @summary Execute program
6589
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6590
- * @param {ProgramRunRequest} programRunRequest
6591
- * @param {*} [options] Override http request option.
6592
- * @throws {RequiredError}
6593
- */
6594
- executeProgram: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6595
- /**
6596
- * 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, ...
6597
- * @summary Get program run
6598
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6599
- * @param {string} run
6600
- * @param {*} [options] Override http request option.
6601
- * @throws {RequiredError}
6602
- */
6603
- getProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6604
- /**
6605
- * Get details about all existing runs
6606
- * @summary List programs
6607
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6608
- * @param {*} [options] Override http request option.
6609
- * @throws {RequiredError}
6610
- */
6611
- getProgramRuns: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6612
- /**
6613
- * Simulate a program given as text/plain
6614
- * @summary Simulate program
6615
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6616
- * @param {ProgramRunRequest} programRunRequest
6617
- * @param {*} [options] Override http request option.
6618
- * @throws {RequiredError}
6619
- */
6620
- simulateProgram: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6621
- /**
6622
- * Stop all runs
6623
- * @summary Stop all programs
6624
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6625
- * @param {*} [options] Override http request option.
6626
- * @throws {RequiredError}
6627
- */
6628
- stopAllPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6629
- /**
6630
- * Stop a specific program run.
6631
- * @summary Stop program run
6632
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6633
- * @param {string} run
6634
- * @param {*} [options] Override http request option.
6635
- * @throws {RequiredError}
6636
- */
6637
- stopProgramRun: (cell: string, run: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6638
- /**
6639
- * Validate a program
6640
- * @summary Validate program
6641
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6642
- * @param {ProgramRunRequest} programRunRequest
6643
- * @param {*} [options] Override http request option.
6644
- * @throws {RequiredError}
6645
- */
6646
- validateProgram: (cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6647
- };
6648
- /**
6649
- * ProgramApi - functional programming interface
6650
- * @export
6651
- */
6652
- export declare const ProgramApiFp: (configuration?: Configuration) => {
6653
- /**
6654
- * 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.
6655
- * @summary Create program run
6656
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6657
- * @param {ProgramRunRequest} programRunRequest
6658
- * @param {*} [options] Override http request option.
6659
- * @throws {RequiredError}
6660
- */
6661
- createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>>;
6662
- /**
6663
- * 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.
6664
- * @summary Execute program
6665
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6666
- * @param {ProgramRunRequest} programRunRequest
6667
- * @param {*} [options] Override http request option.
6668
- * @throws {RequiredError}
6669
- */
6670
- executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
6671
- /**
6672
- * 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, ...
6673
- * @summary Get program run
6674
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6675
- * @param {string} run
6676
- * @param {*} [options] Override http request option.
6677
- * @throws {RequiredError}
6678
- */
6679
- getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
6680
- /**
6681
- * Get details about all existing runs
6682
- * @summary List programs
6683
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6684
- * @param {*} [options] Override http request option.
6685
- * @throws {RequiredError}
6686
- */
6687
- getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>>;
6688
- /**
6689
- * Simulate a program given as text/plain
6690
- * @summary Simulate program
6691
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6692
- * @param {ProgramRunRequest} programRunRequest
6693
- * @param {*} [options] Override http request option.
6694
- * @throws {RequiredError}
6695
- */
6696
- simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>>;
6697
- /**
6698
- * Stop all runs
6699
- * @summary Stop all programs
6700
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6701
- * @param {*} [options] Override http request option.
6702
- * @throws {RequiredError}
6703
- */
6704
- stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6705
- /**
6706
- * Stop a specific program run.
6707
- * @summary Stop program run
6708
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6709
- * @param {string} run
6710
- * @param {*} [options] Override http request option.
6711
- * @throws {RequiredError}
6712
- */
6713
- stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6714
- /**
6715
- * Validate a program
6716
- * @summary Validate program
6717
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6718
- * @param {ProgramRunRequest} programRunRequest
6719
- * @param {*} [options] Override http request option.
6720
- * @throws {RequiredError}
6721
- */
6722
- validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
6723
- };
6724
- /**
6725
- * ProgramApi - factory interface
6726
- * @export
6727
- */
6728
- export declare const ProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6729
- /**
6730
- * 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.
6731
- * @summary Create program run
6732
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6733
- * @param {ProgramRunRequest} programRunRequest
6734
- * @param {*} [options] Override http request option.
6735
- * @throws {RequiredError}
6736
- */
6737
- createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference>;
6738
- /**
6739
- * 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.
6740
- * @summary Execute program
6741
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6742
- * @param {ProgramRunRequest} programRunRequest
6743
- * @param {*} [options] Override http request option.
6744
- * @throws {RequiredError}
6745
- */
6746
- executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
6747
- /**
6748
- * 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, ...
6749
- * @summary Get program run
6750
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6751
- * @param {string} run
6752
- * @param {*} [options] Override http request option.
6753
- * @throws {RequiredError}
6754
- */
6755
- getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
6756
- /**
6757
- * Get details about all existing runs
6758
- * @summary List programs
6759
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6760
- * @param {*} [options] Override http request option.
6761
- * @throws {RequiredError}
6762
- */
6763
- getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>>;
6764
- /**
6765
- * Simulate a program given as text/plain
6766
- * @summary Simulate program
6767
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6768
- * @param {ProgramRunRequest} programRunRequest
6769
- * @param {*} [options] Override http request option.
6770
- * @throws {RequiredError}
6771
- */
6772
- simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun>;
6773
- /**
6774
- * Stop all runs
6775
- * @summary Stop all programs
6776
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6777
- * @param {*} [options] Override http request option.
6778
- * @throws {RequiredError}
6779
- */
6780
- stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6781
- /**
6782
- * Stop a specific program run.
6783
- * @summary Stop program run
6784
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6785
- * @param {string} run
6786
- * @param {*} [options] Override http request option.
6787
- * @throws {RequiredError}
6788
- */
6789
- stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6790
- /**
6791
- * Validate a program
6792
- * @summary Validate program
6793
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6794
- * @param {ProgramRunRequest} programRunRequest
6795
- * @param {*} [options] Override http request option.
6796
- * @throws {RequiredError}
6797
- */
6798
- validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
6799
- };
6800
- /**
6801
- * ProgramApi - object-oriented interface
6802
- * @export
6803
- * @class ProgramApi
6804
- * @extends {BaseAPI}
6805
- */
6806
- export declare class ProgramApi extends BaseAPI {
6807
- /**
6808
- * 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.
6809
- * @summary Create program run
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
- * @memberof ProgramApi
6815
- */
6816
- createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference, any>>;
6817
- /**
6818
- * 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.
6819
- * @summary Execute program
6820
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6821
- * @param {ProgramRunRequest} programRunRequest
6822
- * @param {*} [options] Override http request option.
6823
- * @throws {RequiredError}
6824
- * @memberof ProgramApi
6825
- */
6826
- executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
6827
- /**
6828
- * 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, ...
6829
- * @summary Get program run
6830
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6831
- * @param {string} run
6832
- * @param {*} [options] Override http request option.
6833
- * @throws {RequiredError}
6834
- * @memberof ProgramApi
6835
- */
6836
- getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
6837
- /**
6838
- * Get details about all existing runs
6839
- * @summary List programs
6840
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6841
- * @param {*} [options] Override http request option.
6842
- * @throws {RequiredError}
6843
- * @memberof ProgramApi
6844
- */
6845
- getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRunReference[], any>>;
6846
- /**
6847
- * Simulate a program given as text/plain
6848
- * @summary Simulate program
6849
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6850
- * @param {ProgramRunRequest} programRunRequest
6851
- * @param {*} [options] Override http request option.
6852
- * @throws {RequiredError}
6853
- * @memberof ProgramApi
6854
- */
6855
- simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgramRun, any>>;
6856
- /**
6857
- * Stop all runs
6858
- * @summary Stop all programs
6859
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6860
- * @param {*} [options] Override http request option.
6861
- * @throws {RequiredError}
6862
- * @memberof ProgramApi
6863
- */
6864
- stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6865
- /**
6866
- * Stop a specific program run.
6867
- * @summary Stop program run
6868
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6869
- * @param {string} run
6870
- * @param {*} [options] Override http request option.
6871
- * @throws {RequiredError}
6872
- * @memberof ProgramApi
6873
- */
6874
- stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6875
- /**
6876
- * Validate a program
6877
- * @summary Validate program
6878
- * @param {string} cell Unique identifier addressing a cell in all API calls.
6879
- * @param {ProgramRunRequest} programRunRequest
6880
- * @param {*} [options] Override http request option.
6881
- * @throws {RequiredError}
6882
- * @memberof ProgramApi
6883
- */
6884
- validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
6885
- }
6886
6405
  /**
6887
6406
  * StoreCollisionComponentsApi - axios parameter creator
6888
6407
  * @export
@@ -7859,192 +7378,6 @@ export declare class StoreObjectApi extends BaseAPI {
7859
7378
  [key: string]: string;
7860
7379
  }, anyValue?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
7861
7380
  }
7862
- /**
7863
- * StoreProgramApi - axios parameter creator
7864
- * @export
7865
- */
7866
- export declare const StoreProgramApiAxiosParamCreator: (configuration?: Configuration) => {
7867
- /**
7868
- * Deletes the program. This action is irreversible.
7869
- * @summary Delete Program
7870
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7871
- * @param {string} program
7872
- * @param {*} [options] Override http request option.
7873
- * @throws {RequiredError}
7874
- */
7875
- deleteProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7876
- /**
7877
- * Returns the content of the program.
7878
- * @summary Get Program
7879
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7880
- * @param {string} program
7881
- * @param {*} [options] Override http request option.
7882
- * @throws {RequiredError}
7883
- */
7884
- getProgram: (cell: string, program: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7885
- /**
7886
- * Returns a list of all the stored programs.
7887
- * @summary List all Programs
7888
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7889
- * @param {*} [options] Override http request option.
7890
- * @throws {RequiredError}
7891
- */
7892
- listPrograms: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7893
- /**
7894
- * Stores the content of the program. If the program exists, the operation overwrites the content.
7895
- * @summary Store Program
7896
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7897
- * @param {string} program
7898
- * @param {string} body
7899
- * @param {{ [key: string]: string; }} [xMetadata]
7900
- * @param {*} [options] Override http request option.
7901
- * @throws {RequiredError}
7902
- */
7903
- storeProgram: (cell: string, program: string, body: string, xMetadata?: {
7904
- [key: string]: string;
7905
- }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
7906
- };
7907
- /**
7908
- * StoreProgramApi - functional programming interface
7909
- * @export
7910
- */
7911
- export declare const StoreProgramApiFp: (configuration?: Configuration) => {
7912
- /**
7913
- * Deletes the program. This action is irreversible.
7914
- * @summary Delete Program
7915
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7916
- * @param {string} program
7917
- * @param {*} [options] Override http request option.
7918
- * @throws {RequiredError}
7919
- */
7920
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7921
- /**
7922
- * Returns the content of the program.
7923
- * @summary Get Program
7924
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7925
- * @param {string} program
7926
- * @param {*} [options] Override http request option.
7927
- * @throws {RequiredError}
7928
- */
7929
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
7930
- /**
7931
- * Returns a list of all the stored programs.
7932
- * @summary List all Programs
7933
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7934
- * @param {*} [options] Override http request option.
7935
- * @throws {RequiredError}
7936
- */
7937
- listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
7938
- /**
7939
- * Stores the content of the program. If the program exists, the operation overwrites the content.
7940
- * @summary Store Program
7941
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7942
- * @param {string} program
7943
- * @param {string} body
7944
- * @param {{ [key: string]: string; }} [xMetadata]
7945
- * @param {*} [options] Override http request option.
7946
- * @throws {RequiredError}
7947
- */
7948
- storeProgram(cell: string, program: string, body: string, xMetadata?: {
7949
- [key: string]: string;
7950
- }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
7951
- };
7952
- /**
7953
- * StoreProgramApi - factory interface
7954
- * @export
7955
- */
7956
- export declare const StoreProgramApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
7957
- /**
7958
- * Deletes the program. This action is irreversible.
7959
- * @summary Delete Program
7960
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7961
- * @param {string} program
7962
- * @param {*} [options] Override http request option.
7963
- * @throws {RequiredError}
7964
- */
7965
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7966
- /**
7967
- * Returns the content of the program.
7968
- * @summary Get Program
7969
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7970
- * @param {string} program
7971
- * @param {*} [options] Override http request option.
7972
- * @throws {RequiredError}
7973
- */
7974
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
7975
- /**
7976
- * Returns a list of all the stored programs.
7977
- * @summary List all Programs
7978
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7979
- * @param {*} [options] Override http request option.
7980
- * @throws {RequiredError}
7981
- */
7982
- listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
7983
- /**
7984
- * Stores the content of the program. If the program exists, the operation overwrites the content.
7985
- * @summary Store Program
7986
- * @param {string} cell Unique identifier addressing a cell in all API calls.
7987
- * @param {string} program
7988
- * @param {string} body
7989
- * @param {{ [key: string]: string; }} [xMetadata]
7990
- * @param {*} [options] Override http request option.
7991
- * @throws {RequiredError}
7992
- */
7993
- storeProgram(cell: string, program: string, body: string, xMetadata?: {
7994
- [key: string]: string;
7995
- }, options?: RawAxiosRequestConfig): AxiosPromise<void>;
7996
- };
7997
- /**
7998
- * StoreProgramApi - object-oriented interface
7999
- * @export
8000
- * @class StoreProgramApi
8001
- * @extends {BaseAPI}
8002
- */
8003
- export declare class StoreProgramApi extends BaseAPI {
8004
- /**
8005
- * Deletes the program. This action is irreversible.
8006
- * @summary Delete Program
8007
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8008
- * @param {string} program
8009
- * @param {*} [options] Override http request option.
8010
- * @throws {RequiredError}
8011
- * @memberof StoreProgramApi
8012
- */
8013
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8014
- /**
8015
- * Returns the content of the program.
8016
- * @summary Get Program
8017
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8018
- * @param {string} program
8019
- * @param {*} [options] Override http request option.
8020
- * @throws {RequiredError}
8021
- * @memberof StoreProgramApi
8022
- */
8023
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
8024
- /**
8025
- * Returns a list of all the stored programs.
8026
- * @summary List all Programs
8027
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8028
- * @param {*} [options] Override http request option.
8029
- * @throws {RequiredError}
8030
- * @memberof StoreProgramApi
8031
- */
8032
- listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
8033
- /**
8034
- * Stores the content of the program. If the program exists, the operation overwrites the content.
8035
- * @summary Store Program
8036
- * @param {string} cell Unique identifier addressing a cell in all API calls.
8037
- * @param {string} program
8038
- * @param {string} body
8039
- * @param {{ [key: string]: string; }} [xMetadata]
8040
- * @param {*} [options] Override http request option.
8041
- * @throws {RequiredError}
8042
- * @memberof StoreProgramApi
8043
- */
8044
- storeProgram(cell: string, program: string, body: string, xMetadata?: {
8045
- [key: string]: string;
8046
- }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
8047
- }
8048
7381
  /**
8049
7382
  * SystemApi - axios parameter creator
8050
7383
  * @export
@@ -8069,6 +7402,14 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
8069
7402
  * @throws {RequiredError}
8070
7403
  */
8071
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>;
8072
7413
  /**
8073
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.
8074
7415
  * @summary Download Diagnosis Package
@@ -8139,6 +7480,14 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
8139
7480
  * @throws {RequiredError}
8140
7481
  */
8141
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>>;
8142
7491
  /**
8143
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.
8144
7493
  * @summary Download Diagnosis Package
@@ -8209,6 +7558,14 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
8209
7558
  * @throws {RequiredError}
8210
7559
  */
8211
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>;
8212
7569
  /**
8213
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.
8214
7571
  * @summary Download Diagnosis Package
@@ -8283,6 +7640,15 @@ export declare class SystemApi extends BaseAPI {
8283
7640
  * @memberof SystemApi
8284
7641
  */
8285
7642
  checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
7643
+ /**
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
7647
+ * @param {*} [options] Override http request option.
7648
+ * @throws {RequiredError}
7649
+ * @memberof SystemApi
7650
+ */
7651
+ getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationArchiveStatus, any>>;
8286
7652
  /**
8287
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.
8288
7654
  * @summary Download Diagnosis Package