@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.ts CHANGED
@@ -690,6 +690,85 @@ export const Comparator = {
690
690
  export type Comparator = typeof Comparator[keyof typeof Comparator];
691
691
 
692
692
 
693
+ /**
694
+ * @type ConfigurationArchiveStatus
695
+ * Result of a backup operation.
696
+ * @export
697
+ */
698
+ export type ConfigurationArchiveStatus = { status: 'creating' } & ConfigurationArchiveStatusCreating | { status: 'error' } & ConfigurationArchiveStatusError | { status: 'success' } & ConfigurationArchiveStatusSuccess;
699
+
700
+ /**
701
+ *
702
+ * @export
703
+ * @interface ConfigurationArchiveStatusCreating
704
+ */
705
+ export interface ConfigurationArchiveStatusCreating {
706
+ /**
707
+ * Backup is in progress.
708
+ * @type {string}
709
+ * @memberof ConfigurationArchiveStatusCreating
710
+ */
711
+ 'status': ConfigurationArchiveStatusCreatingStatusEnum;
712
+ /**
713
+ * Current completion ratio (0 – 1).
714
+ * @type {number}
715
+ * @memberof ConfigurationArchiveStatusCreating
716
+ */
717
+ 'progress': number;
718
+ }
719
+
720
+ export const ConfigurationArchiveStatusCreatingStatusEnum = {
721
+ Creating: 'creating'
722
+ } as const;
723
+
724
+ export type ConfigurationArchiveStatusCreatingStatusEnum = typeof ConfigurationArchiveStatusCreatingStatusEnum[keyof typeof ConfigurationArchiveStatusCreatingStatusEnum];
725
+
726
+ /**
727
+ *
728
+ * @export
729
+ * @interface ConfigurationArchiveStatusError
730
+ */
731
+ export interface ConfigurationArchiveStatusError {
732
+ /**
733
+ *
734
+ * @type {string}
735
+ * @memberof ConfigurationArchiveStatusError
736
+ */
737
+ 'status': ConfigurationArchiveStatusErrorStatusEnum;
738
+ /**
739
+ * Human-readable explanation of the failure.
740
+ * @type {string}
741
+ * @memberof ConfigurationArchiveStatusError
742
+ */
743
+ 'message': string;
744
+ }
745
+
746
+ export const ConfigurationArchiveStatusErrorStatusEnum = {
747
+ Error: 'error'
748
+ } as const;
749
+
750
+ export type ConfigurationArchiveStatusErrorStatusEnum = typeof ConfigurationArchiveStatusErrorStatusEnum[keyof typeof ConfigurationArchiveStatusErrorStatusEnum];
751
+
752
+ /**
753
+ *
754
+ * @export
755
+ * @interface ConfigurationArchiveStatusSuccess
756
+ */
757
+ export interface ConfigurationArchiveStatusSuccess {
758
+ /**
759
+ * Backup successfully created.
760
+ * @type {string}
761
+ * @memberof ConfigurationArchiveStatusSuccess
762
+ */
763
+ 'status': ConfigurationArchiveStatusSuccessStatusEnum;
764
+ }
765
+
766
+ export const ConfigurationArchiveStatusSuccessStatusEnum = {
767
+ Success: 'success'
768
+ } as const;
769
+
770
+ export type ConfigurationArchiveStatusSuccessStatusEnum = typeof ConfigurationArchiveStatusSuccessStatusEnum[keyof typeof ConfigurationArchiveStatusSuccessStatusEnum];
771
+
693
772
  /**
694
773
  * Configuration resource object.
695
774
  * @export
@@ -1368,19 +1447,6 @@ export interface HTTPValidationError {
1368
1447
  */
1369
1448
  'detail'?: Array<ValidationError>;
1370
1449
  }
1371
- /**
1372
- *
1373
- * @export
1374
- * @interface HTTPValidationError2
1375
- */
1376
- export interface HTTPValidationError2 {
1377
- /**
1378
- *
1379
- * @type {Array<ValidationError2>}
1380
- * @memberof HTTPValidationError2
1381
- */
1382
- 'detail'?: Array<ValidationError2>;
1383
- }
1384
1450
  /**
1385
1451
  * Input/Output boolean value representation.
1386
1452
  * @export
@@ -2712,31 +2778,6 @@ export interface MotionGroupStateJointLimitReached {
2712
2778
  */
2713
2779
  'limit_reached': Array<boolean>;
2714
2780
  }
2715
- /**
2716
- * Collection of information on the current state of the robot.
2717
- * @export
2718
- * @interface MotionState
2719
- */
2720
- export interface MotionState {
2721
- /**
2722
- * Unique identifier of the motion group that executed the program
2723
- * @type {string}
2724
- * @memberof MotionState
2725
- */
2726
- 'motion_group_id'?: string;
2727
- /**
2728
- * Parameters of the path that was executed
2729
- * @type {number}
2730
- * @memberof MotionState
2731
- */
2732
- 'path_parameters'?: number;
2733
- /**
2734
- *
2735
- * @type {RobotState}
2736
- * @memberof MotionState
2737
- */
2738
- 'state': RobotState;
2739
- }
2740
2781
  /**
2741
2782
  * Error message in case an error occurs during movement execution.
2742
2783
  * @export
@@ -3467,177 +3508,6 @@ export interface Pose {
3467
3508
  */
3468
3509
  'orientation'?: Array<number>;
3469
3510
  }
3470
- /**
3471
- * A program is a collection of instructions that are executed in the robot cell.
3472
- * @export
3473
- * @interface Program
3474
- */
3475
- export interface Program {
3476
- /**
3477
- *
3478
- * @type {string}
3479
- * @memberof Program
3480
- */
3481
- 'content': string;
3482
- /**
3483
- * Defines the program type, e.g. Python and Wandelscript.
3484
- * @type {string}
3485
- * @memberof Program
3486
- */
3487
- 'program_type': ProgramProgramTypeEnum;
3488
- }
3489
-
3490
- export const ProgramProgramTypeEnum = {
3491
- Python: 'PYTHON',
3492
- Wandelscript: 'WANDELSCRIPT'
3493
- } as const;
3494
-
3495
- export type ProgramProgramTypeEnum = typeof ProgramProgramTypeEnum[keyof typeof ProgramProgramTypeEnum];
3496
-
3497
- /**
3498
- * Holds the state of a program run.
3499
- * @export
3500
- * @interface ProgramRun
3501
- */
3502
- export interface ProgramRun {
3503
- /**
3504
- * Unique identifier of the program run
3505
- * @type {string}
3506
- * @memberof ProgramRun
3507
- */
3508
- 'id': string;
3509
- /**
3510
- * State of the program run
3511
- * @type {ProgramRunState}
3512
- * @memberof ProgramRun
3513
- */
3514
- 'state': ProgramRunState;
3515
- /**
3516
- * Logs of the program run
3517
- * @type {string}
3518
- * @memberof ProgramRun
3519
- */
3520
- 'logs'?: string;
3521
- /**
3522
- * Stdout of the program run
3523
- * @type {string}
3524
- * @memberof ProgramRun
3525
- */
3526
- 'stdout'?: string;
3527
- /**
3528
- * Stderr of the program run
3529
- * @type {string}
3530
- * @memberof ProgramRun
3531
- */
3532
- 'stderr'?: string;
3533
- /**
3534
- * Error message of the program run, if any
3535
- * @type {string}
3536
- * @memberof ProgramRun
3537
- */
3538
- 'error'?: string;
3539
- /**
3540
- * Traceback of the program run, if any
3541
- * @type {string}
3542
- * @memberof ProgramRun
3543
- */
3544
- 'traceback'?: string;
3545
- /**
3546
- * Start time of the program run
3547
- * @type {string}
3548
- * @memberof ProgramRun
3549
- */
3550
- 'start_time'?: string;
3551
- /**
3552
- * End time of the program run
3553
- * @type {string}
3554
- * @memberof ProgramRun
3555
- */
3556
- 'end_time'?: string;
3557
- /**
3558
- * Paths executed by the motion group
3559
- * @type {Array<Array<MotionState>>}
3560
- * @memberof ProgramRun
3561
- */
3562
- 'execution_results'?: Array<Array<MotionState>>;
3563
- /**
3564
- * Result of the executed program. Content depends on the program type.
3565
- * @type {object}
3566
- * @memberof ProgramRun
3567
- */
3568
- 'result'?: object;
3569
- }
3570
-
3571
-
3572
- /**
3573
- * Reference to an executed program.
3574
- * @export
3575
- * @interface ProgramRunReference
3576
- */
3577
- export interface ProgramRunReference {
3578
- /**
3579
- *
3580
- * @type {string}
3581
- * @memberof ProgramRunReference
3582
- */
3583
- 'id': string;
3584
- /**
3585
- *
3586
- * @type {ProgramRunState}
3587
- * @memberof ProgramRunReference
3588
- */
3589
- 'state': ProgramRunState;
3590
- }
3591
-
3592
-
3593
- /**
3594
- * Request model for running a program
3595
- * @export
3596
- * @interface ProgramRunRequest
3597
- */
3598
- export interface ProgramRunRequest {
3599
- /**
3600
- *
3601
- * @type {Program}
3602
- * @memberof ProgramRunRequest
3603
- */
3604
- 'program': Program;
3605
- /**
3606
- * Identifier of default robot to use for execution
3607
- * @type {string}
3608
- * @memberof ProgramRunRequest
3609
- */
3610
- 'default_robot'?: string;
3611
- /**
3612
- * Identifier of default TCP to use for execution
3613
- * @type {string}
3614
- * @memberof ProgramRunRequest
3615
- */
3616
- 'default_tcp'?: string;
3617
- /**
3618
- * Initial arguments that are available within the program
3619
- * @type {object}
3620
- * @memberof ProgramRunRequest
3621
- */
3622
- 'run_args'?: object;
3623
- }
3624
- /**
3625
- * The state of a program run.
3626
- * @export
3627
- * @enum {string}
3628
- */
3629
-
3630
- export const ProgramRunState = {
3631
- NotStarted: 'NOT_STARTED',
3632
- Running: 'RUNNING',
3633
- Completed: 'COMPLETED',
3634
- Failed: 'FAILED',
3635
- Stopped: 'STOPPED'
3636
- } as const;
3637
-
3638
- export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
3639
-
3640
-
3641
3511
  /**
3642
3512
  * Defines an x/y-plane with finite size. Centred around the z-axis.
3643
3513
  * @export
@@ -3847,25 +3717,6 @@ export interface RobotSetup {
3847
3717
  */
3848
3718
  'collision_scenes'?: { [key: string]: SingleMotionGroupCollisionScene; };
3849
3719
  }
3850
- /**
3851
- * Collection of information on the current state of the robot.
3852
- * @export
3853
- * @interface RobotState
3854
- */
3855
- export interface RobotState {
3856
- /**
3857
- *
3858
- * @type {Pose}
3859
- * @memberof RobotState
3860
- */
3861
- 'pose': Pose;
3862
- /**
3863
- *
3864
- * @type {Array<number>}
3865
- * @memberof RobotState
3866
- */
3867
- 'joints'?: Array<number>;
3868
- }
3869
3720
  /**
3870
3721
  * 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.
3871
3722
  * @export
@@ -4667,31 +4518,6 @@ export interface ValidationError {
4667
4518
  */
4668
4519
  'type': string;
4669
4520
  }
4670
- /**
4671
- * A validation error of a program.
4672
- * @export
4673
- * @interface ValidationError2
4674
- */
4675
- export interface ValidationError2 {
4676
- /**
4677
- *
4678
- * @type {Array<number>}
4679
- * @memberof ValidationError2
4680
- */
4681
- 'loc': Array<number>;
4682
- /**
4683
- *
4684
- * @type {string}
4685
- * @memberof ValidationError2
4686
- */
4687
- 'msg': string;
4688
- /**
4689
- *
4690
- * @type {string}
4691
- * @memberof ValidationError2
4692
- */
4693
- 'type': string;
4694
- }
4695
4521
  /**
4696
4522
  * @type ValidationErrorLocInner
4697
4523
  * @export
@@ -9046,26 +8872,27 @@ export class MotionGroupModelsApi extends BaseAPI {
9046
8872
 
9047
8873
 
9048
8874
  /**
9049
- * ProgramApi - axios parameter creator
8875
+ * StoreCollisionComponentsApi - axios parameter creator
9050
8876
  * @export
9051
8877
  */
9052
- export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
8878
+ export const StoreCollisionComponentsApiAxiosParamCreator = function (configuration?: Configuration) {
9053
8879
  return {
9054
8880
  /**
9055
- * 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.
9056
- * @summary Create program run
8881
+ * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
8882
+ * @summary Delete Collider
9057
8883
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9058
- * @param {ProgramRunRequest} programRunRequest
8884
+ * @param {string} collider Unique identifier addressing a collider.
9059
8885
  * @param {*} [options] Override http request option.
9060
8886
  * @throws {RequiredError}
9061
8887
  */
9062
- createProgramRun: async (cell: string, programRunRequest: ProgramRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8888
+ deleteStoredCollider: async (cell: string, collider: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9063
8889
  // verify required parameter 'cell' is not null or undefined
9064
- assertParamExists('createProgramRun', 'cell', cell)
9065
- // verify required parameter 'programRunRequest' is not null or undefined
9066
- assertParamExists('createProgramRun', 'programRunRequest', programRunRequest)
9067
- const localVarPath = `/cells/{cell}/programs/runs`
9068
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
8890
+ assertParamExists('deleteStoredCollider', 'cell', cell)
8891
+ // verify required parameter 'collider' is not null or undefined
8892
+ assertParamExists('deleteStoredCollider', 'collider', collider)
8893
+ const localVarPath = `/cells/{cell}/store/collision/colliders/{collider}`
8894
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8895
+ .replace(`{${"collider"}}`, encodeURIComponent(String(collider)));
9069
8896
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9070
8897
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9071
8898
  let baseOptions;
@@ -9073,7 +8900,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9073
8900
  baseOptions = configuration.baseOptions;
9074
8901
  }
9075
8902
 
9076
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
8903
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
9077
8904
  const localVarHeaderParameter = {} as any;
9078
8905
  const localVarQueryParameter = {} as any;
9079
8906
 
@@ -9087,12 +8914,9 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9087
8914
 
9088
8915
 
9089
8916
 
9090
- localVarHeaderParameter['Content-Type'] = 'application/json';
9091
-
9092
8917
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9093
8918
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9094
8919
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9095
- localVarRequestOptions.data = serializeDataIfNeeded(programRunRequest, localVarRequestOptions, configuration)
9096
8920
 
9097
8921
  return {
9098
8922
  url: toPathString(localVarUrlObj),
@@ -9100,20 +8924,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9100
8924
  };
9101
8925
  },
9102
8926
  /**
9103
- * 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.
9104
- * @summary Execute program
8927
+ * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
8928
+ * @summary Delete Link Chain
9105
8929
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9106
- * @param {ProgramRunRequest} programRunRequest
8930
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9107
8931
  * @param {*} [options] Override http request option.
9108
8932
  * @throws {RequiredError}
9109
8933
  */
9110
- executeProgram: async (cell: string, programRunRequest: ProgramRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8934
+ deleteStoredCollisionLinkChain: async (cell: string, linkChain: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9111
8935
  // verify required parameter 'cell' is not null or undefined
9112
- assertParamExists('executeProgram', 'cell', cell)
9113
- // verify required parameter 'programRunRequest' is not null or undefined
9114
- assertParamExists('executeProgram', 'programRunRequest', programRunRequest)
9115
- const localVarPath = `/cells/{cell}/programs/execute`
9116
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
8936
+ assertParamExists('deleteStoredCollisionLinkChain', 'cell', cell)
8937
+ // verify required parameter 'linkChain' is not null or undefined
8938
+ assertParamExists('deleteStoredCollisionLinkChain', 'linkChain', linkChain)
8939
+ const localVarPath = `/cells/{cell}/store/collision/link-chains/{link-chain}`
8940
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
8941
+ .replace(`{${"link-chain"}}`, encodeURIComponent(String(linkChain)));
9117
8942
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9118
8943
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9119
8944
  let baseOptions;
@@ -9121,7 +8946,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9121
8946
  baseOptions = configuration.baseOptions;
9122
8947
  }
9123
8948
 
9124
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
8949
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
9125
8950
  const localVarHeaderParameter = {} as any;
9126
8951
  const localVarQueryParameter = {} as any;
9127
8952
 
@@ -9135,12 +8960,9 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9135
8960
 
9136
8961
 
9137
8962
 
9138
- localVarHeaderParameter['Content-Type'] = 'application/json';
9139
-
9140
8963
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9141
8964
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9142
8965
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9143
- localVarRequestOptions.data = serializeDataIfNeeded(programRunRequest, localVarRequestOptions, configuration)
9144
8966
 
9145
8967
  return {
9146
8968
  url: toPathString(localVarUrlObj),
@@ -9148,21 +8970,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9148
8970
  };
9149
8971
  },
9150
8972
  /**
9151
- * 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, ...
9152
- * @summary Get program run
8973
+ * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
8974
+ * @summary Delete Tool
9153
8975
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9154
- * @param {string} run
8976
+ * @param {string} tool Unique identifier addressing a collision tool.
9155
8977
  * @param {*} [options] Override http request option.
9156
8978
  * @throws {RequiredError}
9157
8979
  */
9158
- getProgramRun: async (cell: string, run: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
8980
+ deleteStoredCollisionTool: async (cell: string, tool: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9159
8981
  // verify required parameter 'cell' is not null or undefined
9160
- assertParamExists('getProgramRun', 'cell', cell)
9161
- // verify required parameter 'run' is not null or undefined
9162
- assertParamExists('getProgramRun', 'run', run)
9163
- const localVarPath = `/cells/{cell}/programs/runs/{run}`
8982
+ assertParamExists('deleteStoredCollisionTool', 'cell', cell)
8983
+ // verify required parameter 'tool' is not null or undefined
8984
+ assertParamExists('deleteStoredCollisionTool', 'tool', tool)
8985
+ const localVarPath = `/cells/{cell}/store/collision/tools/{tool}`
9164
8986
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9165
- .replace(`{${"run"}}`, encodeURIComponent(String(run)));
8987
+ .replace(`{${"tool"}}`, encodeURIComponent(String(tool)));
9166
8988
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9167
8989
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9168
8990
  let baseOptions;
@@ -9170,7 +8992,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9170
8992
  baseOptions = configuration.baseOptions;
9171
8993
  }
9172
8994
 
9173
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
8995
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
9174
8996
  const localVarHeaderParameter = {} as any;
9175
8997
  const localVarQueryParameter = {} as any;
9176
8998
 
@@ -9194,17 +9016,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9194
9016
  };
9195
9017
  },
9196
9018
  /**
9197
- * Get details about all existing runs
9198
- * @summary List programs
9019
+ * Returns the collider.
9020
+ * @summary Get Collider
9199
9021
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9022
+ * @param {string} collider Unique identifier addressing a collider.
9200
9023
  * @param {*} [options] Override http request option.
9201
9024
  * @throws {RequiredError}
9202
9025
  */
9203
- getProgramRuns: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9026
+ getStoredCollider: async (cell: string, collider: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9204
9027
  // verify required parameter 'cell' is not null or undefined
9205
- assertParamExists('getProgramRuns', 'cell', cell)
9206
- const localVarPath = `/cells/{cell}/programs/runs`
9207
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9028
+ assertParamExists('getStoredCollider', 'cell', cell)
9029
+ // verify required parameter 'collider' is not null or undefined
9030
+ assertParamExists('getStoredCollider', 'collider', collider)
9031
+ const localVarPath = `/cells/{cell}/store/collision/colliders/{collider}`
9032
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9033
+ .replace(`{${"collider"}}`, encodeURIComponent(String(collider)));
9208
9034
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9209
9035
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9210
9036
  let baseOptions;
@@ -9236,20 +9062,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9236
9062
  };
9237
9063
  },
9238
9064
  /**
9239
- * Simulate a program given as text/plain
9240
- * @summary Simulate program
9065
+ * Returns the collision link chain.
9066
+ * @summary Get Link Chain
9241
9067
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9242
- * @param {ProgramRunRequest} programRunRequest
9068
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9243
9069
  * @param {*} [options] Override http request option.
9244
9070
  * @throws {RequiredError}
9245
9071
  */
