@wandelbots/nova-api 25.5.0-dev.9 → 25.5.0-rc.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/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,14 @@ export const MotionGroupModel = {
308
309
  YaskawaTurn1: 'Yaskawa_TURN1',
309
310
  YaskawaTurn2: 'Yaskawa_TURN2',
310
311
  YaskawaTurn3: 'Yaskawa_TURN3',
311
- KukaKr1502: 'KUKA_KR150_2',
312
+ KukaKr150R2: 'KUKA_KR150_R2',
313
+ KukaKr3R540: 'KUKA_KR3_R540',
312
314
  KukaKr4R600: 'KUKA_KR4_R600',
313
315
  KukaKr6R700: 'KUKA_KR6_R700',
314
316
  KukaKr6R7002: 'KUKA_KR6_R700_2',
315
317
  KukaKr6R900: 'KUKA_KR6_R900',
316
318
  KukaKr6R9002: 'KUKA_KR6_R900_2',
319
+ KukaKr6R1820: 'KUKA_KR6_R1820',
317
320
  KukaKr10R900: 'KUKA_KR10_R900',
318
321
  KukaKr10R9002: 'KUKA_KR10_R900_2',
319
322
  KukaKr10R1100: 'KUKA_KR10_R1100',
@@ -325,6 +328,7 @@ export const MotionGroupModel = {
325
328
  KukaKr16R20102: 'KUKA_KR16_R2010_2',
326
329
  KukaKr20R1810: 'KUKA_KR20_R1810',
327
330
  KukaKr20R18102: 'KUKA_KR20_R1810_2',
331
+ KukaKr30R3: 'KUKA_KR30_R3',
328
332
  KukaKr50R2500: 'KUKA_KR50_R2500',
329
333
  KukaKr120R2700: 'KUKA_KR120_R2700',
330
334
  KukaKr120R27002: 'KUKA_KR120_R2700_2',
@@ -499,6 +503,17 @@ export const SafetyType = {
499
503
  SafetyNormal: 'SAFETY_NORMAL',
500
504
  SafetyReduced: 'SAFETY_REDUCED'
501
505
  };
506
+ /**
507
+ *
508
+ * @export
509
+ * @enum {string}
510
+ */
511
+ export const ServiceGroup = {
512
+ SystemService: 'SystemService',
513
+ CellService: 'CellService',
514
+ RobotController: 'RobotController',
515
+ App: 'App'
516
+ };
502
517
  /**
503
518
  *
504
519
  * @export
@@ -634,6 +649,7 @@ export const VirtualControllerTypes = {
634
649
  AbbIrb460025020: 'abb-irb4600_250_20',
635
650
  AbbIrb460025540: 'abb-irb4600_255_40',
636
651
  FanucArcMate100iD: 'fanuc-arc_mate_100iD',
652
+ FanucArcMate100iD16S: 'fanuc-arc_mate_100iD16S',
637
653
  FanucArcMate120iD: 'fanuc-arc_mate_120iD',
638
654
  FanucArcMate120iD12L: 'fanuc-arc_mate_120iD12L',
639
655
  FanucArcMate120iD35: 'fanuc-arc_mate_120iD35',
@@ -649,6 +665,7 @@ export const VirtualControllerTypes = {
649
665
  FanucLrMate200iD4S: 'fanuc-lr_mate_200iD4S',
650
666
  FanucLrMate200iD7L: 'fanuc-lr_mate_200iD7L',
651
667
  FanucM10iD12: 'fanuc-m10iD12',
668
+ FanucM10iD16S: 'fanuc-m10iD16S',
652
669
  FanucM20iD25: 'fanuc-m20iD25',
653
670
  FanucM20iD35: 'fanuc-m20iD35',
654
671
  FanucM900iB280L: 'fanuc-m900iB280L',
@@ -661,7 +678,7 @@ export const VirtualControllerTypes = {
661
678
  KukaKr10R9002: 'kuka-kr10_r900_2',
662
679
  KukaKr120R27002: 'kuka-kr120_r2700_2',
663
680
  KukaKr12R18102: 'kuka-kr12_r1810_2',
664
- KukaKr1502: 'kuka-kr150_2',
681
+ KukaKr150R2: 'kuka-kr150_r2',
665
682
  KukaKr16R16102: 'kuka-kr16_r1610_2',
666
683
  KukaKr16R20102: 'kuka-kr16_r2010_2',
667
684
  KukaKr20R1810: 'kuka-kr20_r1810',
@@ -671,10 +688,13 @@ export const VirtualControllerTypes = {
671
688
  KukaKr210R33002: 'kuka-kr210_r3300_2',
672
689
  KukaKr240R2700: 'kuka-kr240_r2700',
673
690
  KukaKr250R27002: 'kuka-kr250_r2700_2',
691
+ KukaKr3R540: 'kuka-kr3_r540',
692
+ KukaKr30R3: 'kuka-kr30_r3',
674
693
  KukaKr360L2403: 'kuka-kr360_l240_3',
675
694
  KukaKr4R600: 'kuka-kr4_r600',
676
695
  KukaKr500L3403: 'kuka-kr500_l340_3',
677
696
  KukaKr50R2500: 'kuka-kr50_r2500',
697
+ KukaKr6R1820: 'kuka-kr6_r1820',
678
698
  KukaKr6R7002: 'kuka-kr6_r700_2',
679
699
  KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
680
700
  KukaKr6R900: 'kuka-kr6_r900',
@@ -693,11 +713,21 @@ export const VirtualControllerTypes = {
693
713
  YaskawaAr3120: 'yaskawa-ar3120',
694
714
  YaskawaAr700: 'yaskawa-ar700',
695
715
  YaskawaAr900: 'yaskawa-ar900',
716
+ YaskawaGp110: 'yaskawa-gp110',
696
717
  YaskawaGp12: 'yaskawa-gp12',
718
+ YaskawaGp180: 'yaskawa-gp180',
719
+ YaskawaGp180120: 'yaskawa-gp180-120',
697
720
  YaskawaGp20hl: 'yaskawa-gp20hl',
721
+ YaskawaGp215: 'yaskawa-gp215',
722
+ YaskawaGp225: 'yaskawa-gp225',
698
723
  YaskawaGp25: 'yaskawa-gp25',
724
+ YaskawaGp250: 'yaskawa-gp250',
699
725
  YaskawaGp2512: 'yaskawa-gp25_12',
726
+ YaskawaGp280: 'yaskawa-gp280',
727
+ YaskawaGp35L: 'yaskawa-gp35L',
728
+ YaskawaGp400: 'yaskawa-gp400',
700
729
  YaskawaGp50: 'yaskawa-gp50',
730
+ YaskawaGp600: 'yaskawa-gp600',
701
731
  YaskawaGp7: 'yaskawa-gp7',
702
732
  YaskawaGp8: 'yaskawa-gp8',
703
733
  YaskawaGp88: 'yaskawa-gp88',
@@ -3662,6 +3692,115 @@ export class CoordinateSystemsApi extends BaseAPI {
3662
3692
  return CoordinateSystemsApiFp(this.configuration).transformInCoordinateSystem(cell, coordinateSystem, poseInCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
3663
3693
  }
3664
3694
  }
3695
+ /**
3696
+ * InverseKinematicsApi - axios parameter creator
3697
+ * @export
3698
+ */
3699
+ export const InverseKinematicsApiAxiosParamCreator = function (configuration) {
3700
+ return {
3701
+ /**
3702
+ * Returns the reachable joint positions for a list of given poses.
3703
+ * @summary Inverse kinematics
3704
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3705
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3706
+ * @param {*} [options] Override http request option.
3707
+ * @throws {RequiredError}
3708
+ */
3709
+ inverseKinematics: async (cell, inverseKinematicsRequest, options = {}) => {
3710
+ // verify required parameter 'cell' is not null or undefined
3711
+ assertParamExists('inverseKinematics', 'cell', cell);
3712
+ const localVarPath = `/cells/{cell}/kinematic/inverse-kinematics`
3713
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
3714
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3715
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3716
+ let baseOptions;
3717
+ if (configuration) {
3718
+ baseOptions = configuration.baseOptions;
3719
+ }
3720
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
3721
+ const localVarHeaderParameter = {};
3722
+ const localVarQueryParameter = {};
3723
+ // authentication BasicAuth required
3724
+ // http basic authentication required
3725
+ setBasicAuthToObject(localVarRequestOptions, configuration);
3726
+ // authentication BearerAuth required
3727
+ // http bearer authentication required
3728
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
3729
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3730
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3731
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3732
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
3733
+ localVarRequestOptions.data = serializeDataIfNeeded(inverseKinematicsRequest, localVarRequestOptions, configuration);
3734
+ return {
3735
+ url: toPathString(localVarUrlObj),
3736
+ options: localVarRequestOptions,
3737
+ };
3738
+ },
3739
+ };
3740
+ };
3741
+ /**
3742
+ * InverseKinematicsApi - functional programming interface
3743
+ * @export
3744
+ */
3745
+ export const InverseKinematicsApiFp = function (configuration) {
3746
+ const localVarAxiosParamCreator = InverseKinematicsApiAxiosParamCreator(configuration);
3747
+ return {
3748
+ /**
3749
+ * Returns the reachable joint positions for a list of given poses.
3750
+ * @summary Inverse kinematics
3751
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3752
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3753
+ * @param {*} [options] Override http request option.
3754
+ * @throws {RequiredError}
3755
+ */
3756
+ async inverseKinematics(cell, inverseKinematicsRequest, options) {
3757
+ const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
3758
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3759
+ const localVarOperationServerBasePath = operationServerMap['InverseKinematicsApi.inverseKinematics']?.[localVarOperationServerIndex]?.url;
3760
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3761
+ },
3762
+ };
3763
+ };
3764
+ /**
3765
+ * InverseKinematicsApi - factory interface
3766
+ * @export
3767
+ */
3768
+ export const InverseKinematicsApiFactory = function (configuration, basePath, axios) {
3769
+ const localVarFp = InverseKinematicsApiFp(configuration);
3770
+ return {
3771
+ /**
3772
+ * Returns the reachable joint positions for a list of given poses.
3773
+ * @summary Inverse kinematics
3774
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3775
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3776
+ * @param {*} [options] Override http request option.
3777
+ * @throws {RequiredError}
3778
+ */
3779
+ inverseKinematics(cell, inverseKinematicsRequest, options) {
3780
+ return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
3781
+ },
3782
+ };
3783
+ };
3784
+ /**
3785
+ * InverseKinematicsApi - object-oriented interface
3786
+ * @export
3787
+ * @class InverseKinematicsApi
3788
+ * @extends {BaseAPI}
3789
+ */
3790
+ export class InverseKinematicsApi extends BaseAPI {
3791
+ /**
3792
+ * Returns the reachable joint positions for a list of given poses.
3793
+ * @summary Inverse kinematics
3794
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
3795
+ * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3796
+ * @param {*} [options] Override http request option.
3797
+ * @throws {RequiredError}
3798
+ * @memberof InverseKinematicsApi
3799
+ */
3800
+ inverseKinematics(cell, inverseKinematicsRequest, options) {
3801
+ return InverseKinematicsApiFp(this.configuration).inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
3802
+ }
3803
+ }
3665
3804
  /**
3666
3805
  * JoggingApi - axios parameter creator
3667
3806
  * @export
@@ -5769,19 +5908,19 @@ export class MotionGroupKinematicsApi extends BaseAPI {
5769
5908
  export const ProgramApiAxiosParamCreator = function (configuration) {
5770
5909
  return {
5771
5910
  /**
5772
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
5773
- * @summary Create Program Runner
5911
+ * 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.
5912
+ * @summary Create program run
5774
5913
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5775
- * @param {Request} request
5914
+ * @param {ProgramRequest} programRequest
5776
5915
  * @param {*} [options] Override http request option.
5777
5916
  * @throws {RequiredError}
5778
5917
  */
5779
- createProgramRunner: async (cell, request, options = {}) => {
5918
+ createProgramRun: async (cell, programRequest, options = {}) => {
5780
5919
  // verify required parameter 'cell' is not null or undefined
5781
- assertParamExists('createProgramRunner', 'cell', cell);
5782
- // verify required parameter 'request' is not null or undefined
5783
- assertParamExists('createProgramRunner', 'request', request);
5784
- const localVarPath = `/cells/{cell}/programs/runners`
5920
+ assertParamExists('createProgramRun', 'cell', cell);
5921
+ // verify required parameter 'programRequest' is not null or undefined
5922
+ assertParamExists('createProgramRun', 'programRequest', programRequest);
5923
+ const localVarPath = `/cells/{cell}/programs/runs`
5785
5924
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5786
5925
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5787
5926
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5798,29 +5937,29 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
5798
5937
  // authentication BearerAuth required
5799
5938
  // http bearer authentication required
5800
5939
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
5801
- localVarHeaderParameter['Content-Type'] = 'text/plain';
5940
+ localVarHeaderParameter['Content-Type'] = 'application/json';
5802
5941
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5803
5942
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5804
5943
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5805
- localVarRequestOptions.data = serializeDataIfNeeded(request, localVarRequestOptions, configuration);
5944
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
5806
5945
  return {
5807
5946
  url: toPathString(localVarUrlObj),
5808
5947
  options: localVarRequestOptions,
5809
5948
  };
5810
5949
  },
5811
5950
  /**
5812
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. 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 succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
5813
- * @summary Execute Program
5951
+ * 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.
5952
+ * @summary Execute program
5814
5953
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5815
- * @param {CodeWithArguments} codeWithArguments
5954
+ * @param {ProgramRequest} programRequest
5816
5955
  * @param {*} [options] Override http request option.
5817
5956
  * @throws {RequiredError}
5818
5957
  */
5819
- executeProgram: async (cell, codeWithArguments, options = {}) => {
5958
+ executeProgram: async (cell, programRequest, options = {}) => {
5820
5959
  // verify required parameter 'cell' is not null or undefined
5821
5960
  assertParamExists('executeProgram', 'cell', cell);
5822
- // verify required parameter 'codeWithArguments' is not null or undefined
5823
- assertParamExists('executeProgram', 'codeWithArguments', codeWithArguments);
5961
+ // verify required parameter 'programRequest' is not null or undefined
5962
+ assertParamExists('executeProgram', 'programRequest', programRequest);
5824
5963
  const localVarPath = `/cells/{cell}/programs/execute`
5825
5964
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5826
5965
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -5842,28 +5981,28 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
5842
5981
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5843
5982
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5844
5983
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5845
- localVarRequestOptions.data = serializeDataIfNeeded(codeWithArguments, localVarRequestOptions, configuration);
5984
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
5846
5985
  return {
5847
5986
  url: toPathString(localVarUrlObj),
5848
5987
  options: localVarRequestOptions,
5849
5988
  };
5850
5989
  },
5851
5990
  /**
5852
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
5853
- * @summary Get Program Runner
5991
+ * 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, ...
5992
+ * @summary Get program run
5854
5993
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5855
- * @param {string} runner
5994
+ * @param {string} run
5856
5995
  * @param {*} [options] Override http request option.
5857
5996
  * @throws {RequiredError}
5858
5997
  */
5859
- getProgramRunner: async (cell, runner, options = {}) => {
5998
+ getProgramRun: async (cell, run, options = {}) => {
5860
5999
  // verify required parameter 'cell' is not null or undefined
5861
- assertParamExists('getProgramRunner', 'cell', cell);
5862
- // verify required parameter 'runner' is not null or undefined
5863
- assertParamExists('getProgramRunner', 'runner', runner);
5864
- const localVarPath = `/cells/{cell}/programs/runners/{runner}`
6000
+ assertParamExists('getProgramRun', 'cell', cell);
6001
+ // verify required parameter 'run' is not null or undefined
6002
+ assertParamExists('getProgramRun', 'run', run);
6003
+ const localVarPath = `/cells/{cell}/programs/runs/{run}`
5865
6004
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5866
- .replace(`{${"runner"}}`, encodeURIComponent(String(runner)));
6005
+ .replace(`{${"run"}}`, encodeURIComponent(String(run)));
5867
6006
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5868
6007
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5869
6008
  let baseOptions;
@@ -5888,16 +6027,16 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
5888
6027
  };
5889
6028
  },
5890
6029
  /**
5891
- * Get details about all existing program runners.
5892
- * @summary List Program Runners
6030
+ * Get details about all existing runs
6031
+ * @summary List programs
5893
6032
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5894
6033
  * @param {*} [options] Override http request option.
5895
6034
  * @throws {RequiredError}
5896
6035
  */
5897
- listProgramRunners: async (cell, options = {}) => {
6036
+ getProgramRuns: async (cell, options = {}) => {
5898
6037
  // verify required parameter 'cell' is not null or undefined
5899
- assertParamExists('listProgramRunners', 'cell', cell);
5900
- const localVarPath = `/cells/{cell}/programs/runners`
6038
+ assertParamExists('getProgramRuns', 'cell', cell);
6039
+ const localVarPath = `/cells/{cell}/programs/runs`
5901
6040
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5902
6041
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5903
6042
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5923,19 +6062,19 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
5923
6062
  };
5924
6063
  },
5925
6064
  /**
5926
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
5927
- * @summary Migrate Program
6065
+ * Simulate a program given as text/plain
6066
+ * @summary Simulate program
5928
6067
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5929
- * @param {Request1} request1
6068
+ * @param {ProgramRequest} programRequest
5930
6069
  * @param {*} [options] Override http request option.
5931
6070
  * @throws {RequiredError}
5932
6071
  */
5933
- migrateProgram: async (cell, request1, options = {}) => {
6072
+ simulateProgram: async (cell, programRequest, options = {}) => {
5934
6073
  // verify required parameter 'cell' is not null or undefined
5935
- assertParamExists('migrateProgram', 'cell', cell);
5936
- // verify required parameter 'request1' is not null or undefined
5937
- assertParamExists('migrateProgram', 'request1', request1);
5938
- const localVarPath = `/cells/{cell}/programs/migrate`
6074
+ assertParamExists('simulateProgram', 'cell', cell);
6075
+ // verify required parameter 'programRequest' is not null or undefined
6076
+ assertParamExists('simulateProgram', 'programRequest', programRequest);
6077
+ const localVarPath = `/cells/{cell}/programs/simulate`
5939
6078
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5940
6079
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5941
6080
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5952,31 +6091,27 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
5952
6091
  // authentication BearerAuth required
5953
6092
  // http bearer authentication required
5954
6093
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
5955
- localVarHeaderParameter['Content-Type'] = 'text/plain';
6094
+ localVarHeaderParameter['Content-Type'] = 'application/json';
5956
6095
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5957
6096
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5958
6097
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5959
- localVarRequestOptions.data = serializeDataIfNeeded(request1, localVarRequestOptions, configuration);
6098
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
5960
6099
  return {
5961
6100
  url: toPathString(localVarUrlObj),
5962
6101
  options: localVarRequestOptions,
5963
6102
  };
5964
6103
  },
5965
6104
  /**
5966
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
5967
- * @summary Plan Program
6105
+ * Stop all runs
6106
+ * @summary Stop all programs
5968
6107
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5969
- * @param {Request} request
5970
- * @param {string} [identifier]
5971
6108
  * @param {*} [options] Override http request option.
5972
6109
  * @throws {RequiredError}
5973
6110
  */
5974
- planProgram: async (cell, request, identifier, options = {}) => {
6111
+ stopAllPrograms: async (cell, options = {}) => {
5975
6112
  // verify required parameter 'cell' is not null or undefined
5976
- assertParamExists('planProgram', 'cell', cell);
5977
- // verify required parameter 'request' is not null or undefined
5978
- assertParamExists('planProgram', 'request', request);
5979
- const localVarPath = `/cells/{cell}/programs/plan`
6113
+ assertParamExists('stopAllPrograms', 'cell', cell);
6114
+ const localVarPath = `/cells/{cell}/programs/runs/stop`
5980
6115
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5981
6116
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5982
6117
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5993,31 +6128,30 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
5993
6128
  // authentication BearerAuth required
5994
6129
  // http bearer authentication required
5995
6130
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
5996
- if (identifier !== undefined) {
5997
- localVarQueryParameter['identifier'] = identifier;
5998
- }
5999
- localVarHeaderParameter['Content-Type'] = 'text/plain';
6000
6131
  setSearchParams(localVarUrlObj, localVarQueryParameter);
6001
6132
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6002
6133
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
6003
- localVarRequestOptions.data = serializeDataIfNeeded(request, localVarRequestOptions, configuration);
6004
6134
  return {
6005
6135
  url: toPathString(localVarUrlObj),
6006
6136
  options: localVarRequestOptions,
6007
6137
  };
6008
6138
  },
6009
6139
  /**
6010
- * Stop all runners.
6011
- * @summary Stop All Program Runners
6140
+ * Stop a specific program run.
6141
+ * @summary Stop program run
6012
6142
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6143
+ * @param {string} run
6013
6144
  * @param {*} [options] Override http request option.
6014
6145
  * @throws {RequiredError}
6015
6146
  */
6016
- stopAllProgramRunner: async (cell, options = {}) => {
6147
+ stopProgramRun: async (cell, run, options = {}) => {
6017
6148
  // verify required parameter 'cell' is not null or undefined
6018
- assertParamExists('stopAllProgramRunner', 'cell', cell);
6019
- const localVarPath = `/cells/{cell}/programs/runners/stop`
6020
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6149
+ assertParamExists('stopProgramRun', 'cell', cell);
6150
+ // verify required parameter 'run' is not null or undefined
6151
+ assertParamExists('stopProgramRun', 'run', run);
6152
+ const localVarPath = `/cells/{cell}/programs/runs/{run}/stop`
6153
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6154
+ .replace(`{${"run"}}`, encodeURIComponent(String(run)));
6021
6155
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6022
6156
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6023
6157
  let baseOptions;
@@ -6042,21 +6176,20 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
6042
6176
  };
6043
6177
  },
6044
6178
  /**
6045
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
6046
- * @summary Stop Program Runner
6179
+ * Validate a program
6180
+ * @summary Validate program
6047
6181
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6048
- * @param {string} runner
6182
+ * @param {ProgramRequest} programRequest
6049
6183
  * @param {*} [options] Override http request option.
6050
6184
  * @throws {RequiredError}
6051
6185
  */
6052
- stopProgramRunner: async (cell, runner, options = {}) => {
6186
+ validateProgram: async (cell, programRequest, options = {}) => {
6053
6187
  // verify required parameter 'cell' is not null or undefined
6054
- assertParamExists('stopProgramRunner', 'cell', cell);
6055
- // verify required parameter 'runner' is not null or undefined
6056
- assertParamExists('stopProgramRunner', 'runner', runner);
6057
- const localVarPath = `/cells/{cell}/programs/runners/{runner}/stop`
6058
- .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
6059
- .replace(`{${"runner"}}`, encodeURIComponent(String(runner)));
6188
+ assertParamExists('validateProgram', 'cell', cell);
6189
+ // verify required parameter 'programRequest' is not null or undefined
6190
+ assertParamExists('validateProgram', 'programRequest', programRequest);
6191
+ const localVarPath = `/cells/{cell}/programs/validate`
6192
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6060
6193
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6061
6194
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6062
6195
  let baseOptions;
@@ -6072,9 +6205,11 @@ export const ProgramApiAxiosParamCreator = function (configuration) {
6072
6205
  // authentication BearerAuth required
6073
6206
  // http bearer authentication required
6074
6207
  await setBearerAuthToObject(localVarHeaderParameter, configuration);
6208
+ localVarHeaderParameter['Content-Type'] = 'application/json';
6075
6209
  setSearchParams(localVarUrlObj, localVarQueryParameter);
6076
6210
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6077
6211
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
6212
+ localVarRequestOptions.data = serializeDataIfNeeded(programRequest, localVarRequestOptions, configuration);
6078
6213
  return {
6079
6214
  url: toPathString(localVarUrlObj),
6080
6215
  options: localVarRequestOptions,
@@ -6090,114 +6225,113 @@ export const ProgramApiFp = function (configuration) {
6090
6225
  const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration);
6091
6226
  return {
6092
6227
  /**
6093
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
6094
- * @summary Create Program Runner
6228
+ * 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.
6229
+ * @summary Create program run
6095
6230
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6096
- * @param {Request} request
6231
+ * @param {ProgramRequest} programRequest
6097
6232
  * @param {*} [options] Override http request option.
6098
6233
  * @throws {RequiredError}
6099
6234
  */
6100
- async createProgramRunner(cell, request, options) {
6101
- const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRunner(cell, request, options);
6235
+ async createProgramRun(cell, programRequest, options) {
6236
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRun(cell, programRequest, options);
6102
6237
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6103
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.createProgramRunner']?.[localVarOperationServerIndex]?.url;
6238
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.createProgramRun']?.[localVarOperationServerIndex]?.url;
6104
6239
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6105
6240
  },
6106
6241
  /**
6107
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. 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 succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
6108
- * @summary Execute Program
6242
+ * 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.
6243
+ * @summary Execute program
6109
6244
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6110
- * @param {CodeWithArguments} codeWithArguments
6245
+ * @param {ProgramRequest} programRequest
6111
6246
  * @param {*} [options] Override http request option.
6112
6247
  * @throws {RequiredError}
6113
6248
  */
6114
- async executeProgram(cell, codeWithArguments, options) {
6115
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell, codeWithArguments, options);
6249
+ async executeProgram(cell, programRequest, options) {
6250
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeProgram(cell, programRequest, options);
6116
6251
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6117
6252
  const localVarOperationServerBasePath = operationServerMap['ProgramApi.executeProgram']?.[localVarOperationServerIndex]?.url;
6118
6253
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6119
6254
  },
6120
6255
  /**
6121
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
6122
- * @summary Get Program Runner
6256
+ * 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, ...
6257
+ * @summary Get program run
6123
6258
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6124
- * @param {string} runner
6259
+ * @param {string} run
6125
6260
  * @param {*} [options] Override http request option.
6126
6261
  * @throws {RequiredError}
6127
6262
  */
6128
- async getProgramRunner(cell, runner, options) {
6129
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRunner(cell, runner, options);
6263
+ async getProgramRun(cell, run, options) {
6264
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRun(cell, run, options);
6130
6265
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6131
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRunner']?.[localVarOperationServerIndex]?.url;
6266
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRun']?.[localVarOperationServerIndex]?.url;
6132
6267
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6133
6268
  },
6134
6269
  /**
6135
- * Get details about all existing program runners.
6136
- * @summary List Program Runners
6270
+ * Get details about all existing runs
6271
+ * @summary List programs
6137
6272
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6138
6273
  * @param {*} [options] Override http request option.
6139
6274
  * @throws {RequiredError}
6140
6275
  */
6141
- async listProgramRunners(cell, options) {
6142
- const localVarAxiosArgs = await localVarAxiosParamCreator.listProgramRunners(cell, options);
6276
+ async getProgramRuns(cell, options) {
6277
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRuns(cell, options);
6143
6278
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6144
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.listProgramRunners']?.[localVarOperationServerIndex]?.url;
6279
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgramRuns']?.[localVarOperationServerIndex]?.url;
6145
6280
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6146
6281
  },
6147
6282
  /**
6148
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
6149
- * @summary Migrate Program
6283
+ * Simulate a program given as text/plain
6284
+ * @summary Simulate program
6150
6285
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6151
- * @param {Request1} request1
6286
+ * @param {ProgramRequest} programRequest
6152
6287
  * @param {*} [options] Override http request option.
6153
6288
  * @throws {RequiredError}
6154
6289
  */
6155
- async migrateProgram(cell, request1, options) {
6156
- const localVarAxiosArgs = await localVarAxiosParamCreator.migrateProgram(cell, request1, options);
6290
+ async simulateProgram(cell, programRequest, options) {
6291
+ const localVarAxiosArgs = await localVarAxiosParamCreator.simulateProgram(cell, programRequest, options);
6157
6292
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6158
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.migrateProgram']?.[localVarOperationServerIndex]?.url;
6293
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.simulateProgram']?.[localVarOperationServerIndex]?.url;
6159
6294
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6160
6295
  },
6161
6296
  /**
6162
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
6163
- * @summary Plan Program
6297
+ * Stop all runs
6298
+ * @summary Stop all programs
6164
6299
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6165
- * @param {Request} request
6166
- * @param {string} [identifier]
6167
6300
  * @param {*} [options] Override http request option.
6168
6301
  * @throws {RequiredError}
6169
6302
  */
6170
- async planProgram(cell, request, identifier, options) {
6171
- const localVarAxiosArgs = await localVarAxiosParamCreator.planProgram(cell, request, identifier, options);
6303
+ async stopAllPrograms(cell, options) {
6304
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllPrograms(cell, options);
6172
6305
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6173
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.planProgram']?.[localVarOperationServerIndex]?.url;
6306
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllPrograms']?.[localVarOperationServerIndex]?.url;
6174
6307
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6175
6308
  },
6176
6309
  /**
6177
- * Stop all runners.
6178
- * @summary Stop All Program Runners
6310
+ * Stop a specific program run.
6311
+ * @summary Stop program run
6179
6312
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6313
+ * @param {string} run
6180
6314
  * @param {*} [options] Override http request option.
6181
6315
  * @throws {RequiredError}
6182
6316
  */
6183
- async stopAllProgramRunner(cell, options) {
6184
- const localVarAxiosArgs = await localVarAxiosParamCreator.stopAllProgramRunner(cell, options);
6317
+ async stopProgramRun(cell, run, options) {
6318
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgramRun(cell, run, options);
6185
6319
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6186
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopAllProgramRunner']?.[localVarOperationServerIndex]?.url;
6320
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgramRun']?.[localVarOperationServerIndex]?.url;
6187
6321
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6188
6322
  },
6189
6323
  /**
6190
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
6191
- * @summary Stop Program Runner
6324
+ * Validate a program
6325
+ * @summary Validate program
6192
6326
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6193
- * @param {string} runner
6327
+ * @param {ProgramRequest} programRequest
6194
6328
  * @param {*} [options] Override http request option.
6195
6329
  * @throws {RequiredError}
6196
6330
  */
6197
- async stopProgramRunner(cell, runner, options) {
6198
- const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgramRunner(cell, runner, options);
6331
+ async validateProgram(cell, programRequest, options) {
6332
+ const localVarAxiosArgs = await localVarAxiosParamCreator.validateProgram(cell, programRequest, options);
6199
6333
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6200
- const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgramRunner']?.[localVarOperationServerIndex]?.url;
6334
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.validateProgram']?.[localVarOperationServerIndex]?.url;
6201
6335
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6202
6336
  },
6203
6337
  };
@@ -6210,91 +6344,90 @@ export const ProgramApiFactory = function (configuration, basePath, axios) {
6210
6344
  const localVarFp = ProgramApiFp(configuration);
6211
6345
  return {
6212
6346
  /**
6213
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
6214
- * @summary Create Program Runner
6347
+ * 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.
6348
+ * @summary Create program run
6215
6349
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6216
- * @param {Request} request
6350
+ * @param {ProgramRequest} programRequest
6217
6351
  * @param {*} [options] Override http request option.
6218
6352
  * @throws {RequiredError}
6219
6353
  */
6220
- createProgramRunner(cell, request, options) {
6221
- return localVarFp.createProgramRunner(cell, request, options).then((request) => request(axios, basePath));
6354
+ createProgramRun(cell, programRequest, options) {
6355
+ return localVarFp.createProgramRun(cell, programRequest, options).then((request) => request(axios, basePath));
6222
6356
  },
6223
6357
  /**
6224
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. 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 succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
6225
- * @summary Execute Program
6358
+ * 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.
6359
+ * @summary Execute program
6226
6360
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6227
- * @param {CodeWithArguments} codeWithArguments
6361
+ * @param {ProgramRequest} programRequest
6228
6362
  * @param {*} [options] Override http request option.
6229
6363
  * @throws {RequiredError}
6230
6364
  */
6231
- executeProgram(cell, codeWithArguments, options) {
6232
- return localVarFp.executeProgram(cell, codeWithArguments, options).then((request) => request(axios, basePath));
6365
+ executeProgram(cell, programRequest, options) {
6366
+ return localVarFp.executeProgram(cell, programRequest, options).then((request) => request(axios, basePath));
6233
6367
  },
6234
6368
  /**
6235
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
6236
- * @summary Get Program Runner
6369
+ * 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, ...
6370
+ * @summary Get program run
6237
6371
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6238
- * @param {string} runner
6372
+ * @param {string} run
6239
6373
  * @param {*} [options] Override http request option.
6240
6374
  * @throws {RequiredError}
6241
6375
  */
6242
- getProgramRunner(cell, runner, options) {
6243
- return localVarFp.getProgramRunner(cell, runner, options).then((request) => request(axios, basePath));
6376
+ getProgramRun(cell, run, options) {
6377
+ return localVarFp.getProgramRun(cell, run, options).then((request) => request(axios, basePath));
6244
6378
  },
6245
6379
  /**
6246
- * Get details about all existing program runners.
6247
- * @summary List Program Runners
6380
+ * Get details about all existing runs
6381
+ * @summary List programs
6248
6382
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6249
6383
  * @param {*} [options] Override http request option.
6250
6384
  * @throws {RequiredError}
6251
6385
  */
6252
- listProgramRunners(cell, options) {
6253
- return localVarFp.listProgramRunners(cell, options).then((request) => request(axios, basePath));
6386
+ getProgramRuns(cell, options) {
6387
+ return localVarFp.getProgramRuns(cell, options).then((request) => request(axios, basePath));
6254
6388
  },
6255
6389
  /**
6256
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
6257
- * @summary Migrate Program
6390
+ * Simulate a program given as text/plain
6391
+ * @summary Simulate program
6258
6392
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6259
- * @param {Request1} request1
6393
+ * @param {ProgramRequest} programRequest
6260
6394
  * @param {*} [options] Override http request option.
6261
6395
  * @throws {RequiredError}
6262
6396
  */
6263
- migrateProgram(cell, request1, options) {
6264
- return localVarFp.migrateProgram(cell, request1, options).then((request) => request(axios, basePath));
6397
+ simulateProgram(cell, programRequest, options) {
6398
+ return localVarFp.simulateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
6265
6399
  },
6266
6400
  /**
6267
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
6268
- * @summary Plan Program
6401
+ * Stop all runs
6402
+ * @summary Stop all programs
6269
6403
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6270
- * @param {Request} request
6271
- * @param {string} [identifier]
6272
6404
  * @param {*} [options] Override http request option.
6273
6405
  * @throws {RequiredError}
6274
6406
  */
6275
- planProgram(cell, request, identifier, options) {
6276
- return localVarFp.planProgram(cell, request, identifier, options).then((request) => request(axios, basePath));
6407
+ stopAllPrograms(cell, options) {
6408
+ return localVarFp.stopAllPrograms(cell, options).then((request) => request(axios, basePath));
6277
6409
  },
6278
6410
  /**
6279
- * Stop all runners.
6280
- * @summary Stop All Program Runners
6411
+ * Stop a specific program run.
6412
+ * @summary Stop program run
6281
6413
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6414
+ * @param {string} run
6282
6415
  * @param {*} [options] Override http request option.
6283
6416
  * @throws {RequiredError}
6284
6417
  */
6285
- stopAllProgramRunner(cell, options) {
6286
- return localVarFp.stopAllProgramRunner(cell, options).then((request) => request(axios, basePath));
6418
+ stopProgramRun(cell, run, options) {
6419
+ return localVarFp.stopProgramRun(cell, run, options).then((request) => request(axios, basePath));
6287
6420
  },
6288
6421
  /**
6289
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
6290
- * @summary Stop Program Runner
6422
+ * Validate a program
6423
+ * @summary Validate program
6291
6424
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6292
- * @param {string} runner
6425
+ * @param {ProgramRequest} programRequest
6293
6426
  * @param {*} [options] Override http request option.
6294
6427
  * @throws {RequiredError}
6295
6428
  */
6296
- stopProgramRunner(cell, runner, options) {
6297
- return localVarFp.stopProgramRunner(cell, runner, options).then((request) => request(axios, basePath));
6429
+ validateProgram(cell, programRequest, options) {
6430
+ return localVarFp.validateProgram(cell, programRequest, options).then((request) => request(axios, basePath));
6298
6431
  },
6299
6432
  };
6300
6433
  };
@@ -6306,99 +6439,98 @@ export const ProgramApiFactory = function (configuration, basePath, axios) {
6306
6439
  */
6307
6440
  export class ProgramApi extends BaseAPI {
6308
6441
  /**
6309
- * This endpoint accepts a program written in Wandelscript and if desired, initial arguments (in the form of a dict). It will then execute this Wandelscript asynchronously. It returns a program runner reference which can be used to query the state of the program runner. ## Parameters See the **Schema** tab for information about the request body. ## Returns A program runner reference which can be used to query the state of the program runner. ## Receiving state updates Receive state updates of the program runner via polling the `/programs/runners/{runner_id}/` ### Via polling You can receive updates about the state of the program runner by polling the `/programs/runners/{runner_id}/` endpoint. ```
6310
- * @summary Create Program Runner
6442
+ * 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.
6443
+ * @summary Create program run
6311
6444
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6312
- * @param {Request} request
6445
+ * @param {ProgramRequest} programRequest
6313
6446
  * @param {*} [options] Override http request option.
6314
6447
  * @throws {RequiredError}
6315
6448
  * @memberof ProgramApi
6316
6449
  */
6317
- createProgramRunner(cell, request, options) {
6318
- return ProgramApiFp(this.configuration).createProgramRunner(cell, request, options).then((request) => request(this.axios, this.basePath));
6450
+ createProgramRun(cell, programRequest, options) {
6451
+ return ProgramApiFp(this.configuration).createProgramRun(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
6319
6452
  }
6320
6453
  /**
6321
- * Execute a program in Wandelscript. The Wandelscript can also move multiple robots by using the \'do with\' syntax. 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 succesful execution. Otherwise an error (e.g. out of reach, singularity), is returned. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
6322
- * @summary Execute Program
6454
+ * 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.
6455
+ * @summary Execute program
6323
6456
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6324
- * @param {CodeWithArguments} codeWithArguments
6457
+ * @param {ProgramRequest} programRequest
6325
6458
  * @param {*} [options] Override http request option.
6326
6459
  * @throws {RequiredError}
6327
6460
  * @memberof ProgramApi
6328
6461
  */
6329
- executeProgram(cell, codeWithArguments, options) {
6330
- return ProgramApiFp(this.configuration).executeProgram(cell, codeWithArguments, options).then((request) => request(this.axios, this.basePath));
6462
+ executeProgram(cell, programRequest, options) {
6463
+ return ProgramApiFp(this.configuration).executeProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
6331
6464
  }
6332
6465
  /**
6333
- * Returns information about a program currently executed. When a program is finished: Program response, result, collected Wandelscript logs, etc. When a program is running: Running status, current executed line, etc. ## Parameters - **runner_id**: The identifier of the program runner
6334
- * @summary Get Program Runner
6466
+ * 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, ...
6467
+ * @summary Get program run
6335
6468
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6336
- * @param {string} runner
6469
+ * @param {string} run
6337
6470
  * @param {*} [options] Override http request option.
6338
6471
  * @throws {RequiredError}
6339
6472
  * @memberof ProgramApi
6340
6473
  */
6341
- getProgramRunner(cell, runner, options) {
6342
- return ProgramApiFp(this.configuration).getProgramRunner(cell, runner, options).then((request) => request(this.axios, this.basePath));
6474
+ getProgramRun(cell, run, options) {
6475
+ return ProgramApiFp(this.configuration).getProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
6343
6476
  }
6344
6477
  /**
6345
- * Get details about all existing program runners.
6346
- * @summary List Program Runners
6478
+ * Get details about all existing runs
6479
+ * @summary List programs
6347
6480
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6348
6481
  * @param {*} [options] Override http request option.
6349
6482
  * @throws {RequiredError}
6350
6483
  * @memberof ProgramApi
6351
6484
  */
6352
- listProgramRunners(cell, options) {
6353
- return ProgramApiFp(this.configuration).listProgramRunners(cell, options).then((request) => request(this.axios, this.basePath));
6485
+ getProgramRuns(cell, options) {
6486
+ return ProgramApiFp(this.configuration).getProgramRuns(cell, options).then((request) => request(this.axios, this.basePath));
6354
6487
  }
6355
6488
  /**
6356
- * Migrate a program ## Parameters See the **Schema** tab for information about the request body
6357
- * @summary Migrate Program
6489
+ * Simulate a program given as text/plain
6490
+ * @summary Simulate program
6358
6491
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6359
- * @param {Request1} request1
6492
+ * @param {ProgramRequest} programRequest
6360
6493
  * @param {*} [options] Override http request option.
6361
6494
  * @throws {RequiredError}
6362
6495
  * @memberof ProgramApi
6363
6496
  */
6364
- migrateProgram(cell, request1, options) {
6365
- return ProgramApiFp(this.configuration).migrateProgram(cell, request1, options).then((request) => request(this.axios, this.basePath));
6497
+ simulateProgram(cell, programRequest, options) {
6498
+ return ProgramApiFp(this.configuration).simulateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
6366
6499
  }
6367
6500
  /**
6368
- * Plan a program based on the specified robot type. The plan operation can be used to check if a Wandelscript is executable, given the current joint configuration of the robot. If the Wandelscript is executable, the result contains the motion path. If the Wandelscript is not executable, e.g. points that are out of reach, or the joints encounter a singularity, the reason is returned. The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". The plan operation can be used in other operating modes besides control mode. The Wandelscript can either be submitted as is, using Content-type text/plain, or as Content-type application/json with the Wandelscript under \"code\" alongside a set of values provided under \"initial_state\". * [WandelEngine & Wandelscript Documentation](/docs/docs/wandelscript)
6369
- * @summary Plan Program
6501
+ * Stop all runs
6502
+ * @summary Stop all programs
6370
6503
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6371
- * @param {Request} request
6372
- * @param {string} [identifier]
6373
6504
  * @param {*} [options] Override http request option.
6374
6505
  * @throws {RequiredError}
6375
6506
  * @memberof ProgramApi
6376
6507
  */
6377
- planProgram(cell, request, identifier, options) {
6378
- return ProgramApiFp(this.configuration).planProgram(cell, request, identifier, options).then((request) => request(this.axios, this.basePath));
6508
+ stopAllPrograms(cell, options) {
6509
+ return ProgramApiFp(this.configuration).stopAllPrograms(cell, options).then((request) => request(this.axios, this.basePath));
6379
6510
  }
6380
6511
  /**
6381
- * Stop all runners.
6382
- * @summary Stop All Program Runners
6512
+ * Stop a specific program run.
6513
+ * @summary Stop program run
6383
6514
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6515
+ * @param {string} run
6384
6516
  * @param {*} [options] Override http request option.
6385
6517
  * @throws {RequiredError}
6386
6518
  * @memberof ProgramApi
6387
6519
  */
6388
- stopAllProgramRunner(cell, options) {
6389
- return ProgramApiFp(this.configuration).stopAllProgramRunner(cell, options).then((request) => request(this.axios, this.basePath));
6520
+ stopProgramRun(cell, run, options) {
6521
+ return ProgramApiFp(this.configuration).stopProgramRun(cell, run, options).then((request) => request(this.axios, this.basePath));
6390
6522
  }
6391
6523
  /**
6392
- * Stop a specific program runner. If the indicated runner was not running, an error will be returned. ## Parameters - **runner_id**: The identifier of the program runner
6393
- * @summary Stop Program Runner
6524
+ * Validate a program
6525
+ * @summary Validate program
6394
6526
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6395
- * @param {string} runner
6527
+ * @param {ProgramRequest} programRequest
6396
6528
  * @param {*} [options] Override http request option.
6397
6529
  * @throws {RequiredError}
6398
6530
  * @memberof ProgramApi
6399
6531
  */
6400
- stopProgramRunner(cell, runner, options) {
6401
- return ProgramApiFp(this.configuration).stopProgramRunner(cell, runner, options).then((request) => request(this.axios, this.basePath));
6532
+ validateProgram(cell, programRequest, options) {
6533
+ return ProgramApiFp(this.configuration).validateProgram(cell, programRequest, options).then((request) => request(this.axios, this.basePath));
6402
6534
  }
6403
6535
  }
6404
6536
  /**
@@ -6408,18 +6540,18 @@ export class ProgramApi extends BaseAPI {
6408
6540
  export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6409
6541
  return {
6410
6542
  /**
6411
- * <!-- 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 id that exists in the program library.
6543
+ * <!-- 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
6544
  * @summary Run Program from Library
6413
6545
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6414
- * @param {CreateProgramRunRequest} createProgramRunRequest
6546
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
6415
6547
  * @param {*} [options] Override http request option.
6416
6548
  * @throws {RequiredError}
6417
6549
  */
6418
- createProgramRun: async (cell, createProgramRunRequest, options = {}) => {
6550
+ createProgramOperatorRun: async (cell, createProgramOperatorRunRequest, options = {}) => {
6419
6551
  // verify required parameter 'cell' is not null or undefined
6420
- assertParamExists('createProgramRun', 'cell', cell);
6421
- // verify required parameter 'createProgramRunRequest' is not null or undefined
6422
- assertParamExists('createProgramRun', 'createProgramRunRequest', createProgramRunRequest);
6552
+ assertParamExists('createProgramOperatorRun', 'cell', cell);
6553
+ // verify required parameter 'createProgramOperatorRunRequest' is not null or undefined
6554
+ assertParamExists('createProgramOperatorRun', 'createProgramOperatorRunRequest', createProgramOperatorRunRequest);
6423
6555
  const localVarPath = `/cells/{cell}/operator/programs/runs`
6424
6556
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6425
6557
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -6441,7 +6573,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6441
6573
  setSearchParams(localVarUrlObj, localVarQueryParameter);
6442
6574
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6443
6575
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
6444
- localVarRequestOptions.data = serializeDataIfNeeded(createProgramRunRequest, localVarRequestOptions, configuration);
6576
+ localVarRequestOptions.data = serializeDataIfNeeded(createProgramOperatorRunRequest, localVarRequestOptions, configuration);
6445
6577
  return {
6446
6578
  url: toPathString(localVarUrlObj),
6447
6579
  options: localVarRequestOptions,
@@ -6527,16 +6659,16 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6527
6659
  };
6528
6660
  },
6529
6661
  /**
6530
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
6662
+ * <!-- 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
6663
  * @summary Get All Program Runs
6532
6664
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6533
6665
  * @param {string} [state]
6534
6666
  * @param {*} [options] Override http request option.
6535
6667
  * @throws {RequiredError}
6536
6668
  */
6537
- getAllProgramRuns: async (cell, state, options = {}) => {
6669
+ getAllProgramOperatorRuns: async (cell, state, options = {}) => {
6538
6670
  // verify required parameter 'cell' is not null or undefined
6539
- assertParamExists('getAllProgramRuns', 'cell', cell);
6671
+ assertParamExists('getAllProgramOperatorRuns', 'cell', cell);
6540
6672
  const localVarPath = `/cells/{cell}/operator/programs/runs`
6541
6673
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
6542
6674
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -6566,7 +6698,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6566
6698
  };
6567
6699
  },
6568
6700
  /**
6569
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
6701
+ * <!-- 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
6702
  * @summary Get All Triggers
6571
6703
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6572
6704
  * @param {*} [options] Override http request option.
@@ -6601,18 +6733,18 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6601
6733
  };
6602
6734
  },
6603
6735
  /**
6604
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
6736
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
6605
6737
  * @summary Get Program Run
6606
6738
  * @param {string} run
6607
6739
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6608
6740
  * @param {*} [options] Override http request option.
6609
6741
  * @throws {RequiredError}
6610
6742
  */
6611
- getProgramRun: async (run, cell, options = {}) => {
6743
+ getProgramOperatorRun: async (run, cell, options = {}) => {
6612
6744
  // verify required parameter 'run' is not null or undefined
6613
- assertParamExists('getProgramRun', 'run', run);
6745
+ assertParamExists('getProgramOperatorRun', 'run', run);
6614
6746
  // verify required parameter 'cell' is not null or undefined
6615
- assertParamExists('getProgramRun', 'cell', cell);
6747
+ assertParamExists('getProgramOperatorRun', 'cell', cell);
6616
6748
  const localVarPath = `/cells/{cell}/operator/programs/runs/{run}`
6617
6749
  .replace(`{${"run"}}`, encodeURIComponent(String(run)))
6618
6750
  .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
@@ -6681,7 +6813,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6681
6813
  /**
6682
6814
  * <!-- 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
6815
  * @summary Update Trigger
6684
- * @param {string} trigger the id of the trigger
6816
+ * @param {string} trigger The identifier of the trigger.
6685
6817
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6686
6818
  * @param {UpdateTriggerRequest} updateTriggerRequest
6687
6819
  * @param {*} [options] Override http request option.
@@ -6732,17 +6864,17 @@ export const ProgramOperatorApiFp = function (configuration) {
6732
6864
  const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration);
6733
6865
  return {
6734
6866
  /**
6735
- * <!-- 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 id that exists in the program library.
6867
+ * <!-- 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
6868
  * @summary Run Program from Library
6737
6869
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6738
- * @param {CreateProgramRunRequest} createProgramRunRequest
6870
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
6739
6871
  * @param {*} [options] Override http request option.
6740
6872
  * @throws {RequiredError}
6741
6873
  */
6742
- async createProgramRun(cell, createProgramRunRequest, options) {
6743
- const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramRun(cell, createProgramRunRequest, options);
6874
+ async createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
6875
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options);
6744
6876
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6745
- const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramRun']?.[localVarOperationServerIndex]?.url;
6877
+ const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
6746
6878
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6747
6879
  },
6748
6880
  /**
@@ -6774,21 +6906,21 @@ export const ProgramOperatorApiFp = function (configuration) {
6774
6906
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6775
6907
  },
6776
6908
  /**
6777
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
6909
+ * <!-- 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
6910
  * @summary Get All Program Runs
6779
6911
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6780
6912
  * @param {string} [state]
6781
6913
  * @param {*} [options] Override http request option.
6782
6914
  * @throws {RequiredError}
6783
6915
  */
6784
- async getAllProgramRuns(cell, state, options) {
6785
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramRuns(cell, state, options);
6916
+ async getAllProgramOperatorRuns(cell, state, options) {
6917
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramOperatorRuns(cell, state, options);
6786
6918
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6787
- const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramRuns']?.[localVarOperationServerIndex]?.url;
6919
+ const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramOperatorRuns']?.[localVarOperationServerIndex]?.url;
6788
6920
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6789
6921
  },
6790
6922
  /**
6791
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
6923
+ * <!-- 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
6924
  * @summary Get All Triggers
6793
6925
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6794
6926
  * @param {*} [options] Override http request option.
@@ -6801,17 +6933,17 @@ export const ProgramOperatorApiFp = function (configuration) {
6801
6933
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6802
6934
  },
6803
6935
  /**
6804
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
6936
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
6805
6937
  * @summary Get Program Run
6806
6938
  * @param {string} run
6807
6939
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6808
6940
  * @param {*} [options] Override http request option.
6809
6941
  * @throws {RequiredError}
6810
6942
  */
6811
- async getProgramRun(run, cell, options) {
6812
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramRun(run, cell, options);
6943
+ async getProgramOperatorRun(run, cell, options) {
6944
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramOperatorRun(run, cell, options);
6813
6945
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
6814
- const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramRun']?.[localVarOperationServerIndex]?.url;
6946
+ const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
6815
6947
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6816
6948
  },
6817
6949
  /**
@@ -6831,7 +6963,7 @@ export const ProgramOperatorApiFp = function (configuration) {
6831
6963
  /**
6832
6964
  * <!-- 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
6965
  * @summary Update Trigger
6834
- * @param {string} trigger the id of the trigger
6966
+ * @param {string} trigger The identifier of the trigger.
6835
6967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6836
6968
  * @param {UpdateTriggerRequest} updateTriggerRequest
6837
6969
  * @param {*} [options] Override http request option.
@@ -6853,15 +6985,15 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6853
6985
  const localVarFp = ProgramOperatorApiFp(configuration);
6854
6986
  return {
6855
6987
  /**
6856
- * <!-- 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 id that exists in the program library.
6988
+ * <!-- 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
6989
  * @summary Run Program from Library
6858
6990
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6859
- * @param {CreateProgramRunRequest} createProgramRunRequest
6991
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
6860
6992
  * @param {*} [options] Override http request option.
6861
6993
  * @throws {RequiredError}
6862
6994
  */
6863
- createProgramRun(cell, createProgramRunRequest, options) {
6864
- return localVarFp.createProgramRun(cell, createProgramRunRequest, options).then((request) => request(axios, basePath));
6995
+ createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
6996
+ return localVarFp.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(axios, basePath));
6865
6997
  },
6866
6998
  /**
6867
6999
  * <!-- 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 +7018,18 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6886
7018
  return localVarFp.deleteTrigger(trigger, cell, options).then((request) => request(axios, basePath));
6887
7019
  },
6888
7020
  /**
6889
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
7021
+ * <!-- 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
7022
  * @summary Get All Program Runs
6891
7023
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6892
7024
  * @param {string} [state]
6893
7025
  * @param {*} [options] Override http request option.
6894
7026
  * @throws {RequiredError}
6895
7027
  */
6896
- getAllProgramRuns(cell, state, options) {
6897
- return localVarFp.getAllProgramRuns(cell, state, options).then((request) => request(axios, basePath));
7028
+ getAllProgramOperatorRuns(cell, state, options) {
7029
+ return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
6898
7030
  },
6899
7031
  /**
6900
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
7032
+ * <!-- 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
7033
  * @summary Get All Triggers
6902
7034
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6903
7035
  * @param {*} [options] Override http request option.
@@ -6907,15 +7039,15 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6907
7039
  return localVarFp.getAllTriggers(cell, options).then((request) => request(axios, basePath));
6908
7040
  },
6909
7041
  /**
6910
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
7042
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
6911
7043
  * @summary Get Program Run
6912
7044
  * @param {string} run
6913
7045
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6914
7046
  * @param {*} [options] Override http request option.
6915
7047
  * @throws {RequiredError}
6916
7048
  */
6917
- getProgramRun(run, cell, options) {
6918
- return localVarFp.getProgramRun(run, cell, options).then((request) => request(axios, basePath));
7049
+ getProgramOperatorRun(run, cell, options) {
7050
+ return localVarFp.getProgramOperatorRun(run, cell, options).then((request) => request(axios, basePath));
6919
7051
  },
6920
7052
  /**
6921
7053
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
@@ -6931,7 +7063,7 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6931
7063
  /**
6932
7064
  * <!-- 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
7065
  * @summary Update Trigger
6934
- * @param {string} trigger the id of the trigger
7066
+ * @param {string} trigger The identifier of the trigger.
6935
7067
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6936
7068
  * @param {UpdateTriggerRequest} updateTriggerRequest
6937
7069
  * @param {*} [options] Override http request option.
@@ -6950,16 +7082,16 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6950
7082
  */
6951
7083
  export class ProgramOperatorApi extends BaseAPI {
6952
7084
  /**
6953
- * <!-- 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 id that exists in the program library.
7085
+ * <!-- 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
7086
  * @summary Run Program from Library
6955
7087
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6956
- * @param {CreateProgramRunRequest} createProgramRunRequest
7088
+ * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
6957
7089
  * @param {*} [options] Override http request option.
6958
7090
  * @throws {RequiredError}
6959
7091
  * @memberof ProgramOperatorApi
6960
7092
  */
6961
- createProgramRun(cell, createProgramRunRequest, options) {
6962
- return ProgramOperatorApiFp(this.configuration).createProgramRun(cell, createProgramRunRequest, options).then((request) => request(this.axios, this.basePath));
7093
+ createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
7094
+ return ProgramOperatorApiFp(this.configuration).createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(this.axios, this.basePath));
6963
7095
  }
6964
7096
  /**
6965
7097
  * <!-- 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 +7118,7 @@ export class ProgramOperatorApi extends BaseAPI {
6986
7118
  return ProgramOperatorApiFp(this.configuration).deleteTrigger(trigger, cell, options).then((request) => request(this.axios, this.basePath));
6987
7119
  }
6988
7120
  /**
6989
- * <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
7121
+ * <!-- 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
7122
  * @summary Get All Program Runs
6991
7123
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6992
7124
  * @param {string} [state]
@@ -6994,11 +7126,11 @@ export class ProgramOperatorApi extends BaseAPI {
6994
7126
  * @throws {RequiredError}
6995
7127
  * @memberof ProgramOperatorApi
6996
7128
  */
6997
- getAllProgramRuns(cell, state, options) {
6998
- return ProgramOperatorApiFp(this.configuration).getAllProgramRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
7129
+ getAllProgramOperatorRuns(cell, state, options) {
7130
+ return ProgramOperatorApiFp(this.configuration).getAllProgramOperatorRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
6999
7131
  }
7000
7132
  /**
7001
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
7133
+ * <!-- 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
7134
  * @summary Get All Triggers
7003
7135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7004
7136
  * @param {*} [options] Override http request option.
@@ -7009,7 +7141,7 @@ export class ProgramOperatorApi extends BaseAPI {
7009
7141
  return ProgramOperatorApiFp(this.configuration).getAllTriggers(cell, options).then((request) => request(this.axios, this.basePath));
7010
7142
  }
7011
7143
  /**
7012
- * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
7144
+ * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
7013
7145
  * @summary Get Program Run
7014
7146
  * @param {string} run
7015
7147
  * @param {string} cell Unique identifier addressing a cell in all API calls.
@@ -7017,8 +7149,8 @@ export class ProgramOperatorApi extends BaseAPI {
7017
7149
  * @throws {RequiredError}
7018
7150
  * @memberof ProgramOperatorApi
7019
7151
  */
7020
- getProgramRun(run, cell, options) {
7021
- return ProgramOperatorApiFp(this.configuration).getProgramRun(run, cell, options).then((request) => request(this.axios, this.basePath));
7152
+ getProgramOperatorRun(run, cell, options) {
7153
+ return ProgramOperatorApiFp(this.configuration).getProgramOperatorRun(run, cell, options).then((request) => request(this.axios, this.basePath));
7022
7154
  }
7023
7155
  /**
7024
7156
  * <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
@@ -7035,7 +7167,7 @@ export class ProgramOperatorApi extends BaseAPI {
7035
7167
  /**
7036
7168
  * <!-- 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
7169
  * @summary Update Trigger
7038
- * @param {string} trigger the id of the trigger
7170
+ * @param {string} trigger The identifier of the trigger.
7039
7171
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7040
7172
  * @param {UpdateTriggerRequest} updateTriggerRequest
7041
7173
  * @param {*} [options] Override http request option.