@wandelbots/nova-api 25.8.0-dev.6 → 25.8.0-dev.60

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
@@ -50,7 +50,7 @@ export const BusIOProfinetBusTypeEnum = {
50
50
  Profinet: 'profinet'
51
51
  };
52
52
  export const BusIOProfinetVirtualBusTypeEnum = {
53
- VirtualProfinet: 'virtual_profinet'
53
+ ProfinetVirtual: 'profinet_virtual'
54
54
  };
55
55
  /**
56
56
  * Current state of the BUS input/output service.
@@ -329,7 +329,7 @@ export const PlaybackSpeedResponseKindEnum = {
329
329
  PlaybackSpeedReceived: 'PLAYBACK_SPEED_RECEIVED'
330
330
  };
331
331
  /**
332
- * Identifies the input/output type.
332
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
333
333
  * @export
334
334
  * @enum {string}
335
335
  */
@@ -339,7 +339,7 @@ export const ProfinetIODirection = {
339
339
  ProfinetIoDirectionInout: 'PROFINET_IO_DIRECTION_INOUT'
340
340
  };
341
341
  /**
342
- * Value type of the PROFINET input/output.
342
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
343
343
  * @export
344
344
  * @enum {string}
345
345
  */
@@ -355,6 +355,18 @@ export const ProfinetIOTypeEnum = {
355
355
  ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
356
356
  ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
357
357
  };
358
+ /**
359
+ * The state of a program run.
360
+ * @export
361
+ * @enum {string}
362
+ */
363
+ export const ProgramRunState = {
364
+ Preparing: 'PREPARING',
365
+ Running: 'RUNNING',
366
+ Completed: 'COMPLETED',
367
+ Failed: 'FAILED',
368
+ Stopped: 'STOPPED'
369
+ };
358
370
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
359
371
  RrtConnectAlgorithm: 'RRTConnectAlgorithm'
360
372
  };