9246
- simulateProgram: async (cell: string, programRunRequest: ProgramRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9072
+ getStoredCollisionLinkChain: async (cell: string, linkChain: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9247
9073
  // verify required parameter 'cell' is not null or undefined
9248
- assertParamExists('simulateProgram', 'cell', cell)
9249
- // verify required parameter 'programRunRequest' is not null or undefined
9250
- assertParamExists('simulateProgram', 'programRunRequest', programRunRequest)
9251
- const localVarPath = `/cells/{cell}/programs/simulate`
9252
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9074
+ assertParamExists('getStoredCollisionLinkChain', 'cell', cell)
9075
+ // verify required parameter 'linkChain' is not null or undefined
9076
+ assertParamExists('getStoredCollisionLinkChain', 'linkChain', linkChain)
9077
+ const localVarPath = `/cells/{cell}/store/collision/link-chains/{link-chain}`
9078
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9079
+ .replace(`{${"link-chain"}}`, encodeURIComponent(String(linkChain)));
9253
9080
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9254
9081
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9255
9082
  let baseOptions;
@@ -9257,7 +9084,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9257
9084
  baseOptions = configuration.baseOptions;
9258
9085
  }
9259
9086
 
9260
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
9087
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9261
9088
  const localVarHeaderParameter = {} as any;
9262
9089
  const localVarQueryParameter = {} as any;
9263
9090
 
@@ -9271,12 +9098,9 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9271
9098
 
9272
9099
 
9273
9100
 
9274
- localVarHeaderParameter['Content-Type'] = 'application/json';
9275
-
9276
9101
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9277
9102
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9278
9103
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9279
- localVarRequestOptions.data = serializeDataIfNeeded(programRunRequest, localVarRequestOptions, configuration)
9280
9104
 
9281
9105
  return {
9282
9106
  url: toPathString(localVarUrlObj),
@@ -9284,17 +9108,21 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9284
9108
  };
9285
9109
  },
9286
9110
  /**
9287
- * Stop all runs
9288
- * @summary Stop all programs
9111
+ * Returns the stored tool.
9112
+ * @summary Get Tool
9289
9113
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9114
+ * @param {string} tool Unique identifier addressing a collision tool.
9290
9115
  * @param {*} [options] Override http request option.
9291
9116
  * @throws {RequiredError}
9292
9117
  */
9293
- stopAllPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9118
+ getStoredCollisionTool: async (cell: string, tool: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9294
9119
  // verify required parameter 'cell' is not null or undefined
9295
- assertParamExists('stopAllPrograms', 'cell', cell)
9296
- const localVarPath = `/cells/{cell}/programs/runs/stop`
9297
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9120
+ assertParamExists('getStoredCollisionTool', 'cell', cell)
9121
+ // verify required parameter 'tool' is not null or undefined
9122
+ assertParamExists('getStoredCollisionTool', 'tool', tool)
9123
+ const localVarPath = `/cells/{cell}/store/collision/tools/{tool}`
9124
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9125
+ .replace(`{${"tool"}}`, encodeURIComponent(String(tool)));
9298
9126
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9299
9127
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9300
9128
  let baseOptions;
@@ -9302,7 +9130,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9302
9130
  baseOptions = configuration.baseOptions;
9303
9131
  }
9304
9132
 
9305
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
9133
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9306
9134
  const localVarHeaderParameter = {} as any;
9307
9135
  const localVarQueryParameter = {} as any;
9308
9136
 
@@ -9326,21 +9154,17 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9326
9154
  };
9327
9155
  },
9328
9156
  /**
9329
- * Stop a specific program run.
9330
- * @summary Stop program run
9157
+ * Returns the stored link chains.
9158
+ * @summary List Link Chains
9331
9159
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9332
- * @param {string} run
9333
9160
  * @param {*} [options] Override http request option.
9334
9161
  * @throws {RequiredError}
9335
9162
  */
9336
- stopProgramRun: async (cell: string, run: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9163
+ listCollisionLinkChains: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9337
9164
  // verify required parameter 'cell' is not null or undefined
9338
- assertParamExists('stopProgramRun', 'cell', cell)
9339
- // verify required parameter 'run' is not null or undefined
9340
- assertParamExists('stopProgramRun', 'run', run)
9341
- const localVarPath = `/cells/{cell}/programs/runs/{run}/stop`
9342
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9343
- .replace(`{${"run"}}`, encodeURIComponent(String(run)));
9165
+ assertParamExists('listCollisionLinkChains', 'cell', cell)
9166
+ const localVarPath = `/cells/{cell}/store/collision/link-chains`
9167
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9344
9168
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9345
9169
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9346
9170
  let baseOptions;
@@ -9348,7 +9172,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9348
9172
  baseOptions = configuration.baseOptions;
9349
9173
  }
9350
9174
 
9351
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
9175
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9352
9176
  const localVarHeaderParameter = {} as any;
9353
9177
  const localVarQueryParameter = {} as any;
9354
9178
 
@@ -9372,19 +9196,16 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9372
9196
  };
9373
9197
  },
9374
9198
  /**
9375
- * Validate a program
9376
- * @summary Validate program
9199
+ * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
9200
+ * @summary List Colliders
9377
9201
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9378
- * @param {ProgramRunRequest} programRunRequest
9379
9202
  * @param {*} [options] Override http request option.
9380
9203
  * @throws {RequiredError}
9381
9204
  */
9382
- validateProgram: async (cell: string, programRunRequest: ProgramRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9205
+ listStoredColliders: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9383
9206
  // verify required parameter 'cell' is not null or undefined
9384
- assertParamExists('validateProgram', 'cell', cell)
9385
- // verify required parameter 'programRunRequest' is not null or undefined
9386
- assertParamExists('validateProgram', 'programRunRequest', programRunRequest)
9387
- const localVarPath = `/cells/{cell}/programs/validate`
9207
+ assertParamExists('listStoredColliders', 'cell', cell)
9208
+ const localVarPath = `/cells/{cell}/store/collision/colliders`
9388
9209
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9389
9210
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9390
9211
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -9393,7 +9214,7 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9393
9214
  baseOptions = configuration.baseOptions;
9394
9215
  }
9395
9216
 
9396
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
9217
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9397
9218
  const localVarHeaderParameter = {} as any;
9398
9219
  const localVarQueryParameter = {} as any;
9399
9220
 
@@ -9407,371 +9228,724 @@ export const ProgramApiAxiosParamCreator = function (configuration?: Configurati
9407
9228
 
9408
9229
 
9409
9230
 
9410
- localVarHeaderParameter['Content-Type'] = 'application/json';
9411
-
9412
9231
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9413
9232
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9414
9233
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9415
- localVarRequestOptions.data = serializeDataIfNeeded(programRunRequest, localVarRequestOptions, configuration)
9416
9234
 
9417
9235
  return {
9418
9236
  url: toPathString(localVarUrlObj),
9419
9237
  options: localVarRequestOptions,
9420
9238
  };
9421
9239
  },
9422
- }
9423
- };
9424
-
9425
- /**
9426
- * ProgramApi - functional programming interface
9427
- * @export
9428
- */
9429
- export const ProgramApiFp = function(configuration?: Configuration) {
9430
- const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
9431
- return {
9432
9240
  /**
9433
- * 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.
9434
- * @summary Create program run
9241
+ * Returns the list of stored tools.
9242
+ * @summary List Tools
9435
9243
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9436
- * @param {ProgramRunRequest} programRunRequest
9437
9244
  * @param {*} [options] Override http request option.
9438
9245
  * @throws {RequiredError}
9439
9246
  */
9440
- async createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRunReference>> {
9441
- const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRun(cell, programRunRequest, options);
9442
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9443
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.createProgramRun']?.[localVarOperationServerIndex]?.url;
9444
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9247
+ listStoredCollisionTools: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9248
+ // verify required parameter 'cell' is not null or undefined
9249
+ assertParamExists('listStoredCollisionTools', 'cell', cell)
9250
+ const localVarPath = `/cells/{cell}/store/collision/tools`
9251
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9252
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9253
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9254
+ let baseOptions;
9255
+ if (configuration) {
9256
+ baseOptions = configuration.baseOptions;
9257
+ }
9258
+
9259
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9260
+ const localVarHeaderParameter = {} as any;
9261
+ const localVarQueryParameter = {} as any;
9262
+
9263
+ // authentication BasicAuth required
9264
+ // http basic authentication required
9265
+ setBasicAuthToObject(localVarRequestOptions, configuration)
9266
+
9267
+ // authentication BearerAuth required
9268
+ // http bearer authentication required
9269
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
9270
+
9271
+
9272
+
9273
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9274
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9275
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9276
+
9277
+ return {
9278
+ url: toPathString(localVarUrlObj),
9279
+ options: localVarRequestOptions,
9280
+ };
9445
9281
  },
9446
9282
  /**
9447
- * 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.
9448
- * @summary Execute program
9283
+ * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
9284
+ * @summary Store Collider
9449
9285
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9450
- * @param {ProgramRunRequest} programRunRequest
9286
+ * @param {string} collider Unique identifier addressing a collider.
9287
+ * @param {Collider} collider2
9451
9288
  * @param {*} [options] Override http request option.
9452
9289
  * @throws {RequiredError}
9453
9290
  */
9454
- async executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
9455
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell, programRunRequest, options);
9456
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9457
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.executeProgram']?.[localVarOperationServerIndex]?.url;
9458
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9291
+ storeCollider: async (cell: string, collider: string, collider2: Collider, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9292
+ // verify required parameter 'cell' is not null or undefined
9293
+ assertParamExists('storeCollider', 'cell', cell)
9294
+ // verify required parameter 'collider' is not null or undefined
9295
+ assertParamExists('storeCollider', 'collider', collider)
9296
+ // verify required parameter 'collider2' is not null or undefined
9297
+ assertParamExists('storeCollider', 'collider2', collider2)
9298
+ const localVarPath = `/cells/{cell}/store/collision/colliders/{collider}`
9299
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9300
+ .replace(`{${"collider"}}`, encodeURIComponent(String(collider)));
9301
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9302
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9303
+ let baseOptions;
9304
+ if (configuration) {
9305
+ baseOptions = configuration.baseOptions;
9306
+ }
9307
+
9308
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
9309
+ const localVarHeaderParameter = {} as any;
9310
+ const localVarQueryParameter = {} as any;
9311
+
9312
+ // authentication BasicAuth required
9313
+ // http basic authentication required
9314
+ setBasicAuthToObject(localVarRequestOptions, configuration)
9315
+
9316
+ // authentication BearerAuth required
9317
+ // http bearer authentication required
9318
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
9319
+
9320
+
9321
+
9322
+ localVarHeaderParameter['Content-Type'] = 'application/json';
9323
+
9324
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9325
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9326
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9327
+ localVarRequestOptions.data = serializeDataIfNeeded(collider2, localVarRequestOptions, configuration)
9328
+
9329
+ return {
9330
+ url: toPathString(localVarUrlObj),
9331
+ options: localVarRequestOptions,
9332
+ };
9459
9333
  },
9460
9334
  /**
9461
- * 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, ...
9462
- * @summary Get program run
9335
+ * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
9336
+ * @summary Store Link Chain
9463
9337
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9464
- * @param {string} run
9338
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9339
+ * @param {Array<{ [key: string]: Collider; }>} collider
9465
9340
  * @param {*} [options] Override http request option.
9466
9341
  * @throws {RequiredError}
9467
9342
  */
9468
- async getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
9469
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRun(cell, run, options);
9470
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9471
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRun']?.[localVarOperationServerIndex]?.url;
9472
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9343
+ storeCollisionLinkChain: async (cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9344
+ // verify required parameter 'cell' is not null or undefined
9345
+ assertParamExists('storeCollisionLinkChain', 'cell', cell)
9346
+ // verify required parameter 'linkChain' is not null or undefined
9347
+ assertParamExists('storeCollisionLinkChain', 'linkChain', linkChain)
9348
+ // verify required parameter 'collider' is not null or undefined
9349
+ assertParamExists('storeCollisionLinkChain', 'collider', collider)
9350
+ const localVarPath = `/cells/{cell}/store/collision/link-chains/{link-chain}`
9351
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9352
+ .replace(`{${"link-chain"}}`, encodeURIComponent(String(linkChain)));
9353
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9354
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9355
+ let baseOptions;
9356
+ if (configuration) {
9357
+ baseOptions = configuration.baseOptions;
9358
+ }
9359
+
9360
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
9361
+ const localVarHeaderParameter = {} as any;
9362
+ const localVarQueryParameter = {} as any;
9363
+
9364
+ // authentication BasicAuth required
9365
+ // http basic authentication required
9366
+ setBasicAuthToObject(localVarRequestOptions, configuration)
9367
+
9368
+ // authentication BearerAuth required
9369
+ // http bearer authentication required
9370
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
9371
+
9372
+
9373
+
9374
+ localVarHeaderParameter['Content-Type'] = 'application/json';
9375
+
9376
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9377
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9378
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9379
+ localVarRequestOptions.data = serializeDataIfNeeded(collider, localVarRequestOptions, configuration)
9380
+
9381
+ return {
9382
+ url: toPathString(localVarUrlObj),
9383
+ options: localVarRequestOptions,
9384
+ };
9473
9385
  },
9474
9386
  /**
9475
- * Get details about all existing runs
9476
- * @summary List programs
9387
+ * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
9388
+ * @summary Store Tool
9477
9389
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9390
+ * @param {string} tool Unique identifier addressing a collision tool.
9391
+ * @param {{ [key: string]: Collider; }} requestBody
9478
9392
  * @param {*} [options] Override http request option.
9479
9393
  * @throws {RequiredError}
9480
9394
  */
9481
- async getProgramRuns(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProgramRunReference>>> {
9482
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRuns(cell, options);
9483
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9484
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRuns']?.[localVarOperationServerIndex]?.url;
9485
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9395
+ storeCollisionTool: async (cell: string, tool: string, requestBody: { [key: string]: Collider; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9396
+ // verify required parameter 'cell' is not null or undefined
9397
+ assertParamExists('storeCollisionTool', 'cell', cell)
9398
+ // verify required parameter 'tool' is not null or undefined
9399
+ assertParamExists('storeCollisionTool', 'tool', tool)
9400
+ // verify required parameter 'requestBody' is not null or undefined
9401
+ assertParamExists('storeCollisionTool', 'requestBody', requestBody)
9402
+ const localVarPath = `/cells/{cell}/store/collision/tools/{tool}`
9403
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9404
+ .replace(`{${"tool"}}`, encodeURIComponent(String(tool)));
9405
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9406
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9407
+ let baseOptions;
9408
+ if (configuration) {
9409
+ baseOptions = configuration.baseOptions;
9410
+ }
9411
+
9412
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
9413
+ const localVarHeaderParameter = {} as any;
9414
+ const localVarQueryParameter = {} as any;
9415
+
9416
+ // authentication BasicAuth required
9417
+ // http basic authentication required
9418
+ setBasicAuthToObject(localVarRequestOptions, configuration)
9419
+
9420
+ // authentication BearerAuth required
9421
+ // http bearer authentication required
9422
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
9423
+
9424
+
9425
+
9426
+ localVarHeaderParameter['Content-Type'] = 'application/json';
9427
+
9428
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9429
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9430
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9431
+ localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
9432
+
9433
+ return {
9434
+ url: toPathString(localVarUrlObj),
9435
+ options: localVarRequestOptions,
9436
+ };
9486
9437
  },
9438
+ }
9439
+ };
9440
+
9441
+ /**
9442
+ * StoreCollisionComponentsApi - functional programming interface
9443
+ * @export
9444
+ */
9445
+ export const StoreCollisionComponentsApiFp = function(configuration?: Configuration) {
9446
+ const localVarAxiosParamCreator = StoreCollisionComponentsApiAxiosParamCreator(configuration)
9447
+ return {
9487
9448
  /**
9488
- * Simulate a program given as text/plain
9489
- * @summary Simulate program
9449
+ * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
9450
+ * @summary Delete Collider
9490
9451
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9491
- * @param {ProgramRunRequest} programRunRequest
9452
+ * @param {string} collider Unique identifier addressing a collider.
9492
9453
  * @param {*} [options] Override http request option.
9493
9454
  * @throws {RequiredError}
9494
9455
  */
9495
- async simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
9496
- const localVarAxiosArgs = await localVarAxiosParamCreator.simulateProgram(cell, programRunRequest, options);
9456
+ async deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9457
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollider(cell, collider, options);
9497
9458
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9498
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.simulateProgram']?.[localVarOperationServerIndex]?.url;
9459
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.deleteStoredCollider']?.[localVarOperationServerIndex]?.url;
9499
9460
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9500
9461
  },
9501
9462
  /**
9502
- * Stop all runs
9503
- * @summary Stop all programs
9463
+ * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
9464
+ * @summary Delete Link Chain
9504
9465
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9466
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9505
9467
  * @param {*} [options] Override http request option.
9506
9468
  * @throws {RequiredError}
9507
9469
  */
9508
- async stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9509
- const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllPrograms(cell, options);
9470
+ async deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9471
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionLinkChain(cell, linkChain, options);
9510
9472
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9511
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllPrograms']?.[localVarOperationServerIndex]?.url;
9473
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.deleteStoredCollisionLinkChain']?.[localVarOperationServerIndex]?.url;
9512
9474
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9513
9475
  },
9514
9476
  /**
9515
- * Stop a specific program run.
9516
- * @summary Stop program run
9477
+ * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
9478
+ * @summary Delete Tool
9517
9479
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9518
- * @param {string} run
9480
+ * @param {string} tool Unique identifier addressing a collision tool.
9519
9481
  * @param {*} [options] Override http request option.
9520
9482
  * @throws {RequiredError}
9521
9483
  */
9522
- async stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9523
- const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgramRun(cell, run, options);
9484
+ async deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9485
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionTool(cell, tool, options);
9524
9486
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9525
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgramRun']?.[localVarOperationServerIndex]?.url;
9487
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.deleteStoredCollisionTool']?.[localVarOperationServerIndex]?.url;
9526
9488
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9527
9489
  },
9528
9490
  /**
9529
- * Validate a program
9530
- * @summary Validate program
9491
+ * Returns the collider.
9492
+ * @summary Get Collider
9531
9493
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9532
- * @param {ProgramRunRequest} programRunRequest
9494
+ * @param {string} collider Unique identifier addressing a collider.
9533
9495
  * @param {*} [options] Override http request option.
9534
9496
  * @throws {RequiredError}
9535
9497
  */
9536
- async validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
9537
- const localVarAxiosArgs = await localVarAxiosParamCreator.validateProgram(cell, programRunRequest, options);
9538
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9539
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.validateProgram']?.[localVarOperationServerIndex]?.url;
9498
+ async getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collider>> {
9499
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollider(cell, collider, options);
9500
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9501
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.getStoredCollider']?.[localVarOperationServerIndex]?.url;
9502
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9503
+ },
9504
+ /**
9505
+ * Returns the collision link chain.
9506
+ * @summary Get Link Chain
9507
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9508
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9509
+ * @param {*} [options] Override http request option.
9510
+ * @throws {RequiredError}
9511
+ */
9512
+ async getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{ [key: string]: Collider; }>>> {
9513
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionLinkChain(cell, linkChain, options);
9514
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9515
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.getStoredCollisionLinkChain']?.[localVarOperationServerIndex]?.url;
9516
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9517
+ },
9518
+ /**
9519
+ * Returns the stored tool.
9520
+ * @summary Get Tool
9521
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9522
+ * @param {string} tool Unique identifier addressing a collision tool.
9523
+ * @param {*} [options] Override http request option.
9524
+ * @throws {RequiredError}
9525
+ */
9526
+ async getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Collider; }>> {
9527
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionTool(cell, tool, options);
9528
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9529
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.getStoredCollisionTool']?.[localVarOperationServerIndex]?.url;
9530
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9531
+ },
9532
+ /**
9533
+ * Returns the stored link chains.
9534
+ * @summary List Link Chains
9535
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9536
+ * @param {*} [options] Override http request option.
9537
+ * @throws {RequiredError}
9538
+ */
9539
+ async listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Array<{ [key: string]: Collider; }>; }>> {
9540
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCollisionLinkChains(cell, options);
9541
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9542
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.listCollisionLinkChains']?.[localVarOperationServerIndex]?.url;
9543
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9544
+ },
9545
+ /**
9546
+ * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
9547
+ * @summary List Colliders
9548
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9549
+ * @param {*} [options] Override http request option.
9550
+ * @throws {RequiredError}
9551
+ */
9552
+ async listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Collider; }>> {
9553
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredColliders(cell, options);
9554
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9555
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.listStoredColliders']?.[localVarOperationServerIndex]?.url;
9556
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9557
+ },
9558
+ /**
9559
+ * Returns the list of stored tools.
9560
+ * @summary List Tools
9561
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9562
+ * @param {*} [options] Override http request option.
9563
+ * @throws {RequiredError}
9564
+ */
9565
+ async listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: Collider; }; }>> {
9566
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionTools(cell, options);
9567
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9568
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.listStoredCollisionTools']?.[localVarOperationServerIndex]?.url;
9569
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9570
+ },
9571
+ /**
9572
+ * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
9573
+ * @summary Store Collider
9574
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9575
+ * @param {string} collider Unique identifier addressing a collider.
9576
+ * @param {Collider} collider2
9577
+ * @param {*} [options] Override http request option.
9578
+ * @throws {RequiredError}
9579
+ */
9580
+ async storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collider>> {
9581
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollider(cell, collider, collider2, options);
9582
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9583
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.storeCollider']?.[localVarOperationServerIndex]?.url;
9584
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9585
+ },
9586
+ /**
9587
+ * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
9588
+ * @summary Store Link Chain
9589
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9590
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9591
+ * @param {Array<{ [key: string]: Collider; }>} collider
9592
+ * @param {*} [options] Override http request option.
9593
+ * @throws {RequiredError}
9594
+ */
9595
+ async storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{ [key: string]: Collider; }>>> {
9596
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionLinkChain(cell, linkChain, collider, options);
9597
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9598
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.storeCollisionLinkChain']?.[localVarOperationServerIndex]?.url;
9599
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9600
+ },
9601
+ /**
9602
+ * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
9603
+ * @summary Store Tool
9604
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9605
+ * @param {string} tool Unique identifier addressing a collision tool.
9606
+ * @param {{ [key: string]: Collider; }} requestBody
9607
+ * @param {*} [options] Override http request option.
9608
+ * @throws {RequiredError}
9609
+ */
9610
+ async storeCollisionTool(cell: string, tool: string, requestBody: { [key: string]: Collider; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Collider; }>> {
9611
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionTool(cell, tool, requestBody, options);
9612
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9613
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.storeCollisionTool']?.[localVarOperationServerIndex]?.url;
9540
9614
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9541
9615
  },
9542
9616
  }
