@wandelbots/nova-api 25.5.0-dev.9 → 25.6.0-dev.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v1/api.d.ts +77 -5
- package/v1/api.js +19 -2
- package/v1/api.js.map +1 -1
- package/v1/api.ts +78 -5
- package/v2/api.d.ts +338 -557
- package/v2/api.js +273 -252
- package/v2/api.js.map +1 -1
- package/v2/api.ts +438 -646
package/v2/api.js
CHANGED
|
@@ -245,6 +245,7 @@ export const MotionGroupModel = {
|
|
|
245
245
|
FanucArcMate50iD: 'FANUC_ARC_Mate_50iD',
|
|
246
246
|
FanucArcMate50iD7L: 'FANUC_ARC_Mate_50iD7L',
|
|
247
247
|
FanucArcMate100iD: 'FANUC_ARC_Mate_100iD',
|
|
248
|
+
FanucArcMate100iD16S: 'FANUC_ARC_Mate_100iD16S',
|
|
248
249
|
FanucArcMate100iD8L: 'FANUC_ARC_Mate_100iD8L',
|
|
249
250
|
FanucArcMate100iD10L: 'FANUC_ARC_Mate_100iD10L',
|
|
250
251
|
FanucArcMate120iD: 'FANUC_ARC_Mate_120iD',
|
|
@@ -308,12 +309,13 @@ export const MotionGroupModel = {
|
|
|
308
309
|
YaskawaTurn1: 'Yaskawa_TURN1',
|
|
309
310
|
YaskawaTurn2: 'Yaskawa_TURN2',
|
|
310
311
|
YaskawaTurn3: 'Yaskawa_TURN3',
|
|
311
|
-
|
|
312
|
+
KukaKr150R2: 'KUKA_KR150_R2',
|
|
312
313
|
KukaKr4R600: 'KUKA_KR4_R600',
|
|
313
314
|
KukaKr6R700: 'KUKA_KR6_R700',
|
|
314
315
|
KukaKr6R7002: 'KUKA_KR6_R700_2',
|
|
315
316
|
KukaKr6R900: 'KUKA_KR6_R900',
|
|
316
317
|
KukaKr6R9002: 'KUKA_KR6_R900_2',
|
|
318
|
+
KukaKr6R1820: 'KUKA_KR6_R1820',
|
|
317
319
|
KukaKr10R900: 'KUKA_KR10_R900',
|
|
318
320
|
KukaKr10R9002: 'KUKA_KR10_R900_2',
|
|
319
321
|
KukaKr10R1100: 'KUKA_KR10_R1100',
|
|
@@ -325,6 +327,7 @@ export const MotionGroupModel = {
|
|
|
325
327
|
KukaKr16R20102: 'KUKA_KR16_R2010_2',
|
|
326
328
|
KukaKr20R1810: 'KUKA_KR20_R1810',
|
|
327
329
|
KukaKr20R18102: 'KUKA_KR20_R1810_2',
|
|
330
|
+
KukaKr30R3: 'KUKA_KR30_R3',
|
|
328
331
|
KukaKr50R2500: 'KUKA_KR50_R2500',
|
|
329
332
|
KukaKr120R2700: 'KUKA_KR120_R2700',
|
|
330
333
|
KukaKr120R27002: 'KUKA_KR120_R2700_2',
|
|
@@ -499,6 +502,17 @@ export const SafetyType = {
|
|
|
499
502
|
SafetyNormal: 'SAFETY_NORMAL',
|
|
500
503
|
SafetyReduced: 'SAFETY_REDUCED'
|
|
501
504
|
};
|
|
505
|
+
/**
|
|
506
|
+
*
|
|
507
|
+
* @export
|
|
508
|
+
* @enum {string}
|
|
509
|
+
*/
|
|
510
|
+
export const ServiceGroup = {
|
|
511
|
+
SystemService: 'SystemService',
|
|
512
|
+
CellService: 'CellService',
|
|
513
|
+
RobotController: 'RobotController',
|
|
514
|
+
App: 'App'
|
|
515
|
+
};
|
|
502
516
|
/**
|
|
503
517
|
*
|
|
504
518
|
* @export
|
|
@@ -634,6 +648,7 @@ export const VirtualControllerTypes = {
|
|
|
634
648
|
AbbIrb460025020: 'abb-irb4600_250_20',
|
|
635
649
|
AbbIrb460025540: 'abb-irb4600_255_40',
|
|
636
650
|
FanucArcMate100iD: 'fanuc-arc_mate_100iD',
|
|
651
|
+
FanucArcMate100iD16S: 'fanuc-arc_mate_100iD16S',
|
|
637
652
|
FanucArcMate120iD: 'fanuc-arc_mate_120iD',
|
|
638
653
|
FanucArcMate120iD12L: 'fanuc-arc_mate_120iD12L',
|
|
639
654
|
FanucArcMate120iD35: 'fanuc-arc_mate_120iD35',
|
|
@@ -649,6 +664,7 @@ export const VirtualControllerTypes = {
|
|
|
649
664
|
FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
|
|
650
665
|
FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
|
|
651
666
|
FanucM10iD12: 'fanuc-m10iD12',
|
|
667
|
+
FanucM10iD16S: 'fanuc-m10iD16S',
|
|
652
668
|
FanucM20iD25: 'fanuc-m20iD25',
|
|
653
669
|
FanucM20iD35: 'fanuc-m20iD35',
|
|
654
670
|
FanucM900iB280L: 'fanuc-m900iB280L',
|
|
@@ -661,7 +677,7 @@ export const VirtualControllerTypes = {
|
|
|
661
677
|
KukaKr10R9002: 'kuka-kr10_r900_2',
|
|
662
678
|
KukaKr120R27002: 'kuka-kr120_r2700_2',
|
|
663
679
|
KukaKr12R18102: 'kuka-kr12_r1810_2',
|
|
664
|
-
|
|
680
|
+
KukaKr150R2: 'kuka-kr150_r2',
|
|
665
681
|
KukaKr16R16102: 'kuka-kr16_r1610_2',
|
|
666
682
|
KukaKr16R20102: 'kuka-kr16_r2010_2',
|
|
667
683
|
KukaKr20R1810: 'kuka-kr20_r1810',
|
|
@@ -671,10 +687,12 @@ export const VirtualControllerTypes = {
|
|
|
671
687
|
KukaKr210R33002: 'kuka-kr210_r3300_2',
|
|
672
688
|
KukaKr240R2700: 'kuka-kr240_r2700',
|
|
673
689
|
KukaKr250R27002: 'kuka-kr250_r2700_2',
|
|
690
|
+
KukaKr30R3: 'kuka-kr30_r3',
|
|
674
691
|
KukaKr360L2403: 'kuka-kr360_l240_3',
|
|
675
692
|
KukaKr4R600: 'kuka-kr4_r600',
|
|
676
693
|
KukaKr500L3403: 'kuka-kr500_l340_3',
|
|
677
694
|
KukaKr50R2500: 'kuka-kr50_r2500',
|
|
695
|
+
KukaKr6R1820: 'kuka-kr6_r1820',
|
|
678
696
|
KukaKr6R7002: 'kuka-kr6_r700_2',
|
|
679
697
|
KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
|
|
680
698
|
KukaKr6R900: 'kuka-kr6_r900',
|
|
@@ -693,11 +711,21 @@ export const VirtualControllerTypes = {
|
|
|
693
711
|
YaskawaAr3120: 'yaskawa-ar3120',
|
|
694
712
|
YaskawaAr700: 'yaskawa-ar700',
|
|
695
713
|
YaskawaAr900: 'yaskawa-ar900',
|
|
714
|
+
YaskawaGp110: 'yaskawa-gp110',
|
|
696
715
|
YaskawaGp12: 'yaskawa-gp12',
|
|
716
|
+
YaskawaGp180: 'yaskawa-gp180',
|
|
717
|
+
YaskawaGp180120: 'yaskawa-gp180-120',
|
|
697
718
|
YaskawaGp20hl: 'yaskawa-gp20hl',
|
|
719
|
+
YaskawaGp215: 'yaskawa-gp215',
|
|
720
|
+
YaskawaGp225: 'yaskawa-gp225',
|
|
698
721
|
YaskawaGp25: 'yaskawa-gp25',
|
|
722
|
+
YaskawaGp250: 'yaskawa-gp250',
|
|
699
723
|
YaskawaGp2512: 'yaskawa-gp25_12',
|
|
724
|
+
YaskawaGp280: 'yaskawa-gp280',
|
|
725
|
+
YaskawaGp35L: 'yaskawa-gp35L',
|
|
726
|
+
YaskawaGp400: 'yaskawa-gp400',
|
|
700
727
|
YaskawaGp50: 'yaskawa-gp50',
|
|
728
|
+
YaskawaGp600: 'yaskawa-gp600',
|
|
701
729
|
YaskawaGp7: 'yaskawa-gp7',
|
|
702
730
|
YaskawaGp8: 'yaskawa-gp8',
|
|
703
731
|
YaskawaGp88: 'yaskawa-gp88',
|
|
@@ -5769,19 +5797,19 @@ export class MotionGroupKinematicsApi extends BaseAPI {
|
|
|
5769
5797
|
export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
5770
5798
|
return {
|
|
5771
5799
|
/**
|
|
5772
|
-
* This endpoint accepts a program
|
|
5773
|
-
* @summary Create
|
|
5800
|
+
* 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.
|
|
5801
|
+
* @summary Create program run
|
|
5774
5802
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5775
|
-
* @param {
|
|
5803
|
+
* @param {ProgramRequest} programRequest
|
|
5776
5804
|
* @param {*} [options] Override http request option.
|
|
5777
5805
|
* @throws {RequiredError}
|
|
5778
5806
|
*/
|
|
5779
|
-
|
|
5807
|
+
createProgramRun: async (cell, programRequest, options = {}) => {
|
|
5780
5808
|
// verify required parameter 'cell' is not null or undefined
|
|
5781
|
-
assertParamExists('
|
|
5782
|
-
// verify required parameter '
|
|
5783
|
-
assertParamExists('
|
|
5784
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
5809
|
+
assertParamExists('createProgramRun', 'cell', cell);
|
|
5810
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
5811
|
+
assertParamExists('createProgramRun', 'programRequest', programRequest);
|
|
5812
|
+
const localVarPath = `/cells/{cell}/programs/runs`
|
|
5785
5813
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5786
5814
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5787
5815
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5798,29 +5826,29 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
5798
5826
|
// authentication BearerAuth required
|
|
5799
5827
|
// http bearer authentication required
|
|
5800
5828
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5801
|
-
localVarHeaderParameter['Content-Type'] = '
|
|
5829
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5802
5830
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5803
5831
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5804
5832
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5805
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
5833
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
|
|
5806
5834
|
return {
|
|
5807
5835
|
url: toPathString(localVarUrlObj),
|
|
5808
5836
|
options: localVarRequestOptions,
|
|
5809
5837
|
};
|
|
5810
5838
|
},
|
|
5811
5839
|
/**
|
|
5812
|
-
* Execute a program
|
|
5813
|
-
* @summary Execute
|
|
5840
|
+
* 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.
|
|
5841
|
+
* @summary Execute program
|
|
5814
5842
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5815
|
-
* @param {
|
|
5843
|
+
* @param {ProgramRequest} programRequest
|
|
5816
5844
|
* @param {*} [options] Override http request option.
|
|
5817
5845
|
* @throws {RequiredError}
|
|
5818
5846
|
*/
|
|
5819
|
-
executeProgram: async (cell,
|
|
5847
|
+
executeProgram: async (cell, programRequest, options = {}) => {
|
|
5820
5848
|
// verify required parameter 'cell' is not null or undefined
|
|
5821
5849
|
assertParamExists('executeProgram', 'cell', cell);
|
|
5822
|
-
// verify required parameter '
|
|
5823
|
-
assertParamExists('executeProgram', '
|
|
5850
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
5851
|
+
assertParamExists('executeProgram', 'programRequest', programRequest);
|
|
5824
5852
|
const localVarPath = `/cells/{cell}/programs/execute`
|
|
5825
5853
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5826
5854
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -5842,28 +5870,28 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
5842
5870
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5843
5871
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5844
5872
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5845
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
5873
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
|
|
5846
5874
|
return {
|
|
5847
5875
|
url: toPathString(localVarUrlObj),
|
|
5848
5876
|
options: localVarRequestOptions,
|
|
5849
5877
|
};
|
|
5850
5878
|
},
|
|
5851
5879
|
/**
|
|
5852
|
-
* Returns information about a program currently executed.
|
|
5853
|
-
* @summary Get
|
|
5880
|
+
* 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, ...
|
|
5881
|
+
* @summary Get program run
|
|
5854
5882
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5855
|
-
* @param {string}
|
|
5883
|
+
* @param {string} run
|
|
5856
5884
|
* @param {*} [options] Override http request option.
|
|
5857
5885
|
* @throws {RequiredError}
|
|
5858
5886
|
*/
|
|
5859
|
-
|
|
5887
|
+
getProgramRun: async (cell, run, options = {}) => {
|
|
5860
5888
|
// verify required parameter 'cell' is not null or undefined
|
|
5861
|
-
assertParamExists('
|
|
5862
|
-
// verify required parameter '
|
|
5863
|
-
assertParamExists('
|
|
5864
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
5889
|
+
assertParamExists('getProgramRun', 'cell', cell);
|
|
5890
|
+
// verify required parameter 'run' is not null or undefined
|
|
5891
|
+
assertParamExists('getProgramRun', 'run', run);
|
|
5892
|
+
const localVarPath = `/cells/{cell}/programs/runs/{run}`
|
|
5865
5893
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5866
|
-
.replace(`{${"
|
|
5894
|
+
.replace(`{${"run"}}`, encodeURIComponent(String(run)));
|
|
5867
5895
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5868
5896
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5869
5897
|
let baseOptions;
|
|
@@ -5888,16 +5916,16 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
5888
5916
|
};
|
|
5889
5917
|
},
|
|
5890
5918
|
/**
|
|
5891
|
-
* Get details about all existing
|
|
5892
|
-
* @summary List
|
|
5919
|
+
* Get details about all existing runs
|
|
5920
|
+
* @summary List programs
|
|
5893
5921
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5894
5922
|
* @param {*} [options] Override http request option.
|
|
5895
5923
|
* @throws {RequiredError}
|
|
5896
5924
|
*/
|
|
5897
|
-
|
|
5925
|
+
getProgramRuns: async (cell, options = {}) => {
|
|
5898
5926
|
// verify required parameter 'cell' is not null or undefined
|
|
5899
|
-
assertParamExists('
|
|
5900
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
5927
|
+
assertParamExists('getProgramRuns', 'cell', cell);
|
|
5928
|
+
const localVarPath = `/cells/{cell}/programs/runs`
|
|
5901
5929
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5902
5930
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5903
5931
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5923,19 +5951,19 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
5923
5951
|
};
|
|
5924
5952
|
},
|
|
5925
5953
|
/**
|
|
5926
|
-
*
|
|
5927
|
-
* @summary
|
|
5954
|
+
* Simulate a program given as text/plain
|
|
5955
|
+
* @summary Simulate program
|
|
5928
5956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5929
|
-
* @param {
|
|
5957
|
+
* @param {ProgramRequest} programRequest
|
|
5930
5958
|
* @param {*} [options] Override http request option.
|
|
5931
5959
|
* @throws {RequiredError}
|
|
5932
5960
|
*/
|
|
5933
|
-
|
|
5961
|
+
simulateProgram: async (cell, programRequest, options = {}) => {
|
|
5934
5962
|
// verify required parameter 'cell' is not null or undefined
|
|
5935
|
-
assertParamExists('
|
|
5936
|
-
// verify required parameter '
|
|
5937
|
-
assertParamExists('
|
|
5938
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
5963
|
+
assertParamExists('simulateProgram', 'cell', cell);
|
|
5964
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
5965
|
+
assertParamExists('simulateProgram', 'programRequest', programRequest);
|
|
5966
|
+
const localVarPath = `/cells/{cell}/programs/simulate`
|
|
5939
5967
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5940
5968
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5941
5969
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5952,31 +5980,27 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
5952
5980
|
// authentication BearerAuth required
|
|
5953
5981
|
// http bearer authentication required
|
|
5954
5982
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5955
|
-
localVarHeaderParameter['Content-Type'] = '
|
|
5983
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5956
5984
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5957
5985
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5958
5986
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5959
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
5987
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
|
|
5960
5988
|
return {
|
|
5961
5989
|
url: toPathString(localVarUrlObj),
|
|
5962
5990
|
options: localVarRequestOptions,
|
|
5963
5991
|
};
|
|
5964
5992
|
},
|
|
5965
5993
|
/**
|
|
5966
|
-
*
|
|
5967
|
-
* @summary
|
|
5994
|
+
* Stop all runs
|
|
5995
|
+
* @summary Stop all programs
|
|
5968
5996
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5969
|
-
* @param {Request} request
|
|
5970
|
-
* @param {string} [identifier]
|
|
5971
5997
|
* @param {*} [options] Override http request option.
|
|
5972
5998
|
* @throws {RequiredError}
|
|
5973
5999
|
*/
|
|
5974
|
-
|
|
6000
|
+
stopAllPrograms: async (cell, options = {}) => {
|
|
5975
6001
|
// verify required parameter 'cell' is not null or undefined
|
|
5976
|
-
assertParamExists('
|
|
5977
|
-
|
|
5978
|
-
assertParamExists('planProgram', 'request', request);
|
|
5979
|
-
const localVarPath = `/cells/{cell}/programs/plan`
|
|
6002
|
+
assertParamExists('stopAllPrograms', 'cell', cell);
|
|
6003
|
+
const localVarPath = `/cells/{cell}/programs/runs/stop`
|
|
5980
6004
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5981
6005
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5982
6006
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5993,31 +6017,30 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
5993
6017
|
// authentication BearerAuth required
|
|
5994
6018
|
// http bearer authentication required
|
|
5995
6019
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5996
|
-
if (identifier !== undefined) {
|
|
5997
|
-
localVarQueryParameter['identifier'] = identifier;
|
|
5998
|
-
}
|
|
5999
|
-
localVarHeaderParameter['Content-Type'] = 'text/plain';
|
|
6000
6020
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6001
6021
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6002
6022
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6003
|
-
localVarRequestOptions.data = serializeDataIfNeeded(request, localVarRequestOptions, configuration);
|
|
6004
6023
|
return {
|
|
6005
6024
|
url: toPathString(localVarUrlObj),
|
|
6006
6025
|
options: localVarRequestOptions,
|
|
6007
6026
|
};
|
|
6008
6027
|
},
|
|
6009
6028
|
/**
|
|
6010
|
-
* Stop
|
|
6011
|
-
* @summary Stop
|
|
6029
|
+
* Stop a specific program run.
|
|
6030
|
+
* @summary Stop program run
|
|
6012
6031
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6032
|
+
* @param {string} run
|
|
6013
6033
|
* @param {*} [options] Override http request option.
|
|
6014
6034
|
* @throws {RequiredError}
|
|
6015
6035
|
*/
|
|
6016
|
-
|
|
6036
|
+
stopProgramRun: async (cell, run, options = {}) => {
|
|
6017
6037
|
// verify required parameter 'cell' is not null or undefined
|
|
6018
|
-
assertParamExists('
|
|
6019
|
-
|
|
6020
|
-
|
|
6038
|
+
assertParamExists('stopProgramRun', 'cell', cell);
|
|
6039
|
+
// verify required parameter 'run' is not null or undefined
|
|
6040
|
+
assertParamExists('stopProgramRun', 'run', run);
|
|
6041
|
+
const localVarPath = `/cells/{cell}/programs/runs/{run}/stop`
|
|
6042
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6043
|
+
.replace(`{${"run"}}`, encodeURIComponent(String(run)));
|
|
6021
6044
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6022
6045
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6023
6046
|
let baseOptions;
|
|
@@ -6042,21 +6065,20 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
6042
6065
|
};
|
|
6043
6066
|
},
|
|
6044
6067
|
/**
|
|
6045
|
-
*
|
|
6046
|
-
* @summary
|
|
6068
|
+
* Validate a program
|
|
6069
|
+
* @summary Validate program
|
|
6047
6070
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6048
|
-
* @param {
|
|
6071
|
+
* @param {ProgramRequest} programRequest
|
|
6049
6072
|
* @param {*} [options] Override http request option.
|
|
6050
6073
|
* @throws {RequiredError}
|
|
6051
6074
|
*/
|
|
6052
|
-
|
|
6075
|
+
validateProgram: async (cell, programRequest, options = {}) => {
|
|
6053
6076
|
// verify required parameter 'cell' is not null or undefined
|
|
6054
|
-
assertParamExists('
|
|
6055
|
-
// verify required parameter '
|
|
6056
|
-
assertParamExists('
|
|
6057
|
-
const localVarPath = `/cells/{cell}/programs/
|
|
6058
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
6059
|
-
.replace(`{${"runner"}}`, encodeURIComponent(String(runner)));
|
|
6077
|
+
assertParamExists('validateProgram', 'cell', cell);
|
|
6078
|
+
// verify required parameter 'programRequest' is not null or undefined
|
|
6079
|
+
assertParamExists('validateProgram', 'programRequest', programRequest);
|
|
6080
|
+
const localVarPath = `/cells/{cell}/programs/validate`
|
|
6081
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6060
6082
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6061
6083
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6062
6084
|
let baseOptions;
|
|
@@ -6072,9 +6094,11 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
|
6072
6094
|
// authentication BearerAuth required
|
|
6073
6095
|
// http bearer authentication required
|
|
6074
6096
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6097
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6075
6098
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6076
6099
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6077
6100
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6101
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
|
|
6078
6102
|
return {
|
|
6079
6103
|
url: toPathString(localVarUrlObj),
|
|
6080
6104
|
options: localVarRequestOptions,
|
|
@@ -6090,114 +6114,113 @@ export const ProgramApiFp = function (configuration) {
|
|
|
6090
6114
|
const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration);
|
|
6091
6115
|
return {
|
|
6092
6116
|
/**
|
|
6093
|
-
* This endpoint accepts a program
|
|
6094
|
-
* @summary Create
|
|
6117
|
+
* 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.
|
|
6118
|
+
* @summary Create program run
|
|
6095
6119
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6096
|
-
* @param {
|
|
6120
|
+
* @param {ProgramRequest} programRequest
|
|
6097
6121
|
* @param {*} [options] Override http request option.
|
|
6098
6122
|
* @throws {RequiredError}
|
|
6099
6123
|
*/
|
|
6100
|
-
async
|
|
6101
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6124
|
+
async createProgramRun(cell, programRequest, options) {
|
|
6125
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRun(cell, programRequest, options);
|
|
6102
6126
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6103
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
6127
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.createProgramRun']?.[localVarOperationServerIndex]?.url;
|
|
6104
6128
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6105
6129
|
},
|
|
6106
6130
|
/**
|
|
6107
|
-
* Execute a program
|
|
6108
|
-
* @summary Execute
|
|
6131
|
+
* 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.
|
|
6132
|
+
* @summary Execute program
|
|
6109
6133
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6110
|
-
* @param {
|
|
6134
|
+
* @param {ProgramRequest} programRequest
|
|
6111
6135
|
* @param {*} [options] Override http request option.
|
|
6112
6136
|
* @throws {RequiredError}
|
|
6113
6137
|
*/
|
|
6114
|
-
async executeProgram(cell,
|
|
6115
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell,
|
|
6138
|
+
async executeProgram(cell, programRequest, options) {
|
|
6139
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell, programRequest, options);
|
|
6116
6140
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6117
6141
|
const localVarOperationServerBasePath = operationServerMap['ProgramApi.executeProgram']?.[localVarOperationServerIndex]?.url;
|
|
6118
6142
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6119
6143
|
},
|
|
6120
6144
|
/**
|
|
6121
|
-
* Returns information about a program currently executed.
|
|
6122
|
-
* @summary Get
|
|
6145
|
+
* 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, ...
|
|
6146
|
+
* @summary Get program run
|
|
6123
6147
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6124
|
-
* @param {string}
|
|
6148
|
+
* @param {string} run
|
|
6125
6149
|
* @param {*} [options] Override http request option.
|
|
6126
6150
|
* @throws {RequiredError}
|
|
6127
6151
|
*/
|
|
6128
|
-
async
|
|
6129
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6152
|
+
async getProgramRun(cell, run, options) {
|
|
6153
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRun(cell, run, options);
|
|
6130
6154
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6131
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
6155
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRun']?.[localVarOperationServerIndex]?.url;
|
|
6132
6156
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6133
6157
|
},
|
|
6134
6158
|
/**
|
|
6135
|
-
* Get details about all existing
|
|
6136
|
-
* @summary List
|
|
6159
|
+
* Get details about all existing runs
|
|
6160
|
+
* @summary List programs
|
|
6137
6161
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6138
6162
|
* @param {*} [options] Override http request option.
|
|
6139
6163
|
* @throws {RequiredError}
|
|
6140
6164
|
*/
|
|
6141
|
-
async
|
|
6142
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6165
|
+
async getProgramRuns(cell, options) {
|
|
6166
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRuns(cell, options);
|
|
6143
6167
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6144
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
6168
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRuns']?.[localVarOperationServerIndex]?.url;
|
|
6145
6169
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6146
6170
|
},
|
|
6147
6171
|
/**
|
|
6148
|
-
*
|
|
6149
|
-
* @summary
|
|
6172
|
+
* Simulate a program given as text/plain
|
|
6173
|
+
* @summary Simulate program
|
|
6150
6174
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6151
|
-
* @param {
|
|
6175
|
+
* @param {ProgramRequest} programRequest
|
|
6152
6176
|
* @param {*} [options] Override http request option.
|
|
6153
6177
|
* @throws {RequiredError}
|
|
6154
6178
|
*/
|
|
6155
|
-
async
|
|
6156
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6179
|
+
async simulateProgram(cell, programRequest, options) {
|
|
6180
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.simulateProgram(cell, programRequest, options);
|
|
6157
6181
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6158
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
6182
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.simulateProgram']?.[localVarOperationServerIndex]?.url;
|
|
6159
6183
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6160
6184
|
},
|
|
6161
6185
|
/**
|
|
6162
|
-
*
|
|
6163
|
-
* @summary
|
|
6186
|
+
* Stop all runs
|
|
6187
|
+
* @summary Stop all programs
|
|
6164
6188
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6165
|
-
* @param {Request} request
|
|
6166
|
-
* @param {string} [identifier]
|
|
6167
6189
|
* @param {*} [options] Override http request option.
|
|
6168
6190
|
* @throws {RequiredError}
|
|
6169
6191
|
*/
|
|
6170
|
-
async
|
|
6171
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6192
|
+
async stopAllPrograms(cell, options) {
|
|
6193
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllPrograms(cell, options);
|
|
6172
6194
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6173
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
6195
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllPrograms']?.[localVarOperationServerIndex]?.url;
|
|
6174
6196
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6175
6197
|
},
|
|
6176
6198
|
/**
|
|
6177
|
-
* Stop
|
|
6178
|
-
* @summary Stop
|
|
6199
|
+
* Stop a specific program run.
|
|
6200
|
+
* @summary Stop program run
|
|
6179
6201
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6202
|
+
* @param {string} run
|
|
6180
6203
|
* @param {*} [options] Override http request option.
|
|
6181
6204
|
* @throws {RequiredError}
|
|
6182
6205
|
*/
|
|
6183
|
-
async
|
|
6184
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6206
|
+
async stopProgramRun(cell, run, options) {
|
|
6207
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgramRun(cell, run, options);
|
|
6185
6208
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6186
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
6209
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgramRun']?.[localVarOperationServerIndex]?.url;
|
|
6187
6210
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6188
6211
|
},
|
|
6189
6212
|
/**
|
|
6190
|
-
*
|
|
6191
|
-
* @summary
|
|
6213
|
+
* Validate a program
|
|
6214
|
+
* @summary Validate program
|
|
6192
6215
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6193
|
-
* @param {
|
|
6216
|
+
* @param {ProgramRequest} programRequest
|
|
6194
6217
|
* @param {*} [options] Override http request option.
|
|
6195
6218
|
* @throws {RequiredError}
|
|
6196
6219
|
*/
|
|
6197
|
-
async
|
|
6198
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6220
|
+
async validateProgram(cell, programRequest, options) {
|
|
6221
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.validateProgram(cell, programRequest, options);
|
|
6199
6222
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6200
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramApi.
|
|
6223
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.validateProgram']?.[localVarOperationServerIndex]?.url;
|
|
6201
6224
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6202
6225
|
},
|
|
6203
6226
|
};
|
|
@@ -6210,91 +6233,90 @@ export const ProgramApiFactory = function (configuration, basePath, axios) {
|
|
|
6210
6233
|
const localVarFp = ProgramApiFp(configuration);
|
|
6211
6234
|
return {
|
|
6212
6235
|
/**
|
|
6213
|
-
* This endpoint accepts a program
|
|
6214
|
-
* @summary Create
|
|
6236
|
+
* 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.
|
|
6237
|
+
* @summary Create program run
|
|
6215
6238
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6216
|
-
* @param {
|
|
6239
|
+
* @param {ProgramRequest} programRequest
|
|
6217
6240
|
* @param {*} [options] Override http request option.
|
|
6218
6241
|
* @throws {RequiredError}
|
|
6219
6242
|
*/
|
|
6220
|
-
|
|
6221
|
-
return localVarFp.
|
|
6243
|
+
createProgramRun(cell, programRequest, options) {
|
|
6244
|
+
return localVarFp.createProgramRun(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
6222
6245
|
},
|
|
6223
6246
|
/**
|
|
6224
|
-
* Execute a program
|
|
6225
|
-
* @summary Execute
|
|
6247
|
+
* 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.
|
|
6248
|
+
* @summary Execute program
|
|
6226
6249
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6227
|
-
* @param {
|
|
6250
|
+
* @param {ProgramRequest} programRequest
|
|
6228
6251
|
* @param {*} [options] Override http request option.
|
|
6229
6252
|
* @throws {RequiredError}
|
|
6230
6253
|
*/
|
|
6231
|
-
executeProgram(cell,
|
|
6232
|
-
return localVarFp.executeProgram(cell,
|
|
6254
|
+
executeProgram(cell, programRequest, options) {
|
|
6255
|
+
return localVarFp.executeProgram(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
6233
6256
|
},
|
|
6234
6257
|
/**
|
|
6235
|
-
* Returns information about a program currently executed.
|
|
6236
|
-
* @summary Get
|
|
6258
|
+
* 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, ...
|
|
6259
|
+
* @summary Get program run
|
|
6237
6260
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6238
|
-
* @param {string}
|
|
6261
|
+
* @param {string} run
|
|
6239
6262
|
* @param {*} [options] Override http request option.
|
|
6240
6263
|
* @throws {RequiredError}
|
|
6241
6264
|
*/
|
|
6242
|
-
|
|
6243
|
-
return localVarFp.
|
|
6265
|
+
getProgramRun(cell, run, options) {
|
|
6266
|
+
return localVarFp.getProgramRun(cell, run, options).then((request) => request(axios, basePath));
|
|
6244
6267
|
},
|
|
6245
6268
|
/**
|
|
6246
|
-
* Get details about all existing
|
|
6247
|
-
* @summary List
|
|
6269
|
+
* Get details about all existing runs
|
|
6270
|
+
* @summary List programs
|
|
6248
6271
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6249
6272
|
* @param {*} [options] Override http request option.
|
|
6250
6273
|
* @throws {RequiredError}
|
|
6251
6274
|
*/
|
|
6252
|
-
|
|
6253
|
-
return localVarFp.
|
|
6275
|
+
getProgramRuns(cell, options) {
|
|
6276
|
+
return localVarFp.getProgramRuns(cell, options).then((request) => request(axios, basePath));
|
|
6254
6277
|
},
|
|
6255
6278
|
/**
|
|
6256
|
-
*
|
|
6257
|
-
* @summary
|
|
6279
|
+
* Simulate a program given as text/plain
|
|
6280
|
+
* @summary Simulate program
|
|
6258
6281
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6259
|
-
* @param {
|
|
6282
|
+
* @param {ProgramRequest} programRequest
|
|
6260
6283
|
* @param {*} [options] Override http request option.
|
|
6261
6284
|
* @throws {RequiredError}
|
|
6262
6285
|
*/
|
|
6263
|
-
|
|
6264
|
-
return localVarFp.
|
|
6286
|
+
simulateProgram(cell, programRequest, options) {
|
|
6287
|
+
return localVarFp.simulateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
6265
6288
|
},
|
|
6266
6289
|
/**
|
|
6267
|
-
*
|
|
6268
|
-
* @summary
|
|
6290
|
+
* Stop all runs
|
|
6291
|
+
* @summary Stop all programs
|
|
6269
6292
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6270
|
-
* @param {Request} request
|
|
6271
|
-
* @param {string} [identifier]
|
|
6272
6293
|
* @param {*} [options] Override http request option.
|
|
6273
6294
|
* @throws {RequiredError}
|
|
6274
6295
|
*/
|
|
6275
|
-
|
|
6276
|
-
return localVarFp.
|
|
6296
|
+
stopAllPrograms(cell, options) {
|
|
6297
|
+
return localVarFp.stopAllPrograms(cell, options).then((request) => request(axios, basePath));
|
|
6277
6298
|
},
|
|
6278
6299
|
/**
|
|
6279
|
-
* Stop
|
|
6280
|
-
* @summary Stop
|
|
6300
|
+
* Stop a specific program run.
|
|
6301
|
+
* @summary Stop program run
|
|
6281
6302
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6303
|
+
* @param {string} run
|
|
6282
6304
|
* @param {*} [options] Override http request option.
|
|
6283
6305
|
* @throws {RequiredError}
|
|
6284
6306
|
*/
|
|
6285
|
-
|
|
6286
|
-
return localVarFp.
|
|
6307
|
+
stopProgramRun(cell, run, options) {
|
|
6308
|
+
return localVarFp.stopProgramRun(cell, run, options).then((request) => request(axios, basePath));
|
|
6287
6309
|
},
|
|
6288
6310
|
/**
|
|
6289
|
-
*
|
|
6290
|
-
* @summary
|
|
6311
|
+
* Validate a program
|
|
6312
|
+
* @summary Validate program
|
|
6291
6313
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6292
|
-
* @param {
|
|
6314
|
+
* @param {ProgramRequest} programRequest
|
|
6293
6315
|
* @param {*} [options] Override http request option.
|
|
6294
6316
|
* @throws {RequiredError}
|
|
6295
6317
|
*/
|
|
6296
|
-
|
|
6297
|
-
return localVarFp.
|
|
6318
|
+
validateProgram(cell, programRequest, options) {
|
|
6319
|
+
return localVarFp.validateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
|
|
6298
6320
|
},
|
|
6299
6321
|
};
|
|
6300
6322
|
};
|
|
@@ -6306,99 +6328,98 @@ export const ProgramApiFactory = function (configuration, basePath, axios) {
|
|
|
6306
6328
|
*/
|
|
6307
6329
|
export class ProgramApi extends BaseAPI {
|
|
6308
6330
|
/**
|
|
6309
|
-
* This endpoint accepts a program
|
|
6310
|
-
* @summary Create
|
|
6331
|
+
* 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.
|
|
6332
|
+
* @summary Create program run
|
|
6311
6333
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6312
|
-
* @param {
|
|
6334
|
+
* @param {ProgramRequest} programRequest
|
|
6313
6335
|
* @param {*} [options] Override http request option.
|
|
6314
6336
|
* @throws {RequiredError}
|
|
6315
6337
|
* @memberof ProgramApi
|
|
6316
6338
|
*/
|
|
6317
|
-
|
|
6318
|
-
return ProgramApiFp(this.configuration).
|
|
6339
|
+
createProgramRun(cell, programRequest, options) {
|
|
6340
|
+
return ProgramApiFp(this.configuration).createProgramRun(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6319
6341
|
}
|
|
6320
6342
|
/**
|
|
6321
|
-
* Execute a program
|
|
6322
|
-
* @summary Execute
|
|
6343
|
+
* 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.
|
|
6344
|
+
* @summary Execute program
|
|
6323
6345
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6324
|
-
* @param {
|
|
6346
|
+
* @param {ProgramRequest} programRequest
|
|
6325
6347
|
* @param {*} [options] Override http request option.
|
|
6326
6348
|
* @throws {RequiredError}
|
|
6327
6349
|
* @memberof ProgramApi
|
|
6328
6350
|
*/
|
|
6329
|
-
executeProgram(cell,
|
|
6330
|
-
return ProgramApiFp(this.configuration).executeProgram(cell,
|
|
6351
|
+
executeProgram(cell, programRequest, options) {
|
|
6352
|
+
return ProgramApiFp(this.configuration).executeProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6331
6353
|
}
|
|
6332
6354
|
/**
|
|
6333
|
-
* Returns information about a program currently executed.
|
|
6334
|
-
* @summary Get
|
|
6355
|
+
* 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, ...
|
|
6356
|
+
* @summary Get program run
|
|
6335
6357
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6336
|
-
* @param {string}
|
|
6358
|
+
* @param {string} run
|
|
6337
6359
|
* @param {*} [options] Override http request option.
|
|
6338
6360
|
* @throws {RequiredError}
|
|
6339
6361
|
* @memberof ProgramApi
|
|
6340
6362
|
*/
|
|
6341
|
-
|
|
6342
|
-
return ProgramApiFp(this.configuration).
|
|
6363
|
+
getProgramRun(cell, run, options) {
|
|
6364
|
+
return ProgramApiFp(this.configuration).getProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
|
|
6343
6365
|
}
|
|
6344
6366
|
/**
|
|
6345
|
-
* Get details about all existing
|
|
6346
|
-
* @summary List
|
|
6367
|
+
* Get details about all existing runs
|
|
6368
|
+
* @summary List programs
|
|
6347
6369
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6348
6370
|
* @param {*} [options] Override http request option.
|
|
6349
6371
|
* @throws {RequiredError}
|
|
6350
6372
|
* @memberof ProgramApi
|
|
6351
6373
|
*/
|
|
6352
|
-
|
|
6353
|
-
return ProgramApiFp(this.configuration).
|
|
6374
|
+
getProgramRuns(cell, options) {
|
|
6375
|
+
return ProgramApiFp(this.configuration).getProgramRuns(cell, options).then((request) => request(this.axios, this.basePath));
|
|
6354
6376
|
}
|
|
6355
6377
|
/**
|
|
6356
|
-
*
|
|
6357
|
-
* @summary
|
|
6378
|
+
* Simulate a program given as text/plain
|
|
6379
|
+
* @summary Simulate program
|
|
6358
6380
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6359
|
-
* @param {
|
|
6381
|
+
* @param {ProgramRequest} programRequest
|
|
6360
6382
|
* @param {*} [options] Override http request option.
|
|
6361
6383
|
* @throws {RequiredError}
|
|
6362
6384
|
* @memberof ProgramApi
|
|
6363
6385
|
*/
|
|
6364
|
-
|
|
6365
|
-
return ProgramApiFp(this.configuration).
|
|
6386
|
+
simulateProgram(cell, programRequest, options) {
|
|
6387
|
+
return ProgramApiFp(this.configuration).simulateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6366
6388
|
}
|
|
6367
6389
|
/**
|
|
6368
|
-
*
|
|
6369
|
-
* @summary
|
|
6390
|
+
* Stop all runs
|
|
6391
|
+
* @summary Stop all programs
|
|
6370
6392
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6371
|
-
* @param {Request} request
|
|
6372
|
-
* @param {string} [identifier]
|
|
6373
6393
|
* @param {*} [options] Override http request option.
|
|
6374
6394
|
* @throws {RequiredError}
|
|
6375
6395
|
* @memberof ProgramApi
|
|
6376
6396
|
*/
|
|
6377
|
-
|
|
6378
|
-
return ProgramApiFp(this.configuration).
|
|
6397
|
+
stopAllPrograms(cell, options) {
|
|
6398
|
+
return ProgramApiFp(this.configuration).stopAllPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
6379
6399
|
}
|
|
6380
6400
|
/**
|
|
6381
|
-
* Stop
|
|
6382
|
-
* @summary Stop
|
|
6401
|
+
* Stop a specific program run.
|
|
6402
|
+
* @summary Stop program run
|
|
6383
6403
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6404
|
+
* @param {string} run
|
|
6384
6405
|
* @param {*} [options] Override http request option.
|
|
6385
6406
|
* @throws {RequiredError}
|
|
6386
6407
|
* @memberof ProgramApi
|
|
6387
6408
|
*/
|
|
6388
|
-
|
|
6389
|
-
return ProgramApiFp(this.configuration).
|
|
6409
|
+
stopProgramRun(cell, run, options) {
|
|
6410
|
+
return ProgramApiFp(this.configuration).stopProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
|
|
6390
6411
|
}
|
|
6391
6412
|
/**
|
|
6392
|
-
*
|
|
6393
|
-
* @summary
|
|
6413
|
+
* Validate a program
|
|
6414
|
+
* @summary Validate program
|
|
6394
6415
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6395
|
-
* @param {
|
|
6416
|
+
* @param {ProgramRequest} programRequest
|
|
6396
6417
|
* @param {*} [options] Override http request option.
|
|
6397
6418
|
* @throws {RequiredError}
|
|
6398
6419
|
* @memberof ProgramApi
|
|
6399
6420
|
*/
|
|
6400
|
-
|
|
6401
|
-
return ProgramApiFp(this.configuration).
|
|
6421
|
+
validateProgram(cell, programRequest, options) {
|
|
6422
|
+
return ProgramApiFp(this.configuration).validateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6402
6423
|
}
|
|
6403
6424
|
}
|
|
6404
6425
|
/**
|
|
@@ -6408,18 +6429,18 @@ export class ProgramApi extends BaseAPI {
|
|
|
6408
6429
|
export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
|
|
6409
6430
|
return {
|
|
6410
6431
|
/**
|
|
6411
|
-
* <!-- theme: danger -->
|
|
6432
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
6412
6433
|
* @summary Run Program from Library
|
|
6413
6434
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6414
|
-
* @param {
|
|
6435
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
6415
6436
|
* @param {*} [options] Override http request option.
|
|
6416
6437
|
* @throws {RequiredError}
|
|
6417
6438
|
*/
|
|
6418
|
-
|
|
6439
|
+
createProgramOperatorRun: async (cell, createProgramOperatorRunRequest, options = {}) => {
|
|
6419
6440
|
// verify required parameter 'cell' is not null or undefined
|
|
6420
|
-
assertParamExists('
|
|
6421
|
-
// verify required parameter '
|
|
6422
|
-
assertParamExists('
|
|
6441
|
+
assertParamExists('createProgramOperatorRun', 'cell', cell);
|
|
6442
|
+
// verify required parameter 'createProgramOperatorRunRequest' is not null or undefined
|
|
6443
|
+
assertParamExists('createProgramOperatorRun', 'createProgramOperatorRunRequest', createProgramOperatorRunRequest);
|
|
6423
6444
|
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
6424
6445
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6425
6446
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -6441,7 +6462,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
|
|
|
6441
6462
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6442
6463
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6443
6464
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6444
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
6465
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createProgramOperatorRunRequest, localVarRequestOptions, configuration);
|
|
6445
6466
|
return {
|
|
6446
6467
|
url: toPathString(localVarUrlObj),
|
|
6447
6468
|
options: localVarRequestOptions,
|
|
@@ -6527,16 +6548,16 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
|
|
|
6527
6548
|
};
|
|
6528
6549
|
},
|
|
6529
6550
|
/**
|
|
6530
|
-
* <!-- theme: danger -->
|
|
6551
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
6531
6552
|
* @summary Get All Program Runs
|
|
6532
6553
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6533
6554
|
* @param {string} [state]
|
|
6534
6555
|
* @param {*} [options] Override http request option.
|
|
6535
6556
|
* @throws {RequiredError}
|
|
6536
6557
|
*/
|
|
6537
|
-
|
|
6558
|
+
getAllProgramOperatorRuns: async (cell, state, options = {}) => {
|
|
6538
6559
|
// verify required parameter 'cell' is not null or undefined
|
|
6539
|
-
assertParamExists('
|
|
6560
|
+
assertParamExists('getAllProgramOperatorRuns', 'cell', cell);
|
|
6540
6561
|
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
6541
6562
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
6542
6563
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -6566,7 +6587,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
|
|
|
6566
6587
|
};
|
|
6567
6588
|
},
|
|
6568
6589
|
/**
|
|
6569
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
6590
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
6570
6591
|
* @summary Get All Triggers
|
|
6571
6592
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6572
6593
|
* @param {*} [options] Override http request option.
|
|
@@ -6601,18 +6622,18 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
|
|
|
6601
6622
|
};
|
|
6602
6623
|
},
|
|
6603
6624
|
/**
|
|
6604
|
-
* <!-- theme: danger -->
|
|
6625
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
6605
6626
|
* @summary Get Program Run
|
|
6606
6627
|
* @param {string} run
|
|
6607
6628
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6608
6629
|
* @param {*} [options] Override http request option.
|
|
6609
6630
|
* @throws {RequiredError}
|
|
6610
6631
|
*/
|
|
6611
|
-
|
|
6632
|
+
getProgramOperatorRun: async (run, cell, options = {}) => {
|
|
6612
6633
|
// verify required parameter 'run' is not null or undefined
|
|
6613
|
-
assertParamExists('
|
|
6634
|
+
assertParamExists('getProgramOperatorRun', 'run', run);
|
|
6614
6635
|
// verify required parameter 'cell' is not null or undefined
|
|
6615
|
-
assertParamExists('
|
|
6636
|
+
assertParamExists('getProgramOperatorRun', 'cell', cell);
|
|
6616
6637
|
const localVarPath = `/cells/{cell}/operator/programs/runs/{run}`
|
|
6617
6638
|
.replace(`{${"run"}}`, encodeURIComponent(String(run)))
|
|
6618
6639
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
@@ -6681,7 +6702,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
|
|
|
6681
6702
|
/**
|
|
6682
6703
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
6683
6704
|
* @summary Update Trigger
|
|
6684
|
-
* @param {string} trigger
|
|
6705
|
+
* @param {string} trigger The identifier of the trigger.
|
|
6685
6706
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6686
6707
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
6687
6708
|
* @param {*} [options] Override http request option.
|
|
@@ -6732,17 +6753,17 @@ export const ProgramOperatorApiFp = function (configuration) {
|
|
|
6732
6753
|
const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration);
|
|
6733
6754
|
return {
|
|
6734
6755
|
/**
|
|
6735
|
-
* <!-- theme: danger -->
|
|
6756
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
6736
6757
|
* @summary Run Program from Library
|
|
6737
6758
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6738
|
-
* @param {
|
|
6759
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
6739
6760
|
* @param {*} [options] Override http request option.
|
|
6740
6761
|
* @throws {RequiredError}
|
|
6741
6762
|
*/
|
|
6742
|
-
async
|
|
6743
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6763
|
+
async createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
|
|
6764
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options);
|
|
6744
6765
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6745
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.
|
|
6766
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
6746
6767
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6747
6768
|
},
|
|
6748
6769
|
/**
|
|
@@ -6774,21 +6795,21 @@ export const ProgramOperatorApiFp = function (configuration) {
|
|
|
6774
6795
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6775
6796
|
},
|
|
6776
6797
|
/**
|
|
6777
|
-
* <!-- theme: danger -->
|
|
6798
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
6778
6799
|
* @summary Get All Program Runs
|
|
6779
6800
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6780
6801
|
* @param {string} [state]
|
|
6781
6802
|
* @param {*} [options] Override http request option.
|
|
6782
6803
|
* @throws {RequiredError}
|
|
6783
6804
|
*/
|
|
6784
|
-
async
|
|
6785
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6805
|
+
async getAllProgramOperatorRuns(cell, state, options) {
|
|
6806
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramOperatorRuns(cell, state, options);
|
|
6786
6807
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6787
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.
|
|
6808
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramOperatorRuns']?.[localVarOperationServerIndex]?.url;
|
|
6788
6809
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6789
6810
|
},
|
|
6790
6811
|
/**
|
|
6791
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
6812
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
6792
6813
|
* @summary Get All Triggers
|
|
6793
6814
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6794
6815
|
* @param {*} [options] Override http request option.
|
|
@@ -6801,17 +6822,17 @@ export const ProgramOperatorApiFp = function (configuration) {
|
|
|
6801
6822
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6802
6823
|
},
|
|
6803
6824
|
/**
|
|
6804
|
-
* <!-- theme: danger -->
|
|
6825
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
6805
6826
|
* @summary Get Program Run
|
|
6806
6827
|
* @param {string} run
|
|
6807
6828
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6808
6829
|
* @param {*} [options] Override http request option.
|
|
6809
6830
|
* @throws {RequiredError}
|
|
6810
6831
|
*/
|
|
6811
|
-
async
|
|
6812
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6832
|
+
async getProgramOperatorRun(run, cell, options) {
|
|
6833
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramOperatorRun(run, cell, options);
|
|
6813
6834
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6814
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.
|
|
6835
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
6815
6836
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6816
6837
|
},
|
|
6817
6838
|
/**
|
|
@@ -6831,7 +6852,7 @@ export const ProgramOperatorApiFp = function (configuration) {
|
|
|
6831
6852
|
/**
|
|
6832
6853
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
6833
6854
|
* @summary Update Trigger
|
|
6834
|
-
* @param {string} trigger
|
|
6855
|
+
* @param {string} trigger The identifier of the trigger.
|
|
6835
6856
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6836
6857
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
6837
6858
|
* @param {*} [options] Override http request option.
|
|
@@ -6853,15 +6874,15 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
|
|
|
6853
6874
|
const localVarFp = ProgramOperatorApiFp(configuration);
|
|
6854
6875
|
return {
|
|
6855
6876
|
/**
|
|
6856
|
-
* <!-- theme: danger -->
|
|
6877
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
6857
6878
|
* @summary Run Program from Library
|
|
6858
6879
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6859
|
-
* @param {
|
|
6880
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
6860
6881
|
* @param {*} [options] Override http request option.
|
|
6861
6882
|
* @throws {RequiredError}
|
|
6862
6883
|
*/
|
|
6863
|
-
|
|
6864
|
-
return localVarFp.
|
|
6884
|
+
createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
|
|
6885
|
+
return localVarFp.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(axios, basePath));
|
|
6865
6886
|
},
|
|
6866
6887
|
/**
|
|
6867
6888
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
@@ -6886,18 +6907,18 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
|
|
|
6886
6907
|
return localVarFp.deleteTrigger(trigger, cell, options).then((request) => request(axios, basePath));
|
|
6887
6908
|
},
|
|
6888
6909
|
/**
|
|
6889
|
-
* <!-- theme: danger -->
|
|
6910
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
6890
6911
|
* @summary Get All Program Runs
|
|
6891
6912
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6892
6913
|
* @param {string} [state]
|
|
6893
6914
|
* @param {*} [options] Override http request option.
|
|
6894
6915
|
* @throws {RequiredError}
|
|
6895
6916
|
*/
|
|
6896
|
-
|
|
6897
|
-
return localVarFp.
|
|
6917
|
+
getAllProgramOperatorRuns(cell, state, options) {
|
|
6918
|
+
return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
|
|
6898
6919
|
},
|
|
6899
6920
|
/**
|
|
6900
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
6921
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
6901
6922
|
* @summary Get All Triggers
|
|
6902
6923
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6903
6924
|
* @param {*} [options] Override http request option.
|
|
@@ -6907,15 +6928,15 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
|
|
|
6907
6928
|
return localVarFp.getAllTriggers(cell, options).then((request) => request(axios, basePath));
|
|
6908
6929
|
},
|
|
6909
6930
|
/**
|
|
6910
|
-
* <!-- theme: danger -->
|
|
6931
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
6911
6932
|
* @summary Get Program Run
|
|
6912
6933
|
* @param {string} run
|
|
6913
6934
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6914
6935
|
* @param {*} [options] Override http request option.
|
|
6915
6936
|
* @throws {RequiredError}
|
|
6916
6937
|
*/
|
|
6917
|
-
|
|
6918
|
-
return localVarFp.
|
|
6938
|
+
getProgramOperatorRun(run, cell, options) {
|
|
6939
|
+
return localVarFp.getProgramOperatorRun(run, cell, options).then((request) => request(axios, basePath));
|
|
6919
6940
|
},
|
|
6920
6941
|
/**
|
|
6921
6942
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
@@ -6931,7 +6952,7 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
|
|
|
6931
6952
|
/**
|
|
6932
6953
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
6933
6954
|
* @summary Update Trigger
|
|
6934
|
-
* @param {string} trigger
|
|
6955
|
+
* @param {string} trigger The identifier of the trigger.
|
|
6935
6956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6936
6957
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
6937
6958
|
* @param {*} [options] Override http request option.
|
|
@@ -6950,16 +6971,16 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
|
|
|
6950
6971
|
*/
|
|
6951
6972
|
export class ProgramOperatorApi extends BaseAPI {
|
|
6952
6973
|
/**
|
|
6953
|
-
* <!-- theme: danger -->
|
|
6974
|
+
* <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
|
|
6954
6975
|
* @summary Run Program from Library
|
|
6955
6976
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6956
|
-
* @param {
|
|
6977
|
+
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
6957
6978
|
* @param {*} [options] Override http request option.
|
|
6958
6979
|
* @throws {RequiredError}
|
|
6959
6980
|
* @memberof ProgramOperatorApi
|
|
6960
6981
|
*/
|
|
6961
|
-
|
|
6962
|
-
return ProgramOperatorApiFp(this.configuration).
|
|
6982
|
+
createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
|
|
6983
|
+
return ProgramOperatorApiFp(this.configuration).createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6963
6984
|
}
|
|
6964
6985
|
/**
|
|
6965
6986
|
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
@@ -6986,7 +7007,7 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
6986
7007
|
return ProgramOperatorApiFp(this.configuration).deleteTrigger(trigger, cell, options).then((request) => request(this.axios, this.basePath));
|
|
6987
7008
|
}
|
|
6988
7009
|
/**
|
|
6989
|
-
* <!-- theme: danger -->
|
|
7010
|
+
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
6990
7011
|
* @summary Get All Program Runs
|
|
6991
7012
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6992
7013
|
* @param {string} [state]
|
|
@@ -6994,11 +7015,11 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
6994
7015
|
* @throws {RequiredError}
|
|
6995
7016
|
* @memberof ProgramOperatorApi
|
|
6996
7017
|
*/
|
|
6997
|
-
|
|
6998
|
-
return ProgramOperatorApiFp(this.configuration).
|
|
7018
|
+
getAllProgramOperatorRuns(cell, state, options) {
|
|
7019
|
+
return ProgramOperatorApiFp(this.configuration).getAllProgramOperatorRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
|
|
6999
7020
|
}
|
|
7000
7021
|
/**
|
|
7001
|
-
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run
|
|
7022
|
+
* <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
|
|
7002
7023
|
* @summary Get All Triggers
|
|
7003
7024
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7004
7025
|
* @param {*} [options] Override http request option.
|
|
@@ -7009,7 +7030,7 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
7009
7030
|
return ProgramOperatorApiFp(this.configuration).getAllTriggers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
7010
7031
|
}
|
|
7011
7032
|
/**
|
|
7012
|
-
* <!-- theme: danger -->
|
|
7033
|
+
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
7013
7034
|
* @summary Get Program Run
|
|
7014
7035
|
* @param {string} run
|
|
7015
7036
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7017,8 +7038,8 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
7017
7038
|
* @throws {RequiredError}
|
|
7018
7039
|
* @memberof ProgramOperatorApi
|
|
7019
7040
|
*/
|
|
7020
|
-
|
|
7021
|
-
return ProgramOperatorApiFp(this.configuration).
|
|
7041
|
+
getProgramOperatorRun(run, cell, options) {
|
|
7042
|
+
return ProgramOperatorApiFp(this.configuration).getProgramOperatorRun(run, cell, options).then((request) => request(this.axios, this.basePath));
|
|
7022
7043
|
}
|
|
7023
7044
|
/**
|
|
7024
7045
|
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
@@ -7035,7 +7056,7 @@ export class ProgramOperatorApi extends BaseAPI {
|
|
|
7035
7056
|
/**
|
|
7036
7057
|
* <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
|
|
7037
7058
|
* @summary Update Trigger
|
|
7038
|
-
* @param {string} trigger
|
|
7059
|
+
* @param {string} trigger The identifier of the trigger.
|
|
7039
7060
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7040
7061
|
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
7041
7062
|
* @param {*} [options] Override http request option.
|