@@ -1170,7 +1182,7 @@ export class ApplicationApi extends BaseAPI {
1170
1182
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1171
1183
  return {
1172
1184
  /**
1173
- * Add a BUS Inputs/Outputs Service to the cell.
1185
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1174
1186
  * @summary Add Service
1175
1187
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1176
1188
  * @param {BusIOType} busIOType
@@ -1214,7 +1226,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1214
1226
  };
1215
1227
  },
1216
1228
  /**
1217
- * Adds an input/output to or updates an input/output on the PROFINET device.
1229
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
1218
1230
  * @summary Add PROFINET Input/Output
1219
1231
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1220
1232
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1258,7 +1270,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1258
1270
  };
1259
1271
  },
1260
1272
  /**
1261
- * Delete BUS Inputs/Outputs Service from the cell.
1273
+ * Remove the BUS inputs/outputs service from the cell.
1262
1274
  * @summary Clear Service
1263
1275
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1264
1276
  * @param {number} [completionTimeout]
@@ -1297,7 +1309,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1297
1309
  };
1298
1310
  },
1299
1311
  /**
1300
- * Removes the input/output from the PROFINET device.
1312
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1301
1313
  * @summary Remove PROFINET Input/Ouptut
1302
1314
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1303
1315
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1336,7 +1348,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1336
1348
  };
1337
1349
  },
1338
1350
  /**
1339
- * Get deployed BUS Inputs/Outputs Service.
1351
+ * Get deployed BUS inputs/outputs service.
1340
1352
  * @summary Get Service
1341
1353
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1342
1354
  * @param {*} [options] Override http request option.
@@ -1445,7 +1457,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1445
1457
  };
1446
1458
  },
1447
1459
  /**
1448
- * Get description of PROFINET
1460
+ * Get description of NOVA as a PROFINET device.
1449
1461
  * @summary Get PROFINET Description
1450
1462
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1451
1463
  * @param {*} [options] Override http request option.
@@ -1480,7 +1492,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1480
1492
  };
1481
1493
  },
1482
1494
  /**
1483
- * Get input/output configuration of the PROFINET device as file.
1495
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
1484
1496
  * @summary PROFINET Inputs/Outputs to File
1485
1497
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1486
1498
  * @param {number} [inputOffset]
@@ -1523,7 +1535,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1523
1535
  };
1524
1536
  },
1525
1537
  /**
1526
- * List all BUS Input/Output descriptions.
1538
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
1527
1539
  * @summary List Descriptions
1528
1540
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1529
1541
  * @param {*} [options] Override http request option.
@@ -1558,7 +1570,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1558
1570
  };
1559
1571
  },
1560
1572
  /**
1561
- * List all PROFINET input and outputs.
1573
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
1562
1574
  * @summary List PROFINET Input/Output Configuration
1563
1575
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1564
1576
  * @param {*} [options] Override http request option.
@@ -1633,7 +1645,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1633
1645
  };
1634
1646
  },
1635
1647
  /**
1636
- * Sets inputs/outputs on the PROFINET device from file.
1648
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
1637
1649
  * @summary Set PROFINET Inputs/Outputs from File
1638
1650
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1639
1651
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -1682,7 +1694,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1682
1694
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration);
1683
1695
  return {
1684
1696
  /**
1685
- * Add a BUS Inputs/Outputs Service to the cell.
1697
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1686
1698
  * @summary Add Service
1687
1699
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1688
1700
  * @param {BusIOType} busIOType
@@ -1697,7 +1709,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1697
1709
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1698
1710
  },
1699
1711
  /**
1700
- * Adds an input/output to or updates an input/output on the PROFINET device.
1712
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
1701
1713
  * @summary Add PROFINET Input/Output
1702
1714
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1703
1715
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1712,7 +1724,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1712
1724
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1713
1725
  },
1714
1726
  /**
1715
- * Delete BUS Inputs/Outputs Service from the cell.
1727
+ * Remove the BUS inputs/outputs service from the cell.
1716
1728
  * @summary Clear Service
1717
1729
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1718
1730
  * @param {number} [completionTimeout]
@@ -1726,7 +1738,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1726
1738
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1727
1739
  },
1728
1740
  /**
1729
- * Removes the input/output from the PROFINET device.
1741
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1730
1742
  * @summary Remove PROFINET Input/Ouptut
1731
1743
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1732
1744
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1740,7 +1752,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1740
1752
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1741
1753
  },
1742
1754
  /**
1743
- * Get deployed BUS Inputs/Outputs Service.
1755
+ * Get deployed BUS inputs/outputs service.
1744
1756
  * @summary Get Service
1745
1757
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1746
1758
  * @param {*} [options] Override http request option.
@@ -1780,7 +1792,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1780
1792
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1781
1793
  },
1782
1794
  /**
1783
- * Get description of PROFINET
1795
+ * Get description of NOVA as a PROFINET device.
1784
1796
  * @summary Get PROFINET Description
1785
1797
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1786
1798
  * @param {*} [options] Override http request option.
@@ -1793,7 +1805,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1793
1805
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1794
1806
  },
1795
1807
  /**
1796
- * Get input/output configuration of the PROFINET device as file.
1808
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
1797
1809
  * @summary PROFINET Inputs/Outputs to File
1798
1810
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1799
1811
  * @param {number} [inputOffset]
@@ -1808,7 +1820,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1808
1820
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1809
1821
  },
1810
1822
  /**
1811
- * List all BUS Input/Output descriptions.
1823
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
1812
1824
  * @summary List Descriptions
1813
1825
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1814
1826
  * @param {*} [options] Override http request option.
@@ -1821,7 +1833,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1821
1833
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1822
1834
  },
1823
1835
  /**
1824
- * List all PROFINET input and outputs.
1836
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
1825
1837
  * @summary List PROFINET Input/Output Configuration
1826
1838
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1827
1839
  * @param {*} [options] Override http request option.
@@ -1848,7 +1860,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1848
1860
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1849
1861
  },
1850
1862
  /**
1851
- * Sets inputs/outputs on the PROFINET device from file.
1863
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
1852
1864
  * @summary Set PROFINET Inputs/Outputs from File
1853
1865
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1854
1866
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -1871,7 +1883,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1871
1883
  const localVarFp = BUSInputsOutputsApiFp(configuration);
1872
1884
  return {
1873
1885
  /**
1874
- * Add a BUS Inputs/Outputs Service to the cell.
1886
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1875
1887
  * @summary Add Service
1876
1888
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1877
1889
  * @param {BusIOType} busIOType
@@ -1883,7 +1895,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1883
1895
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
1884
1896
  },
1885
1897
  /**
1886
- * Adds an input/output to or updates an input/output on the PROFINET device.
1898
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
1887
1899
  * @summary Add PROFINET Input/Output
1888
1900
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1889
1901
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1895,7 +1907,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1895
1907
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
1896
1908
  },
1897
1909
  /**
1898
- * Delete BUS Inputs/Outputs Service from the cell.
1910
+ * Remove the BUS inputs/outputs service from the cell.
1899
1911
  * @summary Clear Service
1900
1912
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1901
1913
  * @param {number} [completionTimeout]
@@ -1906,7 +1918,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1906
1918
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
1907
1919
  },
1908
1920
  /**
1909
- * Removes the input/output from the PROFINET device.
1921
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1910
1922
  * @summary Remove PROFINET Input/Ouptut
1911
1923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1912
1924
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1917,7 +1929,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1917
1929
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
1918
1930
  },
1919
1931
  /**
1920
- * Get deployed BUS Inputs/Outputs Service.
1932
+ * Get deployed BUS inputs/outputs service.
1921
1933
  * @summary Get Service
1922
1934
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1923
1935
  * @param {*} [options] Override http request option.
@@ -1948,7 +1960,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1948
1960
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
1949
1961
  },
1950
1962
  /**
1951
- * Get description of PROFINET
1963
+ * Get description of NOVA as a PROFINET device.
1952
1964
  * @summary Get PROFINET Description
1953
1965
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1954
1966
  * @param {*} [options] Override http request option.
@@ -1958,7 +1970,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1958
1970
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
1959
1971
  },
1960
1972
  /**
1961
- * Get input/output configuration of the PROFINET device as file.
1973
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
1962
1974
  * @summary PROFINET Inputs/Outputs to File
1963
1975
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1964
1976
  * @param {number} [inputOffset]
@@ -1970,7 +1982,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1970
1982
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
1971
1983
  },
1972
1984
  /**
1973
- * List all BUS Input/Output descriptions.
1985
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
1974
1986
  * @summary List Descriptions
1975
1987
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1976
1988
  * @param {*} [options] Override http request option.
@@ -1980,7 +1992,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1980
1992
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
1981
1993
  },
1982
1994
  /**
1983
- * List all PROFINET input and outputs.
1995
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
1984
1996
  * @summary List PROFINET Input/Output Configuration
1985
1997
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1986
1998
  * @param {*} [options] Override http request option.
@@ -2001,7 +2013,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
2001
2013
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
2002
2014
  },
2003
2015
  /**
2004
- * Sets inputs/outputs on the PROFINET device from file.
2016
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
2005
2017
  * @summary Set PROFINET Inputs/Outputs from File
2006
2018
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2007
2019
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -2021,7 +2033,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
2021
2033
  */
2022
2034
  export class BUSInputsOutputsApi extends BaseAPI {
2023
2035
  /**
2024
- * Add a BUS Inputs/Outputs Service to the cell.
2036
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
2025
2037
  * @summary Add Service
2026
2038
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2027
2039
  * @param {BusIOType} busIOType
@@ -2034,7 +2046,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2034
2046
  return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2035
2047
  }
2036
2048
  /**
2037
- * Adds an input/output to or updates an input/output on the PROFINET device.
2049
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal).
2038
2050
  * @summary Add PROFINET Input/Output
2039
2051
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2040
2052
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -2047,7 +2059,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2047
2059
  return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
2048
2060
  }
2049
2061
  /**
2050
- * Delete BUS Inputs/Outputs Service from the cell.
2062
+ * Remove the BUS inputs/outputs service from the cell.
2051
2063
  * @summary Clear Service
2052
2064
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2053
2065
  * @param {number} [completionTimeout]
@@ -2059,7 +2071,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2059
2071
  return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2060
2072
  }
2061
2073
  /**
2062
- * Removes the input/output from the PROFINET device.
2074
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
2063
2075
  * @summary Remove PROFINET Input/Ouptut
2064
2076
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2065
2077
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -2071,7 +2083,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2071
2083
  return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
2072
2084
  }
2073
2085
  /**
2074
- * Get deployed BUS Inputs/Outputs Service.
2086
+ * Get deployed BUS inputs/outputs service.
2075
2087
  * @summary Get Service
2076
2088
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2077
2089
  * @param {*} [options] Override http request option.
@@ -2105,7 +2117,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2105
2117
  return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
2106
2118
  }
2107
2119
  /**
2108
- * Get description of PROFINET
2120
+ * Get description of NOVA as a PROFINET device.
2109
2121
  * @summary Get PROFINET Description
2110
2122
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2111
2123
  * @param {*} [options] Override http request option.
@@ -2116,7 +2128,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2116
2128
  return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
2117
2129
  }
2118
2130
  /**
2119
- * Get input/output configuration of the PROFINET device as file.
2131
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
2120
2132
  * @summary PROFINET Inputs/Outputs to File
2121
2133
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2122
2134
  * @param {number} [inputOffset]
@@ -2129,7 +2141,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2129
2141
  return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
2130
2142
  }
2131
2143
  /**
2132
- * List all BUS Input/Output descriptions.
2144
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
2133
2145
  * @summary List Descriptions
2134
2146
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2135
2147
  * @param {*} [options] Override http request option.
@@ -2140,7 +2152,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2140
2152
  return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
2141
2153
  }
2142
2154
  /**
2143
- * List all PROFINET input and outputs.
2155
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
2144
2156
  * @summary List PROFINET Input/Output Configuration
2145
2157
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2146
2158
  * @param {*} [options] Override http request option.
@@ -2163,7 +2175,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2163
2175
  return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
2164
2176
  }
2165
2177
  /**
2166
- * Sets inputs/outputs on the PROFINET device from file.
2178
+ * Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
2167
2179
  * @summary Set PROFINET Inputs/Outputs from File
2168
2180
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2169
2181
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5271,7 +5283,7 @@ export class MotionGroupApi extends BaseAPI {
5271
5283
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration) {
5272
5284
  return {
5273
5285
  /**
5274
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5286
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5275
5287
  * @summary Get Collision Model
5276
5288
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5277
5289
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -5354,7 +5366,7 @@ export const MotionGroupModelsApiFp = function (configuration) {
5354
5366
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration);
5355
5367
  return {
5356
5368
  /**
5357
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5369
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5358
5370
  * @summary Get Collision Model
5359
5371
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5360
5372
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -5390,7 +5402,7 @@ export const MotionGroupModelsApiFactory = function (configuration, basePath, ax
5390
5402
  const localVarFp = MotionGroupModelsApiFp(configuration);
5391
5403
  return {
5392
5404
  /**
5393
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5405
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5394
5406
  * @summary Get Collision Model
5395
5407
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5396
5408
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -5420,7 +5432,7 @@ export const MotionGroupModelsApiFactory = function (configuration, basePath, ax
5420
5432
  */
5421
5433
  export class MotionGroupModelsApi extends BaseAPI {
5422
5434
  /**
5423
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5435
+ * Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5424
5436
  * @summary Get Collision Model
5425
5437
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5426
5438
  * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
@@ -5443,6 +5455,345 @@ export class MotionGroupModelsApi extends BaseAPI {
5443
5455
  return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(cell, options).then((request) => request(this.axios, this.basePath));
5444
5456
  }
5445
5457
  }
5458
+ /**
5459
+ * ProgramApi - axios parameter creator
5460
+ * @export
5461
+ */
5462
+ export const ProgramApiAxiosParamCreator = function (configuration) {
5463
+ return {
5464
+ /**
5465
+ * Get details of a program.
5466
+ * @summary Get program
5467
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5468
+ * @param {string} program
5469
+ * @param {*} [options] Override http request option.
5470
+ * @throws {RequiredError}
5471
+ */
5472
+ getProgram: async (cell, program, options = {}) => {
5473
+ // verify required parameter 'cell' is not null or undefined
5474
+ assertParamExists('getProgram', 'cell', cell);
5475
+ // verify required parameter 'program' is not null or undefined
5476
+ assertParamExists('getProgram', 'program', program);
5477
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
5478
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5479
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
5480
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5481
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5482
+ let baseOptions;
5483
+ if (configuration) {
5484
+ baseOptions = configuration.baseOptions;
5485
+ }
5486
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
5487
+ const localVarHeaderParameter = {};
5488
+ const localVarQueryParameter = {};
5489
+ // authentication BasicAuth required
5490
+ // http basic authentication required
5491
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5492
+ // authentication BearerAuth required
5493
+ // http bearer authentication required
5494
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5495
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5496
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5497
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5498
+ return {
5499
+ url: toPathString(localVarUrlObj),
5500
+ options: localVarRequestOptions,
5501
+ };
5502
+ },
5503
+ /**
5504
+ * List details of all existing programs.
5505
+ * @summary List programs
5506
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5507
+ * @param {*} [options] Override http request option.
5508
+ * @throws {RequiredError}
5509
+ */
5510
+ listPrograms: async (cell, options = {}) => {
5511
+ // verify required parameter 'cell' is not null or undefined
5512
+ assertParamExists('listPrograms', 'cell', cell);
5513
+ const localVarPath = `/experimental/cells/{cell}/programs`
5514
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5515
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5516
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5517
+ let baseOptions;
5518
+ if (configuration) {
5519
+ baseOptions = configuration.baseOptions;
5520
+ }
5521
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
5522
+ const localVarHeaderParameter = {};
5523
+ const localVarQueryParameter = {};
5524
+ // authentication BasicAuth required
5525
+ // http basic authentication required
5526
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5527
+ // authentication BearerAuth required
5528
+ // http bearer authentication required
5529
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5530
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5531
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5532
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5533
+ return {
5534
+ url: toPathString(localVarUrlObj),
5535
+ options: localVarRequestOptions,
5536
+ };
5537
+ },
5538
+ /**
5539
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5540
+ * @summary Start the program
5541
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5542
+ * @param {string} program
5543
+ * @param {ProgramStartRequest} programStartRequest
5544
+ * @param {*} [options] Override http request option.
5545
+ * @throws {RequiredError}
5546
+ */
5547
+ startProgram: async (cell, program, programStartRequest, options = {}) => {
5548
+ // verify required parameter 'cell' is not null or undefined
5549
+ assertParamExists('startProgram', 'cell', cell);
5550
+ // verify required parameter 'program' is not null or undefined
5551
+ assertParamExists('startProgram', 'program', program);
5552
+ // verify required parameter 'programStartRequest' is not null or undefined
5553
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest);
5554
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
5555
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5556
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
5557
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5558
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5559
+ let baseOptions;
5560
+ if (configuration) {
5561
+ baseOptions = configuration.baseOptions;
5562
+ }
5563
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
5564
+ const localVarHeaderParameter = {};
5565
+ const localVarQueryParameter = {};
5566
+ // authentication BasicAuth required
5567
+ // http basic authentication required
5568
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5569
+ // authentication BearerAuth required
5570
+ // http bearer authentication required
5571
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5572
+ localVarHeaderParameter['Content-Type'] = 'application/json';
5573
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5574
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5575
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5576
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration);
5577
+ return {
5578
+ url: toPathString(localVarUrlObj),
5579
+ options: localVarRequestOptions,
5580
+ };
5581
+ },
5582
+ /**
5583
+ * Stop a specific program run.
5584
+ * @summary Stop program run
5585
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5586
+ * @param {string} program
5587
+ * @param {*} [options] Override http request option.
5588
+ * @throws {RequiredError}
5589
+ */
5590
+ stopProgram: async (cell, program, options = {}) => {
5591
+ // verify required parameter 'cell' is not null or undefined
5592
+ assertParamExists('stopProgram', 'cell', cell);
5593
+ // verify required parameter 'program' is not null or undefined
5594
+ assertParamExists('stopProgram', 'program', program);
5595
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
5596
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5597
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
5598
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5599
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5600
+ let baseOptions;
5601
+ if (configuration) {
5602
+ baseOptions = configuration.baseOptions;
5603
+ }
5604
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
5605
+ const localVarHeaderParameter = {};
5606
+ const localVarQueryParameter = {};
5607
+ // authentication BasicAuth required
5608
+ // http basic authentication required
5609
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5610
+ // authentication BearerAuth required
5611
+ // http bearer authentication required
5612
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5613
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5614
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5615
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5616
+ return {
5617
+ url: toPathString(localVarUrlObj),
5618
+ options: localVarRequestOptions,
5619
+ };
5620
+ },
5621
+ };
5622
+ };
5623
+ /**
5624
+ * ProgramApi - functional programming interface
5625
+ * @export
5626
+ */
5627
+ export const ProgramApiFp = function (configuration) {
5628
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration);
5629
+ return {
5630
+ /**
5631
+ * Get details of a program.
5632
+ * @summary Get program
5633
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5634
+ * @param {string} program
5635
+ * @param {*} [options] Override http request option.
5636
+ * @throws {RequiredError}
5637
+ */
5638
+ async getProgram(cell, program, options) {
5639
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
5640
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5641
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
5642
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5643
+ },
5644
+ /**
5645
+ * List details of all existing programs.
5646
+ * @summary List programs
5647
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5648
+ * @param {*} [options] Override http request option.
5649
+ * @throws {RequiredError}
5650
+ */
5651
+ async listPrograms(cell, options) {
5652
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
5653
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5654
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
5655
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5656
+ },
5657
+ /**
5658
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5659
+ * @summary Start the program
5660
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5661
+ * @param {string} program
5662
+ * @param {ProgramStartRequest} programStartRequest
5663
+ * @param {*} [options] Override http request option.
5664
+ * @throws {RequiredError}
5665
+ */
5666
+ async startProgram(cell, program, programStartRequest, options) {
5667
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
5668
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5669
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
5670
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5671
+ },
5672
+ /**
5673
+ * Stop a specific program run.
5674
+ * @summary Stop program run
5675
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5676
+ * @param {string} program
5677
+ * @param {*} [options] Override http request option.
5678
+ * @throws {RequiredError}
5679
+ */
5680
+ async stopProgram(cell, program, options) {
5681
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
5682
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5683
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
5684
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5685
+ },
5686
+ };
5687
+ };
5688
+ /**
5689
+ * ProgramApi - factory interface
5690
+ * @export
5691
+ */
5692
+ export const ProgramApiFactory = function (configuration, basePath, axios) {
5693
+ const localVarFp = ProgramApiFp(configuration);
5694
+ return {
5695
+ /**
5696
+ * Get details of a program.
5697
+ * @summary Get program
5698
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5699
+ * @param {string} program
5700
+ * @param {*} [options] Override http request option.
5701
+ * @throws {RequiredError}
5702
+ */
5703
+ getProgram(cell, program, options) {
5704
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
5705
+ },
5706
+ /**
5707
+ * List details of all existing programs.
5708
+ * @summary List programs
5709
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5710
+ * @param {*} [options] Override http request option.
5711
+ * @throws {RequiredError}
5712
+ */
5713
+ listPrograms(cell, options) {
5714
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
5715
+ },
5716
+ /**
5717
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5718
+ * @summary Start the program
5719
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5720
+ * @param {string} program
5721
+ * @param {ProgramStartRequest} programStartRequest
5722
+ * @param {*} [options] Override http request option.
5723
+ * @throws {RequiredError}
5724
+ */
5725
+ startProgram(cell, program, programStartRequest, options) {
5726
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
5727
+ },
5728
+ /**
5729
+ * Stop a specific program run.
5730
+ * @summary Stop program run
5731
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5732
+ * @param {string} program
5733
+ * @param {*} [options] Override http request option.
5734
+ * @throws {RequiredError}
5735
+ */
5736
+ stopProgram(cell, program, options) {
5737
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
5738
+ },
5739
+ };
5740
+ };
5741
+ /**
5742
+ * ProgramApi - object-oriented interface
5743
+ * @export
5744
+ * @class ProgramApi
5745
+ * @extends {BaseAPI}
5746
+ */
5747
+ export class ProgramApi extends BaseAPI {
5748
+ /**
5749
+ * Get details of a program.
5750
+ * @summary Get program
5751
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5752
+ * @param {string} program
5753
+ * @param {*} [options] Override http request option.
5754
+ * @throws {RequiredError}
5755
+ * @memberof ProgramApi
5756
+ */
5757
+ getProgram(cell, program, options) {
5758
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
5759
+ }
5760
+ /**
5761
+ * List details of all existing programs.
5762
+ * @summary List programs
5763
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5764
+ * @param {*} [options] Override http request option.
5765
+ * @throws {RequiredError}
5766
+ * @memberof ProgramApi
5767
+ */
5768
+ listPrograms(cell, options) {
5769
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
5770
+ }
5771
+ /**
5772
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5773
+ * @summary Start the program
5774
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5775
+ * @param {string} program
5776
+ * @param {ProgramStartRequest} programStartRequest
5777
+ * @param {*} [options] Override http request option.
5778
+ * @throws {RequiredError}
5779
+ * @memberof ProgramApi
5780
+ */
5781
+ startProgram(cell, program, programStartRequest, options) {
5782
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
5783
+ }
5784
+ /**
5785
+ * Stop a specific program run.
5786
+ * @summary Stop program run
5787
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5788
+ * @param {string} program
5789
+ * @param {*} [options] Override http request option.
5790
+ * @throws {RequiredError}
5791
+ * @memberof ProgramApi
5792
+ */
5793
+ stopProgram(cell, program, options) {
5794
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
5795
+ }
5796
+ }
5446
5797
  /**
5447
5798
  * StoreCollisionComponentsApi - axios parameter creator
5448
5799
  * @export
@@ -5719,7 +6070,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
5719
6070
  };
5720
6071
  },
5721
6072
  /**
5722
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6073
+ * Returns all stored colliders.
5723
6074
  * @summary List Colliders
5724
6075
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5725
6076
  * @param {*} [options] Override http request option.
@@ -6027,7 +6378,7 @@ export const StoreCollisionComponentsApiFp = function (configuration) {
6027
6378
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6028
6379
  },
6029
6380
  /**
6030
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6381
+ * Returns all stored colliders.
6031
6382
  * @summary List Colliders
6032
6383
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6033
6384
  * @param {*} [options] Override http request option.
@@ -6183,7 +6534,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration, baseP
6183
6534
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
6184
6535
  },
6185
6536
  /**
6186
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6537
+ * Returns all stored colliders.
6187
6538
  * @summary List Colliders
6188
6539
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6189
6540
  * @param {*} [options] Override http request option.
@@ -6331,7 +6682,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
6331
6682
  return StoreCollisionComponentsApiFp(this.configuration).listCollisionLinkChains(cell, options).then((request) => request(this.axios, this.basePath));
6332
6683
  }
6333
6684
  /**
6334
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6685
+ * Returns all stored colliders.
6335
6686
  * @summary List Colliders
6336
6687
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6337
6688
  * @param {*} [options] Override http request option.