9543
9617
  };
9544
9618
 
9545
9619
  /**
9546
- * ProgramApi - factory interface
9620
+ * StoreCollisionComponentsApi - factory interface
9547
9621
  * @export
9548
9622
  */
9549
- export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
9550
- const localVarFp = ProgramApiFp(configuration)
9623
+ export const StoreCollisionComponentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
9624
+ const localVarFp = StoreCollisionComponentsApiFp(configuration)
9551
9625
  return {
9552
9626
  /**
9553
- * 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.
9554
- * @summary Create program run
9627
+ * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
9628
+ * @summary Delete Collider
9629
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9630
+ * @param {string} collider Unique identifier addressing a collider.
9631
+ * @param {*} [options] Override http request option.
9632
+ * @throws {RequiredError}
9633
+ */
9634
+ deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
9635
+ return localVarFp.deleteStoredCollider(cell, collider, options).then((request) => request(axios, basePath));
9636
+ },
9637
+ /**
9638
+ * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
9639
+ * @summary Delete Link Chain
9640
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9641
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9642
+ * @param {*} [options] Override http request option.
9643
+ * @throws {RequiredError}
9644
+ */
9645
+ deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
9646
+ return localVarFp.deleteStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(axios, basePath));
9647
+ },
9648
+ /**
9649
+ * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
9650
+ * @summary Delete Tool
9651
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9652
+ * @param {string} tool Unique identifier addressing a collision tool.
9653
+ * @param {*} [options] Override http request option.
9654
+ * @throws {RequiredError}
9655
+ */
9656
+ deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
9657
+ return localVarFp.deleteStoredCollisionTool(cell, tool, options).then((request) => request(axios, basePath));
9658
+ },
9659
+ /**
9660
+ * Returns the collider.
9661
+ * @summary Get Collider
9662
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9663
+ * @param {string} collider Unique identifier addressing a collider.
9664
+ * @param {*} [options] Override http request option.
9665
+ * @throws {RequiredError}
9666
+ */
9667
+ getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): AxiosPromise<Collider> {
9668
+ return localVarFp.getStoredCollider(cell, collider, options).then((request) => request(axios, basePath));
9669
+ },
9670
+ /**
9671
+ * Returns the collision link chain.
9672
+ * @summary Get Link Chain
9555
9673
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9556
- * @param {ProgramRunRequest} programRunRequest
9674
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9557
9675
  * @param {*} [options] Override http request option.
9558
9676
  * @throws {RequiredError}
9559
9677
  */
9560
- createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRunReference> {
9561
- return localVarFp.createProgramRun(cell, programRunRequest, options).then((request) => request(axios, basePath));
9678
+ getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<{ [key: string]: Collider; }>> {
9679
+ return localVarFp.getStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(axios, basePath));
9562
9680
  },
9563
9681
  /**
9564
- * 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.
9565
- * @summary Execute program
9682
+ * Returns the stored tool.
9683
+ * @summary Get Tool
9566
9684
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9567
- * @param {ProgramRunRequest} programRunRequest
9685
+ * @param {string} tool Unique identifier addressing a collision tool.
9568
9686
  * @param {*} [options] Override http request option.
9569
9687
  * @throws {RequiredError}
9570
9688
  */
9571
- executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
9572
- return localVarFp.executeProgram(cell, programRunRequest, options).then((request) => request(axios, basePath));
9689
+ getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Collider; }> {
9690
+ return localVarFp.getStoredCollisionTool(cell, tool, options).then((request) => request(axios, basePath));
9573
9691
  },
9574
9692
  /**
9575
- * 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, ...
9576
- * @summary Get program run
9693
+ * Returns the stored link chains.
9694
+ * @summary List Link Chains
9577
9695
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9578
- * @param {string} run
9579
9696
  * @param {*} [options] Override http request option.
9580
9697
  * @throws {RequiredError}
9581
9698
  */
9582
- getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
9583
- return localVarFp.getProgramRun(cell, run, options).then((request) => request(axios, basePath));
9699
+ listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Array<{ [key: string]: Collider; }>; }> {
9700
+ return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
9584
9701
  },
9585
9702
  /**
9586
- * Get details about all existing runs
9587
- * @summary List programs
9703
+ * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
9704
+ * @summary List Colliders
9588
9705
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9589
9706
  * @param {*} [options] Override http request option.
9590
9707
  * @throws {RequiredError}
9591
9708
  */
9592
- getProgramRuns(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProgramRunReference>> {
9593
- return localVarFp.getProgramRuns(cell, options).then((request) => request(axios, basePath));
9709
+ listStoredColliders(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Collider; }> {
9710
+ return localVarFp.listStoredColliders(cell, options).then((request) => request(axios, basePath));
9594
9711
  },
9595
9712
  /**
9596
- * Simulate a program given as text/plain
9597
- * @summary Simulate program
9713
+ * Returns the list of stored tools.
9714
+ * @summary List Tools
9598
9715
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9599
- * @param {ProgramRunRequest} programRunRequest
9600
9716
  * @param {*} [options] Override http request option.
9601
9717
  * @throws {RequiredError}
9602
9718
  */
9603
- simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
9604
- return localVarFp.simulateProgram(cell, programRunRequest, options).then((request) => request(axios, basePath));
9719
+ listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: Collider; }; }> {
9720
+ return localVarFp.listStoredCollisionTools(cell, options).then((request) => request(axios, basePath));
9605
9721
  },
9606
9722
  /**
9607
- * Stop all runs
9608
- * @summary Stop all programs
9723
+ * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
9724
+ * @summary Store Collider
9609
9725
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9726
+ * @param {string} collider Unique identifier addressing a collider.
9727
+ * @param {Collider} collider2
9610
9728
  * @param {*} [options] Override http request option.
9611
9729
  * @throws {RequiredError}
9612
9730
  */
9613
- stopAllPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
9614
- return localVarFp.stopAllPrograms(cell, options).then((request) => request(axios, basePath));
9731
+ storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): AxiosPromise<Collider> {
9732
+ return localVarFp.storeCollider(cell, collider, collider2, options).then((request) => request(axios, basePath));
9615
9733
  },
9616
9734
  /**
9617
- * Stop a specific program run.
9618
- * @summary Stop program run
9735
+ * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
9736
+ * @summary Store Link Chain
9619
9737
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9620
- * @param {string} run
9738
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9739
+ * @param {Array<{ [key: string]: Collider; }>} collider
9621
9740
  * @param {*} [options] Override http request option.
9622
9741
  * @throws {RequiredError}
9623
9742
  */
9624
- stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
9625
- return localVarFp.stopProgramRun(cell, run, options).then((request) => request(axios, basePath));
9743
+ storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options?: RawAxiosRequestConfig): AxiosPromise<Array<{ [key: string]: Collider; }>> {
9744
+ return localVarFp.storeCollisionLinkChain(cell, linkChain, collider, options).then((request) => request(axios, basePath));
9626
9745
  },
9627
9746
  /**
9628
- * Validate a program
9629
- * @summary Validate program
9747
+ * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
9748
+ * @summary Store Tool
9630
9749
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9631
- * @param {ProgramRunRequest} programRunRequest
9750
+ * @param {string} tool Unique identifier addressing a collision tool.
9751
+ * @param {{ [key: string]: Collider; }} requestBody
9632
9752
  * @param {*} [options] Override http request option.
9633
9753
  * @throws {RequiredError}
9634
9754
  */
9635
- validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
9636
- return localVarFp.validateProgram(cell, programRunRequest, options).then((request) => request(axios, basePath));
9755
+ storeCollisionTool(cell: string, tool: string, requestBody: { [key: string]: Collider; }, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Collider; }> {
9756
+ return localVarFp.storeCollisionTool(cell, tool, requestBody, options).then((request) => request(axios, basePath));
9637
9757
  },
9638
9758
  };
9639
9759
  };
9640
9760
 
9641
9761
  /**
9642
- * ProgramApi - object-oriented interface
9762
+ * StoreCollisionComponentsApi - object-oriented interface
9643
9763
  * @export
9644
- * @class ProgramApi
9764
+ * @class StoreCollisionComponentsApi
9645
9765
  * @extends {BaseAPI}
9646
9766
  */
9647
- export class ProgramApi extends BaseAPI {
9767
+ export class StoreCollisionComponentsApi extends BaseAPI {
9648
9768
  /**
9649
- * 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.
9650
- * @summary Create program run
9769
+ * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
9770
+ * @summary Delete Collider
9651
9771
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9652
- * @param {ProgramRunRequest} programRunRequest
9772
+ * @param {string} collider Unique identifier addressing a collider.
9653
9773
  * @param {*} [options] Override http request option.
9654
9774
  * @throws {RequiredError}
9655
- * @memberof ProgramApi
9775
+ * @memberof StoreCollisionComponentsApi
9656
9776
  */
9657
- public createProgramRun(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) {
9658
- return ProgramApiFp(this.configuration).createProgramRun(cell, programRunRequest, options).then((request) => request(this.axios, this.basePath));
9777
+ public deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig) {
9778
+ return StoreCollisionComponentsApiFp(this.configuration).deleteStoredCollider(cell, collider, options).then((request) => request(this.axios, this.basePath));
9659
9779
  }
9660
9780
 
9661
9781
  /**
9662
- * 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.
9663
- * @summary Execute program
9782
+ * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
9783
+ * @summary Delete Link Chain
9664
9784
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9665
- * @param {ProgramRunRequest} programRunRequest
9785
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9666
9786
  * @param {*} [options] Override http request option.
9667
9787
  * @throws {RequiredError}
9668
- * @memberof ProgramApi
9788
+ * @memberof StoreCollisionComponentsApi
9669
9789
  */
9670
- public executeProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) {
9671
- return ProgramApiFp(this.configuration).executeProgram(cell, programRunRequest, options).then((request) => request(this.axios, this.basePath));
9790
+ public deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig) {
9791
+ return StoreCollisionComponentsApiFp(this.configuration).deleteStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(this.axios, this.basePath));
9672
9792
  }
9673
9793
 
9674
9794
  /**
9675
- * 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, ...
9676
- * @summary Get program run
9795
+ * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
9796
+ * @summary Delete Tool
9677
9797
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9678
- * @param {string} run
9798
+ * @param {string} tool Unique identifier addressing a collision tool.
9679
9799
  * @param {*} [options] Override http request option.
9680
9800
  * @throws {RequiredError}
9681
- * @memberof ProgramApi
9801
+ * @memberof StoreCollisionComponentsApi
9682
9802
  */
9683
- public getProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig) {
9684
- return ProgramApiFp(this.configuration).getProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
9803
+ public deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig) {
9804
+ return StoreCollisionComponentsApiFp(this.configuration).deleteStoredCollisionTool(cell, tool, options).then((request) => request(this.axios, this.basePath));
9685
9805
  }
9686
9806
 
9687
9807
  /**
9688
- * Get details about all existing runs
9689
- * @summary List programs
9808
+ * Returns the collider.
9809
+ * @summary Get Collider
9690
9810
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9811
+ * @param {string} collider Unique identifier addressing a collider.
9691
9812
  * @param {*} [options] Override http request option.
9692
9813
  * @throws {RequiredError}
9693
- * @memberof ProgramApi
9814
+ * @memberof StoreCollisionComponentsApi
9694
9815
  */
9695
- public getProgramRuns(cell: string, options?: RawAxiosRequestConfig) {
9696
- return ProgramApiFp(this.configuration).getProgramRuns(cell, options).then((request) => request(this.axios, this.basePath));
9816
+ public getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig) {
9817
+ return StoreCollisionComponentsApiFp(this.configuration).getStoredCollider(cell, collider, options).then((request) => request(this.axios, this.basePath));
9697
9818
  }
9698
9819
 
9699
9820
  /**
9700
- * Simulate a program given as text/plain
9701
- * @summary Simulate program
9821
+ * Returns the collision link chain.
9822
+ * @summary Get Link Chain
9702
9823
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9703
- * @param {ProgramRunRequest} programRunRequest
9824
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9704
9825
  * @param {*} [options] Override http request option.
9705
9826
  * @throws {RequiredError}
9706
- * @memberof ProgramApi
9827
+ * @memberof StoreCollisionComponentsApi
9707
9828
  */
9708
- public simulateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) {
9709
- return ProgramApiFp(this.configuration).simulateProgram(cell, programRunRequest, options).then((request) => request(this.axios, this.basePath));
9829
+ public getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig) {
9830
+ return StoreCollisionComponentsApiFp(this.configuration).getStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(this.axios, this.basePath));
9710
9831
  }
9711
9832
 
9712
9833
  /**
9713
- * Stop all runs
9714
- * @summary Stop all programs
9834
+ * Returns the stored tool.
9835
+ * @summary Get Tool
9715
9836
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9837
+ * @param {string} tool Unique identifier addressing a collision tool.
9716
9838
  * @param {*} [options] Override http request option.
9717
9839
  * @throws {RequiredError}
9718
- * @memberof ProgramApi
9840
+ * @memberof StoreCollisionComponentsApi
9719
9841
  */
9720
- public stopAllPrograms(cell: string, options?: RawAxiosRequestConfig) {
9721
- return ProgramApiFp(this.configuration).stopAllPrograms(cell, options).then((request) => request(this.axios, this.basePath));
9842
+ public getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig) {
9843
+ return StoreCollisionComponentsApiFp(this.configuration).getStoredCollisionTool(cell, tool, options).then((request) => request(this.axios, this.basePath));
9722
9844
  }
9723
9845
 
9724
9846
  /**
9725
- * Stop a specific program run.
9726
- * @summary Stop program run
9847
+ * Returns the stored link chains.
9848
+ * @summary List Link Chains
9727
9849
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9728
- * @param {string} run
9729
9850
  * @param {*} [options] Override http request option.
9730
9851
  * @throws {RequiredError}
9731
- * @memberof ProgramApi
9852
+ * @memberof StoreCollisionComponentsApi
9732
9853
  */
9733
- public stopProgramRun(cell: string, run: string, options?: RawAxiosRequestConfig) {
9734
- return ProgramApiFp(this.configuration).stopProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
9854
+ public listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig) {
9855
+ return StoreCollisionComponentsApiFp(this.configuration).listCollisionLinkChains(cell, options).then((request) => request(this.axios, this.basePath));
9735
9856
  }
9736
9857
 
9737
9858
  /**
9738
- * Validate a program
9739
- * @summary Validate program
9859
+ * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
9860
+ * @summary List Colliders
9740
9861
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9741
- * @param {ProgramRunRequest} programRunRequest
9742
9862
  * @param {*} [options] Override http request option.
9743
9863
  * @throws {RequiredError}
9744
- * @memberof ProgramApi
9864
+ * @memberof StoreCollisionComponentsApi
9745
9865
  */
9746
- public validateProgram(cell: string, programRunRequest: ProgramRunRequest, options?: RawAxiosRequestConfig) {
9747
- return ProgramApiFp(this.configuration).validateProgram(cell, programRunRequest, options).then((request) => request(this.axios, this.basePath));
9866
+ public listStoredColliders(cell: string, options?: RawAxiosRequestConfig) {
9867
+ return StoreCollisionComponentsApiFp(this.configuration).listStoredColliders(cell, options).then((request) => request(this.axios, this.basePath));
9748
9868
  }
9749
- }
9750
-
9751
9869
 
9752
-
9753
- /**
9754
- * StoreCollisionComponentsApi - axios parameter creator
9870
+ /**
9871
+ * Returns the list of stored tools.
9872
+ * @summary List Tools
9873
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9874
+ * @param {*} [options] Override http request option.
9875
+ * @throws {RequiredError}
9876
+ * @memberof StoreCollisionComponentsApi
9877
+ */
9878
+ public listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig) {
9879
+ return StoreCollisionComponentsApiFp(this.configuration).listStoredCollisionTools(cell, options).then((request) => request(this.axios, this.basePath));
9880
+ }
9881
+
9882
+ /**
9883
+ * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
9884
+ * @summary Store Collider
9885
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9886
+ * @param {string} collider Unique identifier addressing a collider.
9887
+ * @param {Collider} collider2
9888
+ * @param {*} [options] Override http request option.
9889
+ * @throws {RequiredError}
9890
+ * @memberof StoreCollisionComponentsApi
9891
+ */
9892
+ public storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig) {
9893
+ return StoreCollisionComponentsApiFp(this.configuration).storeCollider(cell, collider, collider2, options).then((request) => request(this.axios, this.basePath));
9894
+ }
9895
+
9896
+ /**
9897
+ * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
9898
+ * @summary Store Link Chain
9899
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9900
+ * @param {string} linkChain Unique identifier addressing a collision link chain.
9901
+ * @param {Array<{ [key: string]: Collider; }>} collider
9902
+ * @param {*} [options] Override http request option.
9903
+ * @throws {RequiredError}
9904
+ * @memberof StoreCollisionComponentsApi
9905
+ */
9906
+ public storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options?: RawAxiosRequestConfig) {
9907
+ return StoreCollisionComponentsApiFp(this.configuration).storeCollisionLinkChain(cell, linkChain, collider, options).then((request) => request(this.axios, this.basePath));
9908
+ }
9909
+
9910
+ /**
9911
+ * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
9912
+ * @summary Store Tool
9913
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
9914
+ * @param {string} tool Unique identifier addressing a collision tool.
9915
+ * @param {{ [key: string]: Collider; }} requestBody
9916
+ * @param {*} [options] Override http request option.
9917
+ * @throws {RequiredError}
9918
+ * @memberof StoreCollisionComponentsApi
9919
+ */
9920
+ public storeCollisionTool(cell: string, tool: string, requestBody: { [key: string]: Collider; }, options?: RawAxiosRequestConfig) {
9921
+ return StoreCollisionComponentsApiFp(this.configuration).storeCollisionTool(cell, tool, requestBody, options).then((request) => request(this.axios, this.basePath));
9922
+ }
9923
+ }
9924
+
9925
+
9926
+
9927
+ /**
9928
+ * StoreCollisionScenesApi - axios parameter creator
9755
9929
  * @export
9756
9930
  */
