@kelvininc/js-client-sdk 7.8.1 → 7.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (939) hide show
  1. package/CHANGELOG.md +58 -0
  2. package/dist/cjs/core/http.d.ts +11 -1
  3. package/dist/cjs/core/http.js +16 -1
  4. package/dist/cjs/core/http.js.map +1 -1
  5. package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.d.ts +19 -0
  6. package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js +20 -0
  7. package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js.map +1 -0
  8. package/dist/cjs/models/generated/aCPWorkloadManifests.d.ts +3 -0
  9. package/dist/cjs/models/generated/aCPWorkloadManifests.js +2 -0
  10. package/dist/cjs/models/generated/aCPWorkloadManifests.js.map +1 -1
  11. package/dist/cjs/models/generated/alarm.d.ts +2 -0
  12. package/dist/cjs/models/generated/alarm.js +1 -0
  13. package/dist/cjs/models/generated/alarm.js.map +1 -1
  14. package/dist/cjs/models/generated/alarmClustering.d.ts +21 -0
  15. package/dist/cjs/models/generated/alarmClustering.js +21 -0
  16. package/dist/cjs/models/generated/alarmClustering.js.map +1 -0
  17. package/dist/cjs/models/generated/alarmItem.d.ts +2 -0
  18. package/dist/cjs/models/generated/alarmItem.js +1 -0
  19. package/dist/cjs/models/generated/alarmItem.js.map +1 -1
  20. package/dist/cjs/models/generated/alarmTag.d.ts +23 -0
  21. package/dist/cjs/models/generated/alarmTag.js +22 -0
  22. package/dist/cjs/models/generated/alarmTag.js.map +1 -0
  23. package/dist/cjs/models/generated/alarmTagItem.d.ts +23 -0
  24. package/dist/cjs/models/generated/alarmTagItem.js +22 -0
  25. package/dist/cjs/models/generated/alarmTagItem.js.map +1 -0
  26. package/dist/cjs/models/generated/alarmTagListPaginated.d.ts +21 -0
  27. package/dist/cjs/models/generated/alarmTagListPaginated.js +22 -0
  28. package/dist/cjs/models/generated/alarmTagListPaginated.js.map +1 -0
  29. package/dist/cjs/models/generated/asset.d.ts +51 -0
  30. package/dist/cjs/models/generated/asset.js.map +1 -1
  31. package/dist/cjs/models/generated/assetClass.d.ts +21 -0
  32. package/dist/cjs/models/generated/assetClass.js.map +1 -1
  33. package/dist/cjs/models/generated/assetClassItem.d.ts +21 -0
  34. package/dist/cjs/models/generated/assetClassItem.js.map +1 -1
  35. package/dist/cjs/models/generated/assetClassListPaginated.d.ts +3 -0
  36. package/dist/cjs/models/generated/assetClassListPaginated.js.map +1 -1
  37. package/dist/cjs/models/generated/assetDataStreamItem.d.ts +6 -0
  38. package/dist/cjs/models/generated/assetDataStreamItem.js.map +1 -1
  39. package/dist/cjs/models/generated/assetDataStreamsListPaginated.d.ts +3 -0
  40. package/dist/cjs/models/generated/assetDataStreamsListPaginated.js.map +1 -1
  41. package/dist/cjs/models/generated/assetHierarchies.d.ts +3 -0
  42. package/dist/cjs/models/generated/assetHierarchies.js.map +1 -1
  43. package/dist/cjs/models/generated/assetHierarchyItem.d.ts +24 -0
  44. package/dist/cjs/models/generated/assetHierarchyItem.js.map +1 -1
  45. package/dist/cjs/models/generated/assetHierarchyList.d.ts +3 -0
  46. package/dist/cjs/models/generated/assetHierarchyList.js.map +1 -1
  47. package/dist/cjs/models/generated/assetItem.d.ts +33 -0
  48. package/dist/cjs/models/generated/assetItem.js.map +1 -1
  49. package/dist/cjs/models/generated/assetListPaginated.d.ts +3 -0
  50. package/dist/cjs/models/generated/assetListPaginated.js.map +1 -1
  51. package/dist/cjs/models/generated/assetLocationItem.d.ts +6 -0
  52. package/dist/cjs/models/generated/assetLocationItem.js.map +1 -1
  53. package/dist/cjs/models/generated/assetMetricItem.d.ts +6 -0
  54. package/dist/cjs/models/generated/assetMetricItem.js.map +1 -1
  55. package/dist/cjs/models/generated/assetOEE.d.ts +3 -0
  56. package/dist/cjs/models/generated/assetOEE.js.map +1 -1
  57. package/dist/cjs/models/generated/assetProperty.d.ts +9 -0
  58. package/dist/cjs/models/generated/assetProperty.js.map +1 -1
  59. package/dist/cjs/models/generated/assetStatisticsItem.d.ts +24 -0
  60. package/dist/cjs/models/generated/assetStatisticsItem.js.map +1 -1
  61. package/dist/cjs/models/generated/assetStatisticsPaginated.d.ts +3 -0
  62. package/dist/cjs/models/generated/assetStatisticsPaginated.js.map +1 -1
  63. package/dist/cjs/models/generated/assetStatus.d.ts +3 -0
  64. package/dist/cjs/models/generated/assetStatus.js.map +1 -1
  65. package/dist/cjs/models/generated/assetStatusCount.d.ts +15 -0
  66. package/dist/cjs/models/generated/assetStatusCount.js.map +1 -1
  67. package/dist/cjs/models/generated/assetStatusItem.d.ts +6 -0
  68. package/dist/cjs/models/generated/assetStatusItem.js.map +1 -1
  69. package/dist/cjs/models/generated/assetTemplate.d.ts +48 -0
  70. package/dist/cjs/models/generated/assetTemplate.js.map +1 -1
  71. package/dist/cjs/models/generated/assetTemplateHierarchy.d.ts +24 -0
  72. package/dist/cjs/models/generated/assetTemplateHierarchy.js.map +1 -1
  73. package/dist/cjs/models/generated/assetTemplateItem.d.ts +42 -0
  74. package/dist/cjs/models/generated/assetTemplateItem.js.map +1 -1
  75. package/dist/cjs/models/generated/assetTemplateListPaginated.d.ts +3 -0
  76. package/dist/cjs/models/generated/assetTemplateListPaginated.js.map +1 -1
  77. package/dist/cjs/models/generated/assetTemplateProperties.d.ts +9 -0
  78. package/dist/cjs/models/generated/assetTemplateProperties.js.map +1 -1
  79. package/dist/cjs/models/generated/assetType.d.ts +30 -0
  80. package/dist/cjs/models/generated/assetType.js.map +1 -1
  81. package/dist/cjs/models/generated/assetTypeItem.d.ts +30 -0
  82. package/dist/cjs/models/generated/assetTypeItem.js.map +1 -1
  83. package/dist/cjs/models/generated/assetTypeListPaginated.d.ts +3 -0
  84. package/dist/cjs/models/generated/assetTypeListPaginated.js.map +1 -1
  85. package/dist/cjs/models/generated/assetTypeMetadata.d.ts +15 -0
  86. package/dist/cjs/models/generated/assetTypeMetadata.js.map +1 -1
  87. package/dist/cjs/models/generated/assetTypeMetadataItem.d.ts +15 -0
  88. package/dist/cjs/models/generated/assetTypeMetadataItem.js.map +1 -1
  89. package/dist/cjs/models/generated/assetTypeMetadataListPaginated.d.ts +3 -0
  90. package/dist/cjs/models/generated/assetTypeMetadataListPaginated.js.map +1 -1
  91. package/dist/cjs/models/generated/bridge.d.ts +24 -0
  92. package/dist/cjs/models/generated/bridge.js.map +1 -1
  93. package/dist/cjs/models/generated/bridgeDataStreamItem.d.ts +9 -0
  94. package/dist/cjs/models/generated/bridgeDataStreamItem.js.map +1 -1
  95. package/dist/cjs/models/generated/bridgeDataStreamListPaginated.d.ts +3 -0
  96. package/dist/cjs/models/generated/bridgeDataStreamListPaginated.js.map +1 -1
  97. package/dist/cjs/models/generated/bridgeItem.d.ts +21 -0
  98. package/dist/cjs/models/generated/bridgeItem.js.map +1 -1
  99. package/dist/cjs/models/generated/bridgeListPaginated.d.ts +3 -0
  100. package/dist/cjs/models/generated/bridgeListPaginated.js.map +1 -1
  101. package/dist/cjs/models/generated/cSVError.d.ts +18 -0
  102. package/dist/cjs/models/generated/cSVError.js.map +1 -1
  103. package/dist/cjs/models/generated/cSVErrorMessage.d.ts +3 -0
  104. package/dist/cjs/models/generated/cSVErrorMessage.js.map +1 -1
  105. package/dist/cjs/models/generated/cSVPosition.d.ts +12 -0
  106. package/dist/cjs/models/generated/cSVPosition.js.map +1 -1
  107. package/dist/cjs/models/generated/carbonEmissionsInstanceSettingItem.d.ts +25 -0
  108. package/dist/cjs/models/generated/carbonEmissionsInstanceSettingItem.js +23 -0
  109. package/dist/cjs/models/generated/carbonEmissionsInstanceSettingItem.js.map +1 -0
  110. package/dist/cjs/models/generated/controlChange.d.ts +27 -0
  111. package/dist/cjs/models/generated/controlChange.js.map +1 -1
  112. package/dist/cjs/models/generated/controlChangeClustering.d.ts +21 -0
  113. package/dist/cjs/models/generated/controlChangeClustering.js +21 -0
  114. package/dist/cjs/models/generated/controlChangeClustering.js.map +1 -0
  115. package/dist/cjs/models/generated/controlChangeGet.d.ts +39 -0
  116. package/dist/cjs/models/generated/controlChangeGet.js.map +1 -1
  117. package/dist/cjs/models/generated/controlChangeGetPaginated.d.ts +3 -0
  118. package/dist/cjs/models/generated/controlChangeGetPaginated.js.map +1 -1
  119. package/dist/cjs/models/generated/controlChangeGetStatus.d.ts +12 -0
  120. package/dist/cjs/models/generated/controlChangeGetStatus.js.map +1 -1
  121. package/dist/cjs/models/generated/controlChangePaginated.d.ts +3 -0
  122. package/dist/cjs/models/generated/controlChangePaginated.js.map +1 -1
  123. package/dist/cjs/models/generated/emissionsAsset.d.ts +19 -0
  124. package/dist/cjs/models/generated/emissionsAsset.js +20 -0
  125. package/dist/cjs/models/generated/emissionsAsset.js.map +1 -0
  126. package/dist/cjs/models/generated/emissionsAssetLists.d.ts +22 -0
  127. package/dist/cjs/models/generated/emissionsAssetLists.js +22 -0
  128. package/dist/cjs/models/generated/emissionsAssetLists.js.map +1 -0
  129. package/dist/cjs/models/generated/emissionsDashboard.d.ts +29 -0
  130. package/dist/cjs/models/generated/emissionsDashboard.js +27 -0
  131. package/dist/cjs/models/generated/emissionsDashboard.js.map +1 -0
  132. package/dist/cjs/models/generated/emissionsDashboardAnalytics.d.ts +26 -0
  133. package/dist/cjs/models/generated/emissionsDashboardAnalytics.js +24 -0
  134. package/dist/cjs/models/generated/emissionsDashboardAnalytics.js.map +1 -0
  135. package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.d.ts +25 -0
  136. package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.js +23 -0
  137. package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.js.map +1 -0
  138. package/dist/cjs/models/generated/emissionsDashboardTotals.d.ts +27 -0
  139. package/dist/cjs/models/generated/emissionsDashboardTotals.js +24 -0
  140. package/dist/cjs/models/generated/emissionsDashboardTotals.js.map +1 -0
  141. package/dist/cjs/models/generated/emissionsGreenhouse.d.ts +21 -0
  142. package/dist/cjs/models/generated/emissionsGreenhouse.js +21 -0
  143. package/dist/cjs/models/generated/emissionsGreenhouse.js.map +1 -0
  144. package/dist/cjs/models/generated/errorMessage.d.ts +9 -0
  145. package/dist/cjs/models/generated/errorMessage.js.map +1 -1
  146. package/dist/cjs/models/generated/errorMessages.d.ts +3 -0
  147. package/dist/cjs/models/generated/errorMessages.js.map +1 -1
  148. package/dist/cjs/models/generated/errorsError.d.ts +18 -0
  149. package/dist/cjs/models/generated/errorsError.js.map +1 -1
  150. package/dist/cjs/models/generated/errorsErrorMessage.d.ts +3 -0
  151. package/dist/cjs/models/generated/errorsErrorMessage.js.map +1 -1
  152. package/dist/cjs/models/generated/failureDetection.d.ts +12 -0
  153. package/dist/cjs/models/generated/failureDetection.js.map +1 -1
  154. package/dist/cjs/models/generated/failureDetectionProperty.d.ts +9 -0
  155. package/dist/cjs/models/generated/failureDetectionProperty.js.map +1 -1
  156. package/dist/cjs/models/generated/failureOverviewItem.d.ts +58 -0
  157. package/dist/cjs/models/generated/{siteHierarchyOverviewItem.js → failureOverviewItem.js} +7 -8
  158. package/dist/cjs/models/generated/failureOverviewItem.js.map +1 -0
  159. package/dist/cjs/models/generated/failureOverviewPaginated.d.ts +24 -0
  160. package/dist/cjs/models/generated/failureOverviewPaginated.js +22 -0
  161. package/dist/cjs/models/generated/failureOverviewPaginated.js.map +1 -0
  162. package/dist/cjs/models/generated/failureOverviewStatistics.d.ts +24 -0
  163. package/dist/cjs/models/generated/{siteHierarchyOverviewStatistics.js → failureOverviewStatistics.js} +4 -4
  164. package/dist/cjs/models/generated/failureOverviewStatistics.js.map +1 -0
  165. package/dist/cjs/models/generated/fullMap.d.ts +49 -0
  166. package/dist/cjs/models/generated/fullMap.js +38 -0
  167. package/dist/cjs/models/generated/fullMap.js.map +1 -0
  168. package/dist/cjs/models/generated/fullMapListPaginated.d.ts +21 -0
  169. package/dist/cjs/models/generated/fullMapListPaginated.js +22 -0
  170. package/dist/cjs/models/generated/fullMapListPaginated.js.map +1 -0
  171. package/dist/cjs/models/generated/index.d.ts +36 -4
  172. package/dist/cjs/models/generated/index.js +36 -4
  173. package/dist/cjs/models/generated/index.js.map +1 -1
  174. package/dist/cjs/models/generated/mQTTTopicItem.d.ts +18 -0
  175. package/dist/cjs/models/generated/mQTTTopicItem.js.map +1 -1
  176. package/dist/cjs/models/generated/mQTTTopicList.d.ts +3 -0
  177. package/dist/cjs/models/generated/mQTTTopicList.js.map +1 -1
  178. package/dist/cjs/models/generated/mapFailureDetection.d.ts +17 -0
  179. package/dist/cjs/models/generated/mapFailureDetection.js +19 -0
  180. package/dist/cjs/models/generated/mapFailureDetection.js.map +1 -0
  181. package/dist/cjs/models/generated/mapItem.d.ts +13 -6
  182. package/dist/cjs/models/generated/mapItem.js +8 -4
  183. package/dist/cjs/models/generated/mapItem.js.map +1 -1
  184. package/dist/cjs/models/generated/mapModel.d.ts +11 -4
  185. package/dist/cjs/models/generated/mapModel.js +6 -2
  186. package/dist/cjs/models/generated/mapModel.js.map +1 -1
  187. package/dist/cjs/models/generated/mapOEE.d.ts +26 -0
  188. package/dist/cjs/models/generated/mapOEE.js +25 -0
  189. package/dist/cjs/models/generated/mapOEE.js.map +1 -0
  190. package/dist/cjs/models/generated/{assetShift.d.ts → mapShift.d.ts} +5 -5
  191. package/dist/cjs/models/generated/{assetShift.js → mapShift.js} +5 -5
  192. package/dist/cjs/models/generated/mapShift.js.map +1 -0
  193. package/dist/cjs/models/generated/mapVersionItem.d.ts +4 -2
  194. package/dist/cjs/models/generated/mapVersionItem.js +2 -1
  195. package/dist/cjs/models/generated/mapVersionItem.js.map +1 -1
  196. package/dist/cjs/models/generated/metric.d.ts +30 -0
  197. package/dist/cjs/models/generated/metric.js.map +1 -1
  198. package/dist/cjs/models/generated/metricItem.d.ts +30 -0
  199. package/dist/cjs/models/generated/metricItem.js.map +1 -1
  200. package/dist/cjs/models/generated/metricListPaginated.d.ts +3 -0
  201. package/dist/cjs/models/generated/metricListPaginated.js.map +1 -1
  202. package/dist/cjs/models/generated/oEECalculation.d.ts +15 -0
  203. package/dist/cjs/models/generated/oEECalculation.js.map +1 -1
  204. package/dist/cjs/models/generated/oEEThresholds.d.ts +9 -0
  205. package/dist/cjs/models/generated/oEEThresholds.js.map +1 -1
  206. package/dist/cjs/models/generated/oEEValues.d.ts +12 -0
  207. package/dist/cjs/models/generated/oEEValues.js.map +1 -1
  208. package/dist/cjs/models/generated/page.d.ts +21 -0
  209. package/dist/cjs/models/generated/page.js +21 -0
  210. package/dist/cjs/models/generated/page.js.map +1 -0
  211. package/dist/cjs/models/generated/pagination.d.ts +9 -0
  212. package/dist/cjs/models/generated/pagination.js.map +1 -1
  213. package/dist/cjs/models/generated/parameterAppVersionAsset.d.ts +29 -0
  214. package/dist/cjs/models/generated/parameterAppVersionAsset.js +25 -0
  215. package/dist/cjs/models/generated/parameterAppVersionAsset.js.map +1 -0
  216. package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.d.ts +21 -0
  217. package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.js +22 -0
  218. package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.js.map +1 -0
  219. package/dist/cjs/models/generated/parameterGetSchema.d.ts +28 -0
  220. package/dist/cjs/models/generated/parameterGetSchema.js +23 -0
  221. package/dist/cjs/models/generated/parameterGetSchema.js.map +1 -0
  222. package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.d.ts +28 -0
  223. package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.js +23 -0
  224. package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.js.map +1 -0
  225. package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.d.ts +35 -0
  226. package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.js +28 -0
  227. package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.js.map +1 -0
  228. package/dist/cjs/models/generated/responsibleFor.d.ts +19 -0
  229. package/dist/cjs/models/generated/responsibleFor.js +20 -0
  230. package/dist/cjs/models/generated/responsibleFor.js.map +1 -0
  231. package/dist/cjs/models/generated/rule.d.ts +37 -0
  232. package/dist/cjs/models/generated/rule.js +30 -0
  233. package/dist/cjs/models/generated/rule.js.map +1 -0
  234. package/dist/cjs/models/generated/ruleAction.d.ts +19 -0
  235. package/dist/cjs/models/generated/ruleAction.js +20 -0
  236. package/dist/cjs/models/generated/ruleAction.js.map +1 -0
  237. package/dist/cjs/models/generated/ruleInput.d.ts +19 -0
  238. package/dist/cjs/models/generated/ruleInput.js +20 -0
  239. package/dist/cjs/models/generated/ruleInput.js.map +1 -0
  240. package/dist/cjs/models/generated/ruleLogs.d.ts +17 -0
  241. package/dist/cjs/models/generated/ruleLogs.js +19 -0
  242. package/dist/cjs/models/generated/ruleLogs.js.map +1 -0
  243. package/dist/cjs/models/generated/rulePayload.d.ts +25 -0
  244. package/dist/cjs/models/generated/rulePayload.js +24 -0
  245. package/dist/cjs/models/generated/rulePayload.js.map +1 -0
  246. package/dist/cjs/models/generated/ruleStatus.d.ts +21 -0
  247. package/dist/cjs/models/generated/ruleStatus.js +21 -0
  248. package/dist/cjs/models/generated/ruleStatus.js.map +1 -0
  249. package/dist/cjs/models/generated/rulesListPaginated.d.ts +21 -0
  250. package/dist/cjs/models/generated/rulesListPaginated.js +22 -0
  251. package/dist/cjs/models/generated/rulesListPaginated.js.map +1 -0
  252. package/dist/cjs/models/generated/semanticTypeItem.d.ts +12 -0
  253. package/dist/cjs/models/generated/semanticTypeItem.js.map +1 -1
  254. package/dist/cjs/models/generated/semanticTypeList.d.ts +3 -0
  255. package/dist/cjs/models/generated/semanticTypeList.js.map +1 -1
  256. package/dist/cjs/models/generated/severityStatistics.d.ts +12 -0
  257. package/dist/cjs/models/generated/severityStatistics.js.map +1 -1
  258. package/dist/cjs/models/generated/simpleAsset.d.ts +6 -0
  259. package/dist/cjs/models/generated/simpleAsset.js.map +1 -1
  260. package/dist/cjs/models/generated/statusStatistics.d.ts +9 -0
  261. package/dist/cjs/models/generated/statusStatistics.js.map +1 -1
  262. package/dist/cjs/models/generated/storageData.d.ts +15 -0
  263. package/dist/cjs/models/generated/storageData.js.map +1 -1
  264. package/dist/cjs/models/generated/storageMetric.d.ts +18 -0
  265. package/dist/cjs/models/generated/storageMetric.js.map +1 -1
  266. package/dist/cjs/models/generated/storageMetricListPaginated.d.ts +3 -0
  267. package/dist/cjs/models/generated/storageMetricListPaginated.js.map +1 -1
  268. package/dist/cjs/models/generated/teamMember.d.ts +3 -2
  269. package/dist/cjs/models/generated/teamMember.js +2 -1
  270. package/dist/cjs/models/generated/teamMember.js.map +1 -1
  271. package/dist/cjs/models/generated/view2D.d.ts +9 -0
  272. package/dist/cjs/models/generated/view2D.js.map +1 -1
  273. package/dist/cjs/models/generated/view3D.d.ts +12 -0
  274. package/dist/cjs/models/generated/view3D.js.map +1 -1
  275. package/dist/cjs/models/generated/workload.d.ts +4 -2
  276. package/dist/cjs/models/generated/workload.js +2 -1
  277. package/dist/cjs/models/generated/workload.js.map +1 -1
  278. package/dist/cjs/models/generated/workloadItem.d.ts +4 -2
  279. package/dist/cjs/models/generated/workloadItem.js +2 -1
  280. package/dist/cjs/models/generated/workloadItem.js.map +1 -1
  281. package/dist/cjs/services/generated/api/aCP.service.js.map +1 -1
  282. package/dist/cjs/services/generated/api/alarm.service.d.ts +50 -2
  283. package/dist/cjs/services/generated/api/alarm.service.js +113 -0
  284. package/dist/cjs/services/generated/api/alarm.service.js.map +1 -1
  285. package/dist/cjs/services/generated/api/appRegistry.service.js.map +1 -1
  286. package/dist/cjs/services/generated/api/asset.service.d.ts +135 -159
  287. package/dist/cjs/services/generated/api/asset.service.js +137 -187
  288. package/dist/cjs/services/generated/api/asset.service.js.map +1 -1
  289. package/dist/cjs/services/generated/api/bridge.service.d.ts +50 -50
  290. package/dist/cjs/services/generated/api/bridge.service.js +50 -50
  291. package/dist/cjs/services/generated/api/bridge.service.js.map +1 -1
  292. package/dist/cjs/services/generated/api/controlChange.service.d.ts +40 -33
  293. package/dist/cjs/services/generated/api/controlChange.service.js +46 -31
  294. package/dist/cjs/services/generated/api/controlChange.service.js.map +1 -1
  295. package/dist/cjs/services/generated/api/dataLabel.service.d.ts +8 -1
  296. package/dist/cjs/services/generated/api/dataLabel.service.js +15 -0
  297. package/dist/cjs/services/generated/api/dataLabel.service.js.map +1 -1
  298. package/dist/cjs/services/generated/api/dataType.service.js.map +1 -1
  299. package/dist/cjs/services/generated/api/failureDetection.service.js.map +1 -1
  300. package/dist/cjs/services/generated/api/index.d.ts +3 -0
  301. package/dist/cjs/services/generated/api/index.js +3 -0
  302. package/dist/cjs/services/generated/api/index.js.map +1 -1
  303. package/dist/cjs/services/generated/api/instance.service.d.ts +16 -2
  304. package/dist/cjs/services/generated/api/instance.service.js +34 -0
  305. package/dist/cjs/services/generated/api/instance.service.js.map +1 -1
  306. package/dist/cjs/services/generated/api/integration.service.js.map +1 -1
  307. package/dist/cjs/services/generated/api/map.service.d.ts +39 -4
  308. package/dist/cjs/services/generated/api/map.service.js +88 -2
  309. package/dist/cjs/services/generated/api/map.service.js.map +1 -1
  310. package/dist/cjs/services/generated/api/metric.service.d.ts +26 -26
  311. package/dist/cjs/services/generated/api/metric.service.js +26 -26
  312. package/dist/cjs/services/generated/api/metric.service.js.map +1 -1
  313. package/dist/cjs/services/generated/api/orchestration.service.js.map +1 -1
  314. package/dist/cjs/services/generated/api/parameters.service.d.ts +42 -0
  315. package/dist/cjs/services/generated/api/parameters.service.js +83 -0
  316. package/dist/cjs/services/generated/api/parameters.service.js.map +1 -0
  317. package/dist/cjs/services/generated/api/rule.service.d.ts +63 -0
  318. package/dist/cjs/services/generated/api/rule.service.js +146 -0
  319. package/dist/cjs/services/generated/api/rule.service.js.map +1 -0
  320. package/dist/cjs/services/generated/api/secret.service.js.map +1 -1
  321. package/dist/cjs/services/generated/api/storage.service.d.ts +31 -31
  322. package/dist/cjs/services/generated/api/storage.service.js +31 -31
  323. package/dist/cjs/services/generated/api/storage.service.js.map +1 -1
  324. package/dist/cjs/services/generated/api/thread.service.js.map +1 -1
  325. package/dist/cjs/services/generated/api/uI.service.d.ts +29 -0
  326. package/dist/cjs/services/generated/api/uI.service.js +68 -0
  327. package/dist/cjs/services/generated/api/uI.service.js.map +1 -0
  328. package/dist/cjs/services/generated/api/user.service.js.map +1 -1
  329. package/dist/cjs/services/generated/api/wireguard.service.js.map +1 -1
  330. package/dist/cjs/services/generated/api/workload.service.d.ts +10 -2
  331. package/dist/cjs/services/generated/api/workload.service.js +19 -1
  332. package/dist/cjs/services/generated/api/workload.service.js.map +1 -1
  333. package/dist/cjs/services/generated/models/aCPStatusUpdateData.d.ts +2 -0
  334. package/dist/cjs/services/generated/models/aCPStatusUpdateData.js.map +1 -1
  335. package/dist/cjs/services/generated/models/alarmClusteringData.d.ts +11 -0
  336. package/dist/cjs/services/generated/models/{assetShiftCreateData.js → alarmClusteringData.js} +1 -1
  337. package/dist/cjs/services/generated/models/alarmClusteringData.js.map +1 -0
  338. package/dist/cjs/services/generated/models/alarmCreateData.d.ts +1 -0
  339. package/dist/cjs/services/generated/models/alarmCreateData.js.map +1 -1
  340. package/dist/cjs/services/generated/models/alarmListData.d.ts +1 -0
  341. package/dist/cjs/services/generated/models/alarmListData.js.map +1 -1
  342. package/dist/cjs/services/generated/models/alarmTagCreateData.d.ts +7 -0
  343. package/dist/cjs/services/generated/models/{assetOEECreateData.js → alarmTagCreateData.js} +1 -1
  344. package/dist/cjs/services/generated/models/alarmTagCreateData.js.map +1 -0
  345. package/dist/cjs/services/generated/models/alarmTagUpdateData.d.ts +6 -0
  346. package/dist/cjs/services/generated/models/{siteHierarchyOverviewData.js → alarmTagUpdateData.js} +1 -1
  347. package/dist/cjs/services/generated/models/alarmTagUpdateData.js.map +1 -0
  348. package/dist/cjs/services/generated/models/alarmUpdateData.d.ts +1 -0
  349. package/dist/cjs/services/generated/models/alarmUpdateData.js.map +1 -1
  350. package/dist/cjs/services/generated/models/assetClassCreateData.d.ts +3 -3
  351. package/dist/cjs/services/generated/models/assetClassCreateData.js.map +1 -1
  352. package/dist/cjs/services/generated/models/assetClassUpdateData.d.ts +1 -1
  353. package/dist/cjs/services/generated/models/assetClassUpdateData.js.map +1 -1
  354. package/dist/cjs/services/generated/models/assetCreateData.d.ts +4 -4
  355. package/dist/cjs/services/generated/models/assetCreateData.js.map +1 -1
  356. package/dist/cjs/services/generated/models/assetCreateWithParentData.d.ts +4 -4
  357. package/dist/cjs/services/generated/models/assetCreateWithParentData.js.map +1 -1
  358. package/dist/cjs/services/generated/models/assetOEEGetData.d.ts +1 -1
  359. package/dist/cjs/services/generated/models/assetOEEGetData.js.map +1 -1
  360. package/dist/cjs/services/generated/models/assetTemplateCreateData.d.ts +4 -4
  361. package/dist/cjs/services/generated/models/assetTemplateCreateData.js.map +1 -1
  362. package/dist/cjs/services/generated/models/assetTypeCreateData.d.ts +3 -3
  363. package/dist/cjs/services/generated/models/assetTypeCreateData.js.map +1 -1
  364. package/dist/cjs/services/generated/models/assetTypeMetadataCreateData.d.ts +2 -2
  365. package/dist/cjs/services/generated/models/assetTypeMetadataCreateData.js.map +1 -1
  366. package/dist/cjs/services/generated/models/assetTypeMetadataUpdateData.d.ts +1 -1
  367. package/dist/cjs/services/generated/models/assetTypeMetadataUpdateData.js.map +1 -1
  368. package/dist/cjs/services/generated/models/assetUpdateData.d.ts +1 -1
  369. package/dist/cjs/services/generated/models/assetUpdateData.js.map +1 -1
  370. package/dist/cjs/services/generated/models/bridgeDeployData.d.ts +5 -5
  371. package/dist/cjs/services/generated/models/bridgeDeployData.js.map +1 -1
  372. package/dist/cjs/services/generated/models/carbonEmissionsSettingData.d.ts +15 -0
  373. package/dist/cjs/services/generated/models/carbonEmissionsSettingData.js +3 -0
  374. package/dist/cjs/services/generated/models/carbonEmissionsSettingData.js.map +1 -0
  375. package/dist/cjs/services/generated/models/controlChangeClusteringData.d.ts +12 -0
  376. package/dist/cjs/services/generated/models/controlChangeClusteringData.js +3 -0
  377. package/dist/cjs/services/generated/models/controlChangeClusteringData.js.map +1 -0
  378. package/dist/{esm/services/generated/models/siteHierarchyOverviewData.d.ts → cjs/services/generated/models/failureOverviewData.d.ts} +3 -2
  379. package/dist/cjs/services/generated/models/failureOverviewData.js +3 -0
  380. package/dist/cjs/services/generated/models/failureOverviewData.js.map +1 -0
  381. package/dist/cjs/services/generated/models/hierarchyUpdateItemData.d.ts +4 -4
  382. package/dist/cjs/services/generated/models/hierarchyUpdateItemData.js.map +1 -1
  383. package/dist/cjs/services/generated/models/index.d.ts +19 -4
  384. package/dist/cjs/services/generated/models/index.js +19 -4
  385. package/dist/cjs/services/generated/models/index.js.map +1 -1
  386. package/dist/cjs/services/generated/models/kelvinCarbonEmissionsInstanceSettingUpdateData.d.ts +7 -0
  387. package/dist/cjs/services/generated/models/kelvinCarbonEmissionsInstanceSettingUpdateData.js +3 -0
  388. package/dist/cjs/services/generated/models/kelvinCarbonEmissionsInstanceSettingUpdateData.js.map +1 -0
  389. package/dist/cjs/services/generated/models/mapCreateData.d.ts +3 -1
  390. package/dist/cjs/services/generated/models/mapCreateData.js.map +1 -1
  391. package/dist/cjs/services/generated/models/{assetOEECreateData.d.ts → mapOEECreateData.d.ts} +1 -1
  392. package/dist/cjs/services/generated/models/{assetShiftGetData.js → mapOEECreateData.js} +1 -1
  393. package/dist/cjs/services/generated/models/mapOEECreateData.js.map +1 -0
  394. package/dist/cjs/services/generated/models/{assetShiftGetData.d.ts → mapOEEGetData.d.ts} +2 -2
  395. package/dist/cjs/services/generated/models/mapOEEGetData.js +3 -0
  396. package/dist/cjs/services/generated/models/mapOEEGetData.js.map +1 -0
  397. package/dist/{esm/services/generated/models/assetShiftCreateData.d.ts → cjs/services/generated/models/mapShiftCreateData.d.ts} +1 -1
  398. package/dist/cjs/services/generated/models/mapShiftCreateData.js +3 -0
  399. package/dist/cjs/services/generated/models/mapShiftCreateData.js.map +1 -0
  400. package/dist/{esm/services/generated/models/assetShiftGetData.d.ts → cjs/services/generated/models/mapShiftGetData.d.ts} +2 -2
  401. package/dist/cjs/services/generated/models/mapShiftGetData.js +3 -0
  402. package/dist/cjs/services/generated/models/mapShiftGetData.js.map +1 -0
  403. package/dist/cjs/services/generated/models/mapUpdateData.d.ts +4 -1
  404. package/dist/cjs/services/generated/models/mapUpdateData.js.map +1 -1
  405. package/dist/cjs/services/generated/models/parameterUpdateData.d.ts +6 -0
  406. package/dist/cjs/services/generated/models/parameterUpdateData.js +3 -0
  407. package/dist/cjs/services/generated/models/parameterUpdateData.js.map +1 -0
  408. package/dist/cjs/services/generated/models/processesListData.d.ts +8 -0
  409. package/dist/cjs/services/generated/models/processesListData.js +3 -0
  410. package/dist/cjs/services/generated/models/processesListData.js.map +1 -0
  411. package/dist/cjs/services/generated/models/responsibleForData.d.ts +7 -0
  412. package/dist/cjs/services/generated/models/responsibleForData.js +3 -0
  413. package/dist/cjs/services/generated/models/responsibleForData.js.map +1 -0
  414. package/dist/cjs/services/generated/models/ruleActionData.d.ts +7 -0
  415. package/dist/cjs/services/generated/models/ruleActionData.js +3 -0
  416. package/dist/cjs/services/generated/models/ruleActionData.js.map +1 -0
  417. package/dist/cjs/services/generated/models/ruleCreateData.d.ts +12 -0
  418. package/dist/cjs/services/generated/models/ruleCreateData.js +3 -0
  419. package/dist/cjs/services/generated/models/ruleCreateData.js.map +1 -0
  420. package/dist/cjs/services/generated/models/ruleInputData.d.ts +7 -0
  421. package/dist/cjs/services/generated/models/ruleInputData.js +3 -0
  422. package/dist/cjs/services/generated/models/ruleInputData.js.map +1 -0
  423. package/dist/cjs/services/generated/models/rulePayloadData.d.ts +11 -0
  424. package/dist/cjs/services/generated/models/rulePayloadData.js +3 -0
  425. package/dist/cjs/services/generated/models/rulePayloadData.js.map +1 -0
  426. package/dist/cjs/services/generated/models/ruleUpdateData.d.ts +11 -0
  427. package/dist/cjs/services/generated/models/ruleUpdateData.js +3 -0
  428. package/dist/cjs/services/generated/models/ruleUpdateData.js.map +1 -0
  429. package/dist/cjs/services/generated/models/teamMemberData.d.ts +2 -1
  430. package/dist/cjs/services/generated/models/teamMemberData.js.map +1 -1
  431. package/dist/cjs/services/generated/types/alarm.service.types.d.ts +43 -1
  432. package/dist/cjs/services/generated/types/alarm.service.types.js.map +1 -1
  433. package/dist/cjs/services/generated/types/asset.service.types.d.ts +5 -26
  434. package/dist/cjs/services/generated/types/asset.service.types.js.map +1 -1
  435. package/dist/cjs/services/generated/types/controlChange.service.types.d.ts +7 -1
  436. package/dist/cjs/services/generated/types/controlChange.service.types.js.map +1 -1
  437. package/dist/cjs/services/generated/types/dataLabel.service.types.d.ts +6 -0
  438. package/dist/cjs/services/generated/types/dataLabel.service.types.js.map +1 -1
  439. package/dist/cjs/services/generated/types/index.d.ts +3 -0
  440. package/dist/cjs/services/generated/types/index.js +3 -0
  441. package/dist/cjs/services/generated/types/index.js.map +1 -1
  442. package/dist/cjs/services/generated/types/instance.service.types.d.ts +11 -1
  443. package/dist/cjs/services/generated/types/instance.service.types.js.map +1 -1
  444. package/dist/cjs/services/generated/types/map.service.types.d.ts +32 -1
  445. package/dist/cjs/services/generated/types/map.service.types.js.map +1 -1
  446. package/dist/cjs/services/generated/types/parameters.service.types.d.ts +30 -0
  447. package/dist/cjs/services/generated/types/parameters.service.types.js +3 -0
  448. package/dist/cjs/services/generated/types/parameters.service.types.js.map +1 -0
  449. package/dist/cjs/services/generated/types/rule.service.types.d.ts +48 -0
  450. package/dist/cjs/services/generated/types/rule.service.types.js +3 -0
  451. package/dist/cjs/services/generated/types/rule.service.types.js.map +1 -0
  452. package/dist/cjs/services/generated/types/uI.service.types.d.ts +18 -0
  453. package/dist/cjs/services/generated/types/uI.service.types.js +3 -0
  454. package/dist/cjs/services/generated/types/uI.service.types.js.map +1 -0
  455. package/dist/cjs/services/generated/types/workload.service.types.d.ts +7 -0
  456. package/dist/cjs/services/generated/types/workload.service.types.js.map +1 -1
  457. package/dist/esm/core/http.d.ts +11 -1
  458. package/dist/esm/core/http.js +15 -0
  459. package/dist/esm/core/http.js.map +1 -1
  460. package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.d.ts +19 -0
  461. package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.js +16 -0
  462. package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.js.map +1 -0
  463. package/dist/esm/models/generated/aCPWorkloadManifests.d.ts +3 -0
  464. package/dist/esm/models/generated/aCPWorkloadManifests.js +2 -0
  465. package/dist/esm/models/generated/aCPWorkloadManifests.js.map +1 -1
  466. package/dist/esm/models/generated/alarm.d.ts +2 -0
  467. package/dist/esm/models/generated/alarm.js +1 -0
  468. package/dist/esm/models/generated/alarm.js.map +1 -1
  469. package/dist/esm/models/generated/alarmClustering.d.ts +21 -0
  470. package/dist/esm/models/generated/alarmClustering.js +17 -0
  471. package/dist/esm/models/generated/alarmClustering.js.map +1 -0
  472. package/dist/esm/models/generated/alarmItem.d.ts +2 -0
  473. package/dist/esm/models/generated/alarmItem.js +1 -0
  474. package/dist/esm/models/generated/alarmItem.js.map +1 -1
  475. package/dist/esm/models/generated/alarmTag.d.ts +23 -0
  476. package/dist/esm/models/generated/alarmTag.js +18 -0
  477. package/dist/esm/models/generated/alarmTag.js.map +1 -0
  478. package/dist/esm/models/generated/alarmTagItem.d.ts +23 -0
  479. package/dist/esm/models/generated/alarmTagItem.js +18 -0
  480. package/dist/esm/models/generated/alarmTagItem.js.map +1 -0
  481. package/dist/esm/models/generated/alarmTagListPaginated.d.ts +21 -0
  482. package/dist/esm/models/generated/{siteHierarchyOverviewPaginated.js → alarmTagListPaginated.js} +4 -4
  483. package/dist/esm/models/generated/alarmTagListPaginated.js.map +1 -0
  484. package/dist/esm/models/generated/asset.d.ts +51 -0
  485. package/dist/esm/models/generated/asset.js.map +1 -1
  486. package/dist/esm/models/generated/assetClass.d.ts +21 -0
  487. package/dist/esm/models/generated/assetClass.js.map +1 -1
  488. package/dist/esm/models/generated/assetClassItem.d.ts +21 -0
  489. package/dist/esm/models/generated/assetClassItem.js.map +1 -1
  490. package/dist/esm/models/generated/assetClassListPaginated.d.ts +3 -0
  491. package/dist/esm/models/generated/assetClassListPaginated.js.map +1 -1
  492. package/dist/esm/models/generated/assetDataStreamItem.d.ts +6 -0
  493. package/dist/esm/models/generated/assetDataStreamItem.js.map +1 -1
  494. package/dist/esm/models/generated/assetDataStreamsListPaginated.d.ts +3 -0
  495. package/dist/esm/models/generated/assetDataStreamsListPaginated.js.map +1 -1
  496. package/dist/esm/models/generated/assetHierarchies.d.ts +3 -0
  497. package/dist/esm/models/generated/assetHierarchies.js.map +1 -1
  498. package/dist/esm/models/generated/assetHierarchyItem.d.ts +24 -0
  499. package/dist/esm/models/generated/assetHierarchyItem.js.map +1 -1
  500. package/dist/esm/models/generated/assetHierarchyList.d.ts +3 -0
  501. package/dist/esm/models/generated/assetHierarchyList.js.map +1 -1
  502. package/dist/esm/models/generated/assetItem.d.ts +33 -0
  503. package/dist/esm/models/generated/assetItem.js.map +1 -1
  504. package/dist/esm/models/generated/assetListPaginated.d.ts +3 -0
  505. package/dist/esm/models/generated/assetListPaginated.js.map +1 -1
  506. package/dist/esm/models/generated/assetLocationItem.d.ts +6 -0
  507. package/dist/esm/models/generated/assetLocationItem.js.map +1 -1
  508. package/dist/esm/models/generated/assetMetricItem.d.ts +6 -0
  509. package/dist/esm/models/generated/assetMetricItem.js.map +1 -1
  510. package/dist/esm/models/generated/assetOEE.d.ts +3 -0
  511. package/dist/esm/models/generated/assetOEE.js.map +1 -1
  512. package/dist/esm/models/generated/assetProperty.d.ts +9 -0
  513. package/dist/esm/models/generated/assetProperty.js.map +1 -1
  514. package/dist/esm/models/generated/assetStatisticsItem.d.ts +24 -0
  515. package/dist/esm/models/generated/assetStatisticsItem.js.map +1 -1
  516. package/dist/esm/models/generated/assetStatisticsPaginated.d.ts +3 -0
  517. package/dist/esm/models/generated/assetStatisticsPaginated.js.map +1 -1
  518. package/dist/esm/models/generated/assetStatus.d.ts +3 -0
  519. package/dist/esm/models/generated/assetStatus.js.map +1 -1
  520. package/dist/esm/models/generated/assetStatusCount.d.ts +15 -0
  521. package/dist/esm/models/generated/assetStatusCount.js.map +1 -1
  522. package/dist/esm/models/generated/assetStatusItem.d.ts +6 -0
  523. package/dist/esm/models/generated/assetStatusItem.js.map +1 -1
  524. package/dist/esm/models/generated/assetTemplate.d.ts +48 -0
  525. package/dist/esm/models/generated/assetTemplate.js.map +1 -1
  526. package/dist/esm/models/generated/assetTemplateHierarchy.d.ts +24 -0
  527. package/dist/esm/models/generated/assetTemplateHierarchy.js.map +1 -1
  528. package/dist/esm/models/generated/assetTemplateItem.d.ts +42 -0
  529. package/dist/esm/models/generated/assetTemplateItem.js.map +1 -1
  530. package/dist/esm/models/generated/assetTemplateListPaginated.d.ts +3 -0
  531. package/dist/esm/models/generated/assetTemplateListPaginated.js.map +1 -1
  532. package/dist/esm/models/generated/assetTemplateProperties.d.ts +9 -0
  533. package/dist/esm/models/generated/assetTemplateProperties.js.map +1 -1
  534. package/dist/esm/models/generated/assetType.d.ts +30 -0
  535. package/dist/esm/models/generated/assetType.js.map +1 -1
  536. package/dist/esm/models/generated/assetTypeItem.d.ts +30 -0
  537. package/dist/esm/models/generated/assetTypeItem.js.map +1 -1
  538. package/dist/esm/models/generated/assetTypeListPaginated.d.ts +3 -0
  539. package/dist/esm/models/generated/assetTypeListPaginated.js.map +1 -1
  540. package/dist/esm/models/generated/assetTypeMetadata.d.ts +15 -0
  541. package/dist/esm/models/generated/assetTypeMetadata.js.map +1 -1
  542. package/dist/esm/models/generated/assetTypeMetadataItem.d.ts +15 -0
  543. package/dist/esm/models/generated/assetTypeMetadataItem.js.map +1 -1
  544. package/dist/esm/models/generated/assetTypeMetadataListPaginated.d.ts +3 -0
  545. package/dist/esm/models/generated/assetTypeMetadataListPaginated.js.map +1 -1
  546. package/dist/esm/models/generated/bridge.d.ts +24 -0
  547. package/dist/esm/models/generated/bridge.js.map +1 -1
  548. package/dist/esm/models/generated/bridgeDataStreamItem.d.ts +9 -0
  549. package/dist/esm/models/generated/bridgeDataStreamItem.js.map +1 -1
  550. package/dist/esm/models/generated/bridgeDataStreamListPaginated.d.ts +3 -0
  551. package/dist/esm/models/generated/bridgeDataStreamListPaginated.js.map +1 -1
  552. package/dist/esm/models/generated/bridgeItem.d.ts +21 -0
  553. package/dist/esm/models/generated/bridgeItem.js.map +1 -1
  554. package/dist/esm/models/generated/bridgeListPaginated.d.ts +3 -0
  555. package/dist/esm/models/generated/bridgeListPaginated.js.map +1 -1
  556. package/dist/esm/models/generated/cSVError.d.ts +18 -0
  557. package/dist/esm/models/generated/cSVError.js.map +1 -1
  558. package/dist/esm/models/generated/cSVErrorMessage.d.ts +3 -0
  559. package/dist/esm/models/generated/cSVErrorMessage.js.map +1 -1
  560. package/dist/esm/models/generated/cSVPosition.d.ts +12 -0
  561. package/dist/esm/models/generated/cSVPosition.js.map +1 -1
  562. package/dist/esm/models/generated/carbonEmissionsInstanceSettingItem.d.ts +25 -0
  563. package/dist/esm/models/generated/carbonEmissionsInstanceSettingItem.js +19 -0
  564. package/dist/esm/models/generated/carbonEmissionsInstanceSettingItem.js.map +1 -0
  565. package/dist/esm/models/generated/controlChange.d.ts +27 -0
  566. package/dist/esm/models/generated/controlChange.js.map +1 -1
  567. package/dist/esm/models/generated/controlChangeClustering.d.ts +21 -0
  568. package/dist/esm/models/generated/controlChangeClustering.js +17 -0
  569. package/dist/esm/models/generated/controlChangeClustering.js.map +1 -0
  570. package/dist/esm/models/generated/controlChangeGet.d.ts +39 -0
  571. package/dist/esm/models/generated/controlChangeGet.js.map +1 -1
  572. package/dist/esm/models/generated/controlChangeGetPaginated.d.ts +3 -0
  573. package/dist/esm/models/generated/controlChangeGetPaginated.js.map +1 -1
  574. package/dist/esm/models/generated/controlChangeGetStatus.d.ts +12 -0
  575. package/dist/esm/models/generated/controlChangeGetStatus.js.map +1 -1
  576. package/dist/esm/models/generated/controlChangePaginated.d.ts +3 -0
  577. package/dist/esm/models/generated/controlChangePaginated.js.map +1 -1
  578. package/dist/esm/models/generated/emissionsAsset.d.ts +19 -0
  579. package/dist/esm/models/generated/emissionsAsset.js +16 -0
  580. package/dist/esm/models/generated/emissionsAsset.js.map +1 -0
  581. package/dist/esm/models/generated/emissionsAssetLists.d.ts +22 -0
  582. package/dist/esm/models/generated/emissionsAssetLists.js +18 -0
  583. package/dist/esm/models/generated/emissionsAssetLists.js.map +1 -0
  584. package/dist/esm/models/generated/emissionsDashboard.d.ts +29 -0
  585. package/dist/esm/models/generated/emissionsDashboard.js +23 -0
  586. package/dist/esm/models/generated/emissionsDashboard.js.map +1 -0
  587. package/dist/esm/models/generated/emissionsDashboardAnalytics.d.ts +26 -0
  588. package/dist/esm/models/generated/emissionsDashboardAnalytics.js +20 -0
  589. package/dist/esm/models/generated/emissionsDashboardAnalytics.js.map +1 -0
  590. package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.d.ts +25 -0
  591. package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js +19 -0
  592. package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js.map +1 -0
  593. package/dist/esm/models/generated/emissionsDashboardTotals.d.ts +27 -0
  594. package/dist/esm/models/generated/emissionsDashboardTotals.js +20 -0
  595. package/dist/esm/models/generated/emissionsDashboardTotals.js.map +1 -0
  596. package/dist/esm/models/generated/emissionsGreenhouse.d.ts +21 -0
  597. package/dist/esm/models/generated/emissionsGreenhouse.js +17 -0
  598. package/dist/esm/models/generated/emissionsGreenhouse.js.map +1 -0
  599. package/dist/esm/models/generated/errorMessage.d.ts +9 -0
  600. package/dist/esm/models/generated/errorMessage.js.map +1 -1
  601. package/dist/esm/models/generated/errorMessages.d.ts +3 -0
  602. package/dist/esm/models/generated/errorMessages.js.map +1 -1
  603. package/dist/esm/models/generated/errorsError.d.ts +18 -0
  604. package/dist/esm/models/generated/errorsError.js.map +1 -1
  605. package/dist/esm/models/generated/errorsErrorMessage.d.ts +3 -0
  606. package/dist/esm/models/generated/errorsErrorMessage.js.map +1 -1
  607. package/dist/esm/models/generated/failureDetection.d.ts +12 -0
  608. package/dist/esm/models/generated/failureDetection.js.map +1 -1
  609. package/dist/esm/models/generated/failureDetectionProperty.d.ts +9 -0
  610. package/dist/esm/models/generated/failureDetectionProperty.js.map +1 -1
  611. package/dist/esm/models/generated/failureOverviewItem.d.ts +58 -0
  612. package/dist/esm/models/generated/{siteHierarchyOverviewItem.js → failureOverviewItem.js} +5 -6
  613. package/dist/esm/models/generated/failureOverviewItem.js.map +1 -0
  614. package/dist/esm/models/generated/failureOverviewPaginated.d.ts +24 -0
  615. package/dist/esm/models/generated/failureOverviewPaginated.js +18 -0
  616. package/dist/esm/models/generated/failureOverviewPaginated.js.map +1 -0
  617. package/dist/esm/models/generated/failureOverviewStatistics.d.ts +24 -0
  618. package/dist/esm/models/generated/{siteHierarchyOverviewStatistics.js → failureOverviewStatistics.js} +2 -2
  619. package/dist/esm/models/generated/failureOverviewStatistics.js.map +1 -0
  620. package/dist/esm/models/generated/fullMap.d.ts +49 -0
  621. package/dist/esm/models/generated/fullMap.js +34 -0
  622. package/dist/esm/models/generated/fullMap.js.map +1 -0
  623. package/dist/esm/models/generated/fullMapListPaginated.d.ts +21 -0
  624. package/dist/esm/models/generated/fullMapListPaginated.js +18 -0
  625. package/dist/esm/models/generated/fullMapListPaginated.js.map +1 -0
  626. package/dist/esm/models/generated/index.d.ts +36 -4
  627. package/dist/esm/models/generated/index.js +36 -4
  628. package/dist/esm/models/generated/index.js.map +1 -1
  629. package/dist/esm/models/generated/mQTTTopicItem.d.ts +18 -0
  630. package/dist/esm/models/generated/mQTTTopicItem.js.map +1 -1
  631. package/dist/esm/models/generated/mQTTTopicList.d.ts +3 -0
  632. package/dist/esm/models/generated/mQTTTopicList.js.map +1 -1
  633. package/dist/esm/models/generated/mapFailureDetection.d.ts +17 -0
  634. package/dist/esm/models/generated/mapFailureDetection.js +15 -0
  635. package/dist/esm/models/generated/mapFailureDetection.js.map +1 -0
  636. package/dist/esm/models/generated/mapItem.d.ts +13 -6
  637. package/dist/esm/models/generated/mapItem.js +8 -4
  638. package/dist/esm/models/generated/mapItem.js.map +1 -1
  639. package/dist/esm/models/generated/mapModel.d.ts +11 -4
  640. package/dist/esm/models/generated/mapModel.js +6 -2
  641. package/dist/esm/models/generated/mapModel.js.map +1 -1
  642. package/dist/esm/models/generated/mapOEE.d.ts +26 -0
  643. package/dist/esm/models/generated/mapOEE.js +21 -0
  644. package/dist/esm/models/generated/mapOEE.js.map +1 -0
  645. package/dist/esm/models/generated/{assetShift.d.ts → mapShift.d.ts} +5 -5
  646. package/dist/esm/models/generated/{assetShift.js → mapShift.js} +3 -3
  647. package/dist/esm/models/generated/mapShift.js.map +1 -0
  648. package/dist/esm/models/generated/mapVersionItem.d.ts +4 -2
  649. package/dist/esm/models/generated/mapVersionItem.js +2 -1
  650. package/dist/esm/models/generated/mapVersionItem.js.map +1 -1
  651. package/dist/esm/models/generated/metric.d.ts +30 -0
  652. package/dist/esm/models/generated/metric.js.map +1 -1
  653. package/dist/esm/models/generated/metricItem.d.ts +30 -0
  654. package/dist/esm/models/generated/metricItem.js.map +1 -1
  655. package/dist/esm/models/generated/metricListPaginated.d.ts +3 -0
  656. package/dist/esm/models/generated/metricListPaginated.js.map +1 -1
  657. package/dist/esm/models/generated/oEECalculation.d.ts +15 -0
  658. package/dist/esm/models/generated/oEECalculation.js.map +1 -1
  659. package/dist/esm/models/generated/oEEThresholds.d.ts +9 -0
  660. package/dist/esm/models/generated/oEEThresholds.js.map +1 -1
  661. package/dist/esm/models/generated/oEEValues.d.ts +12 -0
  662. package/dist/esm/models/generated/oEEValues.js.map +1 -1
  663. package/dist/esm/models/generated/page.d.ts +21 -0
  664. package/dist/esm/models/generated/page.js +17 -0
  665. package/dist/esm/models/generated/page.js.map +1 -0
  666. package/dist/esm/models/generated/pagination.d.ts +9 -0
  667. package/dist/esm/models/generated/pagination.js.map +1 -1
  668. package/dist/esm/models/generated/parameterAppVersionAsset.d.ts +29 -0
  669. package/dist/esm/models/generated/parameterAppVersionAsset.js +21 -0
  670. package/dist/esm/models/generated/parameterAppVersionAsset.js.map +1 -0
  671. package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.d.ts +21 -0
  672. package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.js +18 -0
  673. package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.js.map +1 -0
  674. package/dist/esm/models/generated/parameterGetSchema.d.ts +28 -0
  675. package/dist/esm/models/generated/parameterGetSchema.js +19 -0
  676. package/dist/esm/models/generated/parameterGetSchema.js.map +1 -0
  677. package/dist/esm/models/generated/parameterschemaParameterJSONSchema.d.ts +28 -0
  678. package/dist/esm/models/generated/parameterschemaParameterJSONSchema.js +19 -0
  679. package/dist/esm/models/generated/parameterschemaParameterJSONSchema.js.map +1 -0
  680. package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.d.ts +35 -0
  681. package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.js +24 -0
  682. package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.js.map +1 -0
  683. package/dist/esm/models/generated/responsibleFor.d.ts +19 -0
  684. package/dist/esm/models/generated/responsibleFor.js +16 -0
  685. package/dist/esm/models/generated/responsibleFor.js.map +1 -0
  686. package/dist/esm/models/generated/rule.d.ts +37 -0
  687. package/dist/esm/models/generated/rule.js +26 -0
  688. package/dist/esm/models/generated/rule.js.map +1 -0
  689. package/dist/esm/models/generated/ruleAction.d.ts +19 -0
  690. package/dist/esm/models/generated/ruleAction.js +16 -0
  691. package/dist/esm/models/generated/ruleAction.js.map +1 -0
  692. package/dist/esm/models/generated/ruleInput.d.ts +19 -0
  693. package/dist/esm/models/generated/ruleInput.js +16 -0
  694. package/dist/esm/models/generated/ruleInput.js.map +1 -0
  695. package/dist/esm/models/generated/ruleLogs.d.ts +17 -0
  696. package/dist/esm/models/generated/ruleLogs.js +15 -0
  697. package/dist/esm/models/generated/ruleLogs.js.map +1 -0
  698. package/dist/esm/models/generated/rulePayload.d.ts +25 -0
  699. package/dist/esm/models/generated/rulePayload.js +20 -0
  700. package/dist/esm/models/generated/rulePayload.js.map +1 -0
  701. package/dist/esm/models/generated/ruleStatus.d.ts +21 -0
  702. package/dist/esm/models/generated/ruleStatus.js +17 -0
  703. package/dist/esm/models/generated/ruleStatus.js.map +1 -0
  704. package/dist/esm/models/generated/rulesListPaginated.d.ts +21 -0
  705. package/dist/esm/models/generated/rulesListPaginated.js +18 -0
  706. package/dist/esm/models/generated/rulesListPaginated.js.map +1 -0
  707. package/dist/esm/models/generated/semanticTypeItem.d.ts +12 -0
  708. package/dist/esm/models/generated/semanticTypeItem.js.map +1 -1
  709. package/dist/esm/models/generated/semanticTypeList.d.ts +3 -0
  710. package/dist/esm/models/generated/semanticTypeList.js.map +1 -1
  711. package/dist/esm/models/generated/severityStatistics.d.ts +12 -0
  712. package/dist/esm/models/generated/severityStatistics.js.map +1 -1
  713. package/dist/esm/models/generated/simpleAsset.d.ts +6 -0
  714. package/dist/esm/models/generated/simpleAsset.js.map +1 -1
  715. package/dist/esm/models/generated/statusStatistics.d.ts +9 -0
  716. package/dist/esm/models/generated/statusStatistics.js.map +1 -1
  717. package/dist/esm/models/generated/storageData.d.ts +15 -0
  718. package/dist/esm/models/generated/storageData.js.map +1 -1
  719. package/dist/esm/models/generated/storageMetric.d.ts +18 -0
  720. package/dist/esm/models/generated/storageMetric.js.map +1 -1
  721. package/dist/esm/models/generated/storageMetricListPaginated.d.ts +3 -0
  722. package/dist/esm/models/generated/storageMetricListPaginated.js.map +1 -1
  723. package/dist/esm/models/generated/teamMember.d.ts +3 -2
  724. package/dist/esm/models/generated/teamMember.js +2 -1
  725. package/dist/esm/models/generated/teamMember.js.map +1 -1
  726. package/dist/esm/models/generated/view2D.d.ts +9 -0
  727. package/dist/esm/models/generated/view2D.js.map +1 -1
  728. package/dist/esm/models/generated/view3D.d.ts +12 -0
  729. package/dist/esm/models/generated/view3D.js.map +1 -1
  730. package/dist/esm/models/generated/workload.d.ts +4 -2
  731. package/dist/esm/models/generated/workload.js +2 -1
  732. package/dist/esm/models/generated/workload.js.map +1 -1
  733. package/dist/esm/models/generated/workloadItem.d.ts +4 -2
  734. package/dist/esm/models/generated/workloadItem.js +2 -1
  735. package/dist/esm/models/generated/workloadItem.js.map +1 -1
  736. package/dist/esm/services/generated/api/aCP.service.js.map +1 -1
  737. package/dist/esm/services/generated/api/alarm.service.d.ts +50 -2
  738. package/dist/esm/services/generated/api/alarm.service.js +114 -1
  739. package/dist/esm/services/generated/api/alarm.service.js.map +1 -1
  740. package/dist/esm/services/generated/api/appRegistry.service.js.map +1 -1
  741. package/dist/esm/services/generated/api/asset.service.d.ts +135 -159
  742. package/dist/esm/services/generated/api/asset.service.js +138 -188
  743. package/dist/esm/services/generated/api/asset.service.js.map +1 -1
  744. package/dist/esm/services/generated/api/bridge.service.d.ts +50 -50
  745. package/dist/esm/services/generated/api/bridge.service.js +50 -50
  746. package/dist/esm/services/generated/api/bridge.service.js.map +1 -1
  747. package/dist/esm/services/generated/api/controlChange.service.d.ts +40 -33
  748. package/dist/esm/services/generated/api/controlChange.service.js +47 -32
  749. package/dist/esm/services/generated/api/controlChange.service.js.map +1 -1
  750. package/dist/esm/services/generated/api/dataLabel.service.d.ts +8 -1
  751. package/dist/esm/services/generated/api/dataLabel.service.js +15 -0
  752. package/dist/esm/services/generated/api/dataLabel.service.js.map +1 -1
  753. package/dist/esm/services/generated/api/dataType.service.js.map +1 -1
  754. package/dist/esm/services/generated/api/failureDetection.service.js.map +1 -1
  755. package/dist/esm/services/generated/api/index.d.ts +3 -0
  756. package/dist/esm/services/generated/api/index.js +3 -0
  757. package/dist/esm/services/generated/api/index.js.map +1 -1
  758. package/dist/esm/services/generated/api/instance.service.d.ts +16 -2
  759. package/dist/esm/services/generated/api/instance.service.js +35 -1
  760. package/dist/esm/services/generated/api/instance.service.js.map +1 -1
  761. package/dist/esm/services/generated/api/integration.service.js.map +1 -1
  762. package/dist/esm/services/generated/api/map.service.d.ts +39 -4
  763. package/dist/esm/services/generated/api/map.service.js +89 -3
  764. package/dist/esm/services/generated/api/map.service.js.map +1 -1
  765. package/dist/esm/services/generated/api/metric.service.d.ts +26 -26
  766. package/dist/esm/services/generated/api/metric.service.js +26 -26
  767. package/dist/esm/services/generated/api/metric.service.js.map +1 -1
  768. package/dist/esm/services/generated/api/orchestration.service.js.map +1 -1
  769. package/dist/esm/services/generated/api/parameters.service.d.ts +42 -0
  770. package/dist/esm/services/generated/api/parameters.service.js +79 -0
  771. package/dist/esm/services/generated/api/parameters.service.js.map +1 -0
  772. package/dist/esm/services/generated/api/rule.service.d.ts +63 -0
  773. package/dist/esm/services/generated/api/rule.service.js +142 -0
  774. package/dist/esm/services/generated/api/rule.service.js.map +1 -0
  775. package/dist/esm/services/generated/api/secret.service.js.map +1 -1
  776. package/dist/esm/services/generated/api/storage.service.d.ts +31 -31
  777. package/dist/esm/services/generated/api/storage.service.js +31 -31
  778. package/dist/esm/services/generated/api/storage.service.js.map +1 -1
  779. package/dist/esm/services/generated/api/thread.service.js.map +1 -1
  780. package/dist/esm/services/generated/api/uI.service.d.ts +29 -0
  781. package/dist/esm/services/generated/api/uI.service.js +64 -0
  782. package/dist/esm/services/generated/api/uI.service.js.map +1 -0
  783. package/dist/esm/services/generated/api/user.service.js.map +1 -1
  784. package/dist/esm/services/generated/api/wireguard.service.js.map +1 -1
  785. package/dist/esm/services/generated/api/workload.service.d.ts +10 -2
  786. package/dist/esm/services/generated/api/workload.service.js +19 -1
  787. package/dist/esm/services/generated/api/workload.service.js.map +1 -1
  788. package/dist/esm/services/generated/models/aCPStatusUpdateData.d.ts +2 -0
  789. package/dist/esm/services/generated/models/aCPStatusUpdateData.js.map +1 -1
  790. package/dist/esm/services/generated/models/alarmClusteringData.d.ts +11 -0
  791. package/dist/esm/services/generated/models/alarmClusteringData.js +1 -0
  792. package/dist/esm/services/generated/models/alarmClusteringData.js.map +1 -0
  793. package/dist/esm/services/generated/models/alarmCreateData.d.ts +1 -0
  794. package/dist/esm/services/generated/models/alarmCreateData.js.map +1 -1
  795. package/dist/esm/services/generated/models/alarmListData.d.ts +1 -0
  796. package/dist/esm/services/generated/models/alarmListData.js.map +1 -1
  797. package/dist/esm/services/generated/models/alarmTagCreateData.d.ts +7 -0
  798. package/dist/esm/services/generated/models/alarmTagCreateData.js +1 -0
  799. package/dist/esm/services/generated/models/alarmTagCreateData.js.map +1 -0
  800. package/dist/esm/services/generated/models/alarmTagUpdateData.d.ts +6 -0
  801. package/dist/esm/services/generated/models/alarmTagUpdateData.js +1 -0
  802. package/dist/esm/services/generated/models/alarmTagUpdateData.js.map +1 -0
  803. package/dist/esm/services/generated/models/alarmUpdateData.d.ts +1 -0
  804. package/dist/esm/services/generated/models/alarmUpdateData.js.map +1 -1
  805. package/dist/esm/services/generated/models/assetClassCreateData.d.ts +3 -3
  806. package/dist/esm/services/generated/models/assetClassCreateData.js.map +1 -1
  807. package/dist/esm/services/generated/models/assetClassUpdateData.d.ts +1 -1
  808. package/dist/esm/services/generated/models/assetClassUpdateData.js.map +1 -1
  809. package/dist/esm/services/generated/models/assetCreateData.d.ts +4 -4
  810. package/dist/esm/services/generated/models/assetCreateData.js.map +1 -1
  811. package/dist/esm/services/generated/models/assetCreateWithParentData.d.ts +4 -4
  812. package/dist/esm/services/generated/models/assetCreateWithParentData.js.map +1 -1
  813. package/dist/esm/services/generated/models/assetOEEGetData.d.ts +1 -1
  814. package/dist/esm/services/generated/models/assetOEEGetData.js.map +1 -1
  815. package/dist/esm/services/generated/models/assetTemplateCreateData.d.ts +4 -4
  816. package/dist/esm/services/generated/models/assetTemplateCreateData.js.map +1 -1
  817. package/dist/esm/services/generated/models/assetTypeCreateData.d.ts +3 -3
  818. package/dist/esm/services/generated/models/assetTypeCreateData.js.map +1 -1
  819. package/dist/esm/services/generated/models/assetTypeMetadataCreateData.d.ts +2 -2
  820. package/dist/esm/services/generated/models/assetTypeMetadataCreateData.js.map +1 -1
  821. package/dist/esm/services/generated/models/assetTypeMetadataUpdateData.d.ts +1 -1
  822. package/dist/esm/services/generated/models/assetTypeMetadataUpdateData.js.map +1 -1
  823. package/dist/esm/services/generated/models/assetUpdateData.d.ts +1 -1
  824. package/dist/esm/services/generated/models/assetUpdateData.js.map +1 -1
  825. package/dist/esm/services/generated/models/bridgeDeployData.d.ts +5 -5
  826. package/dist/esm/services/generated/models/bridgeDeployData.js.map +1 -1
  827. package/dist/esm/services/generated/models/carbonEmissionsSettingData.d.ts +15 -0
  828. package/dist/esm/services/generated/models/carbonEmissionsSettingData.js +1 -0
  829. package/dist/esm/services/generated/models/carbonEmissionsSettingData.js.map +1 -0
  830. package/dist/esm/services/generated/models/controlChangeClusteringData.d.ts +12 -0
  831. package/dist/esm/services/generated/models/controlChangeClusteringData.js +1 -0
  832. package/dist/esm/services/generated/models/controlChangeClusteringData.js.map +1 -0
  833. package/dist/{cjs/services/generated/models/siteHierarchyOverviewData.d.ts → esm/services/generated/models/failureOverviewData.d.ts} +3 -2
  834. package/dist/esm/services/generated/models/failureOverviewData.js +1 -0
  835. package/dist/esm/services/generated/models/failureOverviewData.js.map +1 -0
  836. package/dist/esm/services/generated/models/hierarchyUpdateItemData.d.ts +4 -4
  837. package/dist/esm/services/generated/models/hierarchyUpdateItemData.js.map +1 -1
  838. package/dist/esm/services/generated/models/index.d.ts +19 -4
  839. package/dist/esm/services/generated/models/index.js +19 -4
  840. package/dist/esm/services/generated/models/index.js.map +1 -1
  841. package/dist/esm/services/generated/models/kelvinCarbonEmissionsInstanceSettingUpdateData.d.ts +7 -0
  842. package/dist/esm/services/generated/models/kelvinCarbonEmissionsInstanceSettingUpdateData.js +1 -0
  843. package/dist/esm/services/generated/models/kelvinCarbonEmissionsInstanceSettingUpdateData.js.map +1 -0
  844. package/dist/esm/services/generated/models/mapCreateData.d.ts +3 -1
  845. package/dist/esm/services/generated/models/mapCreateData.js.map +1 -1
  846. package/dist/esm/services/generated/models/{assetOEECreateData.d.ts → mapOEECreateData.d.ts} +1 -1
  847. package/dist/esm/services/generated/models/mapOEECreateData.js +1 -0
  848. package/dist/esm/services/generated/models/mapOEECreateData.js.map +1 -0
  849. package/dist/esm/services/generated/models/mapOEEGetData.d.ts +7 -0
  850. package/dist/esm/services/generated/models/mapOEEGetData.js +1 -0
  851. package/dist/esm/services/generated/models/mapOEEGetData.js.map +1 -0
  852. package/dist/{cjs/services/generated/models/assetShiftCreateData.d.ts → esm/services/generated/models/mapShiftCreateData.d.ts} +1 -1
  853. package/dist/esm/services/generated/models/mapShiftCreateData.js +1 -0
  854. package/dist/esm/services/generated/models/mapShiftCreateData.js.map +1 -0
  855. package/dist/esm/services/generated/models/mapShiftGetData.d.ts +7 -0
  856. package/dist/esm/services/generated/models/mapShiftGetData.js +1 -0
  857. package/dist/esm/services/generated/models/mapShiftGetData.js.map +1 -0
  858. package/dist/esm/services/generated/models/mapUpdateData.d.ts +4 -1
  859. package/dist/esm/services/generated/models/mapUpdateData.js.map +1 -1
  860. package/dist/esm/services/generated/models/parameterUpdateData.d.ts +6 -0
  861. package/dist/esm/services/generated/models/parameterUpdateData.js +1 -0
  862. package/dist/esm/services/generated/models/parameterUpdateData.js.map +1 -0
  863. package/dist/esm/services/generated/models/processesListData.d.ts +8 -0
  864. package/dist/esm/services/generated/models/processesListData.js +1 -0
  865. package/dist/esm/services/generated/models/processesListData.js.map +1 -0
  866. package/dist/esm/services/generated/models/responsibleForData.d.ts +7 -0
  867. package/dist/esm/services/generated/models/responsibleForData.js +1 -0
  868. package/dist/esm/services/generated/models/responsibleForData.js.map +1 -0
  869. package/dist/esm/services/generated/models/ruleActionData.d.ts +7 -0
  870. package/dist/esm/services/generated/models/ruleActionData.js +1 -0
  871. package/dist/esm/services/generated/models/ruleActionData.js.map +1 -0
  872. package/dist/esm/services/generated/models/ruleCreateData.d.ts +12 -0
  873. package/dist/esm/services/generated/models/ruleCreateData.js +1 -0
  874. package/dist/esm/services/generated/models/ruleCreateData.js.map +1 -0
  875. package/dist/esm/services/generated/models/ruleInputData.d.ts +7 -0
  876. package/dist/esm/services/generated/models/ruleInputData.js +1 -0
  877. package/dist/esm/services/generated/models/ruleInputData.js.map +1 -0
  878. package/dist/esm/services/generated/models/rulePayloadData.d.ts +11 -0
  879. package/dist/esm/services/generated/models/rulePayloadData.js +1 -0
  880. package/dist/esm/services/generated/models/rulePayloadData.js.map +1 -0
  881. package/dist/esm/services/generated/models/ruleUpdateData.d.ts +11 -0
  882. package/dist/esm/services/generated/models/ruleUpdateData.js +1 -0
  883. package/dist/esm/services/generated/models/ruleUpdateData.js.map +1 -0
  884. package/dist/esm/services/generated/models/teamMemberData.d.ts +2 -1
  885. package/dist/esm/services/generated/models/teamMemberData.js.map +1 -1
  886. package/dist/esm/services/generated/types/alarm.service.types.d.ts +43 -1
  887. package/dist/esm/services/generated/types/alarm.service.types.js.map +1 -1
  888. package/dist/esm/services/generated/types/asset.service.types.d.ts +5 -26
  889. package/dist/esm/services/generated/types/asset.service.types.js.map +1 -1
  890. package/dist/esm/services/generated/types/controlChange.service.types.d.ts +7 -1
  891. package/dist/esm/services/generated/types/controlChange.service.types.js.map +1 -1
  892. package/dist/esm/services/generated/types/dataLabel.service.types.d.ts +6 -0
  893. package/dist/esm/services/generated/types/dataLabel.service.types.js.map +1 -1
  894. package/dist/esm/services/generated/types/index.d.ts +3 -0
  895. package/dist/esm/services/generated/types/index.js +3 -0
  896. package/dist/esm/services/generated/types/index.js.map +1 -1
  897. package/dist/esm/services/generated/types/instance.service.types.d.ts +11 -1
  898. package/dist/esm/services/generated/types/instance.service.types.js.map +1 -1
  899. package/dist/esm/services/generated/types/map.service.types.d.ts +32 -1
  900. package/dist/esm/services/generated/types/map.service.types.js.map +1 -1
  901. package/dist/esm/services/generated/types/parameters.service.types.d.ts +30 -0
  902. package/dist/esm/services/generated/types/parameters.service.types.js +1 -0
  903. package/dist/esm/services/generated/types/parameters.service.types.js.map +1 -0
  904. package/dist/esm/services/generated/types/rule.service.types.d.ts +48 -0
  905. package/dist/esm/services/generated/types/rule.service.types.js +1 -0
  906. package/dist/esm/services/generated/types/rule.service.types.js.map +1 -0
  907. package/dist/esm/services/generated/types/uI.service.types.d.ts +18 -0
  908. package/dist/esm/services/generated/types/uI.service.types.js +1 -0
  909. package/dist/esm/services/generated/types/uI.service.types.js.map +1 -0
  910. package/dist/esm/services/generated/types/workload.service.types.d.ts +7 -0
  911. package/dist/esm/services/generated/types/workload.service.types.js.map +1 -1
  912. package/package.json +2 -2
  913. package/dist/cjs/models/generated/assetShift.js.map +0 -1
  914. package/dist/cjs/models/generated/siteHierarchyOverviewItem.d.ts +0 -36
  915. package/dist/cjs/models/generated/siteHierarchyOverviewItem.js.map +0 -1
  916. package/dist/cjs/models/generated/siteHierarchyOverviewPaginated.d.ts +0 -21
  917. package/dist/cjs/models/generated/siteHierarchyOverviewPaginated.js +0 -22
  918. package/dist/cjs/models/generated/siteHierarchyOverviewPaginated.js.map +0 -1
  919. package/dist/cjs/models/generated/siteHierarchyOverviewStatistics.d.ts +0 -21
  920. package/dist/cjs/models/generated/siteHierarchyOverviewStatistics.js.map +0 -1
  921. package/dist/cjs/services/generated/models/assetOEECreateData.js.map +0 -1
  922. package/dist/cjs/services/generated/models/assetShiftCreateData.js.map +0 -1
  923. package/dist/cjs/services/generated/models/assetShiftGetData.js.map +0 -1
  924. package/dist/cjs/services/generated/models/siteHierarchyOverviewData.js.map +0 -1
  925. package/dist/esm/models/generated/assetShift.js.map +0 -1
  926. package/dist/esm/models/generated/siteHierarchyOverviewItem.d.ts +0 -36
  927. package/dist/esm/models/generated/siteHierarchyOverviewItem.js.map +0 -1
  928. package/dist/esm/models/generated/siteHierarchyOverviewPaginated.d.ts +0 -21
  929. package/dist/esm/models/generated/siteHierarchyOverviewPaginated.js.map +0 -1
  930. package/dist/esm/models/generated/siteHierarchyOverviewStatistics.d.ts +0 -21
  931. package/dist/esm/models/generated/siteHierarchyOverviewStatistics.js.map +0 -1
  932. package/dist/esm/services/generated/models/assetOEECreateData.js +0 -1
  933. package/dist/esm/services/generated/models/assetOEECreateData.js.map +0 -1
  934. package/dist/esm/services/generated/models/assetShiftCreateData.js +0 -1
  935. package/dist/esm/services/generated/models/assetShiftCreateData.js.map +0 -1
  936. package/dist/esm/services/generated/models/assetShiftGetData.js +0 -1
  937. package/dist/esm/services/generated/models/assetShiftGetData.js.map +0 -1
  938. package/dist/esm/services/generated/models/siteHierarchyOverviewData.js +0 -1
  939. package/dist/esm/services/generated/models/siteHierarchyOverviewData.js.map +0 -1