9757
- export const StoreCollisionComponentsApiAxiosParamCreator = function (configuration?: Configuration) {
9931
+ export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?: Configuration) {
9758
9932
  return {
9759
9933
  /**
9760
- * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
9761
- * @summary Delete Collider
9934
+ * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
9935
+ * @summary Delete Scene
9762
9936
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9763
- * @param {string} collider Unique identifier addressing a collider.
9937
+ * @param {string} scene Unique identifier addressing a collision scene.
9764
9938
  * @param {*} [options] Override http request option.
9765
9939
  * @throws {RequiredError}
9766
9940
  */
9767
- deleteStoredCollider: async (cell: string, collider: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9941
+ deleteStoredCollisionScene: async (cell: string, scene: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9768
9942
  // verify required parameter 'cell' is not null or undefined
9769
- assertParamExists('deleteStoredCollider', 'cell', cell)
9770
- // verify required parameter 'collider' is not null or undefined
9771
- assertParamExists('deleteStoredCollider', 'collider', collider)
9772
- const localVarPath = `/cells/{cell}/store/collision/colliders/{collider}`
9943
+ assertParamExists('deleteStoredCollisionScene', 'cell', cell)
9944
+ // verify required parameter 'scene' is not null or undefined
9945
+ assertParamExists('deleteStoredCollisionScene', 'scene', scene)
9946
+ const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
9773
9947
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9774
- .replace(`{${"collider"}}`, encodeURIComponent(String(collider)));
9948
+ .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
9775
9949
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9776
9950
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9777
9951
  let baseOptions;
@@ -9803,21 +9977,21 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
9803
9977
  };
9804
9978
  },
9805
9979
  /**
9806
- * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
9807
- * @summary Delete Link Chain
9980
+ * Returns the stored scene.
9981
+ * @summary Get Scene
9808
9982
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9809
- * @param {string} linkChain Unique identifier addressing a collision link chain.
9983
+ * @param {string} scene Unique identifier addressing a collision scene.
9810
9984
  * @param {*} [options] Override http request option.
9811
9985
  * @throws {RequiredError}
9812
9986
  */
9813
- deleteStoredCollisionLinkChain: async (cell: string, linkChain: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9987
+ getStoredCollisionScene: async (cell: string, scene: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9814
9988
  // verify required parameter 'cell' is not null or undefined
9815
- assertParamExists('deleteStoredCollisionLinkChain', 'cell', cell)
9816
- // verify required parameter 'linkChain' is not null or undefined
9817
- assertParamExists('deleteStoredCollisionLinkChain', 'linkChain', linkChain)
9818
- const localVarPath = `/cells/{cell}/store/collision/link-chains/{link-chain}`
9989
+ assertParamExists('getStoredCollisionScene', 'cell', cell)
9990
+ // verify required parameter 'scene' is not null or undefined
9991
+ assertParamExists('getStoredCollisionScene', 'scene', scene)
9992
+ const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
9819
9993
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9820
- .replace(`{${"link-chain"}}`, encodeURIComponent(String(linkChain)));
9994
+ .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
9821
9995
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9822
9996
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9823
9997
  let baseOptions;
@@ -9825,7 +9999,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
9825
9999
  baseOptions = configuration.baseOptions;
9826
10000
  }
9827
10001
 
9828
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
10002
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9829
10003
  const localVarHeaderParameter = {} as any;
9830
10004
  const localVarQueryParameter = {} as any;
9831
10005
 
@@ -9849,21 +10023,17 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
9849
10023
  };
9850
10024
  },
9851
10025
  /**
9852
- * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
9853
- * @summary Delete Tool
10026
+ * Returns a list of stored scenes.
10027
+ * @summary List Scenes
9854
10028
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9855
- * @param {string} tool Unique identifier addressing a collision tool.
9856
10029
  * @param {*} [options] Override http request option.
9857
10030
  * @throws {RequiredError}
9858
10031
  */
9859
- deleteStoredCollisionTool: async (cell: string, tool: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10032
+ listStoredCollisionScenes: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9860
10033
  // verify required parameter 'cell' is not null or undefined
9861
- assertParamExists('deleteStoredCollisionTool', 'cell', cell)
9862
- // verify required parameter 'tool' is not null or undefined
9863
- assertParamExists('deleteStoredCollisionTool', 'tool', tool)
9864
- const localVarPath = `/cells/{cell}/store/collision/tools/{tool}`
9865
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9866
- .replace(`{${"tool"}}`, encodeURIComponent(String(tool)));
10034
+ assertParamExists('listStoredCollisionScenes', 'cell', cell)
10035
+ const localVarPath = `/cells/{cell}/store/collision/scenes`
10036
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
9867
10037
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9868
10038
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9869
10039
  let baseOptions;
@@ -9871,7 +10041,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
9871
10041
  baseOptions = configuration.baseOptions;
9872
10042
  }
9873
10043
 
9874
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
10044
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9875
10045
  const localVarHeaderParameter = {} as any;
9876
10046
  const localVarQueryParameter = {} as any;
9877
10047
 
@@ -9895,21 +10065,24 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
9895
10065
  };
9896
10066
  },
9897
10067
  /**
9898
- * Returns the collider.
9899
- * @summary Get Collider
10068
+ * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10069
+ * @summary Store Scene
9900
10070
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9901
- * @param {string} collider Unique identifier addressing a collider.
10071
+ * @param {string} scene Unique identifier addressing a collision scene.
10072
+ * @param {CollisionSceneAssembly} collisionSceneAssembly
9902
10073
  * @param {*} [options] Override http request option.
9903
10074
  * @throws {RequiredError}
9904
10075
  */
9905
- getStoredCollider: async (cell: string, collider: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10076
+ storeCollisionScene: async (cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9906
10077
  // verify required parameter 'cell' is not null or undefined
9907
- assertParamExists('getStoredCollider', 'cell', cell)
9908
- // verify required parameter 'collider' is not null or undefined
9909
- assertParamExists('getStoredCollider', 'collider', collider)
9910
- const localVarPath = `/cells/{cell}/store/collision/colliders/{collider}`
10078
+ assertParamExists('storeCollisionScene', 'cell', cell)
10079
+ // verify required parameter 'scene' is not null or undefined
10080
+ assertParamExists('storeCollisionScene', 'scene', scene)
10081
+ // verify required parameter 'collisionSceneAssembly' is not null or undefined
10082
+ assertParamExists('storeCollisionScene', 'collisionSceneAssembly', collisionSceneAssembly)
10083
+ const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
9911
10084
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9912
- .replace(`{${"collider"}}`, encodeURIComponent(String(collider)));
10085
+ .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
9913
10086
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9914
10087
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9915
10088
  let baseOptions;
@@ -9917,7 +10090,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
9917
10090
  baseOptions = configuration.baseOptions;
9918
10091
  }
9919
10092
 
9920
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10093
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
9921
10094
  const localVarHeaderParameter = {} as any;
9922
10095
  const localVarQueryParameter = {} as any;
9923
10096
 
@@ -9931,1827 +10104,313 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
9931
10104
 
9932
10105
 
9933
10106
 
10107
+ localVarHeaderParameter['Content-Type'] = 'application/json';
10108
+
9934
10109
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9935
10110
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9936
10111
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10112
+ localVarRequestOptions.data = serializeDataIfNeeded(collisionSceneAssembly, localVarRequestOptions, configuration)
9937
10113
 
9938
10114
  return {
9939
10115
  url: toPathString(localVarUrlObj),
9940
10116
  options: localVarRequestOptions,
9941
10117
  };
9942
10118
  },
10119
+ }
10120
+ };
10121
+
10122
+ /**
10123
+ * StoreCollisionScenesApi - functional programming interface
10124
+ * @export
10125
+ */
10126
+ export const StoreCollisionScenesApiFp = function(configuration?: Configuration) {
10127
+ const localVarAxiosParamCreator = StoreCollisionScenesApiAxiosParamCreator(configuration)
10128
+ return {
9943
10129
  /**
9944
- * Returns the collision link chain.
9945
- * @summary Get Link Chain
10130
+ * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10131
+ * @summary Delete Scene
9946
10132
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9947
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10133
+ * @param {string} scene Unique identifier addressing a collision scene.
9948
10134
  * @param {*} [options] Override http request option.
9949
10135
  * @throws {RequiredError}
9950
10136
  */
9951
- getStoredCollisionLinkChain: async (cell: string, linkChain: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9952
- // verify required parameter 'cell' is not null or undefined
9953
- assertParamExists('getStoredCollisionLinkChain', 'cell', cell)
9954
- // verify required parameter 'linkChain' is not null or undefined
9955
- assertParamExists('getStoredCollisionLinkChain', 'linkChain', linkChain)
9956
- const localVarPath = `/cells/{cell}/store/collision/link-chains/{link-chain}`
9957
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
9958
- .replace(`{${"link-chain"}}`, encodeURIComponent(String(linkChain)));
9959
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
9960
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9961
- let baseOptions;
9962
- if (configuration) {
9963
- baseOptions = configuration.baseOptions;
9964
- }
9965
-
9966
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
9967
- const localVarHeaderParameter = {} as any;
9968
- const localVarQueryParameter = {} as any;
9969
-
9970
- // authentication BasicAuth required
9971
- // http basic authentication required
9972
- setBasicAuthToObject(localVarRequestOptions, configuration)
9973
-
9974
- // authentication BearerAuth required
9975
- // http bearer authentication required
9976
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
9977
-
9978
-
9979
-
9980
- setSearchParams(localVarUrlObj, localVarQueryParameter);
9981
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9982
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
9983
-
9984
- return {
9985
- url: toPathString(localVarUrlObj),
9986
- options: localVarRequestOptions,
9987
- };
10137
+ async deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10138
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionScene(cell, scene, options);
10139
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10140
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.deleteStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
10141
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9988
10142
  },
9989
10143
  /**
9990
- * Returns the stored tool.
9991
- * @summary Get Tool
10144
+ * Returns the stored scene.
10145
+ * @summary Get Scene
9992
10146
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9993
- * @param {string} tool Unique identifier addressing a collision tool.
10147
+ * @param {string} scene Unique identifier addressing a collision scene.
9994
10148
  * @param {*} [options] Override http request option.
9995
10149
  * @throws {RequiredError}
9996
10150
  */
9997
- getStoredCollisionTool: async (cell: string, tool: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
9998
- // verify required parameter 'cell' is not null or undefined
9999
- assertParamExists('getStoredCollisionTool', 'cell', cell)
10000
- // verify required parameter 'tool' is not null or undefined
10001
- assertParamExists('getStoredCollisionTool', 'tool', tool)
10002
- const localVarPath = `/cells/{cell}/store/collision/tools/{tool}`
10003
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10004
- .replace(`{${"tool"}}`, encodeURIComponent(String(tool)));
10005
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10006
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10007
- let baseOptions;
10008
- if (configuration) {
10009
- baseOptions = configuration.baseOptions;
10010
- }
10011
-
10012
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10013
- const localVarHeaderParameter = {} as any;
10014
- const localVarQueryParameter = {} as any;
10015
-
10016
- // authentication BasicAuth required
10017
- // http basic authentication required
10018
- setBasicAuthToObject(localVarRequestOptions, configuration)
10019
-
10020
- // authentication BearerAuth required
10021
- // http bearer authentication required
10022
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10023
-
10024
-
10025
-
10026
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10027
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10028
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10029
-
10030
- return {
10031
- url: toPathString(localVarUrlObj),
10032
- options: localVarRequestOptions,
10033
- };
10151
+ async getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>> {
10152
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionScene(cell, scene, options);
10153
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10154
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.getStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
10155
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10034
10156
  },
10035
10157
  /**
10036
- * Returns the stored link chains.
10037
- * @summary List Link Chains
10158
+ * Returns a list of stored scenes.
10159
+ * @summary List Scenes
10038
10160
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10039
10161
  * @param {*} [options] Override http request option.
10040
10162
  * @throws {RequiredError}
10041
10163
  */
10042
- listCollisionLinkChains: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10043
- // verify required parameter 'cell' is not null or undefined
10044
- assertParamExists('listCollisionLinkChains', 'cell', cell)
10045
- const localVarPath = `/cells/{cell}/store/collision/link-chains`
10046
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
10047
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10048
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10049
- let baseOptions;
10050
- if (configuration) {
10051
- baseOptions = configuration.baseOptions;
10052
- }
10053
-
10054
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10055
- const localVarHeaderParameter = {} as any;
10056
- const localVarQueryParameter = {} as any;
10057
-
10058
- // authentication BasicAuth required
10059
- // http basic authentication required
10060
- setBasicAuthToObject(localVarRequestOptions, configuration)
10061
-
10062
- // authentication BearerAuth required
10063
- // http bearer authentication required
10064
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10065
-
10066
-
10067
-
10068
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10069
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10070
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10071
-
10072
- return {
10073
- url: toPathString(localVarUrlObj),
10074
- options: localVarRequestOptions,
10075
- };
10076
- },
10077
- /**
10078
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
10079
- * @summary List Colliders
10080
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10081
- * @param {*} [options] Override http request option.
10082
- * @throws {RequiredError}
10083
- */
10084
- listStoredColliders: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10085
- // verify required parameter 'cell' is not null or undefined
10086
- assertParamExists('listStoredColliders', 'cell', cell)
10087
- const localVarPath = `/cells/{cell}/store/collision/colliders`
10088
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
10089
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10090
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10091
- let baseOptions;
10092
- if (configuration) {
10093
- baseOptions = configuration.baseOptions;
10094
- }
10095
-
10096
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10097
- const localVarHeaderParameter = {} as any;
10098
- const localVarQueryParameter = {} as any;
10099
-
10100
- // authentication BasicAuth required
10101
- // http basic authentication required
10102
- setBasicAuthToObject(localVarRequestOptions, configuration)
10103
-
10104
- // authentication BearerAuth required
10105
- // http bearer authentication required
10106
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10107
-
10108
-
10109
-
10110
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10111
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10112
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10113
-
10114
- return {
10115
- url: toPathString(localVarUrlObj),
10116
- options: localVarRequestOptions,
10117
- };
10118
- },
10119
- /**
10120
- * Returns the list of stored tools.
10121
- * @summary List Tools
10122
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10123
- * @param {*} [options] Override http request option.
10124
- * @throws {RequiredError}
10125
- */
10126
- listStoredCollisionTools: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10127
- // verify required parameter 'cell' is not null or undefined
10128
- assertParamExists('listStoredCollisionTools', 'cell', cell)
10129
- const localVarPath = `/cells/{cell}/store/collision/tools`
10130
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
10131
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10132
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10133
- let baseOptions;
10134
- if (configuration) {
10135
- baseOptions = configuration.baseOptions;
10136
- }
10137
-
10138
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10139
- const localVarHeaderParameter = {} as any;
10140
- const localVarQueryParameter = {} as any;
10141
-
10142
- // authentication BasicAuth required
10143
- // http basic authentication required
10144
- setBasicAuthToObject(localVarRequestOptions, configuration)
10145
-
10146
- // authentication BearerAuth required
10147
- // http bearer authentication required
10148
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10149
-
10150
-
10151
-
10152
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10153
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10154
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10155
-
10156
- return {
10157
- url: toPathString(localVarUrlObj),
10158
- options: localVarRequestOptions,
10159
- };
10160
- },
10161
- /**
10162
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
10163
- * @summary Store Collider
10164
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10165
- * @param {string} collider Unique identifier addressing a collider.
10166
- * @param {Collider} collider2
10167
- * @param {*} [options] Override http request option.
10168
- * @throws {RequiredError}
10169
- */
10170
- storeCollider: async (cell: string, collider: string, collider2: Collider, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10171
- // verify required parameter 'cell' is not null or undefined
10172
- assertParamExists('storeCollider', 'cell', cell)
10173
- // verify required parameter 'collider' is not null or undefined
10174
- assertParamExists('storeCollider', 'collider', collider)
10175
- // verify required parameter 'collider2' is not null or undefined
10176
- assertParamExists('storeCollider', 'collider2', collider2)
10177
- const localVarPath = `/cells/{cell}/store/collision/colliders/{collider}`
10178
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10179
- .replace(`{${"collider"}}`, encodeURIComponent(String(collider)));
10180
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10181
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10182
- let baseOptions;
10183
- if (configuration) {
10184
- baseOptions = configuration.baseOptions;
10185
- }
10186
-
10187
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
10188
- const localVarHeaderParameter = {} as any;
10189
- const localVarQueryParameter = {} as any;
10190
-
10191
- // authentication BasicAuth required
10192
- // http basic authentication required
10193
- setBasicAuthToObject(localVarRequestOptions, configuration)
10194
-
10195
- // authentication BearerAuth required
10196
- // http bearer authentication required
10197
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10198
-
10199
-
10200
-
10201
- localVarHeaderParameter['Content-Type'] = 'application/json';
10202
-
10203
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10204
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10205
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10206
- localVarRequestOptions.data = serializeDataIfNeeded(collider2, localVarRequestOptions, configuration)
10207
-
10208
- return {
10209
- url: toPathString(localVarUrlObj),
10210
- options: localVarRequestOptions,
10211
- };
10212
- },
10213
- /**
10214
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
10215
- * @summary Store Link Chain
10216
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10217
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10218
- * @param {Array<{ [key: string]: Collider; }>} collider
10219
- * @param {*} [options] Override http request option.
10220
- * @throws {RequiredError}
10221
- */
10222
- storeCollisionLinkChain: async (cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10223
- // verify required parameter 'cell' is not null or undefined
10224
- assertParamExists('storeCollisionLinkChain', 'cell', cell)
10225
- // verify required parameter 'linkChain' is not null or undefined
10226
- assertParamExists('storeCollisionLinkChain', 'linkChain', linkChain)
10227
- // verify required parameter 'collider' is not null or undefined
10228
- assertParamExists('storeCollisionLinkChain', 'collider', collider)
10229
- const localVarPath = `/cells/{cell}/store/collision/link-chains/{link-chain}`
10230
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10231
- .replace(`{${"link-chain"}}`, encodeURIComponent(String(linkChain)));
10232
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10233
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10234
- let baseOptions;
10235
- if (configuration) {
10236
- baseOptions = configuration.baseOptions;
10237
- }
10238
-
10239
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
10240
- const localVarHeaderParameter = {} as any;
10241
- const localVarQueryParameter = {} as any;
10242
-
10243
- // authentication BasicAuth required
10244
- // http basic authentication required
10245
- setBasicAuthToObject(localVarRequestOptions, configuration)
10246
-
10247
- // authentication BearerAuth required
10248
- // http bearer authentication required
10249
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10250
-
10251
-
10252
-
10253
- localVarHeaderParameter['Content-Type'] = 'application/json';
10254
-
10255
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10256
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10257
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10258
- localVarRequestOptions.data = serializeDataIfNeeded(collider, localVarRequestOptions, configuration)
10259
-
10260
- return {
10261
- url: toPathString(localVarUrlObj),
10262
- options: localVarRequestOptions,
10263
- };
10264
- },
10265
- /**
10266
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
10267
- * @summary Store Tool
10268
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10269
- * @param {string} tool Unique identifier addressing a collision tool.
10270
- * @param {{ [key: string]: Collider; }} requestBody
10271
- * @param {*} [options] Override http request option.
10272
- * @throws {RequiredError}
10273
- */
10274
- storeCollisionTool: async (cell: string, tool: string, requestBody: { [key: string]: Collider; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10275
- // verify required parameter 'cell' is not null or undefined
10276
- assertParamExists('storeCollisionTool', 'cell', cell)
10277
- // verify required parameter 'tool' is not null or undefined
10278
- assertParamExists('storeCollisionTool', 'tool', tool)
10279
- // verify required parameter 'requestBody' is not null or undefined
10280
- assertParamExists('storeCollisionTool', 'requestBody', requestBody)
10281
- const localVarPath = `/cells/{cell}/store/collision/tools/{tool}`
10282
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10283
- .replace(`{${"tool"}}`, encodeURIComponent(String(tool)));
10284
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10285
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10286
- let baseOptions;
10287
- if (configuration) {
10288
- baseOptions = configuration.baseOptions;
10289
- }
10290
-
10291
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
10292
- const localVarHeaderParameter = {} as any;
10293
- const localVarQueryParameter = {} as any;
10294
-
10295
- // authentication BasicAuth required
10296
- // http basic authentication required
10297
- setBasicAuthToObject(localVarRequestOptions, configuration)
10298
-
10299
- // authentication BearerAuth required
10300
- // http bearer authentication required
10301
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10302
-
10303
-
10304
-
10305
- localVarHeaderParameter['Content-Type'] = 'application/json';
10306
-
10307
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10308
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10309
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10310
- localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
10311
-
10312
- return {
10313
- url: toPathString(localVarUrlObj),
10314
- options: localVarRequestOptions,
10315
- };
10316
- },
10317
- }
10318
- };
10319
-
10320
- /**
10321
- * StoreCollisionComponentsApi - functional programming interface
10322
- * @export
10323
- */
10324
- export const StoreCollisionComponentsApiFp = function(configuration?: Configuration) {
10325
- const localVarAxiosParamCreator = StoreCollisionComponentsApiAxiosParamCreator(configuration)
10326
- return {
10327
- /**
10328
- * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
10329
- * @summary Delete Collider
10330
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10331
- * @param {string} collider Unique identifier addressing a collider.
10332
- * @param {*} [options] Override http request option.
10333
- * @throws {RequiredError}
10334
- */
10335
- async deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10336
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollider(cell, collider, options);
10337
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10338
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.deleteStoredCollider']?.[localVarOperationServerIndex]?.url;
10339
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10340
- },
10341
- /**
10342
- * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
10343
- * @summary Delete Link Chain
10344
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10345
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10346
- * @param {*} [options] Override http request option.
10347
- * @throws {RequiredError}
10348
- */
10349
- async deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10350
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionLinkChain(cell, linkChain, options);
10351
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10352
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.deleteStoredCollisionLinkChain']?.[localVarOperationServerIndex]?.url;
10353
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10354
- },
10355
- /**
10356
- * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
10357
- * @summary Delete Tool
10358
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10359
- * @param {string} tool Unique identifier addressing a collision tool.
10360
- * @param {*} [options] Override http request option.
10361
- * @throws {RequiredError}
10362
- */
10363
- async deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10364
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionTool(cell, tool, options);
10365
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10366
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.deleteStoredCollisionTool']?.[localVarOperationServerIndex]?.url;
10367
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10368
- },
10369
- /**
10370
- * Returns the collider.
10371
- * @summary Get Collider
10372
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10373
- * @param {string} collider Unique identifier addressing a collider.
10374
- * @param {*} [options] Override http request option.
10375
- * @throws {RequiredError}
10376
- */
10377
- async getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collider>> {
10378
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollider(cell, collider, options);
10379
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10380
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.getStoredCollider']?.[localVarOperationServerIndex]?.url;
10381
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10382
- },
10383
- /**
10384
- * Returns the collision link chain.
10385
- * @summary Get Link Chain
10386
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10387
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10388
- * @param {*} [options] Override http request option.
10389
- * @throws {RequiredError}
10390
- */
10391
- async getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{ [key: string]: Collider; }>>> {
10392
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionLinkChain(cell, linkChain, options);
10393
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10394
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.getStoredCollisionLinkChain']?.[localVarOperationServerIndex]?.url;
10395
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10396
- },
10397
- /**
10398
- * Returns the stored tool.
10399
- * @summary Get Tool
10400
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10401
- * @param {string} tool Unique identifier addressing a collision tool.
10402
- * @param {*} [options] Override http request option.
10403
- * @throws {RequiredError}
10404
- */
10405
- async getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Collider; }>> {
10406
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionTool(cell, tool, options);
10407
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10408
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.getStoredCollisionTool']?.[localVarOperationServerIndex]?.url;
10409
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10410
- },
10411
- /**
10412
- * Returns the stored link chains.
10413
- * @summary List Link Chains
10414
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10415
- * @param {*} [options] Override http request option.
10416
- * @throws {RequiredError}
10417
- */
10418
- async listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Array<{ [key: string]: Collider; }>; }>> {
10419
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCollisionLinkChains(cell, options);
10420
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10421
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.listCollisionLinkChains']?.[localVarOperationServerIndex]?.url;
10422
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10423
- },
10424
- /**
10425
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
10426
- * @summary List Colliders
10427
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10428
- * @param {*} [options] Override http request option.
10429
- * @throws {RequiredError}
10430
- */
10431
- async listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Collider; }>> {
10432
- const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredColliders(cell, options);
10433
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10434
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.listStoredColliders']?.[localVarOperationServerIndex]?.url;
10435
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10436
- },
10437
- /**
10438
- * Returns the list of stored tools.
10439
- * @summary List Tools
10440
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10441
- * @param {*} [options] Override http request option.
10442
- * @throws {RequiredError}
10443
- */
10444
- async listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: Collider; }; }>> {
10445
- const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionTools(cell, options);
10446
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10447
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.listStoredCollisionTools']?.[localVarOperationServerIndex]?.url;
10448
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10449
- },
10450
- /**
10451
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
10452
- * @summary Store Collider
10453
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10454
- * @param {string} collider Unique identifier addressing a collider.
10455
- * @param {Collider} collider2
10456
- * @param {*} [options] Override http request option.
10457
- * @throws {RequiredError}
10458
- */
10459
- async storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Collider>> {
10460
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollider(cell, collider, collider2, options);
10461
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10462
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.storeCollider']?.[localVarOperationServerIndex]?.url;
10463
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10464
- },
10465
- /**
10466
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
10467
- * @summary Store Link Chain
10468
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10469
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10470
- * @param {Array<{ [key: string]: Collider; }>} collider
10471
- * @param {*} [options] Override http request option.
10472
- * @throws {RequiredError}
10473
- */
10474
- async storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{ [key: string]: Collider; }>>> {
10475
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionLinkChain(cell, linkChain, collider, options);
10476
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10477
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.storeCollisionLinkChain']?.[localVarOperationServerIndex]?.url;
10478
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10479
- },
10480
- /**
10481
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
10482
- * @summary Store Tool
10483
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10484
- * @param {string} tool Unique identifier addressing a collision tool.
10485
- * @param {{ [key: string]: Collider; }} requestBody
10486
- * @param {*} [options] Override http request option.
10487
- * @throws {RequiredError}
10488
- */
10489
- async storeCollisionTool(cell: string, tool: string, requestBody: { [key: string]: Collider; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Collider; }>> {
10490
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionTool(cell, tool, requestBody, options);
10491
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10492
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionComponentsApi.storeCollisionTool']?.[localVarOperationServerIndex]?.url;
10493
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10494
- },
10495
- }
10496
- };
10497
-
10498
- /**
10499
- * StoreCollisionComponentsApi - factory interface
10500
- * @export
10501
- */
10502
- export const StoreCollisionComponentsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
10503
- const localVarFp = StoreCollisionComponentsApiFp(configuration)
10504
- return {
10505
- /**
10506
- * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
10507
- * @summary Delete Collider
10508
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10509
- * @param {string} collider Unique identifier addressing a collider.
10510
- * @param {*} [options] Override http request option.
10511
- * @throws {RequiredError}
10512
- */
10513
- deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10514
- return localVarFp.deleteStoredCollider(cell, collider, options).then((request) => request(axios, basePath));
10515
- },
10516
- /**
10517
- * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
10518
- * @summary Delete Link Chain
10519
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10520
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10521
- * @param {*} [options] Override http request option.
10522
- * @throws {RequiredError}
10523
- */
10524
- deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10525
- return localVarFp.deleteStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(axios, basePath));
10526
- },
10527
- /**
10528
- * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
10529
- * @summary Delete Tool
10530
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10531
- * @param {string} tool Unique identifier addressing a collision tool.
10532
- * @param {*} [options] Override http request option.
10533
- * @throws {RequiredError}
10534
- */
10535
- deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10536
- return localVarFp.deleteStoredCollisionTool(cell, tool, options).then((request) => request(axios, basePath));
10537
- },
10538
- /**
10539
- * Returns the collider.
10540
- * @summary Get Collider
10541
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10542
- * @param {string} collider Unique identifier addressing a collider.
10543
- * @param {*} [options] Override http request option.
10544
- * @throws {RequiredError}
10545
- */
10546
- getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): AxiosPromise<Collider> {
10547
- return localVarFp.getStoredCollider(cell, collider, options).then((request) => request(axios, basePath));
10548
- },
10549
- /**
10550
- * Returns the collision link chain.
10551
- * @summary Get Link Chain
10552
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10553
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10554
- * @param {*} [options] Override http request option.
10555
- * @throws {RequiredError}
10556
- */
10557
- getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<{ [key: string]: Collider; }>> {
10558
- return localVarFp.getStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(axios, basePath));
10559
- },
10560
- /**
10561
- * Returns the stored tool.
10562
- * @summary Get Tool
10563
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10564
- * @param {string} tool Unique identifier addressing a collision tool.
10565
- * @param {*} [options] Override http request option.
10566
- * @throws {RequiredError}
10567
- */
10568
- getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Collider; }> {
10569
- return localVarFp.getStoredCollisionTool(cell, tool, options).then((request) => request(axios, basePath));
10570
- },
10571
- /**
10572
- * Returns the stored link chains.
10573
- * @summary List Link Chains
10574
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10575
- * @param {*} [options] Override http request option.
10576
- * @throws {RequiredError}
10577
- */
10578
- listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Array<{ [key: string]: Collider; }>; }> {
10579
- return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
10580
- },
10581
- /**
10582
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
10583
- * @summary List Colliders
10584
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10585
- * @param {*} [options] Override http request option.
10586
- * @throws {RequiredError}
10587
- */
10588
- listStoredColliders(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Collider; }> {
10589
- return localVarFp.listStoredColliders(cell, options).then((request) => request(axios, basePath));
10590
- },
10591
- /**
10592
- * Returns the list of stored tools.
10593
- * @summary List Tools
10594
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10595
- * @param {*} [options] Override http request option.
10596
- * @throws {RequiredError}
10597
- */
10598
- listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: Collider; }; }> {
10599
- return localVarFp.listStoredCollisionTools(cell, options).then((request) => request(axios, basePath));
10600
- },
10601
- /**
10602
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
10603
- * @summary Store Collider
10604
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10605
- * @param {string} collider Unique identifier addressing a collider.
10606
- * @param {Collider} collider2
10607
- * @param {*} [options] Override http request option.
10608
- * @throws {RequiredError}
10609
- */
10610
- storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): AxiosPromise<Collider> {
10611
- return localVarFp.storeCollider(cell, collider, collider2, options).then((request) => request(axios, basePath));
10612
- },
10613
- /**
10614
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
10615
- * @summary Store Link Chain
10616
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10617
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10618
- * @param {Array<{ [key: string]: Collider; }>} collider
10619
- * @param {*} [options] Override http request option.
10620
- * @throws {RequiredError}
10621
- */
10622
- storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options?: RawAxiosRequestConfig): AxiosPromise<Array<{ [key: string]: Collider; }>> {
10623
- return localVarFp.storeCollisionLinkChain(cell, linkChain, collider, options).then((request) => request(axios, basePath));
10624
- },
10625
- /**
10626
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
10627
- * @summary Store Tool
10628
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10629
- * @param {string} tool Unique identifier addressing a collision tool.
10630
- * @param {{ [key: string]: Collider; }} requestBody
10631
- * @param {*} [options] Override http request option.
10632
- * @throws {RequiredError}
10633
- */
10634
- storeCollisionTool(cell: string, tool: string, requestBody: { [key: string]: Collider; }, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Collider; }> {
10635
- return localVarFp.storeCollisionTool(cell, tool, requestBody, options).then((request) => request(axios, basePath));
10636
- },
10637
- };
10638
- };
10639
-
10640
- /**
10641
- * StoreCollisionComponentsApi - object-oriented interface
10642
- * @export
10643
- * @class StoreCollisionComponentsApi
10644
- * @extends {BaseAPI}
10645
- */
10646
- export class StoreCollisionComponentsApi extends BaseAPI {
10647
- /**
10648
- * Deletes the stored collider. <!-- theme: danger --> > This will delete persistently stored data.
10649
- * @summary Delete Collider
10650
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10651
- * @param {string} collider Unique identifier addressing a collider.
10652
- * @param {*} [options] Override http request option.
10653
- * @throws {RequiredError}
10654
- * @memberof StoreCollisionComponentsApi
10655
- */
10656
- public deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig) {
10657
- return StoreCollisionComponentsApiFp(this.configuration).deleteStoredCollider(cell, collider, options).then((request) => request(this.axios, this.basePath));
10658
- }
10659
-
10660
- /**
10661
- * Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
10662
- * @summary Delete Link Chain
10663
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10664
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10665
- * @param {*} [options] Override http request option.
10666
- * @throws {RequiredError}
10667
- * @memberof StoreCollisionComponentsApi
10668
- */
10669
- public deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig) {
10670
- return StoreCollisionComponentsApiFp(this.configuration).deleteStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(this.axios, this.basePath));
10671
- }
10672
-
10673
- /**
10674
- * Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
10675
- * @summary Delete Tool
10676
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10677
- * @param {string} tool Unique identifier addressing a collision tool.
10678
- * @param {*} [options] Override http request option.
10679
- * @throws {RequiredError}
10680
- * @memberof StoreCollisionComponentsApi
10681
- */
10682
- public deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig) {
10683
- return StoreCollisionComponentsApiFp(this.configuration).deleteStoredCollisionTool(cell, tool, options).then((request) => request(this.axios, this.basePath));
10684
- }
10685
-
10686
- /**
10687
- * Returns the collider.
10688
- * @summary Get Collider
10689
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10690
- * @param {string} collider Unique identifier addressing a collider.
10691
- * @param {*} [options] Override http request option.
10692
- * @throws {RequiredError}
10693
- * @memberof StoreCollisionComponentsApi
10694
- */
10695
- public getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig) {
10696
- return StoreCollisionComponentsApiFp(this.configuration).getStoredCollider(cell, collider, options).then((request) => request(this.axios, this.basePath));
10697
- }
10698
-
10699
- /**
10700
- * Returns the collision link chain.
10701
- * @summary Get Link Chain
10702
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10703
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10704
- * @param {*} [options] Override http request option.
10705
- * @throws {RequiredError}
10706
- * @memberof StoreCollisionComponentsApi
10707
- */
10708
- public getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig) {
10709
- return StoreCollisionComponentsApiFp(this.configuration).getStoredCollisionLinkChain(cell, linkChain, options).then((request) => request(this.axios, this.basePath));
10710
- }
10711
-
10712
- /**
10713
- * Returns the stored tool.
10714
- * @summary Get Tool
10715
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10716
- * @param {string} tool Unique identifier addressing a collision tool.
10717
- * @param {*} [options] Override http request option.
10718
- * @throws {RequiredError}
10719
- * @memberof StoreCollisionComponentsApi
10720
- */
10721
- public getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig) {
10722
- return StoreCollisionComponentsApiFp(this.configuration).getStoredCollisionTool(cell, tool, options).then((request) => request(this.axios, this.basePath));
10723
- }
10724
-
10725
- /**
10726
- * Returns the stored link chains.
10727
- * @summary List Link Chains
10728
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10729
- * @param {*} [options] Override http request option.
10730
- * @throws {RequiredError}
10731
- * @memberof StoreCollisionComponentsApi
10732
- */
10733
- public listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig) {
10734
- return StoreCollisionComponentsApiFp(this.configuration).listCollisionLinkChains(cell, options).then((request) => request(this.axios, this.basePath));
10735
- }
10736
-
10737
- /**
10738
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
10739
- * @summary List Colliders
10740
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10741
- * @param {*} [options] Override http request option.
10742
- * @throws {RequiredError}
10743
- * @memberof StoreCollisionComponentsApi
10744
- */
10745
- public listStoredColliders(cell: string, options?: RawAxiosRequestConfig) {
10746
- return StoreCollisionComponentsApiFp(this.configuration).listStoredColliders(cell, options).then((request) => request(this.axios, this.basePath));
10747
- }
10748
-
10749
- /**
10750
- * Returns the list of stored tools.
10751
- * @summary List Tools
10752
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10753
- * @param {*} [options] Override http request option.
10754
- * @throws {RequiredError}
10755
- * @memberof StoreCollisionComponentsApi
10756
- */
10757
- public listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig) {
10758
- return StoreCollisionComponentsApiFp(this.configuration).listStoredCollisionTools(cell, options).then((request) => request(this.axios, this.basePath));
10759
- }
10760
-
10761
- /**
10762
- * Stores collider. If the collider does not exist, it will be created. If the collider exists, it will be updated.
10763
- * @summary Store Collider
10764
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10765
- * @param {string} collider Unique identifier addressing a collider.
10766
- * @param {Collider} collider2
10767
- * @param {*} [options] Override http request option.
10768
- * @throws {RequiredError}
10769
- * @memberof StoreCollisionComponentsApi
10770
- */
10771
- public storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig) {
10772
- return StoreCollisionComponentsApiFp(this.configuration).storeCollider(cell, collider, collider2, options).then((request) => request(this.axios, this.basePath));
10773
- }
10774
-
10775
- /**
10776
- * Stores link chain. If the link chain does not exist, it will be created. If the link chain exists, it will be updated.
10777
- * @summary Store Link Chain
10778
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10779
- * @param {string} linkChain Unique identifier addressing a collision link chain.
10780
- * @param {Array<{ [key: string]: Collider; }>} collider
10781
- * @param {*} [options] Override http request option.
10782
- * @throws {RequiredError}
10783
- * @memberof StoreCollisionComponentsApi
10784
- */
10785
- public storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{ [key: string]: Collider; }>, options?: RawAxiosRequestConfig) {
10786
- return StoreCollisionComponentsApiFp(this.configuration).storeCollisionLinkChain(cell, linkChain, collider, options).then((request) => request(this.axios, this.basePath));
10787
- }
10788
-
10789
- /**
10790
- * Stores the tool. If the tool does not exist, it will be created. If the tool exists, it will be updated.
10791
- * @summary Store Tool
10792
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10793
- * @param {string} tool Unique identifier addressing a collision tool.
10794
- * @param {{ [key: string]: Collider; }} requestBody
10795
- * @param {*} [options] Override http request option.
10796
- * @throws {RequiredError}
10797
- * @memberof StoreCollisionComponentsApi
10798
- */
10799
- public storeCollisionTool(cell: string, tool: string, requestBody: { [key: string]: Collider; }, options?: RawAxiosRequestConfig) {
10800
- return StoreCollisionComponentsApiFp(this.configuration).storeCollisionTool(cell, tool, requestBody, options).then((request) => request(this.axios, this.basePath));
10801
- }
10802
- }
10803
-
10804
-
10805
-
10806
- /**
10807
- * StoreCollisionScenesApi - axios parameter creator
10808
- * @export
10809
- */
10810
- export const StoreCollisionScenesApiAxiosParamCreator = function (configuration?: Configuration) {
10811
- return {
10812
- /**
10813
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10814
- * @summary Delete Scene
10815
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10816
- * @param {string} scene Unique identifier addressing a collision scene.
10817
- * @param {*} [options] Override http request option.
10818
- * @throws {RequiredError}
10819
- */
10820
- deleteStoredCollisionScene: async (cell: string, scene: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10821
- // verify required parameter 'cell' is not null or undefined
10822
- assertParamExists('deleteStoredCollisionScene', 'cell', cell)
10823
- // verify required parameter 'scene' is not null or undefined
10824
- assertParamExists('deleteStoredCollisionScene', 'scene', scene)
10825
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
10826
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10827
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
10828
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10829
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10830
- let baseOptions;
10831
- if (configuration) {
10832
- baseOptions = configuration.baseOptions;
10833
- }
10834
-
10835
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
10836
- const localVarHeaderParameter = {} as any;
10837
- const localVarQueryParameter = {} as any;
10838
-
10839
- // authentication BasicAuth required
10840
- // http basic authentication required
10841
- setBasicAuthToObject(localVarRequestOptions, configuration)
10842
-
10843
- // authentication BearerAuth required
10844
- // http bearer authentication required
10845
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10846
-
10847
-
10848
-
10849
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10850
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10851
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10852
-
10853
- return {
10854
- url: toPathString(localVarUrlObj),
10855
- options: localVarRequestOptions,
10856
- };
10857
- },
10858
- /**
10859
- * Returns the stored scene.
10860
- * @summary Get Scene
10861
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10862
- * @param {string} scene Unique identifier addressing a collision scene.
10863
- * @param {*} [options] Override http request option.
10864
- * @throws {RequiredError}
10865
- */
10866
- getStoredCollisionScene: async (cell: string, scene: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10867
- // verify required parameter 'cell' is not null or undefined
10868
- assertParamExists('getStoredCollisionScene', 'cell', cell)
10869
- // verify required parameter 'scene' is not null or undefined
10870
- assertParamExists('getStoredCollisionScene', 'scene', scene)
10871
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
10872
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10873
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
10874
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10875
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10876
- let baseOptions;
10877
- if (configuration) {
10878
- baseOptions = configuration.baseOptions;
10879
- }
10880
-
10881
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10882
- const localVarHeaderParameter = {} as any;
10883
- const localVarQueryParameter = {} as any;
10884
-
10885
- // authentication BasicAuth required
10886
- // http basic authentication required
10887
- setBasicAuthToObject(localVarRequestOptions, configuration)
10888
-
10889
- // authentication BearerAuth required
10890
- // http bearer authentication required
10891
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10892
-
10893
-
10894
-
10895
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10896
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10897
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10898
-
10899
- return {
10900
- url: toPathString(localVarUrlObj),
10901
- options: localVarRequestOptions,
10902
- };
10903
- },
10904
- /**
10905
- * Returns a list of stored scenes.
10906
- * @summary List Scenes
10907
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10908
- * @param {*} [options] Override http request option.
10909
- * @throws {RequiredError}
10910
- */
10911
- listStoredCollisionScenes: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10912
- // verify required parameter 'cell' is not null or undefined
10913
- assertParamExists('listStoredCollisionScenes', 'cell', cell)
10914
- const localVarPath = `/cells/{cell}/store/collision/scenes`
10915
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
10916
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10917
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10918
- let baseOptions;
10919
- if (configuration) {
10920
- baseOptions = configuration.baseOptions;
10921
- }
10922
-
10923
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10924
- const localVarHeaderParameter = {} as any;
10925
- const localVarQueryParameter = {} as any;
10926
-
10927
- // authentication BasicAuth required
10928
- // http basic authentication required
10929
- setBasicAuthToObject(localVarRequestOptions, configuration)
10930
-
10931
- // authentication BearerAuth required
10932
- // http bearer authentication required
10933
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10934
-
10935
-
10936
-
10937
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10938
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10939
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10940
-
10941
- return {
10942
- url: toPathString(localVarUrlObj),
10943
- options: localVarRequestOptions,
10944
- };
10945
- },
10946
- /**
10947
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10948
- * @summary Store Scene
10949
- * @param {string} cell Unique identifier addressing a cell in all API calls.
10950
- * @param {string} scene Unique identifier addressing a collision scene.
10951
- * @param {CollisionSceneAssembly} collisionSceneAssembly
10952
- * @param {*} [options] Override http request option.
10953
- * @throws {RequiredError}
10954
- */
10955
- storeCollisionScene: async (cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10956
- // verify required parameter 'cell' is not null or undefined
10957
- assertParamExists('storeCollisionScene', 'cell', cell)
10958
- // verify required parameter 'scene' is not null or undefined
10959
- assertParamExists('storeCollisionScene', 'scene', scene)
10960
- // verify required parameter 'collisionSceneAssembly' is not null or undefined
10961
- assertParamExists('storeCollisionScene', 'collisionSceneAssembly', collisionSceneAssembly)
10962
- const localVarPath = `/cells/{cell}/store/collision/scenes/{scene}`
10963
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10964
- .replace(`{${"scene"}}`, encodeURIComponent(String(scene)));
10965
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
10966
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10967
- let baseOptions;
10968
- if (configuration) {
10969
- baseOptions = configuration.baseOptions;
10970
- }
10971
-
10972
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
10973
- const localVarHeaderParameter = {} as any;
10974
- const localVarQueryParameter = {} as any;
10975
-
10976
- // authentication BasicAuth required
10977
- // http basic authentication required
10978
- setBasicAuthToObject(localVarRequestOptions, configuration)
10979
-
10980
- // authentication BearerAuth required
10981
- // http bearer authentication required
10982
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
10983
-
10984
-
10985
-
10986
- localVarHeaderParameter['Content-Type'] = 'application/json';
10987
-
10988
- setSearchParams(localVarUrlObj, localVarQueryParameter);
10989
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10990
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10991
- localVarRequestOptions.data = serializeDataIfNeeded(collisionSceneAssembly, localVarRequestOptions, configuration)
10992
-
10993
- return {
10994
- url: toPathString(localVarUrlObj),
10995
- options: localVarRequestOptions,
10996
- };
10997
- },
10998
- }
10999
- };
11000
-
11001
- /**
11002
- * StoreCollisionScenesApi - functional programming interface
11003
- * @export
11004
- */
11005
- export const StoreCollisionScenesApiFp = function(configuration?: Configuration) {
11006
- const localVarAxiosParamCreator = StoreCollisionScenesApiAxiosParamCreator(configuration)
11007
- return {
11008
- /**
11009
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
11010
- * @summary Delete Scene
11011
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11012
- * @param {string} scene Unique identifier addressing a collision scene.
11013
- * @param {*} [options] Override http request option.
11014
- * @throws {RequiredError}
11015
- */
11016
- async deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11017
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStoredCollisionScene(cell, scene, options);
11018
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11019
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.deleteStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
11020
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11021
- },
11022
- /**
11023
- * Returns the stored scene.
11024
- * @summary Get Scene
11025
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11026
- * @param {string} scene Unique identifier addressing a collision scene.
11027
- * @param {*} [options] Override http request option.
11028
- * @throws {RequiredError}
11029
- */
11030
- async getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>> {
11031
- const localVarAxiosArgs = await localVarAxiosParamCreator.getStoredCollisionScene(cell, scene, options);
11032
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11033
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.getStoredCollisionScene']?.[localVarOperationServerIndex]?.url;
11034
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11035
- },
11036
- /**
11037
- * Returns a list of stored scenes.
11038
- * @summary List Scenes
11039
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11040
- * @param {*} [options] Override http request option.
11041
- * @throws {RequiredError}
11042
- */
11043
- async listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: CollisionScene; }>> {
11044
- const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionScenes(cell, options);
11045
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11046
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.listStoredCollisionScenes']?.[localVarOperationServerIndex]?.url;
11047
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11048
- },
11049
- /**
11050
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
11051
- * @summary Store Scene
11052
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11053
- * @param {string} scene Unique identifier addressing a collision scene.
11054
- * @param {CollisionSceneAssembly} collisionSceneAssembly
11055
- * @param {*} [options] Override http request option.
11056
- * @throws {RequiredError}
11057
- */
11058
- async storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>> {
11059
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionScene(cell, scene, collisionSceneAssembly, options);
11060
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11061
- const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.storeCollisionScene']?.[localVarOperationServerIndex]?.url;
11062
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11063
- },
11064
- }
11065
- };
11066
-
11067
- /**
11068
- * StoreCollisionScenesApi - factory interface
11069
- * @export
11070
- */
11071
- export const StoreCollisionScenesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11072
- const localVarFp = StoreCollisionScenesApiFp(configuration)
11073
- return {
11074
- /**
11075
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
11076
- * @summary Delete Scene
11077
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11078
- * @param {string} scene Unique identifier addressing a collision scene.
11079
- * @param {*} [options] Override http request option.
11080
- * @throws {RequiredError}
11081
- */
11082
- deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11083
- return localVarFp.deleteStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
11084
- },
11085
- /**
11086
- * Returns the stored scene.
11087
- * @summary Get Scene
11088
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11089
- * @param {string} scene Unique identifier addressing a collision scene.
11090
- * @param {*} [options] Override http request option.
11091
- * @throws {RequiredError}
11092
- */
11093
- getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene> {
11094
- return localVarFp.getStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
11095
- },
11096
- /**
11097
- * Returns a list of stored scenes.
11098
- * @summary List Scenes
11099
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11100
- * @param {*} [options] Override http request option.
11101
- * @throws {RequiredError}
11102
- */
11103
- listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: CollisionScene; }> {
11104
- return localVarFp.listStoredCollisionScenes(cell, options).then((request) => request(axios, basePath));
11105
- },
11106
- /**
11107
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
11108
- * @summary Store Scene
11109
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11110
- * @param {string} scene Unique identifier addressing a collision scene.
11111
- * @param {CollisionSceneAssembly} collisionSceneAssembly
11112
- * @param {*} [options] Override http request option.
11113
- * @throws {RequiredError}
11114
- */
11115
- storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene> {
11116
- return localVarFp.storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(axios, basePath));
11117
- },
11118
- };
11119
- };
11120
-
11121
- /**
11122
- * StoreCollisionScenesApi - object-oriented interface
11123
- * @export
11124
- * @class StoreCollisionScenesApi
11125
- * @extends {BaseAPI}
11126
- */
11127
- export class StoreCollisionScenesApi extends BaseAPI {
11128
- /**
11129
- * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
11130
- * @summary Delete Scene
11131
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11132
- * @param {string} scene Unique identifier addressing a collision scene.
11133
- * @param {*} [options] Override http request option.
11134
- * @throws {RequiredError}
11135
- * @memberof StoreCollisionScenesApi
11136
- */
11137
- public deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig) {
11138
- return StoreCollisionScenesApiFp(this.configuration).deleteStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
11139
- }
11140
-
11141
- /**
11142
- * Returns the stored scene.
11143
- * @summary Get Scene
11144
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11145
- * @param {string} scene Unique identifier addressing a collision scene.
11146
- * @param {*} [options] Override http request option.
11147
- * @throws {RequiredError}
11148
- * @memberof StoreCollisionScenesApi
11149
- */
11150
- public getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig) {
11151
- return StoreCollisionScenesApiFp(this.configuration).getStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
11152
- }
11153
-
11154
- /**
11155
- * Returns a list of stored scenes.
11156
- * @summary List Scenes
11157
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11158
- * @param {*} [options] Override http request option.
11159
- * @throws {RequiredError}
11160
- * @memberof StoreCollisionScenesApi
11161
- */
11162
- public listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig) {
11163
- return StoreCollisionScenesApiFp(this.configuration).listStoredCollisionScenes(cell, options).then((request) => request(this.axios, this.basePath));
11164
- }
11165
-
11166
- /**
11167
- * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
11168
- * @summary Store Scene
11169
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11170
- * @param {string} scene Unique identifier addressing a collision scene.
11171
- * @param {CollisionSceneAssembly} collisionSceneAssembly
11172
- * @param {*} [options] Override http request option.
11173
- * @throws {RequiredError}
11174
- * @memberof StoreCollisionScenesApi
11175
- */
11176
- public storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig) {
11177
- return StoreCollisionScenesApiFp(this.configuration).storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(this.axios, this.basePath));
11178
- }
11179
- }
11180
-
11181
-
11182
-
11183
- /**
11184
- * StoreObjectApi - axios parameter creator
11185
- * @export
11186
- */
11187
- export const StoreObjectApiAxiosParamCreator = function (configuration?: Configuration) {
11188
- return {
11189
- /**
11190
- * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
11191
- * @summary Clear all Objects
11192
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11193
- * @param {*} [options] Override http request option.
11194
- * @throws {RequiredError}
11195
- */
11196
- clearAllObjects: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11197
- // verify required parameter 'cell' is not null or undefined
11198
- assertParamExists('clearAllObjects', 'cell', cell)
11199
- const localVarPath = `/cells/{cell}/store/objects`
11200
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11201
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
11202
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11203
- let baseOptions;
11204
- if (configuration) {
11205
- baseOptions = configuration.baseOptions;
11206
- }
11207
-
11208
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
11209
- const localVarHeaderParameter = {} as any;
11210
- const localVarQueryParameter = {} as any;
11211
-
11212
- // authentication BasicAuth required
11213
- // http basic authentication required
11214
- setBasicAuthToObject(localVarRequestOptions, configuration)
11215
-
11216
- // authentication BearerAuth required
11217
- // http bearer authentication required
11218
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
11219
-
11220
-
11221
-
11222
- setSearchParams(localVarUrlObj, localVarQueryParameter);
11223
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11224
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11225
-
11226
- return {
11227
- url: toPathString(localVarUrlObj),
11228
- options: localVarRequestOptions,
11229
- };
11230
- },
11231
- /**
11232
- * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
11233
- * @summary Delete Object
11234
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11235
- * @param {string} key
11236
- * @param {*} [options] Override http request option.
11237
- * @throws {RequiredError}
11238
- */
11239
- deleteObject: async (cell: string, key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11240
- // verify required parameter 'cell' is not null or undefined
11241
- assertParamExists('deleteObject', 'cell', cell)
11242
- // verify required parameter 'key' is not null or undefined
11243
- assertParamExists('deleteObject', 'key', key)
11244
- const localVarPath = `/cells/{cell}/store/objects/{key}`
11245
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11246
- .replace(`{${"key"}}`, encodeURIComponent(String(key)));
11247
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
11248
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11249
- let baseOptions;
11250
- if (configuration) {
11251
- baseOptions = configuration.baseOptions;
11252
- }
11253
-
11254
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
11255
- const localVarHeaderParameter = {} as any;
11256
- const localVarQueryParameter = {} as any;
11257
-
11258
- // authentication BasicAuth required
11259
- // http basic authentication required
11260
- setBasicAuthToObject(localVarRequestOptions, configuration)
11261
-
11262
- // authentication BearerAuth required
11263
- // http bearer authentication required
11264
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
11265
-
11266
-
11267
-
11268
- setSearchParams(localVarUrlObj, localVarQueryParameter);
11269
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11270
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11271
-
11272
- return {
11273
- url: toPathString(localVarUrlObj),
11274
- options: localVarRequestOptions,
11275
- };
11276
- },
11277
- /**
11278
- * Get the object. This request returns the object and any metadata attached to it.
11279
- * @summary Get Object
11280
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11281
- * @param {string} key
11282
- * @param {*} [options] Override http request option.
11283
- * @throws {RequiredError}
11284
- */
11285
- getObject: async (cell: string, key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11286
- // verify required parameter 'cell' is not null or undefined
11287
- assertParamExists('getObject', 'cell', cell)
11288
- // verify required parameter 'key' is not null or undefined
11289
- assertParamExists('getObject', 'key', key)
11290
- const localVarPath = `/cells/{cell}/store/objects/{key}`
11291
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11292
- .replace(`{${"key"}}`, encodeURIComponent(String(key)));
11293
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
11294
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11295
- let baseOptions;
11296
- if (configuration) {
11297
- baseOptions = configuration.baseOptions;
11298
- }
11299
-
11300
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11301
- const localVarHeaderParameter = {} as any;
11302
- const localVarQueryParameter = {} as any;
11303
-
11304
- // authentication BasicAuth required
11305
- // http basic authentication required
11306
- setBasicAuthToObject(localVarRequestOptions, configuration)
11307
-
11308
- // authentication BearerAuth required
11309
- // http bearer authentication required
11310
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
11311
-
11312
-
11313
-
11314
- setSearchParams(localVarUrlObj, localVarQueryParameter);
11315
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11316
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11317
-
11318
- return {
11319
- url: toPathString(localVarUrlObj),
11320
- options: localVarRequestOptions,
11321
- };
11322
- },
11323
- /**
11324
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
11325
- * @summary Get Object Metadata
11326
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11327
- * @param {string} key
11328
- * @param {*} [options] Override http request option.
11329
- * @throws {RequiredError}
11330
- */
11331
- getObjectMetadata: async (cell: string, key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11332
- // verify required parameter 'cell' is not null or undefined
11333
- assertParamExists('getObjectMetadata', 'cell', cell)
11334
- // verify required parameter 'key' is not null or undefined
11335
- assertParamExists('getObjectMetadata', 'key', key)
11336
- const localVarPath = `/cells/{cell}/store/objects/{key}`
11337
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11338
- .replace(`{${"key"}}`, encodeURIComponent(String(key)));
11339
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
11340
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11341
- let baseOptions;
11342
- if (configuration) {
11343
- baseOptions = configuration.baseOptions;
11344
- }
11345
-
11346
- const localVarRequestOptions = { method: 'HEAD', ...baseOptions, ...options};
11347
- const localVarHeaderParameter = {} as any;
11348
- const localVarQueryParameter = {} as any;
11349
-
11350
- // authentication BasicAuth required
11351
- // http basic authentication required
11352
- setBasicAuthToObject(localVarRequestOptions, configuration)
11353
-
11354
- // authentication BearerAuth required
11355
- // http bearer authentication required
11356
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
11357
-
11358
-
11359
-
11360
- setSearchParams(localVarUrlObj, localVarQueryParameter);
11361
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11362
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11363
-
11364
- return {
11365
- url: toPathString(localVarUrlObj),
11366
- options: localVarRequestOptions,
11367
- };
11368
- },
11369
- /**
11370
- * List the keys for all objects.
11371
- * @summary List all Object Keys
11372
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11373
- * @param {*} [options] Override http request option.
11374
- * @throws {RequiredError}
11375
- */
11376
- listAllObjectKeys: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11377
- // verify required parameter 'cell' is not null or undefined
11378
- assertParamExists('listAllObjectKeys', 'cell', cell)
11379
- const localVarPath = `/cells/{cell}/store/objects`
11380
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11381
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
11382
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11383
- let baseOptions;
11384
- if (configuration) {
11385
- baseOptions = configuration.baseOptions;
11386
- }
11387
-
11388
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11389
- const localVarHeaderParameter = {} as any;
11390
- const localVarQueryParameter = {} as any;
11391
-
11392
- // authentication BasicAuth required
11393
- // http basic authentication required
11394
- setBasicAuthToObject(localVarRequestOptions, configuration)
11395
-
11396
- // authentication BearerAuth required
11397
- // http bearer authentication required
11398
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
11399
-
11400
-
11401
-
11402
- setSearchParams(localVarUrlObj, localVarQueryParameter);
11403
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11404
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11405
-
11406
- return {
11407
- url: toPathString(localVarUrlObj),
11408
- options: localVarRequestOptions,
11409
- };
11410
- },
11411
- /**
11412
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
11413
- * @summary Store Object
11414
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11415
- * @param {string} key
11416
- * @param {{ [key: string]: string; }} [xMetadata]
11417
- * @param {any} [anyValue]
11418
- * @param {*} [options] Override http request option.
11419
- * @throws {RequiredError}
11420
- */
11421
- storeObject: async (cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11422
- // verify required parameter 'cell' is not null or undefined
11423
- assertParamExists('storeObject', 'cell', cell)
11424
- // verify required parameter 'key' is not null or undefined
11425
- assertParamExists('storeObject', 'key', key)
11426
- const localVarPath = `/cells/{cell}/store/objects/{key}`
11427
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11428
- .replace(`{${"key"}}`, encodeURIComponent(String(key)));
11429
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
11430
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11431
- let baseOptions;
11432
- if (configuration) {
11433
- baseOptions = configuration.baseOptions;
11434
- }
11435
-
11436
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
11437
- const localVarHeaderParameter = {} as any;
11438
- const localVarQueryParameter = {} as any;
11439
- const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
11440
-
11441
- // authentication BasicAuth required
11442
- // http basic authentication required
11443
- setBasicAuthToObject(localVarRequestOptions, configuration)
11444
-
11445
- // authentication BearerAuth required
11446
- // http bearer authentication required
11447
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
11448
-
11449
-
11450
- if (anyValue !== undefined) {
11451
- localVarFormParams.append('any_value', new Blob([JSON.stringify(anyValue)], { type: "application/json", }));
11452
- }
11453
-
11454
-
11455
- localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
11456
-
11457
- if (xMetadata != null) {
11458
- localVarHeaderParameter['X-Metadata'] = typeof xMetadata === 'string'
11459
- ? xMetadata
11460
- : JSON.stringify(xMetadata);
11461
- }
11462
- setSearchParams(localVarUrlObj, localVarQueryParameter);
11463
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11464
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11465
- localVarRequestOptions.data = localVarFormParams;
11466
-
11467
- return {
11468
- url: toPathString(localVarUrlObj),
11469
- options: localVarRequestOptions,
11470
- };
11471
- },
11472
- }
11473
- };
11474
-
11475
- /**
11476
- * StoreObjectApi - functional programming interface
11477
- * @export
11478
- */
11479
- export const StoreObjectApiFp = function(configuration?: Configuration) {
11480
- const localVarAxiosParamCreator = StoreObjectApiAxiosParamCreator(configuration)
11481
- return {
11482
- /**
11483
- * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
11484
- * @summary Clear all Objects
11485
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11486
- * @param {*} [options] Override http request option.
11487
- * @throws {RequiredError}
11488
- */
11489
- async clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11490
- const localVarAxiosArgs = await localVarAxiosParamCreator.clearAllObjects(cell, options);
11491
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11492
- const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.clearAllObjects']?.[localVarOperationServerIndex]?.url;
11493
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11494
- },
11495
- /**
11496
- * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
11497
- * @summary Delete Object
11498
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11499
- * @param {string} key
11500
- * @param {*} [options] Override http request option.
11501
- * @throws {RequiredError}
11502
- */
11503
- async deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11504
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObject(cell, key, options);
11505
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11506
- const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.deleteObject']?.[localVarOperationServerIndex]?.url;
11507
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11508
- },
11509
- /**
11510
- * Get the object. This request returns the object and any metadata attached to it.
11511
- * @summary Get Object
11512
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11513
- * @param {string} key
11514
- * @param {*} [options] Override http request option.
11515
- * @throws {RequiredError}
11516
- */
11517
- async getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
11518
- const localVarAxiosArgs = await localVarAxiosParamCreator.getObject(cell, key, options);
11519
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11520
- const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.getObject']?.[localVarOperationServerIndex]?.url;
11521
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11522
- },
11523
- /**
11524
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
11525
- * @summary Get Object Metadata
11526
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11527
- * @param {string} key
11528
- * @param {*} [options] Override http request option.
11529
- * @throws {RequiredError}
11530
- */
11531
- async getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11532
- const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMetadata(cell, key, options);
11533
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11534
- const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.getObjectMetadata']?.[localVarOperationServerIndex]?.url;
11535
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11536
- },
11537
- /**
11538
- * List the keys for all objects.
11539
- * @summary List all Object Keys
11540
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11541
- * @param {*} [options] Override http request option.
11542
- * @throws {RequiredError}
11543
- */
11544
- async listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
11545
- const localVarAxiosArgs = await localVarAxiosParamCreator.listAllObjectKeys(cell, options);
10164
+ async listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: CollisionScene; }>> {
10165
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listStoredCollisionScenes(cell, options);
11546
10166
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11547
- const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.listAllObjectKeys']?.[localVarOperationServerIndex]?.url;
10167
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.listStoredCollisionScenes']?.[localVarOperationServerIndex]?.url;
11548
10168
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11549
10169
  },