@@ -9,9 +9,9 @@ const base_service_1 = require("../../base.service");
9
9
  class AssetService extends base_service_1.BaseService {
10
10
  /**
11
11
  * Create Asset
12
- * Create Asset **Permission Required:** `kelvin.permission.asset.create`
12
+ * Create Asset Create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> and optionally create a full <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> under the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> with one API request. If the top <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, then multiple <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> can be created in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> and below the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>, multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a> can be created according to <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> rules. If the top <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> is a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>, then below the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>, only multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a> can be created according to <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> rules. To create any <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A Kelvin Asset Class is linked to an entity type which defines how the Kelvin Asset will be referenced in Kelvin Assets. for example: Kelvin Assets that is defined as a Group can only be linked to a Kelvin Type and Kelvin Class that is saved as entity type **group**. There are five entity types; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these entity types and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. **Permission Required:** `kelvin.permission.asset.create`
13
13
  * @param asset Asset create schema
14
- * @param dryRun Dry Run
14
+ * @param dryRun Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> structure without making any changes on the Kelvin Platform.
15
15
  * @param {IKvHttpRequestOptions} options Request optional parameters
16
16
  */
17
17
  static createAsset({ asset, dryRun }, options) {
@@ -30,7 +30,7 @@ class AssetService extends base_service_1.BaseService {
30
30
  }
31
31
  /**
32
32
  * Create Asset Class
33
- * Create Asset Class To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A Kelvin Asset Class is linked to an entity type which defines how the Kelvin Asset will be referenced in Kelvin Assets. for example: Kelvin Assets that is defined as a Group can only be linked to a Kelvin Type and Kelvin Class that is saved as entity type **group**. There are five entity types; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these entity types and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. **Permission Required:** `kelvin.permission.asset_class.create`
33
+ * Create Asset Class To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> is linked to an <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> which defines how the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> will be referenced in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. For example: <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> that is defined as a Group can only be linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> that is saved as <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> **group**. There are five <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. A <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> is directly linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. There can be many <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> linked to one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. **Permission Required:** `kelvin.permission.asset_class.create`
34
34
  * @param assetClass Asset Class Create Parameters
35
35
  * @param {IKvHttpRequestOptions} options Request optional parameters
36
36
  */
@@ -43,41 +43,9 @@ class AssetService extends base_service_1.BaseService {
43
43
  requestConfig.options = options;
44
44
  return this.request(`/assets/class/create`, requestConfig, models_1.AssetClass);
45
45
  }
46
- /**
47
- * Create Asset OEE
48
- * Create Asset OEE **Permission Required:** `kelvin.permission.asset.create`
49
- * @param assetsOee Asset OEE create schema
50
- * @param assetName Asset name
51
- * @param {IKvHttpRequestOptions} options Request optional parameters
52
- */
53
- static createAssetOEE({ assetsOee, assetName }, options) {
54
- const requestConfig = {
55
- method: 'post'
56
- };
57
- requestConfig.data = assetsOee;
58
- requestConfig.mediaType = 'application/json';
59
- requestConfig.options = options;
60
- return this.request(`/assets/${encodeURIComponent(String(assetName))}/oee/create`, requestConfig, models_1.AssetOEE);
61
- }
62
- /**
63
- * Create Asset Shift
64
- * Create Asset Shift **Permission Required:** `kelvin.permission.asset.create`
65
- * @param assetShift Asset Shift create schema
66
- * @param assetName Asset name
67
- * @param {IKvHttpRequestOptions} options Request optional parameters
68
- */
69
- static createAssetShift({ assetShift, assetName }, options) {
70
- const requestConfig = {
71
- method: 'post'
72
- };
73
- requestConfig.data = assetShift;
74
- requestConfig.mediaType = 'application/json';
75
- requestConfig.options = options;
76
- return this.request(`/assets/${encodeURIComponent(String(assetName))}/shift/create`, requestConfig, models_1.AssetShift);
77
- }
78
46
  /**
79
47
  * Create Asset Template
80
- * Create Asset Template **Permission Required:** `kelvin.permission.asset.create`
48
+ * Create Asset Template Create a custom <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/asset-groups' target='_blank'>Kelvin Group</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> template with a full <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Assets</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a>. For each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>, this template can also create all the parameters for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/' target='_blank'>Kelvin Failure Detection AI</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> and visualization information for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/' target='_blank'>Kelvin Maps</a> **Permission Required:** `kelvin.permission.asset.create`
81
49
  * @param assetTemplate Asset Template create schema
82
50
  * @param {IKvHttpRequestOptions} options Request optional parameters
83
51
  */
@@ -92,8 +60,8 @@ class AssetService extends base_service_1.BaseService {
92
60
  }
93
61
  /**
94
62
  * Create Asset Type
95
- * Create Asset Type To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> is linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. You can have many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> linked to a single <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> is directly linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. There can be many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> linked to one <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. **Permission Required:** `kelvin.permission.asset_type.create`
96
- * @param assettype AssetType create schema
63
+ * Create Asset Type To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> is linked to an <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> which defines how the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> will be referenced in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. For example: <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> that is defined as a Group can only be linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> that is saved as <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> **group**. There are five <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. A <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> is directly linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. There can be many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> linked to one <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. **Permission Required:** `kelvin.permission.asset_type.create`
64
+ * @param assettype Asset Type create schema
97
65
  * @param {IKvHttpRequestOptions} options Request optional parameters
98
66
  */
99
67
  static createAssetType({ assettype }, options) {
@@ -107,8 +75,8 @@ class AssetService extends base_service_1.BaseService {
107
75
  }
108
76
  /**
109
77
  * Create Asset Type Metadata
110
- * Create Asset Type Metadata Creates a custom JSON payload that can be attached to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. You can create multiple different types of metadata payloads for each <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a>. When performing a `get` or `list` API request on <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> or <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> then you can also add a metadata parameter to return this custom information for your own use. This metadata does not affect the operation of the Kelvin Platform. **Permission Required:** `kelvin.permission.asset_type.create`
111
- * @param assetTypeName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> to attach the metadata to.
78
+ * Create Asset Type Metadata Creates a custom JSON payload that can be attached to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. You can create multiple different types of metadata payloads for each <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a>. When performing a `get` or `list` API request on <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> or <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> then you can also add a metadata parameter. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payload will then be embedded in the response. For listing <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> you can also perform filters on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payload to only return <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> with <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payload parameters matching the filters. This <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> does not affect the operations of <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> on the Kelvin Platform. <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> is not available in the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-manager-ui\" target=\"_blank\">Kelvin Manager UI</a>. **Permission Required:** `kelvin.permission.asset_type.create`
79
+ * @param assetTypeName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> to attach the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> to.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
112
80
  * @param assettypemetadata Asset Type Metadata create schema
113
81
  * @param {IKvHttpRequestOptions} options Request optional parameters
114
82
  */
@@ -123,8 +91,8 @@ class AssetService extends base_service_1.BaseService {
123
91
  }
124
92
  /**
125
93
  * Delete Asset
126
- * Delete Asset **Permission Required:** `kelvin.permission.asset.delete`
127
- * @param assetName Asset name
94
+ * Delete Asset Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. This cannot be undone once the API request has been submitted. <span style=\"color: #ff0000;font-weight: bold;\">WARNING</span> : This command will also delete any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that are in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> being deleted. For example; if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> has also two <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a> and one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> linked in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>, when deleting the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>, the two <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a> and one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> will also be automatically deleted. If you delete one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a>, then the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>, and the remaining <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> will still remain active as long as they are not positioned below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. **Permission Required:** `kelvin.permission.asset.delete`
95
+ * @param assetName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
128
96
  * @param {IKvHttpRequestOptions} options Request optional parameters
129
97
  */
130
98
  static deleteAsset({ assetName }, options) {
@@ -138,7 +106,7 @@ class AssetService extends base_service_1.BaseService {
138
106
  /**
139
107
  * Delete Asset Class
140
108
  * Delete Asset Class Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. This cannot be undone once the API request has been submitted. This command can not delete <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a> that are currently linked to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> and will return an error 403. **Permission Required:** `kelvin.permission.asset_class.delete`
141
- * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.
109
+ * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
142
110
  * @param {IKvHttpRequestOptions} options Request optional parameters
143
111
  */
144
112
  static deleteAssetClass({ assetClassName }, options) {
@@ -151,8 +119,8 @@ class AssetService extends base_service_1.BaseService {
151
119
  }
152
120
  /**
153
121
  * Delete Asset Template
154
- * Delete Asset Template **Permission Required:** `kelvin.permission.asset.delete`
155
- * @param assetTemplateName Asset Template Name
122
+ * Delete Asset Template Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>. This cannot be undone once the API request has been submitted. **Permission Required:** `kelvin.permission.asset.delete`
123
+ * @param assetTemplateName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>.
156
124
  * @param {IKvHttpRequestOptions} options Request optional parameters
157
125
  */
158
126
  static deleteAssetTemplate({ assetTemplateName }, options) {
@@ -165,8 +133,8 @@ class AssetService extends base_service_1.BaseService {
165
133
  }
166
134
  /**
167
135
  * Delete Asset Type
168
- * Delete Asset Type **Permission Required:** `kelvin.permission.asset_type.delete`
169
- * @param assetTypeName Asset Type name
136
+ * Delete Asset Type Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. This cannot be undone once the API request has been submitted. This command can not delete <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> that are currently linked to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and will return an error 403. **Permission Required:** `kelvin.permission.asset_type.delete`
137
+ * @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.
170
138
  * @param {IKvHttpRequestOptions} options Request optional parameters
171
139
  */
172
140
  static deleteAssetType({ assetTypeName }, options) {
@@ -179,9 +147,9 @@ class AssetService extends base_service_1.BaseService {
179
147
  }
180
148
  /**
181
149
  * Delete Asset Type Metadata
182
- * Delete Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.delete`
183
- * @param assetTypeName Asset Type name
184
- * @param assetTypeMetadataName Asset Type Metadata name
150
+ * Delete Asset Type Metadata Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object associated with a specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. This cannot be undone once the API request has been submitted. This will only delete the specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. If there is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object with the same name and payload BUT associated with a different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, this will not be deleted. **Permission Required:** `kelvin.permission.asset_type.delete`
151
+ * @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
152
+ * @param assetTypeMetadataName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> unique identifier name to delete.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
185
153
  * @param {IKvHttpRequestOptions} options Request optional parameters
186
154
  */
187
155
  static deleteAssetTypeMetadata({ assetTypeName, assetTypeMetadataName }, options) {
@@ -194,9 +162,9 @@ class AssetService extends base_service_1.BaseService {
194
162
  }
195
163
  /**
196
164
  * Get Asset
197
- * Get Asset **Permission Required:** `kelvin.permission.asset.read`
198
- * @param assetName Asset name
199
- * @param metadata Inject metadata into the response
165
+ * Get Asset Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> and all children <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in it's <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. **Permission Required:** `kelvin.permission.asset.read`
166
+ * @param assetName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
167
+ * @param metadata Array of Kelvin Asset Type Metadata names. Kelvin Asset Type Metadata payload(s) of the names provided will be attached to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> response object that are linked to any of the Kelvin Asset Type Metadata name(s) in this list.</p> The relationship between <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> and Kelvin Asset Type Metadata objects is via the common link to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.
200
168
  * @param {IKvHttpRequestOptions} options Request optional parameters
201
169
  */
202
170
  static getAsset({ assetName, metadata }, options) {
@@ -215,7 +183,7 @@ class AssetService extends base_service_1.BaseService {
215
183
  /**
216
184
  * Get Asset Class
217
185
  * Get Asset Class Retrieves the properties of a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. **Permission Required:** `kelvin.permission.asset_class.read`
218
- * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.
186
+ * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
219
187
  * @param {IKvHttpRequestOptions} options Request optional parameters
220
188
  */
221
189
  static getAssetClass({ assetClassName }, options) {
@@ -228,7 +196,7 @@ class AssetService extends base_service_1.BaseService {
228
196
  }
229
197
  /**
230
198
  * Get Asset Hierarchies
231
- * Get Asset Hierarchies **Permission Required:** `kelvin.permission.asset.read`
199
+ * Get Asset Hierarchies Retrieve a full list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> stored on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. The list will contain all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> information inclusive of their <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. There are no options to filter the list, so this list can get very big if there are large numbers of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> present on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. **Permission Required:** `kelvin.permission.asset.read`
232
200
  * @param {IKvHttpRequestOptions} options Request optional parameters
233
201
  */
234
202
  static getAssetHierarchies(options) {
@@ -241,10 +209,10 @@ class AssetService extends base_service_1.BaseService {
241
209
  }
242
210
  /**
243
211
  * Get Asset Hierarchy
244
- * Get Asset Hierarchy **Permission Required:** `kelvin.permission.asset.read`
245
- * @param assetName Asset name
246
- * @param entityTypeDepth Sets the start entity type depth in which the hierarchy is returned.
247
- * @param assetTypeDepth Sets the start asset type depth in which the hierarchy is returned. Only valid when entity_type_depth = group
212
+ * Get Asset Hierarchy Retrieve a full list of one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and it's <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> stored on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. **Permission Required:** `kelvin.permission.asset.read`
213
+ * @param assetName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> to retrieve the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
214
+ * @param entityTypeDepth Sets the start entity type depth in which the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> is returned.
215
+ * @param assetTypeDepth Sets the start asset type depth in which the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> is returned. Only valid when entity_type_depth = group
248
216
  * @param {IKvHttpRequestOptions} options Request optional parameters
249
217
  */
250
218
  static getAssetHierarchy({ assetName, entityTypeDepth, assetTypeDepth }, options) {
@@ -267,7 +235,7 @@ class AssetService extends base_service_1.BaseService {
267
235
  * Get Asset OEE
268
236
  * Get Asset OEE **Permission Required:** `kelvin.permission.asset.read`
269
237
  * @param assetNames Asset OEE get schema
270
- * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
238
+ * @param timestamp Timestamp to search for specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> related <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#performance-details' target='_blank'>OEE</a> values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision).</p> If no timestamp is given in the query or body parameters, then the current time will be selected.
271
239
  * @param {IKvHttpRequestOptions} options Request optional parameters
272
240
  */
273
241
  static getAssetOEE({ assetNames, timestamp }, options) {
@@ -284,36 +252,15 @@ class AssetService extends base_service_1.BaseService {
284
252
  requestConfig.options = options;
285
253
  return this.request(`/assets/oee/get`, requestConfig, models_1.AssetOEE);
286
254
  }
287
- /**
288
- * Get Asset Shift
289
- * Get Asset Shift **Permission Required:** `kelvin.permission.asset.read`
290
- * @param assetNames Asset Shift get schema
291
- * @param timestamp Timestamp to search for specific Shift information for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
292
- * @param {IKvHttpRequestOptions} options Request optional parameters
293
- */
294
- static getAssetShift({ assetNames, timestamp }, options) {
295
- const requestConfig = {
296
- method: 'post'
297
- };
298
- const queryParameters = {};
299
- if (timestamp != null) {
300
- queryParameters['timestamp'] = timestamp;
301
- }
302
- requestConfig.params = queryParameters;
303
- requestConfig.data = assetNames;
304
- requestConfig.mediaType = 'application/json';
305
- requestConfig.options = options;
306
- return this.request(`/assets/shift/get`, requestConfig, models_1.AssetShift);
307
- }
308
255
  /**
309
256
  * Get Asset Statistics
310
- * Get Asset Statistics **Pagination Sortable Columns:** `asset.name`, `asset.asset_type_name`, `asset.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
257
+ * Get Asset Statistics Returns a list of the requested <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> with details on the failure quotient, number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (children) and the current OEE calculations. **Pagination Sortable Columns:** `asset.name`, `asset.asset_type_name`, `asset.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
311
258
  * @param asset Asset statistics schema
312
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
313
- * @param startingAfter Lower bound cursor for use in pagination
314
- * @param endingBefore Upper bound cursor for use in pagination
315
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
316
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
259
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> Statistic objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset Statistic objects.
260
+ * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> statistics in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
261
+ * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> statistics in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
262
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> parameters. Only one parameter can be selected.</p> There are three parameter options; `asset.name`, `asset.asset_type_name` and `asset.device_type_name`.</p> The default is `asset.name`
263
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
317
264
  * @param {IKvHttpRequestOptions} options Request optional parameters
318
265
  */
319
266
  static getAssetStatistics({ asset, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
@@ -344,7 +291,7 @@ class AssetService extends base_service_1.BaseService {
344
291
  }
345
292
  /**
346
293
  * Get Asset Status Count
347
- * Get Asset Status Count **Permission Required:** `kelvin.permission.asset.read`
294
+ * Get Asset Status Count Summary total count of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> into four statuses. There are four status (state) values that can be returned; `online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all online and receiving information, `offline` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all offline, `partially_online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and some assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are online and receiving information and `unknown` where the status (state) has never received any data to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> and/or is not declared on any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> as a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair. **Permission Required:** `kelvin.permission.asset.read`
348
295
  * @param {IKvHttpRequestOptions} options Request optional parameters
349
296
  */
350
297
  static getAssetStatusCount(options) {
@@ -357,7 +304,7 @@ class AssetService extends base_service_1.BaseService {
357
304
  }
358
305
  /**
359
306
  * Get Asset Statuses
360
- * Get Asset Statuses **Permission Required:** `kelvin.permission.asset.read`
307
+ * Get Asset Statuses Returns a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and the current status (state). There are four status (state) values that can be returned; `online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all online and receiving information, `offline` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and all assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are all offline, `partially_online` where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and some assets below in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (if applicable) are online and receiving information and `unknown` where the status (state) has never received any data to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> and/or is not declared on any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> as a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair. **Permission Required:** `kelvin.permission.asset.read`
361
308
  * @param {IKvHttpRequestOptions} options Request optional parameters
362
309
  */
363
310
  static getAssetStatuses(options) {
@@ -370,8 +317,8 @@ class AssetService extends base_service_1.BaseService {
370
317
  }
371
318
  /**
372
319
  * Get Asset Template
373
- * Get Asset Template **Permission Required:** `kelvin.permission.asset.read`
374
- * @param assetTemplateName Asset Template Name
320
+ * Get Asset Template Retrieves the properties of a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>. **Permission Required:** `kelvin.permission.asset.read`
321
+ * @param assetTemplateName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
375
322
  * @param {IKvHttpRequestOptions} options Request optional parameters
376
323
  */
377
324
  static getAssetTemplate({ assetTemplateName }, options) {
@@ -384,9 +331,9 @@ class AssetService extends base_service_1.BaseService {
384
331
  }
385
332
  /**
386
333
  * Get Asset Type
387
- * Get Asset Type **Permission Required:** `kelvin.permission.asset_type.read`
388
- * @param assetTypeName Asset Type name
389
- * @param metadata Inject metadata into the response
334
+ * Get Asset Type Retrieves the properties of a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. **Permission Required:** `kelvin.permission.asset_type.read`
335
+ * @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
336
+ * @param metadata Array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> names. If the metadata name exists for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, then the payload for the metadata name will be attached in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> response object.</p> <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects are created using the API endpoint `/assets/types/{asset_type_name}/metadata/` and is linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. The same name can be used for different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> for easy filtering across multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.
390
337
  * @param {IKvHttpRequestOptions} options Request optional parameters
391
338
  */
392
339
  static getAssetType({ assetTypeName, metadata }, options) {
@@ -404,9 +351,9 @@ class AssetService extends base_service_1.BaseService {
404
351
  }
405
352
  /**
406
353
  * Get Asset Type Metadata
407
- * Get Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.read`
408
- * @param assetTypeName Asset Type name
409
- * @param assetTypeMetadataName Asset Type Metadata name
354
+ * Get Asset Type Metadata Retrieves the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object associated with a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. This will only retrieve the specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. If there is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object with the same name and payload BUT associated with a different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, this will not be retrieved. **Permission Required:** `kelvin.permission.asset_type.read`
355
+ * @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
356
+ * @param assetTypeMetadataName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> unique identifier name to retrieve.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
410
357
  * @param {IKvHttpRequestOptions} options Request optional parameters
411
358
  */
412
359
  static getAssetTypeMetadata({ assetTypeName, assetTypeMetadataName }, options) {
@@ -419,22 +366,23 @@ class AssetService extends base_service_1.BaseService {
419
366
  }
420
367
  /**
421
368
  * List Asset
422
- * List Asset **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.name`, `asset_type.title`, `status_state`, `status_last_seen` **Permission Required:** `kelvin.permission.asset.read`
423
- * @param search Search assets by name or title
424
- * @param names Filter assets matching a list of names
425
- * @param assetTypeName Filter assets by asset type
426
- * @param statusState Filter assets by status state [`online`, `offline`, `partially_online`, `unknown`]
427
- * @param entityTypeName Filter assets by entity type. Prefix any `entity_type_name` with the character `!` for a NOT operation
428
- * @param propertiesFilter Filter assets that have an property.name = property.value. Format `property_name=property_value`
429
- * @param properties Only return specific properties (default: return all properties): Format `property_name`
430
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
431
- * @param startingAfter Lower bound cursor for use in pagination
432
- * @param endingBefore Upper bound cursor for use in pagination
433
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
434
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
435
- * @param {IKvHttpRequestOptions} options Request optional parameters
436
- */
437
- static listAsset({ search, names, assetTypeName, statusState, entityTypeName, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
369
+ * List Asset Returns a dictionary with a data property containing a filtered array of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> are categorized by entity types and, unless specified, all entity types are included in the filter. There are five entity types; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these entity types and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>. **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.name`, `asset_type.title`, `status_state`, `status_last_seen` **Permission Required:** `kelvin.permission.asset.read`
370
+ * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> name or display name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
371
+ * @param names Filter on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> parameter `name`. This is given as an array, for example `[pump,fan]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
372
+ * @param assetTypeName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
373
+ * @param statusState Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> by its current status. Multiple parameters can be given in an array, for example `[online,partially_online]` and will be filtered as `OR`.</p> There are four parameter options; `online`, `offline`, `partially_online` and `unknown`.
374
+ * @param entityTypeName Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
375
+ * @param map Filter for assets that belong to the map
376
+ * @param propertiesFilter Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that contain a property with a specified value. The property must be declared using its `name` and not its `title` (Display Name). Multiple properties or multiple values can be filtered within this array. For example `[demo_property=demo_value]` or `[demo_property_1=demo_value,demo_property_2=88]`.</p> All values to be filtered must be an exact match and is case sensitive. Also there must be no spaces before or after the equal sign.</p> For example; `[demo_property=88]` is accepted but `[demo_property = 88]` will cause a 400 error.
377
+ * @param properties Only returns specified properties in each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>.</p> This does not filter the array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> returned, only filters the properties in each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. If the property does not exist in a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>, then the properties parameter is returned with no contents. If this is the only parameter used, then all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> will be returned.</p> The default is to return all properties for each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>.
378
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> objects.
379
+ * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
380
+ * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
381
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are eight parameter options; `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.name`, `asset_type.title`, `status_state` and `status_last_seen`.</p> The default is `asset.name`
382
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
383
+ * @param {IKvHttpRequestOptions} options Request optional parameters
384
+ */
385
+ static listAsset({ search, names, assetTypeName, statusState, entityTypeName, map, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
438
386
  const requestConfig = {
439
387
  method: 'get'
440
388
  };
@@ -454,6 +402,9 @@ class AssetService extends base_service_1.BaseService {
454
402
  if (entityTypeName != null) {
455
403
  queryParameters['entity_type_name'] = entityTypeName;
456
404
  }
405
+ if (map != null) {
406
+ queryParameters['map'] = map;
407
+ }
457
408
  if (propertiesFilter != null) {
458
409
  queryParameters['properties_filter'] = propertiesFilter;
459
410
  }
@@ -482,15 +433,15 @@ class AssetService extends base_service_1.BaseService {
482
433
  }
483
434
  /**
484
435
  * List Asset Class
485
- * List Asset Class Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> on the Kelvin Platform. If no query parameters are given with the API request, then the defaults will be used to return the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> list. The defaults are the first 20 <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_class.read`
486
- * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Class name is centrifugal_pump, then a match will be made if the search string is `pum` or `FUGaL`.
487
- * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> objects to be returned. Page size can be between 1 and 1000. The default is 20 Kelvin Asset Class objects.
436
+ * List Asset Class Returns a filtered dictionary with a data object containing an array of <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> objects on the Kelvin Platform that meet the criteria of any parameters passed with the API request. If no query parameters are given with the API request, then the defaults will be used to return the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> list. The defaults are the first 20 <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classe</a> objects returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_class.read`
437
+ * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
438
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> objects.
488
439
  * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
489
440
  * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
490
- * @param sortBy Sort the results by one of the Kelvin Asset Class parameters. Only one parameter can be selected.</p> There are six parameter options; `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner` and `asset_class.device_type_name`. The default is `asset_class.name`
491
- * @param sortAsc Sorting order for the results.</p> There are two options; `true` (ascending order) and `false` (descending order). The default is true (ascending).
492
- * @param owner Filter Kelvin Asset Class by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin asset class).
493
- * @param entityTypeName Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
441
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> parameters. Only one parameter can be selected.</p> There are six parameter options; `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner` and `asset_class.device_type_name`.</p> The default is `asset_class.name`
442
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
443
+ * @param owner Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>).</p> The default will select all owner options.
444
+ * @param entityTypeName Filter and return the results of one or more of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a> name options.</p>
494
445
  * @param {IKvHttpRequestOptions} options Request optional parameters
495
446
  */
496
447
  static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
@@ -529,17 +480,17 @@ class AssetService extends base_service_1.BaseService {
529
480
  }
530
481
  /**
531
482
  * List Asset Data Streams
532
- * List Asset Data Streams **Pagination Sortable Columns:** `datastream.asset_name`, `datastream.metric_name` **Permission Required:** `kelvin.permission.asset.read`
483
+ * List Asset Data Streams Returns an array of dictionary objects with all the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pairs for the requested <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. If the optional `include_asset_children` in the request body is true, then the returned dictionary will also filter for all children <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> below the `asset_name`. **Pagination Sortable Columns:** `datastream.asset_name`, `datastream.metric_name` **Permission Required:** `kelvin.permission.asset.read`
484
+ * @param assetName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
533
485
  * @param assetDatastreams Asset Data Streams list schema
534
- * @param assetName Asset name
535
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
536
- * @param startingAfter Lower bound cursor for use in pagination
537
- * @param endingBefore Upper bound cursor for use in pagination
538
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
539
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
486
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset/Kelvin Metric pair objects.
487
+ * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
488
+ * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
489
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects. Only one parameter can be selected.</p> There are two parameter options; `datastream.asset_name` and `datastream.metric_name`.</p> The default is `datastream.asset_name`
490
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
540
491
  * @param {IKvHttpRequestOptions} options Request optional parameters
541
492
  */
542
- static listAssetDataStreams({ assetDatastreams, assetName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
493
+ static listAssetDataStreams({ assetName, assetDatastreams, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
543
494
  const requestConfig = {
544
495
  method: 'post'
545
496
  };
@@ -567,17 +518,17 @@ class AssetService extends base_service_1.BaseService {
567
518
  }
568
519
  /**
569
520
  * List Asset Template
570
- * List Asset Template **Pagination Sortable Columns:** `asset_template.name`, `asset_template.title`, `asset_template.created`, `asset_template.updated`, `asset_template.asset_type_name`, `asset_template.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
571
- * @param search Search Asset Template by name or title
572
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
573
- * @param startingAfter Lower bound cursor for use in pagination
574
- * @param endingBefore Upper bound cursor for use in pagination
575
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
576
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
577
- * @param assetTypeNames Asset Type Names
578
- * @param entityTypeNames Entity Type Names. Prefix any `entity_type_name` with the character `!` for a NOT operation
579
- * @param assetClassNames Asset Class Names
580
- * @param owner Owner
521
+ * List Asset Template Returns a dictionary with a data property containing a filtered array of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Templates</a> objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. **Pagination Sortable Columns:** `asset_template.name`, `asset_template.title`, `asset_template.created`, `asset_template.updated`, `asset_template.asset_type_name`, `asset_template.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
522
+ * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Type name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
523
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Template objects.
524
+ * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
525
+ * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
526
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> parameters. Only one parameter can be selected.</p> There are six parameter options; `asset_template.name`, `asset_template.title`, `asset_template.created`, `asset_template.updated`, `asset_template.asset_type_name` and `asset_template.device_type_name`.</p> The default is `asset_template.name`
527
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
528
+ * @param assetTypeNames Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end). For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
529
+ * @param entityTypeNames Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
530
+ * @param assetClassNames Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end). For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
531
+ * @param owner Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Templates</a> by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin).
581
532
  * @param {IKvHttpRequestOptions} options Request optional parameters
582
533
  */
583
534
  static listAssetTemplate({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, assetTypeNames, entityTypeNames, assetClassNames, owner } = {}, options) {
@@ -622,18 +573,18 @@ class AssetService extends base_service_1.BaseService {
622
573
  }
623
574
  /**
624
575
  * List Asset Type
625
- * List Asset Type Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> on the Kelvin Platform. If no query parameters are given with the API request, then the defaults will be used to return the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> list. The defaults are the first 20 <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_type.owner`, `asset_class.name`, `asset_class.title`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_type.read`
626
- * @param search Search asset type by name or title
627
- * @param assetClassName Filter asset type by asset class
628
- * @param metadata Inject metadata into the response
629
- * @param metadataFilter Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>
630
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
631
- * @param startingAfter Lower bound cursor for use in pagination
632
- * @param endingBefore Upper bound cursor for use in pagination
633
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
634
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
635
- * @param owner Filter Asset Class by owner. Possible Values: kelvin/custom
636
- * @param entityTypeName Filter by asset class entity type Name. Prefix any `entity_type_name` with the character `!` for a NOT operation
576
+ * List Asset Type Returns a filtered dictionary with a data object containing an array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> objects on the Kelvin Platform that meet the criteria of any parameters passed with the API request. If no query parameters are given with the API request, then the defaults will be used to return the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> list. The defaults are the first 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> objects returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`, `asset_class.device_type_name` **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_type.owner`, `asset_class.name`, `asset_class.title`, `asset_class.device_type_name` **Permission Required:** `kelvin.permission.asset_type.read`
577
+ * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Type name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
578
+ * @param assetClassName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> by its name. This is given as an array, for example `[pump,fan]`.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end). For example a search with `[pump,fan]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
579
+ * @param metadata Array of Kelvin Asset Type Metadata names. Kelvin Asset Type Metadata payload(s) will be attached to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> that are linked to any of the Kelvin Asset Type Metadata name(s) in this list.
580
+ * @param metadataFilter Array of Kelvin Asset Type Metadata filter options to perform on the Kelvin Asset Type Metadata payload.</p> Each filter takes the format `<metadata_name>.<payload_key>=<wanted_filtered_value>`. An example of two filters is `[metadata-test1.key1=String1,metadata-test2.key2=88]`.</p> Any JSON keys with string values are case sensitive.</p> Multiple JSON key filters in the array from the same Kelvin Asset Type Metadata object will be filtered as `OR`. For example; if Kelvin Asset Type Metadata name `metadata-test` has two key parameters `'key1': 'String1'` and `'key2': 25`, then a metadata_filter `[metadata-test.key1=String1,metadata-test.key2=88]` will return results as one of the two values match in the same Kelvin Asset Type Metadata object.</p> Multiple JSON key filters in the array from different Kelvin Asset Type Metadata objects will be filtered as `AND`. For example; if Kelvin Asset Type Metadata name `metadata-test1` has a key/value pair `'key1': 'String1'` and Kelvin Asset Type Metadata name `metadata-test2` has a key/value pair`'key2': 25`, then a metadata_filter `[metadata-test1.key1=String1,metadata-test2.key2=88]` will <strong>NOT</strong> return results as one of the two key/value pairs from different Kelvin Asset Type Metadata objects does not match.
581
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset Type objects.
582
+ * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
583
+ * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
584
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> parameters. Only one parameter can be selected.</p> There are eight parameter options; `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_class.name`, `asset_class.title`, `asset_type.owner` and `asset_class.device_type_name`.</p> The default is `asset_type.name`
585
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
586
+ * @param owner Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin asset type).</p> The default will select all owner options.
587
+ * @param entityTypeName Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
637
588
  * @param {IKvHttpRequestOptions} options Request optional parameters
638
589
  */
639
590
  static listAssetType({ search, assetClassName, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
@@ -681,14 +632,14 @@ class AssetService extends base_service_1.BaseService {
681
632
  }
682
633
  /**
683
634
  * List Asset Type Metadata
684
- * List Asset Type Metadata **Pagination Sortable Columns:** `asset_type_metadata.name` **Permission Required:** `kelvin.permission.asset_type.read`
685
- * @param assetTypeName Asset Type name
686
- * @param search Search Asset Type Metadata by name
687
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
688
- * @param startingAfter Lower bound cursor for use in pagination
689
- * @param endingBefore Upper bound cursor for use in pagination
690
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
691
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
635
+ * List Asset Type Metadata Returns a filtered list of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects linked with a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. The path parameter is required but the query parameters are optional. If no query parameters are given with the API request, then the defaults will be used to return the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> list. The defaults are the first 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> returned in alphabetical order by the unique identifier name. **Pagination Sortable Columns:** `asset_type_metadata.name` **Permission Required:** `kelvin.permission.asset_type.read`
636
+ * @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> payloads are stored.</p> The search is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space.). For example a search with the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name `big-pump` will return all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> associated with the name `big-pump` but not with the names `pump` or `big-pump-machine`.
637
+ * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects list. Only the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Type name is centrifugal_pump, then a match will be made if the search string is `pum` or `FUGaL`.
638
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects to be returned. Page size can be between 1 and 1000 objects. The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects.
639
+ * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
640
+ * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> objects in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
641
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> parameters. Only one parameter can be selected.</p> There in only one parameter option; `asset_type_metadata.name`
642
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order). The default is `true` (ascending).
692
643
  * @param {IKvHttpRequestOptions} options Request optional parameters
693
644
  */
694
645
  static listAssetTypeMetadata({ assetTypeName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
@@ -720,18 +671,17 @@ class AssetService extends base_service_1.BaseService {
720
671
  return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/list`, requestConfig, models_1.AssetTypeMetadataListPaginated);
721
672
  }
722
673
  /**
723
- * List Site Hierarchy Overview
724
- * List Site Hierarchy Overview **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.failure_quotient`, `asset_type.title` **Permission Required:** `kelvin.permission.asset.read`
725
- * @param asset Site Hierarchy Overview schema
726
- * @param siteName Site name
727
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
728
- * @param startingAfter Lower bound cursor for use in pagination
729
- * @param endingBefore Upper bound cursor for use in pagination
730
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
731
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
674
+ * List Failure Overview
675
+ * List Failure Overview Returns a dictionary with a data property containing an array of failure overview summaries for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> objects that have failures recorded on the Kelvin Platform based on the filter requirements in the body parameters. This will summarize all failures on <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> and give the failure quotient per <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>. **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.failure_quotient`, `asset_type.title` **Permission Required:** `kelvin.permission.asset.read`
676
+ * @param asset Failure Overview schema
677
+ * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overview objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset Statistic objects.
678
+ * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overviews in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
679
+ * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overviews in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
680
+ * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overview parameters. Only one parameter can be selected.</p> There are three parameter options; `asset.name`, `asset.title`, `asset.failure_quotient` and `asset_type.title`.</p> The default is `asset.name`
681
+ * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
732
682
  * @param {IKvHttpRequestOptions} options Request optional parameters
733
683
  */
734
- static listSiteHierarchyOverview({ asset, siteName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
684
+ static listFailureOverview({ asset, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
735
685
  const requestConfig = {
736
686
  method: 'post'
737
687
  };
@@ -755,14 +705,14 @@ class AssetService extends base_service_1.BaseService {
755
705
  requestConfig.data = asset;
756
706
  requestConfig.mediaType = 'application/json';
757
707
  requestConfig.options = options;
758
- return this.request(`/assets/${encodeURIComponent(String(siteName))}/site-hierarchy-overview/list`, requestConfig, models_1.SiteHierarchyOverviewPaginated);
708
+ return this.request(`/assets/failure-overview/list`, requestConfig, models_1.FailureOverviewPaginated);
759
709
  }
760
710
  /**
761
711
  * Update Asset
762
- * Update Asset **Permission Required:** `kelvin.permission.asset.update`
712
+ * Update Asset Update an existing <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> with any new values passed through the body parameters. With the same API request you can also include updates to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that are in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. It is only possible to edit starting from either a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>. It is not possible to directly edit <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a>. To edit a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Part</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a>, the body parameters must start with either the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> higher up in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. The only exception is if the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> is below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, the body parameters can start at the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> level and ignore the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>. The minimum required in the body parameters is the top level `title`. If this body parameter does not need to be changed, it should still have the original Display Name (title) given. Any other body parameters that are not required and not provided will remain unchanged. <span style=\"color: #ff0000;font-weight: bold;\">WARNING</span> : If the `hierarchy` parameter is used, all `components`, `parts` and `sensors` for that next level only must be included in the body parameters with a minimum parameters `name`, `title`, `asset_type_name` and `entity_type_name` given. If any body parameter does not need to be changed, it should still contain the original information. Any other body parameters that are not required and not provided will remain unchanged. <span style=\"color: #ff0000;font-weight: bold;\">Any `components`, `parts` or `sensors` at this level not included will be automatically and permanently deleted.</span>. If in any `components`, `parts` or `sensors` body parameters, the `hierarchy` parameter is not provided, then the `hierarchy` for that particular `components`, `parts` or `sensors` will remain unchanged and not be deleted. **Permission Required:** `kelvin.permission.asset.update`
763
713
  * @param asset Asset update schema
764
- * @param assetName Asset name
765
- * @param dryRun Dry Run
714
+ * @param assetName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> name at the top of the hierarchy. Even if the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> is below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> name be used here.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>.
715
+ * @param dryRun Perform a trial run to update the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> structure without making any changes on the Kelvin Platform.
766
716
  * @param {IKvHttpRequestOptions} options Request optional parameters
767
717
  */
768
718
  static updateAsset({ asset, assetName, dryRun }, options) {
@@ -781,9 +731,9 @@ class AssetService extends base_service_1.BaseService {
781
731
  }
782
732
  /**
783
733
  * Update Asset Class
784
- * Update Asset Class Updates an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with any new values passed through the body parameters.</p> Only the Display Name (title) body parameter is required. If this body parameter does not need to be changed, it should still have the original Display Name (title) given. Any other body parameters that are not required and not provided will remain unchanged.</p> Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> and relink all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> to the new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. **Permission Required:** `kelvin.permission.asset_class.update`
734
+ * Update Asset Class Updates an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with any new values passed through the body parameters. Only the Display Name (title) body parameter is required. If this body parameter does not need to be changed, it should still have the original Display Name (title) given. Any other body parameters that are not required and not provided will remain unchanged. Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> and relink all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> to the new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. **Permission Required:** `kelvin.permission.asset_class.update`
785
735
  * @param assetClass AssetClass update schema
786
- * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to retrieve.</p> This is the unique identifier name and not the display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.
736
+ * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> name to retrieve.</p> This is the unique identifier name and not the display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
787
737
  * @param {IKvHttpRequestOptions} options Request optional parameters
788
738
  */
789
739
  static updateAssetClass({ assetClass, assetClassName }, options) {
@@ -797,9 +747,9 @@ class AssetService extends base_service_1.BaseService {
797
747
  }
798
748
  /**
799
749
  * Update Asset Hierarchies
800
- * Update Asset Hierarchies **Permission Required:** `kelvin.permission.asset.create`
750
+ * Update Asset Hierarchies Update one or many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> in one API request with any new values passed through the body parameters. Any <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> not included in the body parameter will remain unchanged. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of every <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> must be maintained within this structure. This is similar as `/assets/{asset_name}/update` API request except that you can update multiple <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> at the same time and one key difference regarding `hierarchy` that is explains later. Below is an explanation which should apply to all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> given in the body parameter. It is only possible to edit starting from either a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>. It is not possible to directly edit <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Components</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Parts</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</a>. To edit a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#component' target='_blank'>Kelvin Component</a>, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#part' target='_blank'>Kelvin Part</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a>, the body parameters must start with either the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> or a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a> higher up in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. Every <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> must be declared from the highest level. The API request will accept any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> to update without requiring it to be inside the `hierarchy` parameter in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, but if this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> originally is positioned under a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a>, then this structure will be lost and the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> will move to the top of a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. The minimum required in the body parameters is the `name`, `title`, `asset_type_name` and `entity_type_name`. If these body parameters do not need to be changed, it should still contain the original information. Any other body parameters that are not required and not provided will remain unchanged. The only exception to this minimum requirement is when the parameter `delete` is marked as `true`. In this case the only other parameter required is `name`. If deleting any <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> with this method, all children <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> in the `hierarchy` below will also be deleted. <span style=\"color: #ff0000;font-weight: bold;\">WARNING</span> : If the `hierarchy` parameter is used, all `components`, `parts` and `sensors` for only the next level down must be included in the body parameters with a minimum parameters `name`, `title`, `asset_type_name` and `entity_type_name` given. If any body parameter does not need to be changed, it should still contain the original information. Any other body parameters that are not required and not provided will remain unchanged. <span style=\"color: #ff0000;font-weight: bold;\">Any `components`, `parts` or `sensors` and its children items at this level not included will be automatically and permenently deleted.</span>. If in any `components`, `parts` or `sensors` body parameters, the `hierarchy` parameter is not provided, then the `hierarchy` for that particular `components`, `parts` or `sensors` will remain and not be deleted. **Permission Required:** `kelvin.permission.asset.create`
801
751
  * @param hierarchy Asset Hierarchy update schema
802
- * @param dryRun Dry Run
752
+ * @param dryRun Perform a trial run to update the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> structure without making any changes on the Kelvin Platform.
803
753
  * @param {IKvHttpRequestOptions} options Request optional parameters
804
754
  */
805
755
  static updateAssetHierarchies({ hierarchy, dryRun }, options) {
@@ -818,9 +768,9 @@ class AssetService extends base_service_1.BaseService {
818
768
  }
819
769
  /**
820
770
  * Update Asset Template
821
- * Update Asset Template **Permission Required:** `kelvin.permission.asset.update`
771
+ * Update Asset Template Updates an existing Kelvin Template with any new values passed through the body parameters.</p> All body parameters are optional and if not provided will remain unchanged. Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new Kelvin Template with a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> (Hint: To avoid having to type everything in again, you can get the current JSON structure of the Kelvin Template from /assets/templates/{asset_template_name}/get API and then use this as the foundation for a new Kelvin Template). **Permission Required:** `kelvin.permission.asset.update`
822
772
  * @param assetTemplate Asset Template update schema
823
- * @param assetTemplateName Asset Template Name
773
+ * @param assetTemplateName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates' target='_blank'>Kelvin Template</a>.
824
774
  * @param {IKvHttpRequestOptions} options Request optional parameters
825
775
  */
826
776
  static updateAssetTemplate({ assetTemplate, assetTemplateName }, options) {
@@ -834,9 +784,9 @@ class AssetService extends base_service_1.BaseService {
834
784
  }
835
785
  /**
836
786
  * Update Asset Type
837
- * Update Asset Type **Permission Required:** `kelvin.permission.asset_type.update`
787
+ * Update Asset Type Updates an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> with any new values passed through the body parameters.</p> All body parameters are optional and if not provided will remain unchanged.</p> Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> and relink all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> to the new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. **Permission Required:** `kelvin.permission.asset_type.update`
838
788
  * @param assettype AssetType update schema
839
- * @param assetTypeName Asset Type name
789
+ * @param assetTypeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> name to retrieve.</p> This is the unique identifier name and not the display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
840
790
  * @param {IKvHttpRequestOptions} options Request optional parameters
841
791
  */
842
792
  static updateAssetType({ assettype, assetTypeName }, options) {
@@ -850,10 +800,10 @@ class AssetService extends base_service_1.BaseService {
850
800
  }
851
801
  /**
852
802
  * Update Asset Type Metadata
853
- * Update Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.update`
803
+ * Update Asset Type Metadata Updates the payload of an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object associated with a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. The payload will be completely replaced by the new payload. Any existing key/value pairs that you want to keep must be included in your new payload that is sent with the API request. This will only update the payload of the specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>. If there is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object with the same name and payload BUT associated with a different <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a>, this will not be updated. **Permission Required:** `kelvin.permission.asset_type.update`
854
804
  * @param assettypemetadata Asset Type Metadata update schema
855
- * @param assetTypeName Asset Type name
856
- * @param assetTypeMetadataName Asset Type Metadata name
805
+ * @param assetTypeName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> to replace the specified metadata payload.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
806
+ * @param assetTypeMetadataName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> unique identifier name to retrieve.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
857
807
  * @param {IKvHttpRequestOptions} options Request optional parameters
858
808
  */
859
809
  static updateAssetTypeMetadata({ assettypemetadata, assetTypeName, assetTypeMetadataName }, options) {
@@ -867,9 +817,9 @@ class AssetService extends base_service_1.BaseService {
867
817
  }
868
818
  /**
869
819
  * Upload Assets
870
- * Upload Assets **Permission Required:** `kelvin.permission.asset.create`
871
- * @param file CSV File
872
- * @param dryRun If set to true performs only validation
820
+ * Upload Assets Upload a csv (comma-separated values) file with up to 20,000 assets to add as <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> into the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Each row represents one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> can also be created in this file by declaring the parent for each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>. If this field is left blank, then it is assumed to have no parent and will appear at the top of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>. The first row of the csv file needs to be the header of the columns. `DISPLAY NAME,NAME,ASSET TYPE,LATITUDE,LONGITUDE,DIRECT PARENT,ENTITY TYPE`. Details of the options for each column are explained in this <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/assets/assets/#importing-assets-in-bulk' target='_blank'>Kelvin Documentation</a> link. The file needs to be saved in UTF-8 format with a comma separating each field. Do not use other separation options available in Microsoft Excel or Google Sheets such as semi-colons or colons. Strings in the csv file can be with or without quotation marks. **Permission Required:** `kelvin.permission.asset.create`
821
+ * @param file Path and name of the CSV File to upload to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.</p> You can download a blank copy of the template from the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/control-manager-ui-overview/' target='_blank'>Kelvin Manager UI</a>. Instructions can be found in the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/metrics/metrics/#1-download-the-assets-csv-template' target='_blank'>Kelvin Documentation</a>.
822
+ * @param dryRun Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> structure without making any changes on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.
873
823
  * @param {IKvHttpRequestOptions} options Request optional parameters
874
824
  */
875
825
  static uploadAssets({ file, dryRun }, options) {