11550
10170
  /**
11551
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
11552
- * @summary Store Object
10171
+ * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10172
+ * @summary Store Scene
11553
10173
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11554
- * @param {string} key
11555
- * @param {{ [key: string]: string; }} [xMetadata]
11556
- * @param {any} [anyValue]
10174
+ * @param {string} scene Unique identifier addressing a collision scene.
10175
+ * @param {CollisionSceneAssembly} collisionSceneAssembly
11557
10176
  * @param {*} [options] Override http request option.
11558
10177
  * @throws {RequiredError}
11559
10178
  */
11560
- async storeObject(cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11561
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeObject(cell, key, xMetadata, anyValue, options);
10179
+ async storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollisionScene>> {
10180
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeCollisionScene(cell, scene, collisionSceneAssembly, options);
11562
10181
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11563
- const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.storeObject']?.[localVarOperationServerIndex]?.url;
10182
+ const localVarOperationServerBasePath = operationServerMap['StoreCollisionScenesApi.storeCollisionScene']?.[localVarOperationServerIndex]?.url;
11564
10183
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11565
10184
  },
11566
10185
  }
11567
10186
  };
11568
10187
 
11569
10188
  /**
11570
- * StoreObjectApi - factory interface
10189
+ * StoreCollisionScenesApi - factory interface
11571
10190
  * @export
11572
10191
  */
11573
- export const StoreObjectApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
11574
- const localVarFp = StoreObjectApiFp(configuration)
10192
+ export const StoreCollisionScenesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
10193
+ const localVarFp = StoreCollisionScenesApiFp(configuration)
11575
10194
  return {
11576
10195
  /**
11577
- * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
11578
- * @summary Clear all Objects
11579
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11580
- * @param {*} [options] Override http request option.
11581
- * @throws {RequiredError}
11582
- */
11583
- clearAllObjects(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11584
- return localVarFp.clearAllObjects(cell, options).then((request) => request(axios, basePath));
11585
- },
11586
- /**
11587
- * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
11588
- * @summary Delete Object
11589
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11590
- * @param {string} key
11591
- * @param {*} [options] Override http request option.
11592
- * @throws {RequiredError}
11593
- */
11594
- deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11595
- return localVarFp.deleteObject(cell, key, options).then((request) => request(axios, basePath));
11596
- },
11597
- /**
11598
- * Get the object. This request returns the object and any metadata attached to it.
11599
- * @summary Get Object
10196
+ * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10197
+ * @summary Delete Scene
11600
10198
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11601
- * @param {string} key
10199
+ * @param {string} scene Unique identifier addressing a collision scene.
11602
10200
  * @param {*} [options] Override http request option.
11603
10201
  * @throws {RequiredError}
11604
10202
  */
11605
- getObject(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
11606
- return localVarFp.getObject(cell, key, options).then((request) => request(axios, basePath));
10203
+ deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10204
+ return localVarFp.deleteStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
11607
10205
  },
11608
10206
  /**
11609
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
11610
- * @summary Get Object Metadata
10207
+ * Returns the stored scene.
10208
+ * @summary Get Scene
11611
10209
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11612
- * @param {string} key
10210
+ * @param {string} scene Unique identifier addressing a collision scene.
11613
10211
  * @param {*} [options] Override http request option.
11614
10212
  * @throws {RequiredError}
11615
10213
  */
11616
- getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11617
- return localVarFp.getObjectMetadata(cell, key, options).then((request) => request(axios, basePath));
10214
+ getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene> {
10215
+ return localVarFp.getStoredCollisionScene(cell, scene, options).then((request) => request(axios, basePath));
11618
10216
  },
11619
10217
  /**
11620
- * List the keys for all objects.
11621
- * @summary List all Object Keys
10218
+ * Returns a list of stored scenes.
10219
+ * @summary List Scenes
11622
10220
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11623
10221
  * @param {*} [options] Override http request option.
11624
10222
  * @throws {RequiredError}
11625
10223
  */
11626
- listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
11627
- return localVarFp.listAllObjectKeys(cell, options).then((request) => request(axios, basePath));
10224
+ listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: CollisionScene; }> {
10225
+ return localVarFp.listStoredCollisionScenes(cell, options).then((request) => request(axios, basePath));
11628
10226
  },
11629
10227
  /**
11630
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
11631
- * @summary Store Object
10228
+ * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10229
+ * @summary Store Scene
11632
10230
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11633
- * @param {string} key
11634
- * @param {{ [key: string]: string; }} [xMetadata]
11635
- * @param {any} [anyValue]
10231
+ * @param {string} scene Unique identifier addressing a collision scene.
10232
+ * @param {CollisionSceneAssembly} collisionSceneAssembly
11636
10233
  * @param {*} [options] Override http request option.
11637
10234
  * @throws {RequiredError}
11638
10235
  */
11639
- storeObject(cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options?: RawAxiosRequestConfig): AxiosPromise<void> {
11640
- return localVarFp.storeObject(cell, key, xMetadata, anyValue, options).then((request) => request(axios, basePath));
10236
+ storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig): AxiosPromise<CollisionScene> {
10237
+ return localVarFp.storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(axios, basePath));
11641
10238
  },
11642
10239
  };
11643
10240
  };
11644
10241
 
11645
10242
  /**
11646
- * StoreObjectApi - object-oriented interface
10243
+ * StoreCollisionScenesApi - object-oriented interface
11647
10244
  * @export
11648
- * @class StoreObjectApi
10245
+ * @class StoreCollisionScenesApi
11649
10246
  * @extends {BaseAPI}
11650
10247
  */
11651
- export class StoreObjectApi extends BaseAPI {
11652
- /**
11653
- * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
11654
- * @summary Clear all Objects
11655
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11656
- * @param {*} [options] Override http request option.
11657
- * @throws {RequiredError}
11658
- * @memberof StoreObjectApi
11659
- */
11660
- public clearAllObjects(cell: string, options?: RawAxiosRequestConfig) {
11661
- return StoreObjectApiFp(this.configuration).clearAllObjects(cell, options).then((request) => request(this.axios, this.basePath));
11662
- }
11663
-
11664
- /**
11665
- * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
11666
- * @summary Delete Object
11667
- * @param {string} cell Unique identifier addressing a cell in all API calls.
11668
- * @param {string} key
11669
- * @param {*} [options] Override http request option.
11670
- * @throws {RequiredError}
11671
- * @memberof StoreObjectApi
11672
- */
11673
- public deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig) {
11674
- return StoreObjectApiFp(this.configuration).deleteObject(cell, key, options).then((request) => request(this.axios, this.basePath));
11675
- }
11676
-
10248
+ export class StoreCollisionScenesApi extends BaseAPI {
11677
10249
  /**
11678
- * Get the object. This request returns the object and any metadata attached to it.
11679
- * @summary Get Object
10250
+ * Deletes the stored scene. <!-- theme: danger --> > This will delete persistently stored data.
10251
+ * @summary Delete Scene
11680
10252
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11681
- * @param {string} key
10253
+ * @param {string} scene Unique identifier addressing a collision scene.
11682
10254
  * @param {*} [options] Override http request option.
11683
10255
  * @throws {RequiredError}
11684
- * @memberof StoreObjectApi
10256
+ * @memberof StoreCollisionScenesApi
11685
10257
  */
11686
- public getObject(cell: string, key: string, options?: RawAxiosRequestConfig) {
11687
- return StoreObjectApiFp(this.configuration).getObject(cell, key, options).then((request) => request(this.axios, this.basePath));
10258
+ public deleteStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig) {
10259
+ return StoreCollisionScenesApiFp(this.configuration).deleteStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
11688
10260
  }
11689
10261
 
11690
10262
  /**
11691
- * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
11692
- * @summary Get Object Metadata
10263
+ * Returns the stored scene.
10264
+ * @summary Get Scene
11693
10265
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11694
- * @param {string} key
10266
+ * @param {string} scene Unique identifier addressing a collision scene.
11695
10267
  * @param {*} [options] Override http request option.
11696
10268
  * @throws {RequiredError}
11697
- * @memberof StoreObjectApi
10269
+ * @memberof StoreCollisionScenesApi
11698
10270
  */
11699
- public getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig) {
11700
- return StoreObjectApiFp(this.configuration).getObjectMetadata(cell, key, options).then((request) => request(this.axios, this.basePath));
10271
+ public getStoredCollisionScene(cell: string, scene: string, options?: RawAxiosRequestConfig) {
10272
+ return StoreCollisionScenesApiFp(this.configuration).getStoredCollisionScene(cell, scene, options).then((request) => request(this.axios, this.basePath));
11701
10273
  }
11702
10274
 
11703
10275
  /**
11704
- * List the keys for all objects.
11705
- * @summary List all Object Keys
10276
+ * Returns a list of stored scenes.
10277
+ * @summary List Scenes
11706
10278
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11707
10279
  * @param {*} [options] Override http request option.
11708
10280
  * @throws {RequiredError}
11709
- * @memberof StoreObjectApi
10281
+ * @memberof StoreCollisionScenesApi
11710
10282
  */
11711
- public listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig) {
11712
- return StoreObjectApiFp(this.configuration).listAllObjectKeys(cell, options).then((request) => request(this.axios, this.basePath));
10283
+ public listStoredCollisionScenes(cell: string, options?: RawAxiosRequestConfig) {
10284
+ return StoreCollisionScenesApiFp(this.configuration).listStoredCollisionScenes(cell, options).then((request) => request(this.axios, this.basePath));
11713
10285
  }
11714
10286
 
11715
10287
  /**
11716
- * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
11717
- * @summary Store Object
10288
+ * Creates or replaces the stored collision scene. The scene is assembled from components as defined in the request body. <!-- theme: info --> > This endpoint allows indicating previously stored components. > Components used within the request will be copied into the new or updated scene. An error is returned if an indicated component does not exist.
10289
+ * @summary Store Scene
11718
10290
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11719
- * @param {string} key
11720
- * @param {{ [key: string]: string; }} [xMetadata]
11721
- * @param {any} [anyValue]
10291
+ * @param {string} scene Unique identifier addressing a collision scene.
10292
+ * @param {CollisionSceneAssembly} collisionSceneAssembly
11722
10293
  * @param {*} [options] Override http request option.
11723
10294
  * @throws {RequiredError}
11724
- * @memberof StoreObjectApi
10295
+ * @memberof StoreCollisionScenesApi
11725
10296
  */
11726
- public storeObject(cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options?: RawAxiosRequestConfig) {
11727
- return StoreObjectApiFp(this.configuration).storeObject(cell, key, xMetadata, anyValue, options).then((request) => request(this.axios, this.basePath));
10297
+ public storeCollisionScene(cell: string, scene: string, collisionSceneAssembly: CollisionSceneAssembly, options?: RawAxiosRequestConfig) {
10298
+ return StoreCollisionScenesApiFp(this.configuration).storeCollisionScene(cell, scene, collisionSceneAssembly, options).then((request) => request(this.axios, this.basePath));
11728
10299
  }
11729
10300
  }
11730
10301
 
11731
10302
 
11732
10303
 
11733
10304
  /**
11734
- * StoreProgramApi - axios parameter creator
10305
+ * StoreObjectApi - axios parameter creator
11735
10306
  * @export
11736
10307
  */
11737
- export const StoreProgramApiAxiosParamCreator = function (configuration?: Configuration) {
10308
+ export const StoreObjectApiAxiosParamCreator = function (configuration?: Configuration) {
11738
10309
  return {
11739
10310
  /**
11740
- * Deletes the program. This action is irreversible.
11741
- * @summary Delete Program
10311
+ * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
10312
+ * @summary Clear all Objects
10313
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10314
+ * @param {*} [options] Override http request option.
10315
+ * @throws {RequiredError}
10316
+ */
10317
+ clearAllObjects: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10318
+ // verify required parameter 'cell' is not null or undefined
10319
+ assertParamExists('clearAllObjects', 'cell', cell)
10320
+ const localVarPath = `/cells/{cell}/store/objects`
10321
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
10322
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10323
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10324
+ let baseOptions;
10325
+ if (configuration) {
10326
+ baseOptions = configuration.baseOptions;
10327
+ }
10328
+
10329
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
10330
+ const localVarHeaderParameter = {} as any;
10331
+ const localVarQueryParameter = {} as any;
10332
+
10333
+ // authentication BasicAuth required
10334
+ // http basic authentication required
10335
+ setBasicAuthToObject(localVarRequestOptions, configuration)
10336
+
10337
+ // authentication BearerAuth required
10338
+ // http bearer authentication required
10339
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
10340
+
10341
+
10342
+
10343
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10344
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10345
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10346
+
10347
+ return {
10348
+ url: toPathString(localVarUrlObj),
10349
+ options: localVarRequestOptions,
10350
+ };
10351
+ },
10352
+ /**
10353
+ * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
10354
+ * @summary Delete Object
10355
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10356
+ * @param {string} key
10357
+ * @param {*} [options] Override http request option.
10358
+ * @throws {RequiredError}
10359
+ */
10360
+ deleteObject: async (cell: string, key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10361
+ // verify required parameter 'cell' is not null or undefined
10362
+ assertParamExists('deleteObject', 'cell', cell)
10363
+ // verify required parameter 'key' is not null or undefined
10364
+ assertParamExists('deleteObject', 'key', key)
10365
+ const localVarPath = `/cells/{cell}/store/objects/{key}`
10366
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
10367
+ .replace(`{${"key"}}`, encodeURIComponent(String(key)));
10368
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10369
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10370
+ let baseOptions;
10371
+ if (configuration) {
10372
+ baseOptions = configuration.baseOptions;
10373
+ }
10374
+
10375
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
10376
+ const localVarHeaderParameter = {} as any;
10377
+ const localVarQueryParameter = {} as any;
10378
+
10379
+ // authentication BasicAuth required
10380
+ // http basic authentication required
10381
+ setBasicAuthToObject(localVarRequestOptions, configuration)
10382
+
10383
+ // authentication BearerAuth required
10384
+ // http bearer authentication required
10385
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
10386
+
10387
+
10388
+
10389
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10390
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10391
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10392
+
10393
+ return {
10394
+ url: toPathString(localVarUrlObj),
10395
+ options: localVarRequestOptions,
10396
+ };
10397
+ },
10398
+ /**
10399
+ * Get the object. This request returns the object and any metadata attached to it.
10400
+ * @summary Get Object
11742
10401
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11743
- * @param {string} program
10402
+ * @param {string} key
11744
10403
  * @param {*} [options] Override http request option.
11745
10404
  * @throws {RequiredError}
11746
10405
  */
11747
- deleteProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10406
+ getObject: async (cell: string, key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11748
10407
  // verify required parameter 'cell' is not null or undefined
11749
- assertParamExists('deleteProgram', 'cell', cell)
11750
- // verify required parameter 'program' is not null or undefined
11751
- assertParamExists('deleteProgram', 'program', program)
11752
- const localVarPath = `/cells/{cell}/store/programs/{program}`
10408
+ assertParamExists('getObject', 'cell', cell)
10409
+ // verify required parameter 'key' is not null or undefined
10410
+ assertParamExists('getObject', 'key', key)
10411
+ const localVarPath = `/cells/{cell}/store/objects/{key}`
11753
10412
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11754
- .replace(`{${"program"}}`, encodeURIComponent(String(program)));
10413
+ .replace(`{${"key"}}`, encodeURIComponent(String(key)));
11755
10414
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11756
10415
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11757
10416
  let baseOptions;
@@ -11759,7 +10418,7 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11759
10418
  baseOptions = configuration.baseOptions;
11760
10419
  }
11761
10420
 
11762
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
10421
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
11763
10422
  const localVarHeaderParameter = {} as any;
11764
10423
  const localVarQueryParameter = {} as any;
11765
10424
 
@@ -11783,21 +10442,21 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11783
10442
  };
11784
10443
  },
11785
10444
  /**
11786
- * Returns the content of the program.
11787
- * @summary Get Program
10445
+ * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
10446
+ * @summary Get Object Metadata
11788
10447
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11789
- * @param {string} program
10448
+ * @param {string} key
11790
10449
  * @param {*} [options] Override http request option.
11791
10450
  * @throws {RequiredError}
11792
10451
  */
11793
- getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10452
+ getObjectMetadata: async (cell: string, key: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11794
10453
  // verify required parameter 'cell' is not null or undefined
11795
- assertParamExists('getProgram', 'cell', cell)
11796
- // verify required parameter 'program' is not null or undefined
11797
- assertParamExists('getProgram', 'program', program)
11798
- const localVarPath = `/cells/{cell}/store/programs/{program}`
10454
+ assertParamExists('getObjectMetadata', 'cell', cell)
10455
+ // verify required parameter 'key' is not null or undefined
10456
+ assertParamExists('getObjectMetadata', 'key', key)
10457
+ const localVarPath = `/cells/{cell}/store/objects/{key}`
11799
10458
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11800
- .replace(`{${"program"}}`, encodeURIComponent(String(program)));
10459
+ .replace(`{${"key"}}`, encodeURIComponent(String(key)));
11801
10460
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11802
10461
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11803
10462
  let baseOptions;
@@ -11805,7 +10464,7 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11805
10464
  baseOptions = configuration.baseOptions;
11806
10465
  }
11807
10466
 
11808
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10467
+ const localVarRequestOptions = { method: 'HEAD', ...baseOptions, ...options};
11809
10468
  const localVarHeaderParameter = {} as any;
11810
10469
  const localVarQueryParameter = {} as any;
11811
10470
 
@@ -11829,16 +10488,16 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11829
10488
  };
11830
10489
  },
11831
10490
  /**
11832
- * Returns a list of all the stored programs.
11833
- * @summary List all Programs
10491
+ * List the keys for all objects.
10492
+ * @summary List all Object Keys
11834
10493
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11835
10494
  * @param {*} [options] Override http request option.
11836
10495
  * @throws {RequiredError}
11837
10496
  */
11838
- listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10497
+ listAllObjectKeys: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11839
10498
  // verify required parameter 'cell' is not null or undefined
11840
- assertParamExists('listPrograms', 'cell', cell)
11841
- const localVarPath = `/cells/{cell}/store/programs`
10499
+ assertParamExists('listAllObjectKeys', 'cell', cell)
10500
+ const localVarPath = `/cells/{cell}/store/objects`
11842
10501
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
11843
10502
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11844
10503
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -11871,25 +10530,23 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11871
10530
  };
11872
10531
  },
11873
10532
  /**
11874
- * Stores the content of the program. If the program exists, the operation overwrites the content.
11875
- * @summary Store Program
10533
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10534
+ * @summary Store Object
11876
10535
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11877
- * @param {string} program
11878
- * @param {string} body
10536
+ * @param {string} key
11879
10537
  * @param {{ [key: string]: string; }} [xMetadata]
10538
+ * @param {any} [anyValue]
11880
10539
  * @param {*} [options] Override http request option.
11881
10540
  * @throws {RequiredError}
11882
10541
  */
11883
- storeProgram: async (cell: string, program: string, body: string, xMetadata?: { [key: string]: string; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10542
+ storeObject: async (cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
11884
10543
  // verify required parameter 'cell' is not null or undefined
11885
- assertParamExists('storeProgram', 'cell', cell)
11886
- // verify required parameter 'program' is not null or undefined
11887
- assertParamExists('storeProgram', 'program', program)
11888
- // verify required parameter 'body' is not null or undefined
11889
- assertParamExists('storeProgram', 'body', body)
11890
- const localVarPath = `/cells/{cell}/store/programs/{program}`
10544
+ assertParamExists('storeObject', 'cell', cell)
10545
+ // verify required parameter 'key' is not null or undefined
10546
+ assertParamExists('storeObject', 'key', key)
10547
+ const localVarPath = `/cells/{cell}/store/objects/{key}`
11891
10548
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
11892
- .replace(`{${"program"}}`, encodeURIComponent(String(program)));
10549
+ .replace(`{${"key"}}`, encodeURIComponent(String(key)));
11893
10550
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
11894
10551
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
11895
10552
  let baseOptions;
@@ -11900,6 +10557,7 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11900
10557
  const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
11901
10558
  const localVarHeaderParameter = {} as any;
11902
10559
  const localVarQueryParameter = {} as any;
10560
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
11903
10561
 
11904
10562
  // authentication BasicAuth required
11905
10563
  // http basic authentication required
@@ -11910,9 +10568,13 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11910
10568
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
11911
10569
 
11912
10570
 
10571
+ if (anyValue !== undefined) {
10572
+ localVarFormParams.append('any_value', new Blob([JSON.stringify(anyValue)], { type: "application/json", }));
10573
+ }
10574
+
10575
+
10576
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
11913
10577
 
11914
- localVarHeaderParameter['Content-Type'] = 'text/*';
11915
-
11916
10578
  if (xMetadata != null) {
11917
10579
  localVarHeaderParameter['X-Metadata'] = typeof xMetadata === 'string'
11918
10580
  ? xMetadata
@@ -11921,7 +10583,7 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11921
10583
  setSearchParams(localVarUrlObj, localVarQueryParameter);
11922
10584
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
11923
10585
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
11924
- localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
10586
+ localVarRequestOptions.data = localVarFormParams;
11925
10587
 
11926
10588
  return {
11927
10589
  url: toPathString(localVarUrlObj),
@@ -11932,185 +10594,258 @@ export const StoreProgramApiAxiosParamCreator = function (configuration?: Config
11932
10594
  };
11933
10595
 
11934
10596
  /**
11935
- * StoreProgramApi - functional programming interface
10597
+ * StoreObjectApi - functional programming interface
11936
10598
  * @export
11937
10599
  */
11938
- export const StoreProgramApiFp = function(configuration?: Configuration) {
11939
- const localVarAxiosParamCreator = StoreProgramApiAxiosParamCreator(configuration)
10600
+ export const StoreObjectApiFp = function(configuration?: Configuration) {
10601
+ const localVarAxiosParamCreator = StoreObjectApiAxiosParamCreator(configuration)
11940
10602
  return {
11941
10603
  /**
11942
- * Deletes the program. This action is irreversible.
11943
- * @summary Delete Program
10604
+ * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
10605
+ * @summary Clear all Objects
10606
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10607
+ * @param {*} [options] Override http request option.
10608
+ * @throws {RequiredError}
10609
+ */
10610
+ async clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10611
+ const localVarAxiosArgs = await localVarAxiosParamCreator.clearAllObjects(cell, options);
10612
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10613
+ const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.clearAllObjects']?.[localVarOperationServerIndex]?.url;
10614
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10615
+ },
10616
+ /**
10617
+ * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
10618
+ * @summary Delete Object
10619
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10620
+ * @param {string} key
10621
+ * @param {*} [options] Override http request option.
10622
+ * @throws {RequiredError}
10623
+ */
10624
+ async deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10625
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObject(cell, key, options);
10626
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
10627
+ const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.deleteObject']?.[localVarOperationServerIndex]?.url;
10628
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
10629
+ },
10630
+ /**
10631
+ * Get the object. This request returns the object and any metadata attached to it.
10632
+ * @summary Get Object
11944
10633
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11945
- * @param {string} program
10634
+ * @param {string} key
11946
10635
  * @param {*} [options] Override http request option.
11947
10636
  * @throws {RequiredError}
11948
10637
  */
11949
- async deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11950
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteProgram(cell, program, options);
10638
+ async getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
10639
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getObject(cell, key, options);
11951
10640
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11952
- const localVarOperationServerBasePath = operationServerMap['StoreProgramApi.deleteProgram']?.[localVarOperationServerIndex]?.url;
10641
+ const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.getObject']?.[localVarOperationServerIndex]?.url;
11953
10642
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11954
10643
  },
11955
10644
  /**
11956
- * Returns the content of the program.
11957
- * @summary Get Program
10645
+ * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
10646
+ * @summary Get Object Metadata
11958
10647
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11959
- * @param {string} program
10648
+ * @param {string} key
11960
10649
  * @param {*} [options] Override http request option.
11961
10650
  * @throws {RequiredError}
11962
10651
  */
11963
- async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
11964
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
10652
+ async getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10653
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectMetadata(cell, key, options);
11965
10654
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11966
- const localVarOperationServerBasePath = operationServerMap['StoreProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
10655
+ const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.getObjectMetadata']?.[localVarOperationServerIndex]?.url;
11967
10656
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11968
10657
  },
11969
10658
  /**
11970
- * Returns a list of all the stored programs.
11971
- * @summary List all Programs
10659
+ * List the keys for all objects.
10660
+ * @summary List all Object Keys
11972
10661
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11973
10662
  * @param {*} [options] Override http request option.
11974
10663
  * @throws {RequiredError}
11975
10664
  */
11976
- async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
11977
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
10665
+ async listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
10666
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listAllObjectKeys(cell, options);
11978
10667
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11979
- const localVarOperationServerBasePath = operationServerMap['StoreProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
10668
+ const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.listAllObjectKeys']?.[localVarOperationServerIndex]?.url;
11980
10669
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11981
10670
  },
11982
10671
  /**
11983
- * Stores the content of the program. If the program exists, the operation overwrites the content.
11984
- * @summary Store Program
10672
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10673
+ * @summary Store Object
11985
10674
  * @param {string} cell Unique identifier addressing a cell in all API calls.
11986
- * @param {string} program
11987
- * @param {string} body
10675
+ * @param {string} key
11988
10676
  * @param {{ [key: string]: string; }} [xMetadata]
10677
+ * @param {any} [anyValue]
11989
10678
  * @param {*} [options] Override http request option.
11990
10679
  * @throws {RequiredError}
11991
10680
  */
11992
- async storeProgram(cell: string, program: string, body: string, xMetadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
11993
- const localVarAxiosArgs = await localVarAxiosParamCreator.storeProgram(cell, program, body, xMetadata, options);
10681
+ async storeObject(cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
10682
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storeObject(cell, key, xMetadata, anyValue, options);
11994
10683
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11995
- const localVarOperationServerBasePath = operationServerMap['StoreProgramApi.storeProgram']?.[localVarOperationServerIndex]?.url;
10684
+ const localVarOperationServerBasePath = operationServerMap['StoreObjectApi.storeObject']?.[localVarOperationServerIndex]?.url;
11996
10685
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11997
10686
  },
11998
10687
  }
11999
10688
  };
12000
10689
 
12001
10690
  /**
12002
- * StoreProgramApi - factory interface
10691
+ * StoreObjectApi - factory interface
12003
10692
  * @export
12004
10693
  */
12005
- export const StoreProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
12006
- const localVarFp = StoreProgramApiFp(configuration)
10694
+ export const StoreObjectApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
10695
+ const localVarFp = StoreObjectApiFp(configuration)
12007
10696
  return {
12008
10697
  /**
12009
- * Deletes the program. This action is irreversible.
12010
- * @summary Delete Program
10698
+ * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
10699
+ * @summary Clear all Objects
10700
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10701
+ * @param {*} [options] Override http request option.
10702
+ * @throws {RequiredError}
10703
+ */
10704
+ clearAllObjects(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10705
+ return localVarFp.clearAllObjects(cell, options).then((request) => request(axios, basePath));
10706
+ },
10707
+ /**
10708
+ * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
10709
+ * @summary Delete Object
10710
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10711
+ * @param {string} key
10712
+ * @param {*} [options] Override http request option.
10713
+ * @throws {RequiredError}
10714
+ */
10715
+ deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10716
+ return localVarFp.deleteObject(cell, key, options).then((request) => request(axios, basePath));
10717
+ },
10718
+ /**
10719
+ * Get the object. This request returns the object and any metadata attached to it.
10720
+ * @summary Get Object
12011
10721
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12012
- * @param {string} program
10722
+ * @param {string} key
12013
10723
  * @param {*} [options] Override http request option.
12014
10724
  * @throws {RequiredError}
12015
10725
  */
12016
- deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12017
- return localVarFp.deleteProgram(cell, program, options).then((request) => request(axios, basePath));
10726
+ getObject(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
10727
+ return localVarFp.getObject(cell, key, options).then((request) => request(axios, basePath));
12018
10728
  },
12019
10729
  /**
12020
- * Returns the content of the program.
12021
- * @summary Get Program
10730
+ * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
10731
+ * @summary Get Object Metadata
12022
10732
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12023
- * @param {string} program
10733
+ * @param {string} key
12024
10734
  * @param {*} [options] Override http request option.
12025
10735
  * @throws {RequiredError}
12026
10736
  */
12027
- getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<string> {
12028
- return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
10737
+ getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10738
+ return localVarFp.getObjectMetadata(cell, key, options).then((request) => request(axios, basePath));
12029
10739
  },
12030
10740
  /**
12031
- * Returns a list of all the stored programs.
12032
- * @summary List all Programs
10741
+ * List the keys for all objects.
10742
+ * @summary List all Object Keys
12033
10743
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12034
10744
  * @param {*} [options] Override http request option.
12035
10745
  * @throws {RequiredError}
12036
10746
  */
12037
- listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
12038
- return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
10747
+ listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
10748
+ return localVarFp.listAllObjectKeys(cell, options).then((request) => request(axios, basePath));
12039
10749
  },
12040
10750
  /**
12041
- * Stores the content of the program. If the program exists, the operation overwrites the content.
12042
- * @summary Store Program
10751
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10752
+ * @summary Store Object
12043
10753
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12044
- * @param {string} program
12045
- * @param {string} body
10754
+ * @param {string} key
12046
10755
  * @param {{ [key: string]: string; }} [xMetadata]
10756
+ * @param {any} [anyValue]
12047
10757
  * @param {*} [options] Override http request option.
12048
10758
  * @throws {RequiredError}
12049
10759
  */
12050
- storeProgram(cell: string, program: string, body: string, xMetadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig): AxiosPromise<void> {
12051
- return localVarFp.storeProgram(cell, program, body, xMetadata, options).then((request) => request(axios, basePath));
10760
+ storeObject(cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options?: RawAxiosRequestConfig): AxiosPromise<void> {
10761
+ return localVarFp.storeObject(cell, key, xMetadata, anyValue, options).then((request) => request(axios, basePath));
12052
10762
  },
12053
10763
  };
12054
10764
  };
12055
10765
 
12056
10766
  /**
12057
- * StoreProgramApi - object-oriented interface
10767
+ * StoreObjectApi - object-oriented interface
12058
10768
  * @export
12059
- * @class StoreProgramApi
10769
+ * @class StoreObjectApi
12060
10770
  * @extends {BaseAPI}
12061
10771
  */
12062
- export class StoreProgramApi extends BaseAPI {
10772
+ export class StoreObjectApi extends BaseAPI {
10773
+ /**
10774
+ * Delete all objects. <!-- theme: danger --> > This will delete ALL your persistently stored data.
10775
+ * @summary Clear all Objects
10776
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10777
+ * @param {*} [options] Override http request option.
10778
+ * @throws {RequiredError}
10779
+ * @memberof StoreObjectApi
10780
+ */
10781
+ public clearAllObjects(cell: string, options?: RawAxiosRequestConfig) {
10782
+ return StoreObjectApiFp(this.configuration).clearAllObjects(cell, options).then((request) => request(this.axios, this.basePath));
10783
+ }
10784
+
10785
+ /**
10786
+ * Delete an object <!-- theme: danger --> > This will delete persistently stored data.
10787
+ * @summary Delete Object
10788
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
10789
+ * @param {string} key
10790
+ * @param {*} [options] Override http request option.
10791
+ * @throws {RequiredError}
10792
+ * @memberof StoreObjectApi
10793
+ */
10794
+ public deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig) {
10795
+ return StoreObjectApiFp(this.configuration).deleteObject(cell, key, options).then((request) => request(this.axios, this.basePath));
10796
+ }
10797
+
12063
10798
  /**
12064
- * Deletes the program. This action is irreversible.
12065
- * @summary Delete Program
10799
+ * Get the object. This request returns the object and any metadata attached to it.
10800
+ * @summary Get Object
12066
10801
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12067
- * @param {string} program
10802
+ * @param {string} key
12068
10803
  * @param {*} [options] Override http request option.
12069
10804
  * @throws {RequiredError}
12070
- * @memberof StoreProgramApi
10805
+ * @memberof StoreObjectApi
12071
10806
  */
12072
- public deleteProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
12073
- return StoreProgramApiFp(this.configuration).deleteProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
10807
+ public getObject(cell: string, key: string, options?: RawAxiosRequestConfig) {
10808
+ return StoreObjectApiFp(this.configuration).getObject(cell, key, options).then((request) => request(this.axios, this.basePath));
12074
10809
  }
12075
10810
 
12076
10811
  /**
12077
- * Returns the content of the program.
12078
- * @summary Get Program
10812
+ * Get object metadata. Objects can be large. Therefore this request only returns metadata without fetching the object\'s content.
10813
+ * @summary Get Object Metadata
12079
10814
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12080
- * @param {string} program
10815
+ * @param {string} key
12081
10816
  * @param {*} [options] Override http request option.
12082
10817
  * @throws {RequiredError}
12083
- * @memberof StoreProgramApi
10818
+ * @memberof StoreObjectApi
12084
10819
  */
12085
- public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
12086
- return StoreProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
10820
+ public getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig) {
10821
+ return StoreObjectApiFp(this.configuration).getObjectMetadata(cell, key, options).then((request) => request(this.axios, this.basePath));
12087
10822
  }
12088
10823
 
12089
10824
  /**
12090
- * Returns a list of all the stored programs.
12091
- * @summary List all Programs
10825
+ * List the keys for all objects.
10826
+ * @summary List all Object Keys
12092
10827
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12093
10828
  * @param {*} [options] Override http request option.
12094
10829
  * @throws {RequiredError}
12095
- * @memberof StoreProgramApi
10830
+ * @memberof StoreObjectApi
12096
10831
  */
12097
- public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
12098
- return StoreProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
10832
+ public listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig) {
10833
+ return StoreObjectApiFp(this.configuration).listAllObjectKeys(cell, options).then((request) => request(this.axios, this.basePath));
12099
10834
  }
12100
10835
 
12101
10836
  /**
12102
- * Stores the content of the program. If the program exists, the operation overwrites the content.
12103
- * @summary Store Program
10837
+ * Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. Optional: Specify metadata as a dictionary with names and values.
10838
+ * @summary Store Object
12104
10839
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12105
- * @param {string} program
12106
- * @param {string} body
10840
+ * @param {string} key
12107
10841
  * @param {{ [key: string]: string; }} [xMetadata]
10842
+ * @param {any} [anyValue]
12108
10843
  * @param {*} [options] Override http request option.
12109
10844
  * @throws {RequiredError}
12110
- * @memberof StoreProgramApi
10845
+ * @memberof StoreObjectApi
12111
10846
  */
12112
- public storeProgram(cell: string, program: string, body: string, xMetadata?: { [key: string]: string; }, options?: RawAxiosRequestConfig) {
12113
- return StoreProgramApiFp(this.configuration).storeProgram(cell, program, body, xMetadata, options).then((request) => request(this.axios, this.basePath));
10847
+ public storeObject(cell: string, key: string, xMetadata?: { [key: string]: string; }, anyValue?: any, options?: RawAxiosRequestConfig) {
10848
+ return StoreObjectApiFp(this.configuration).storeObject(cell, key, xMetadata, anyValue, options).then((request) => request(this.axios, this.basePath));
12114
10849
  }
12115
10850
  }
12116
10851
 
@@ -12208,6 +10943,51 @@ export const SystemApiAxiosParamCreator = function (configuration?: Configuratio
12208
10943
 
12209
10944
 
12210
10945
 
10946
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
10947
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
10948
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
10949
+
10950
+ return {
10951
+ url: toPathString(localVarUrlObj),
10952
+ options: localVarRequestOptions,
10953
+ };
10954
+ },
10955
+ /**
10956
+ * 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.
10957
+ * @summary Retrieve Backup Status
10958
+ * @param {string} operationId
10959
+ * @param {*} [options] Override http request option.
10960
+ * @throws {RequiredError}
10961
+ */
10962
+ getConfigurationBackupStatus: async (operationId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
10963
+ // verify required parameter 'operationId' is not null or undefined
10964
+ assertParamExists('getConfigurationBackupStatus', 'operationId', operationId)
10965
+ const localVarPath = `/system/configuration/status`;
10966
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
10967
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
10968
+ let baseOptions;
10969
+ if (configuration) {
10970
+ baseOptions = configuration.baseOptions;
10971
+ }
10972
+
10973
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
10974
+ const localVarHeaderParameter = {} as any;
10975
+ const localVarQueryParameter = {} as any;
10976
+
10977
+ // authentication BasicAuth required
10978
+ // http basic authentication required
10979
+ setBasicAuthToObject(localVarRequestOptions, configuration)
10980
+
10981
+ // authentication BearerAuth required
10982
+ // http bearer authentication required
10983
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
10984
+
10985
+ if (operationId !== undefined) {
10986
+ localVarQueryParameter['operation_id'] = operationId;
10987
+ }
10988
+
10989
+
10990
+
12211
10991
  setSearchParams(localVarUrlObj, localVarQueryParameter);
12212
10992
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
12213
10993
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -12501,6 +11281,19 @@ export const SystemApiFp = function(configuration?: Configuration) {
12501
11281
  const localVarOperationServerBasePath = operationServerMap['SystemApi.checkNovaVersionUpdate']?.[localVarOperationServerIndex]?.url;
12502
11282
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12503
11283
  },
11284
+ /**
11285
+ * 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.
11286
+ * @summary Retrieve Backup Status
11287
+ * @param {string} operationId
11288
+ * @param {*} [options] Override http request option.
11289
+ * @throws {RequiredError}
11290
+ */
11291
+ async getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationArchiveStatus>> {
11292
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getConfigurationBackupStatus(operationId, options);
11293
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
11294
+ const localVarOperationServerBasePath = operationServerMap['SystemApi.getConfigurationBackupStatus']?.[localVarOperationServerIndex]?.url;
11295
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
11296
+ },
12504
11297
  /**
12505
11298
  * 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.
12506
11299
  * @summary Download Diagnosis Package
@@ -12607,6 +11400,16 @@ export const SystemApiFactory = function (configuration?: Configuration, basePat
12607
11400
  checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): AxiosPromise<string> {
12608
11401
  return localVarFp.checkNovaVersionUpdate(channel, options).then((request) => request(axios, basePath));
12609
11402
  },
11403
+ /**
11404
+ * 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.
11405
+ * @summary Retrieve Backup Status
11406
+ * @param {string} operationId
11407
+ * @param {*} [options] Override http request option.
11408
+ * @throws {RequiredError}
11409
+ */
11410
+ getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): AxiosPromise<ConfigurationArchiveStatus> {
11411
+ return localVarFp.getConfigurationBackupStatus(operationId, options).then((request) => request(axios, basePath));
11412
+ },
12610
11413
  /**
12611
11414
  * 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.
12612
11415
  * @summary Download Diagnosis Package
@@ -12699,6 +11502,18 @@ export class SystemApi extends BaseAPI {
12699
11502
  return SystemApiFp(this.configuration).checkNovaVersionUpdate(channel, options).then((request) => request(this.axios, this.basePath));
12700
11503
  }
12701
11504
 
11505
+ /**
11506
+ * 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.
11507
+ * @summary Retrieve Backup Status
11508
+ * @param {string} operationId
11509
+ * @param {*} [options] Override http request option.
11510
+ * @throws {RequiredError}
11511
+ * @memberof SystemApi
11512
+ */
11513
+ public getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig) {
11514
+ return SystemApiFp(this.configuration).getConfigurationBackupStatus(operationId, options).then((request) => request(this.axios, this.basePath));
11515
+ }
11516
+
12702
11517
  /**
12703
11518
  * 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.
12704
11519
  * @summary Download Diagnosis Package
@@ -13360,7 +12175,7 @@ export const TrajectoryPlanningApiAxiosParamCreator = function (configuration?:
13360
12175
  planTrajectory: async (cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
13361
12176
  // verify required parameter 'cell' is not null or undefined
13362
12177
  assertParamExists('planTrajectory', 'cell', cell)
13363
- const localVarPath = `/cells/{cell}/motion-planning/plan-trajectory`
12178
+ const localVarPath = `/cells/{cell}/trajectory-planning/plan-trajectory`
13364
12179
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
13365
12180
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
13366
12181
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);