@kelvininc/js-client-sdk 7.8.1 → 7.9.1

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 (719) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.d.ts +19 -0
  3. package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js +20 -0
  4. package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js.map +1 -0
  5. package/dist/cjs/models/generated/aCPWorkloadManifests.d.ts +3 -0
  6. package/dist/cjs/models/generated/aCPWorkloadManifests.js +2 -0
  7. package/dist/cjs/models/generated/aCPWorkloadManifests.js.map +1 -1
  8. package/dist/cjs/models/generated/asset.d.ts +51 -0
  9. package/dist/cjs/models/generated/asset.js.map +1 -1
  10. package/dist/cjs/models/generated/assetClass.d.ts +21 -0
  11. package/dist/cjs/models/generated/assetClass.js.map +1 -1
  12. package/dist/cjs/models/generated/assetClassItem.d.ts +21 -0
  13. package/dist/cjs/models/generated/assetClassItem.js.map +1 -1
  14. package/dist/cjs/models/generated/assetClassListPaginated.d.ts +3 -0
  15. package/dist/cjs/models/generated/assetClassListPaginated.js.map +1 -1
  16. package/dist/cjs/models/generated/assetDataStreamItem.d.ts +6 -0
  17. package/dist/cjs/models/generated/assetDataStreamItem.js.map +1 -1
  18. package/dist/cjs/models/generated/assetDataStreamsListPaginated.d.ts +3 -0
  19. package/dist/cjs/models/generated/assetDataStreamsListPaginated.js.map +1 -1
  20. package/dist/cjs/models/generated/assetHierarchies.d.ts +3 -0
  21. package/dist/cjs/models/generated/assetHierarchies.js.map +1 -1
  22. package/dist/cjs/models/generated/assetHierarchyItem.d.ts +24 -0
  23. package/dist/cjs/models/generated/assetHierarchyItem.js.map +1 -1
  24. package/dist/cjs/models/generated/assetHierarchyList.d.ts +3 -0
  25. package/dist/cjs/models/generated/assetHierarchyList.js.map +1 -1
  26. package/dist/cjs/models/generated/assetItem.d.ts +33 -0
  27. package/dist/cjs/models/generated/assetItem.js.map +1 -1
  28. package/dist/cjs/models/generated/assetListPaginated.d.ts +3 -0
  29. package/dist/cjs/models/generated/assetListPaginated.js.map +1 -1
  30. package/dist/cjs/models/generated/assetLocationItem.d.ts +6 -0
  31. package/dist/cjs/models/generated/assetLocationItem.js.map +1 -1
  32. package/dist/cjs/models/generated/assetMetricItem.d.ts +6 -0
  33. package/dist/cjs/models/generated/assetMetricItem.js.map +1 -1
  34. package/dist/cjs/models/generated/assetOEE.d.ts +3 -0
  35. package/dist/cjs/models/generated/assetOEE.js.map +1 -1
  36. package/dist/cjs/models/generated/assetProperty.d.ts +9 -0
  37. package/dist/cjs/models/generated/assetProperty.js.map +1 -1
  38. package/dist/cjs/models/generated/assetStatisticsItem.d.ts +24 -0
  39. package/dist/cjs/models/generated/assetStatisticsItem.js.map +1 -1
  40. package/dist/cjs/models/generated/assetStatisticsPaginated.d.ts +3 -0
  41. package/dist/cjs/models/generated/assetStatisticsPaginated.js.map +1 -1
  42. package/dist/cjs/models/generated/assetStatus.d.ts +3 -0
  43. package/dist/cjs/models/generated/assetStatus.js.map +1 -1
  44. package/dist/cjs/models/generated/assetStatusCount.d.ts +15 -0
  45. package/dist/cjs/models/generated/assetStatusCount.js.map +1 -1
  46. package/dist/cjs/models/generated/assetStatusItem.d.ts +6 -0
  47. package/dist/cjs/models/generated/assetStatusItem.js.map +1 -1
  48. package/dist/cjs/models/generated/assetTemplate.d.ts +48 -0
  49. package/dist/cjs/models/generated/assetTemplate.js.map +1 -1
  50. package/dist/cjs/models/generated/assetTemplateHierarchy.d.ts +24 -0
  51. package/dist/cjs/models/generated/assetTemplateHierarchy.js.map +1 -1
  52. package/dist/cjs/models/generated/assetTemplateItem.d.ts +42 -0
  53. package/dist/cjs/models/generated/assetTemplateItem.js.map +1 -1
  54. package/dist/cjs/models/generated/assetTemplateListPaginated.d.ts +3 -0
  55. package/dist/cjs/models/generated/assetTemplateListPaginated.js.map +1 -1
  56. package/dist/cjs/models/generated/assetTemplateProperties.d.ts +9 -0
  57. package/dist/cjs/models/generated/assetTemplateProperties.js.map +1 -1
  58. package/dist/cjs/models/generated/assetType.d.ts +30 -0
  59. package/dist/cjs/models/generated/assetType.js.map +1 -1
  60. package/dist/cjs/models/generated/assetTypeItem.d.ts +30 -0
  61. package/dist/cjs/models/generated/assetTypeItem.js.map +1 -1
  62. package/dist/cjs/models/generated/assetTypeListPaginated.d.ts +3 -0
  63. package/dist/cjs/models/generated/assetTypeListPaginated.js.map +1 -1
  64. package/dist/cjs/models/generated/assetTypeMetadata.d.ts +15 -0
  65. package/dist/cjs/models/generated/assetTypeMetadata.js.map +1 -1
  66. package/dist/cjs/models/generated/assetTypeMetadataItem.d.ts +15 -0
  67. package/dist/cjs/models/generated/assetTypeMetadataItem.js.map +1 -1
  68. package/dist/cjs/models/generated/assetTypeMetadataListPaginated.d.ts +3 -0
  69. package/dist/cjs/models/generated/assetTypeMetadataListPaginated.js.map +1 -1
  70. package/dist/cjs/models/generated/cSVError.d.ts +18 -0
  71. package/dist/cjs/models/generated/cSVError.js.map +1 -1
  72. package/dist/cjs/models/generated/cSVErrorMessage.d.ts +3 -0
  73. package/dist/cjs/models/generated/cSVErrorMessage.js.map +1 -1
  74. package/dist/cjs/models/generated/cSVPosition.d.ts +12 -0
  75. package/dist/cjs/models/generated/cSVPosition.js.map +1 -1
  76. package/dist/cjs/models/generated/controlChange.d.ts +27 -0
  77. package/dist/cjs/models/generated/controlChange.js.map +1 -1
  78. package/dist/cjs/models/generated/controlChangeGet.d.ts +39 -0
  79. package/dist/cjs/models/generated/controlChangeGet.js.map +1 -1
  80. package/dist/cjs/models/generated/controlChangeGetPaginated.d.ts +3 -0
  81. package/dist/cjs/models/generated/controlChangeGetPaginated.js.map +1 -1
  82. package/dist/cjs/models/generated/controlChangeGetStatus.d.ts +12 -0
  83. package/dist/cjs/models/generated/controlChangeGetStatus.js.map +1 -1
  84. package/dist/cjs/models/generated/controlChangePaginated.d.ts +3 -0
  85. package/dist/cjs/models/generated/controlChangePaginated.js.map +1 -1
  86. package/dist/cjs/models/generated/emissionsAsset.d.ts +19 -0
  87. package/dist/cjs/models/generated/emissionsAsset.js +20 -0
  88. package/dist/cjs/models/generated/emissionsAsset.js.map +1 -0
  89. package/dist/cjs/models/generated/emissionsAssetLists.d.ts +22 -0
  90. package/dist/cjs/models/generated/emissionsAssetLists.js +22 -0
  91. package/dist/cjs/models/generated/emissionsAssetLists.js.map +1 -0
  92. package/dist/cjs/models/generated/emissionsDashboard.d.ts +29 -0
  93. package/dist/cjs/models/generated/emissionsDashboard.js +27 -0
  94. package/dist/cjs/models/generated/emissionsDashboard.js.map +1 -0
  95. package/dist/cjs/models/generated/emissionsDashboardAnalytics.d.ts +26 -0
  96. package/dist/cjs/models/generated/emissionsDashboardAnalytics.js +24 -0
  97. package/dist/cjs/models/generated/emissionsDashboardAnalytics.js.map +1 -0
  98. package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.d.ts +25 -0
  99. package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.js +23 -0
  100. package/dist/cjs/models/generated/emissionsDashboardAnalyticsHistorian.js.map +1 -0
  101. package/dist/cjs/models/generated/emissionsDashboardTotals.d.ts +27 -0
  102. package/dist/cjs/models/generated/emissionsDashboardTotals.js +24 -0
  103. package/dist/cjs/models/generated/emissionsDashboardTotals.js.map +1 -0
  104. package/dist/cjs/models/generated/emissionsGreenhouse.d.ts +21 -0
  105. package/dist/cjs/models/generated/emissionsGreenhouse.js +21 -0
  106. package/dist/cjs/models/generated/emissionsGreenhouse.js.map +1 -0
  107. package/dist/cjs/models/generated/errorMessage.d.ts +9 -0
  108. package/dist/cjs/models/generated/errorMessage.js.map +1 -1
  109. package/dist/cjs/models/generated/errorMessages.d.ts +3 -0
  110. package/dist/cjs/models/generated/errorMessages.js.map +1 -1
  111. package/dist/cjs/models/generated/errorsError.d.ts +18 -0
  112. package/dist/cjs/models/generated/errorsError.js.map +1 -1
  113. package/dist/cjs/models/generated/errorsErrorMessage.d.ts +3 -0
  114. package/dist/cjs/models/generated/errorsErrorMessage.js.map +1 -1
  115. package/dist/cjs/models/generated/failureDetection.d.ts +12 -0
  116. package/dist/cjs/models/generated/failureDetection.js.map +1 -1
  117. package/dist/cjs/models/generated/failureDetectionProperty.d.ts +9 -0
  118. package/dist/cjs/models/generated/failureDetectionProperty.js.map +1 -1
  119. package/dist/cjs/models/generated/failureOverviewItem.d.ts +58 -0
  120. package/dist/cjs/models/generated/{siteHierarchyOverviewItem.js → failureOverviewItem.js} +7 -8
  121. package/dist/cjs/models/generated/failureOverviewItem.js.map +1 -0
  122. package/dist/cjs/models/generated/failureOverviewPaginated.d.ts +24 -0
  123. package/dist/cjs/models/generated/failureOverviewPaginated.js +22 -0
  124. package/dist/cjs/models/generated/failureOverviewPaginated.js.map +1 -0
  125. package/dist/cjs/models/generated/failureOverviewStatistics.d.ts +24 -0
  126. package/dist/cjs/models/generated/{siteHierarchyOverviewStatistics.js → failureOverviewStatistics.js} +4 -4
  127. package/dist/cjs/models/generated/failureOverviewStatistics.js.map +1 -0
  128. package/dist/cjs/models/generated/index.d.ts +27 -4
  129. package/dist/cjs/models/generated/index.js +27 -4
  130. package/dist/cjs/models/generated/index.js.map +1 -1
  131. package/dist/cjs/models/generated/mapFailureDetection.d.ts +17 -0
  132. package/dist/cjs/models/generated/mapFailureDetection.js +19 -0
  133. package/dist/cjs/models/generated/mapFailureDetection.js.map +1 -0
  134. package/dist/cjs/models/generated/mapItem.d.ts +9 -6
  135. package/dist/cjs/models/generated/mapItem.js +5 -3
  136. package/dist/cjs/models/generated/mapItem.js.map +1 -1
  137. package/dist/cjs/models/generated/mapModel.d.ts +7 -4
  138. package/dist/cjs/models/generated/mapModel.js +4 -2
  139. package/dist/cjs/models/generated/mapModel.js.map +1 -1
  140. package/dist/cjs/models/generated/mapOEE.d.ts +26 -0
  141. package/dist/cjs/models/generated/mapOEE.js +25 -0
  142. package/dist/cjs/models/generated/mapOEE.js.map +1 -0
  143. package/dist/cjs/models/generated/{assetShift.d.ts → mapShift.d.ts} +5 -5
  144. package/dist/cjs/models/generated/{assetShift.js → mapShift.js} +5 -5
  145. package/dist/cjs/models/generated/mapShift.js.map +1 -0
  146. package/dist/cjs/models/generated/metric.d.ts +30 -0
  147. package/dist/cjs/models/generated/metric.js.map +1 -1
  148. package/dist/cjs/models/generated/metricItem.d.ts +30 -0
  149. package/dist/cjs/models/generated/metricItem.js.map +1 -1
  150. package/dist/cjs/models/generated/metricListPaginated.d.ts +3 -0
  151. package/dist/cjs/models/generated/metricListPaginated.js.map +1 -1
  152. package/dist/cjs/models/generated/oEECalculation.d.ts +15 -0
  153. package/dist/cjs/models/generated/oEECalculation.js.map +1 -1
  154. package/dist/cjs/models/generated/oEEThresholds.d.ts +9 -0
  155. package/dist/cjs/models/generated/oEEThresholds.js.map +1 -1
  156. package/dist/cjs/models/generated/oEEValues.d.ts +12 -0
  157. package/dist/cjs/models/generated/oEEValues.js.map +1 -1
  158. package/dist/cjs/models/generated/pagination.d.ts +9 -0
  159. package/dist/cjs/models/generated/pagination.js.map +1 -1
  160. package/dist/cjs/models/generated/parameterAppVersionAsset.d.ts +29 -0
  161. package/dist/cjs/models/generated/parameterAppVersionAsset.js +25 -0
  162. package/dist/cjs/models/generated/parameterAppVersionAsset.js.map +1 -0
  163. package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.d.ts +21 -0
  164. package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.js +22 -0
  165. package/dist/cjs/models/generated/parameterAppVersionAssetListPaginated.js.map +1 -0
  166. package/dist/cjs/models/generated/parameterGetSchema.d.ts +28 -0
  167. package/dist/cjs/models/generated/parameterGetSchema.js +23 -0
  168. package/dist/cjs/models/generated/parameterGetSchema.js.map +1 -0
  169. package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.d.ts +28 -0
  170. package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.js +23 -0
  171. package/dist/cjs/models/generated/parameterschemaParameterJSONSchema.js.map +1 -0
  172. package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.d.ts +35 -0
  173. package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.js +28 -0
  174. package/dist/cjs/models/generated/parameterschemaParameterJSONSchemaProperties.js.map +1 -0
  175. package/dist/cjs/models/generated/responsibleFor.d.ts +19 -0
  176. package/dist/cjs/models/generated/responsibleFor.js +20 -0
  177. package/dist/cjs/models/generated/responsibleFor.js.map +1 -0
  178. package/dist/cjs/models/generated/rule.d.ts +37 -0
  179. package/dist/cjs/models/generated/rule.js +30 -0
  180. package/dist/cjs/models/generated/rule.js.map +1 -0
  181. package/dist/cjs/models/generated/ruleAction.d.ts +19 -0
  182. package/dist/cjs/models/generated/ruleAction.js +20 -0
  183. package/dist/cjs/models/generated/ruleAction.js.map +1 -0
  184. package/dist/cjs/models/generated/ruleInput.d.ts +19 -0
  185. package/dist/cjs/models/generated/ruleInput.js +20 -0
  186. package/dist/cjs/models/generated/ruleInput.js.map +1 -0
  187. package/dist/cjs/models/generated/ruleLogs.d.ts +17 -0
  188. package/dist/cjs/models/generated/ruleLogs.js +19 -0
  189. package/dist/cjs/models/generated/ruleLogs.js.map +1 -0
  190. package/dist/cjs/models/generated/rulePayload.d.ts +23 -0
  191. package/dist/cjs/models/generated/rulePayload.js +23 -0
  192. package/dist/cjs/models/generated/rulePayload.js.map +1 -0
  193. package/dist/cjs/models/generated/ruleStatus.d.ts +21 -0
  194. package/dist/cjs/models/generated/ruleStatus.js +21 -0
  195. package/dist/cjs/models/generated/ruleStatus.js.map +1 -0
  196. package/dist/cjs/models/generated/rulesListPaginated.d.ts +21 -0
  197. package/dist/cjs/models/generated/rulesListPaginated.js +22 -0
  198. package/dist/cjs/models/generated/rulesListPaginated.js.map +1 -0
  199. package/dist/cjs/models/generated/semanticTypeItem.d.ts +12 -0
  200. package/dist/cjs/models/generated/semanticTypeItem.js.map +1 -1
  201. package/dist/cjs/models/generated/semanticTypeList.d.ts +3 -0
  202. package/dist/cjs/models/generated/semanticTypeList.js.map +1 -1
  203. package/dist/cjs/models/generated/severityStatistics.d.ts +12 -0
  204. package/dist/cjs/models/generated/severityStatistics.js.map +1 -1
  205. package/dist/cjs/models/generated/simpleAsset.d.ts +6 -0
  206. package/dist/cjs/models/generated/simpleAsset.js.map +1 -1
  207. package/dist/cjs/models/generated/statusStatistics.d.ts +9 -0
  208. package/dist/cjs/models/generated/statusStatistics.js.map +1 -1
  209. package/dist/cjs/models/generated/teamMember.d.ts +3 -2
  210. package/dist/cjs/models/generated/teamMember.js +2 -1
  211. package/dist/cjs/models/generated/teamMember.js.map +1 -1
  212. package/dist/cjs/models/generated/view2D.d.ts +9 -0
  213. package/dist/cjs/models/generated/view2D.js.map +1 -1
  214. package/dist/cjs/models/generated/view3D.d.ts +12 -0
  215. package/dist/cjs/models/generated/view3D.js.map +1 -1
  216. package/dist/cjs/services/generated/api/aCP.service.js.map +1 -1
  217. package/dist/cjs/services/generated/api/alarm.service.js.map +1 -1
  218. package/dist/cjs/services/generated/api/appRegistry.service.js.map +1 -1
  219. package/dist/cjs/services/generated/api/asset.service.d.ts +135 -159
  220. package/dist/cjs/services/generated/api/asset.service.js +137 -187
  221. package/dist/cjs/services/generated/api/asset.service.js.map +1 -1
  222. package/dist/cjs/services/generated/api/bridge.service.js.map +1 -1
  223. package/dist/cjs/services/generated/api/controlChange.service.d.ts +31 -31
  224. package/dist/cjs/services/generated/api/controlChange.service.js +31 -31
  225. package/dist/cjs/services/generated/api/controlChange.service.js.map +1 -1
  226. package/dist/cjs/services/generated/api/dataLabel.service.d.ts +8 -1
  227. package/dist/cjs/services/generated/api/dataLabel.service.js +15 -0
  228. package/dist/cjs/services/generated/api/dataLabel.service.js.map +1 -1
  229. package/dist/cjs/services/generated/api/dataType.service.js.map +1 -1
  230. package/dist/cjs/services/generated/api/failureDetection.service.js.map +1 -1
  231. package/dist/cjs/services/generated/api/index.d.ts +3 -0
  232. package/dist/cjs/services/generated/api/index.js +3 -0
  233. package/dist/cjs/services/generated/api/index.js.map +1 -1
  234. package/dist/cjs/services/generated/api/instance.service.js.map +1 -1
  235. package/dist/cjs/services/generated/api/integration.service.js.map +1 -1
  236. package/dist/cjs/services/generated/api/map.service.d.ts +36 -3
  237. package/dist/cjs/services/generated/api/map.service.js +79 -1
  238. package/dist/cjs/services/generated/api/map.service.js.map +1 -1
  239. package/dist/cjs/services/generated/api/metric.service.d.ts +26 -26
  240. package/dist/cjs/services/generated/api/metric.service.js +26 -26
  241. package/dist/cjs/services/generated/api/metric.service.js.map +1 -1
  242. package/dist/cjs/services/generated/api/orchestration.service.js.map +1 -1
  243. package/dist/cjs/services/generated/api/parameters.service.d.ts +42 -0
  244. package/dist/cjs/services/generated/api/parameters.service.js +83 -0
  245. package/dist/cjs/services/generated/api/parameters.service.js.map +1 -0
  246. package/dist/cjs/services/generated/api/rule.service.d.ts +63 -0
  247. package/dist/cjs/services/generated/api/rule.service.js +146 -0
  248. package/dist/cjs/services/generated/api/rule.service.js.map +1 -0
  249. package/dist/cjs/services/generated/api/secret.service.js.map +1 -1
  250. package/dist/cjs/services/generated/api/storage.service.js.map +1 -1
  251. package/dist/cjs/services/generated/api/thread.service.js.map +1 -1
  252. package/dist/cjs/services/generated/api/uI.service.d.ts +17 -0
  253. package/dist/cjs/services/generated/api/uI.service.js +31 -0
  254. package/dist/cjs/services/generated/api/uI.service.js.map +1 -0
  255. package/dist/cjs/services/generated/api/user.service.js.map +1 -1
  256. package/dist/cjs/services/generated/api/wireguard.service.js.map +1 -1
  257. package/dist/cjs/services/generated/api/workload.service.d.ts +2 -1
  258. package/dist/cjs/services/generated/api/workload.service.js +5 -1
  259. package/dist/cjs/services/generated/api/workload.service.js.map +1 -1
  260. package/dist/cjs/services/generated/models/aCPStatusUpdateData.d.ts +1 -0
  261. package/dist/cjs/services/generated/models/aCPStatusUpdateData.js.map +1 -1
  262. package/dist/cjs/services/generated/models/assetClassCreateData.d.ts +3 -3
  263. package/dist/cjs/services/generated/models/assetClassCreateData.js.map +1 -1
  264. package/dist/cjs/services/generated/models/assetClassUpdateData.d.ts +1 -1
  265. package/dist/cjs/services/generated/models/assetClassUpdateData.js.map +1 -1
  266. package/dist/cjs/services/generated/models/assetCreateData.d.ts +4 -4
  267. package/dist/cjs/services/generated/models/assetCreateData.js.map +1 -1
  268. package/dist/cjs/services/generated/models/assetCreateWithParentData.d.ts +4 -4
  269. package/dist/cjs/services/generated/models/assetCreateWithParentData.js.map +1 -1
  270. package/dist/cjs/services/generated/models/assetOEEGetData.d.ts +1 -1
  271. package/dist/cjs/services/generated/models/assetOEEGetData.js.map +1 -1
  272. package/dist/cjs/services/generated/models/assetTemplateCreateData.d.ts +4 -4
  273. package/dist/cjs/services/generated/models/assetTemplateCreateData.js.map +1 -1
  274. package/dist/cjs/services/generated/models/assetTypeCreateData.d.ts +3 -3
  275. package/dist/cjs/services/generated/models/assetTypeCreateData.js.map +1 -1
  276. package/dist/cjs/services/generated/models/assetTypeMetadataCreateData.d.ts +2 -2
  277. package/dist/cjs/services/generated/models/assetTypeMetadataCreateData.js.map +1 -1
  278. package/dist/cjs/services/generated/models/assetTypeMetadataUpdateData.d.ts +1 -1
  279. package/dist/cjs/services/generated/models/assetTypeMetadataUpdateData.js.map +1 -1
  280. package/dist/cjs/services/generated/models/assetUpdateData.d.ts +1 -1
  281. package/dist/cjs/services/generated/models/assetUpdateData.js.map +1 -1
  282. package/dist/{esm/services/generated/models/siteHierarchyOverviewData.d.ts → cjs/services/generated/models/failureOverviewData.d.ts} +2 -2
  283. package/dist/cjs/services/generated/models/{assetShiftCreateData.js → failureOverviewData.js} +1 -1
  284. package/dist/cjs/services/generated/models/failureOverviewData.js.map +1 -0
  285. package/dist/cjs/services/generated/models/hierarchyUpdateItemData.d.ts +4 -4
  286. package/dist/cjs/services/generated/models/hierarchyUpdateItemData.js.map +1 -1
  287. package/dist/cjs/services/generated/models/index.d.ts +12 -4
  288. package/dist/cjs/services/generated/models/index.js +12 -4
  289. package/dist/cjs/services/generated/models/index.js.map +1 -1
  290. package/dist/cjs/services/generated/models/{assetOEECreateData.d.ts → mapOEECreateData.d.ts} +1 -1
  291. package/dist/cjs/services/generated/models/{assetShiftGetData.js → mapOEECreateData.js} +1 -1
  292. package/dist/cjs/services/generated/models/mapOEECreateData.js.map +1 -0
  293. package/dist/cjs/services/generated/models/{assetShiftGetData.d.ts → mapOEEGetData.d.ts} +2 -2
  294. package/dist/cjs/services/generated/models/{assetOEECreateData.js → mapOEEGetData.js} +1 -1
  295. package/dist/cjs/services/generated/models/mapOEEGetData.js.map +1 -0
  296. package/dist/{esm/services/generated/models/assetShiftCreateData.d.ts → cjs/services/generated/models/mapShiftCreateData.d.ts} +1 -1
  297. package/dist/cjs/services/generated/models/{siteHierarchyOverviewData.js → mapShiftCreateData.js} +1 -1
  298. package/dist/cjs/services/generated/models/mapShiftCreateData.js.map +1 -0
  299. package/dist/{esm/services/generated/models/assetShiftGetData.d.ts → cjs/services/generated/models/mapShiftGetData.d.ts} +2 -2
  300. package/dist/cjs/services/generated/models/mapShiftGetData.js +3 -0
  301. package/dist/cjs/services/generated/models/mapShiftGetData.js.map +1 -0
  302. package/dist/cjs/services/generated/models/mapUpdateData.d.ts +1 -0
  303. package/dist/cjs/services/generated/models/mapUpdateData.js.map +1 -1
  304. package/dist/cjs/services/generated/models/parameterUpdateData.d.ts +6 -0
  305. package/dist/cjs/services/generated/models/parameterUpdateData.js +3 -0
  306. package/dist/cjs/services/generated/models/parameterUpdateData.js.map +1 -0
  307. package/dist/cjs/services/generated/models/responsibleForData.d.ts +7 -0
  308. package/dist/cjs/services/generated/models/responsibleForData.js +3 -0
  309. package/dist/cjs/services/generated/models/responsibleForData.js.map +1 -0
  310. package/dist/cjs/services/generated/models/ruleActionData.d.ts +7 -0
  311. package/dist/cjs/services/generated/models/ruleActionData.js +3 -0
  312. package/dist/cjs/services/generated/models/ruleActionData.js.map +1 -0
  313. package/dist/cjs/services/generated/models/ruleCreateData.d.ts +12 -0
  314. package/dist/cjs/services/generated/models/ruleCreateData.js +3 -0
  315. package/dist/cjs/services/generated/models/ruleCreateData.js.map +1 -0
  316. package/dist/cjs/services/generated/models/ruleInputData.d.ts +7 -0
  317. package/dist/cjs/services/generated/models/ruleInputData.js +3 -0
  318. package/dist/cjs/services/generated/models/ruleInputData.js.map +1 -0
  319. package/dist/cjs/services/generated/models/rulePayloadData.d.ts +10 -0
  320. package/dist/cjs/services/generated/models/rulePayloadData.js +3 -0
  321. package/dist/cjs/services/generated/models/rulePayloadData.js.map +1 -0
  322. package/dist/cjs/services/generated/models/ruleUpdateData.d.ts +11 -0
  323. package/dist/cjs/services/generated/models/ruleUpdateData.js +3 -0
  324. package/dist/cjs/services/generated/models/ruleUpdateData.js.map +1 -0
  325. package/dist/cjs/services/generated/models/teamMemberData.d.ts +2 -1
  326. package/dist/cjs/services/generated/models/teamMemberData.js.map +1 -1
  327. package/dist/cjs/services/generated/types/asset.service.types.d.ts +5 -26
  328. package/dist/cjs/services/generated/types/asset.service.types.js.map +1 -1
  329. package/dist/cjs/services/generated/types/dataLabel.service.types.d.ts +6 -0
  330. package/dist/cjs/services/generated/types/dataLabel.service.types.js.map +1 -1
  331. package/dist/cjs/services/generated/types/index.d.ts +3 -0
  332. package/dist/cjs/services/generated/types/index.js +3 -0
  333. package/dist/cjs/services/generated/types/index.js.map +1 -1
  334. package/dist/cjs/services/generated/types/map.service.types.d.ts +30 -1
  335. package/dist/cjs/services/generated/types/map.service.types.js.map +1 -1
  336. package/dist/cjs/services/generated/types/parameters.service.types.d.ts +30 -0
  337. package/dist/cjs/services/generated/types/parameters.service.types.js +3 -0
  338. package/dist/cjs/services/generated/types/parameters.service.types.js.map +1 -0
  339. package/dist/cjs/services/generated/types/rule.service.types.d.ts +48 -0
  340. package/dist/cjs/services/generated/types/rule.service.types.js +3 -0
  341. package/dist/cjs/services/generated/types/rule.service.types.js.map +1 -0
  342. package/dist/cjs/services/generated/types/uI.service.types.d.ts +6 -0
  343. package/dist/cjs/services/generated/types/uI.service.types.js +3 -0
  344. package/dist/cjs/services/generated/types/uI.service.types.js.map +1 -0
  345. package/dist/cjs/services/generated/types/workload.service.types.d.ts +1 -0
  346. package/dist/cjs/services/generated/types/workload.service.types.js.map +1 -1
  347. package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.d.ts +19 -0
  348. package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.js +16 -0
  349. package/dist/esm/models/generated/aCPWorkloadManifestConfigItem.js.map +1 -0
  350. package/dist/esm/models/generated/aCPWorkloadManifests.d.ts +3 -0
  351. package/dist/esm/models/generated/aCPWorkloadManifests.js +2 -0
  352. package/dist/esm/models/generated/aCPWorkloadManifests.js.map +1 -1
  353. package/dist/esm/models/generated/asset.d.ts +51 -0
  354. package/dist/esm/models/generated/asset.js.map +1 -1
  355. package/dist/esm/models/generated/assetClass.d.ts +21 -0
  356. package/dist/esm/models/generated/assetClass.js.map +1 -1
  357. package/dist/esm/models/generated/assetClassItem.d.ts +21 -0
  358. package/dist/esm/models/generated/assetClassItem.js.map +1 -1
  359. package/dist/esm/models/generated/assetClassListPaginated.d.ts +3 -0
  360. package/dist/esm/models/generated/assetClassListPaginated.js.map +1 -1
  361. package/dist/esm/models/generated/assetDataStreamItem.d.ts +6 -0
  362. package/dist/esm/models/generated/assetDataStreamItem.js.map +1 -1
  363. package/dist/esm/models/generated/assetDataStreamsListPaginated.d.ts +3 -0
  364. package/dist/esm/models/generated/assetDataStreamsListPaginated.js.map +1 -1
  365. package/dist/esm/models/generated/assetHierarchies.d.ts +3 -0
  366. package/dist/esm/models/generated/assetHierarchies.js.map +1 -1
  367. package/dist/esm/models/generated/assetHierarchyItem.d.ts +24 -0
  368. package/dist/esm/models/generated/assetHierarchyItem.js.map +1 -1
  369. package/dist/esm/models/generated/assetHierarchyList.d.ts +3 -0
  370. package/dist/esm/models/generated/assetHierarchyList.js.map +1 -1
  371. package/dist/esm/models/generated/assetItem.d.ts +33 -0
  372. package/dist/esm/models/generated/assetItem.js.map +1 -1
  373. package/dist/esm/models/generated/assetListPaginated.d.ts +3 -0
  374. package/dist/esm/models/generated/assetListPaginated.js.map +1 -1
  375. package/dist/esm/models/generated/assetLocationItem.d.ts +6 -0
  376. package/dist/esm/models/generated/assetLocationItem.js.map +1 -1
  377. package/dist/esm/models/generated/assetMetricItem.d.ts +6 -0
  378. package/dist/esm/models/generated/assetMetricItem.js.map +1 -1
  379. package/dist/esm/models/generated/assetOEE.d.ts +3 -0
  380. package/dist/esm/models/generated/assetOEE.js.map +1 -1
  381. package/dist/esm/models/generated/assetProperty.d.ts +9 -0
  382. package/dist/esm/models/generated/assetProperty.js.map +1 -1
  383. package/dist/esm/models/generated/assetStatisticsItem.d.ts +24 -0
  384. package/dist/esm/models/generated/assetStatisticsItem.js.map +1 -1
  385. package/dist/esm/models/generated/assetStatisticsPaginated.d.ts +3 -0
  386. package/dist/esm/models/generated/assetStatisticsPaginated.js.map +1 -1
  387. package/dist/esm/models/generated/assetStatus.d.ts +3 -0
  388. package/dist/esm/models/generated/assetStatus.js.map +1 -1
  389. package/dist/esm/models/generated/assetStatusCount.d.ts +15 -0
  390. package/dist/esm/models/generated/assetStatusCount.js.map +1 -1
  391. package/dist/esm/models/generated/assetStatusItem.d.ts +6 -0
  392. package/dist/esm/models/generated/assetStatusItem.js.map +1 -1
  393. package/dist/esm/models/generated/assetTemplate.d.ts +48 -0
  394. package/dist/esm/models/generated/assetTemplate.js.map +1 -1
  395. package/dist/esm/models/generated/assetTemplateHierarchy.d.ts +24 -0
  396. package/dist/esm/models/generated/assetTemplateHierarchy.js.map +1 -1
  397. package/dist/esm/models/generated/assetTemplateItem.d.ts +42 -0
  398. package/dist/esm/models/generated/assetTemplateItem.js.map +1 -1
  399. package/dist/esm/models/generated/assetTemplateListPaginated.d.ts +3 -0
  400. package/dist/esm/models/generated/assetTemplateListPaginated.js.map +1 -1
  401. package/dist/esm/models/generated/assetTemplateProperties.d.ts +9 -0
  402. package/dist/esm/models/generated/assetTemplateProperties.js.map +1 -1
  403. package/dist/esm/models/generated/assetType.d.ts +30 -0
  404. package/dist/esm/models/generated/assetType.js.map +1 -1
  405. package/dist/esm/models/generated/assetTypeItem.d.ts +30 -0
  406. package/dist/esm/models/generated/assetTypeItem.js.map +1 -1
  407. package/dist/esm/models/generated/assetTypeListPaginated.d.ts +3 -0
  408. package/dist/esm/models/generated/assetTypeListPaginated.js.map +1 -1
  409. package/dist/esm/models/generated/assetTypeMetadata.d.ts +15 -0
  410. package/dist/esm/models/generated/assetTypeMetadata.js.map +1 -1
  411. package/dist/esm/models/generated/assetTypeMetadataItem.d.ts +15 -0
  412. package/dist/esm/models/generated/assetTypeMetadataItem.js.map +1 -1
  413. package/dist/esm/models/generated/assetTypeMetadataListPaginated.d.ts +3 -0
  414. package/dist/esm/models/generated/assetTypeMetadataListPaginated.js.map +1 -1
  415. package/dist/esm/models/generated/cSVError.d.ts +18 -0
  416. package/dist/esm/models/generated/cSVError.js.map +1 -1
  417. package/dist/esm/models/generated/cSVErrorMessage.d.ts +3 -0
  418. package/dist/esm/models/generated/cSVErrorMessage.js.map +1 -1
  419. package/dist/esm/models/generated/cSVPosition.d.ts +12 -0
  420. package/dist/esm/models/generated/cSVPosition.js.map +1 -1
  421. package/dist/esm/models/generated/controlChange.d.ts +27 -0
  422. package/dist/esm/models/generated/controlChange.js.map +1 -1
  423. package/dist/esm/models/generated/controlChangeGet.d.ts +39 -0
  424. package/dist/esm/models/generated/controlChangeGet.js.map +1 -1
  425. package/dist/esm/models/generated/controlChangeGetPaginated.d.ts +3 -0
  426. package/dist/esm/models/generated/controlChangeGetPaginated.js.map +1 -1
  427. package/dist/esm/models/generated/controlChangeGetStatus.d.ts +12 -0
  428. package/dist/esm/models/generated/controlChangeGetStatus.js.map +1 -1
  429. package/dist/esm/models/generated/controlChangePaginated.d.ts +3 -0
  430. package/dist/esm/models/generated/controlChangePaginated.js.map +1 -1
  431. package/dist/esm/models/generated/emissionsAsset.d.ts +19 -0
  432. package/dist/esm/models/generated/emissionsAsset.js +16 -0
  433. package/dist/esm/models/generated/emissionsAsset.js.map +1 -0
  434. package/dist/esm/models/generated/emissionsAssetLists.d.ts +22 -0
  435. package/dist/esm/models/generated/emissionsAssetLists.js +18 -0
  436. package/dist/esm/models/generated/emissionsAssetLists.js.map +1 -0
  437. package/dist/esm/models/generated/emissionsDashboard.d.ts +29 -0
  438. package/dist/esm/models/generated/emissionsDashboard.js +23 -0
  439. package/dist/esm/models/generated/emissionsDashboard.js.map +1 -0
  440. package/dist/esm/models/generated/emissionsDashboardAnalytics.d.ts +26 -0
  441. package/dist/esm/models/generated/emissionsDashboardAnalytics.js +20 -0
  442. package/dist/esm/models/generated/emissionsDashboardAnalytics.js.map +1 -0
  443. package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.d.ts +25 -0
  444. package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js +19 -0
  445. package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js.map +1 -0
  446. package/dist/esm/models/generated/emissionsDashboardTotals.d.ts +27 -0
  447. package/dist/esm/models/generated/emissionsDashboardTotals.js +20 -0
  448. package/dist/esm/models/generated/emissionsDashboardTotals.js.map +1 -0
  449. package/dist/esm/models/generated/emissionsGreenhouse.d.ts +21 -0
  450. package/dist/esm/models/generated/emissionsGreenhouse.js +17 -0
  451. package/dist/esm/models/generated/emissionsGreenhouse.js.map +1 -0
  452. package/dist/esm/models/generated/errorMessage.d.ts +9 -0
  453. package/dist/esm/models/generated/errorMessage.js.map +1 -1
  454. package/dist/esm/models/generated/errorMessages.d.ts +3 -0
  455. package/dist/esm/models/generated/errorMessages.js.map +1 -1
  456. package/dist/esm/models/generated/errorsError.d.ts +18 -0
  457. package/dist/esm/models/generated/errorsError.js.map +1 -1
  458. package/dist/esm/models/generated/errorsErrorMessage.d.ts +3 -0
  459. package/dist/esm/models/generated/errorsErrorMessage.js.map +1 -1
  460. package/dist/esm/models/generated/failureDetection.d.ts +12 -0
  461. package/dist/esm/models/generated/failureDetection.js.map +1 -1
  462. package/dist/esm/models/generated/failureDetectionProperty.d.ts +9 -0
  463. package/dist/esm/models/generated/failureDetectionProperty.js.map +1 -1
  464. package/dist/esm/models/generated/failureOverviewItem.d.ts +58 -0
  465. package/dist/esm/models/generated/{siteHierarchyOverviewItem.js → failureOverviewItem.js} +5 -6
  466. package/dist/esm/models/generated/failureOverviewItem.js.map +1 -0
  467. package/dist/esm/models/generated/failureOverviewPaginated.d.ts +24 -0
  468. package/dist/esm/models/generated/{siteHierarchyOverviewPaginated.js → failureOverviewPaginated.js} +4 -4
  469. package/dist/esm/models/generated/failureOverviewPaginated.js.map +1 -0
  470. package/dist/esm/models/generated/failureOverviewStatistics.d.ts +24 -0
  471. package/dist/esm/models/generated/{siteHierarchyOverviewStatistics.js → failureOverviewStatistics.js} +2 -2
  472. package/dist/esm/models/generated/failureOverviewStatistics.js.map +1 -0
  473. package/dist/esm/models/generated/index.d.ts +27 -4
  474. package/dist/esm/models/generated/index.js +27 -4
  475. package/dist/esm/models/generated/index.js.map +1 -1
  476. package/dist/esm/models/generated/mapFailureDetection.d.ts +17 -0
  477. package/dist/esm/models/generated/mapFailureDetection.js +15 -0
  478. package/dist/esm/models/generated/mapFailureDetection.js.map +1 -0
  479. package/dist/esm/models/generated/mapItem.d.ts +9 -6
  480. package/dist/esm/models/generated/mapItem.js +5 -3
  481. package/dist/esm/models/generated/mapItem.js.map +1 -1
  482. package/dist/esm/models/generated/mapModel.d.ts +7 -4
  483. package/dist/esm/models/generated/mapModel.js +4 -2
  484. package/dist/esm/models/generated/mapModel.js.map +1 -1
  485. package/dist/esm/models/generated/mapOEE.d.ts +26 -0
  486. package/dist/esm/models/generated/mapOEE.js +21 -0
  487. package/dist/esm/models/generated/mapOEE.js.map +1 -0
  488. package/dist/esm/models/generated/{assetShift.d.ts → mapShift.d.ts} +5 -5
  489. package/dist/esm/models/generated/{assetShift.js → mapShift.js} +3 -3
  490. package/dist/esm/models/generated/mapShift.js.map +1 -0
  491. package/dist/esm/models/generated/metric.d.ts +30 -0
  492. package/dist/esm/models/generated/metric.js.map +1 -1
  493. package/dist/esm/models/generated/metricItem.d.ts +30 -0
  494. package/dist/esm/models/generated/metricItem.js.map +1 -1
  495. package/dist/esm/models/generated/metricListPaginated.d.ts +3 -0
  496. package/dist/esm/models/generated/metricListPaginated.js.map +1 -1
  497. package/dist/esm/models/generated/oEECalculation.d.ts +15 -0
  498. package/dist/esm/models/generated/oEECalculation.js.map +1 -1
  499. package/dist/esm/models/generated/oEEThresholds.d.ts +9 -0
  500. package/dist/esm/models/generated/oEEThresholds.js.map +1 -1
  501. package/dist/esm/models/generated/oEEValues.d.ts +12 -0
  502. package/dist/esm/models/generated/oEEValues.js.map +1 -1
  503. package/dist/esm/models/generated/pagination.d.ts +9 -0
  504. package/dist/esm/models/generated/pagination.js.map +1 -1
  505. package/dist/esm/models/generated/parameterAppVersionAsset.d.ts +29 -0
  506. package/dist/esm/models/generated/parameterAppVersionAsset.js +21 -0
  507. package/dist/esm/models/generated/parameterAppVersionAsset.js.map +1 -0
  508. package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.d.ts +21 -0
  509. package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.js +18 -0
  510. package/dist/esm/models/generated/parameterAppVersionAssetListPaginated.js.map +1 -0
  511. package/dist/esm/models/generated/parameterGetSchema.d.ts +28 -0
  512. package/dist/esm/models/generated/parameterGetSchema.js +19 -0
  513. package/dist/esm/models/generated/parameterGetSchema.js.map +1 -0
  514. package/dist/esm/models/generated/parameterschemaParameterJSONSchema.d.ts +28 -0
  515. package/dist/esm/models/generated/parameterschemaParameterJSONSchema.js +19 -0
  516. package/dist/esm/models/generated/parameterschemaParameterJSONSchema.js.map +1 -0
  517. package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.d.ts +35 -0
  518. package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.js +24 -0
  519. package/dist/esm/models/generated/parameterschemaParameterJSONSchemaProperties.js.map +1 -0
  520. package/dist/esm/models/generated/responsibleFor.d.ts +19 -0
  521. package/dist/esm/models/generated/responsibleFor.js +16 -0
  522. package/dist/esm/models/generated/responsibleFor.js.map +1 -0
  523. package/dist/esm/models/generated/rule.d.ts +37 -0
  524. package/dist/esm/models/generated/rule.js +26 -0
  525. package/dist/esm/models/generated/rule.js.map +1 -0
  526. package/dist/esm/models/generated/ruleAction.d.ts +19 -0
  527. package/dist/esm/models/generated/ruleAction.js +16 -0
  528. package/dist/esm/models/generated/ruleAction.js.map +1 -0
  529. package/dist/esm/models/generated/ruleInput.d.ts +19 -0
  530. package/dist/esm/models/generated/ruleInput.js +16 -0
  531. package/dist/esm/models/generated/ruleInput.js.map +1 -0
  532. package/dist/esm/models/generated/ruleLogs.d.ts +17 -0
  533. package/dist/esm/models/generated/ruleLogs.js +15 -0
  534. package/dist/esm/models/generated/ruleLogs.js.map +1 -0
  535. package/dist/esm/models/generated/rulePayload.d.ts +23 -0
  536. package/dist/esm/models/generated/rulePayload.js +19 -0
  537. package/dist/esm/models/generated/rulePayload.js.map +1 -0
  538. package/dist/esm/models/generated/ruleStatus.d.ts +21 -0
  539. package/dist/esm/models/generated/ruleStatus.js +17 -0
  540. package/dist/esm/models/generated/ruleStatus.js.map +1 -0
  541. package/dist/esm/models/generated/rulesListPaginated.d.ts +21 -0
  542. package/dist/esm/models/generated/rulesListPaginated.js +18 -0
  543. package/dist/esm/models/generated/rulesListPaginated.js.map +1 -0
  544. package/dist/esm/models/generated/semanticTypeItem.d.ts +12 -0
  545. package/dist/esm/models/generated/semanticTypeItem.js.map +1 -1
  546. package/dist/esm/models/generated/semanticTypeList.d.ts +3 -0
  547. package/dist/esm/models/generated/semanticTypeList.js.map +1 -1
  548. package/dist/esm/models/generated/severityStatistics.d.ts +12 -0
  549. package/dist/esm/models/generated/severityStatistics.js.map +1 -1
  550. package/dist/esm/models/generated/simpleAsset.d.ts +6 -0
  551. package/dist/esm/models/generated/simpleAsset.js.map +1 -1
  552. package/dist/esm/models/generated/statusStatistics.d.ts +9 -0
  553. package/dist/esm/models/generated/statusStatistics.js.map +1 -1
  554. package/dist/esm/models/generated/teamMember.d.ts +3 -2
  555. package/dist/esm/models/generated/teamMember.js +2 -1
  556. package/dist/esm/models/generated/teamMember.js.map +1 -1
  557. package/dist/esm/models/generated/view2D.d.ts +9 -0
  558. package/dist/esm/models/generated/view2D.js.map +1 -1
  559. package/dist/esm/models/generated/view3D.d.ts +12 -0
  560. package/dist/esm/models/generated/view3D.js.map +1 -1
  561. package/dist/esm/services/generated/api/aCP.service.js.map +1 -1
  562. package/dist/esm/services/generated/api/alarm.service.js.map +1 -1
  563. package/dist/esm/services/generated/api/appRegistry.service.js.map +1 -1
  564. package/dist/esm/services/generated/api/asset.service.d.ts +135 -159
  565. package/dist/esm/services/generated/api/asset.service.js +138 -188
  566. package/dist/esm/services/generated/api/asset.service.js.map +1 -1
  567. package/dist/esm/services/generated/api/bridge.service.js.map +1 -1
  568. package/dist/esm/services/generated/api/controlChange.service.d.ts +31 -31
  569. package/dist/esm/services/generated/api/controlChange.service.js +31 -31
  570. package/dist/esm/services/generated/api/controlChange.service.js.map +1 -1
  571. package/dist/esm/services/generated/api/dataLabel.service.d.ts +8 -1
  572. package/dist/esm/services/generated/api/dataLabel.service.js +15 -0
  573. package/dist/esm/services/generated/api/dataLabel.service.js.map +1 -1
  574. package/dist/esm/services/generated/api/dataType.service.js.map +1 -1
  575. package/dist/esm/services/generated/api/failureDetection.service.js.map +1 -1
  576. package/dist/esm/services/generated/api/index.d.ts +3 -0
  577. package/dist/esm/services/generated/api/index.js +3 -0
  578. package/dist/esm/services/generated/api/index.js.map +1 -1
  579. package/dist/esm/services/generated/api/instance.service.js.map +1 -1
  580. package/dist/esm/services/generated/api/integration.service.js.map +1 -1
  581. package/dist/esm/services/generated/api/map.service.d.ts +36 -3
  582. package/dist/esm/services/generated/api/map.service.js +80 -2
  583. package/dist/esm/services/generated/api/map.service.js.map +1 -1
  584. package/dist/esm/services/generated/api/metric.service.d.ts +26 -26
  585. package/dist/esm/services/generated/api/metric.service.js +26 -26
  586. package/dist/esm/services/generated/api/metric.service.js.map +1 -1
  587. package/dist/esm/services/generated/api/orchestration.service.js.map +1 -1
  588. package/dist/esm/services/generated/api/parameters.service.d.ts +42 -0
  589. package/dist/esm/services/generated/api/parameters.service.js +79 -0
  590. package/dist/esm/services/generated/api/parameters.service.js.map +1 -0
  591. package/dist/esm/services/generated/api/rule.service.d.ts +63 -0
  592. package/dist/esm/services/generated/api/rule.service.js +142 -0
  593. package/dist/esm/services/generated/api/rule.service.js.map +1 -0
  594. package/dist/esm/services/generated/api/secret.service.js.map +1 -1
  595. package/dist/esm/services/generated/api/storage.service.js.map +1 -1
  596. package/dist/esm/services/generated/api/thread.service.js.map +1 -1
  597. package/dist/esm/services/generated/api/uI.service.d.ts +17 -0
  598. package/dist/esm/services/generated/api/uI.service.js +27 -0
  599. package/dist/esm/services/generated/api/uI.service.js.map +1 -0
  600. package/dist/esm/services/generated/api/user.service.js.map +1 -1
  601. package/dist/esm/services/generated/api/wireguard.service.js.map +1 -1
  602. package/dist/esm/services/generated/api/workload.service.d.ts +2 -1
  603. package/dist/esm/services/generated/api/workload.service.js +5 -1
  604. package/dist/esm/services/generated/api/workload.service.js.map +1 -1
  605. package/dist/esm/services/generated/models/aCPStatusUpdateData.d.ts +1 -0
  606. package/dist/esm/services/generated/models/aCPStatusUpdateData.js.map +1 -1
  607. package/dist/esm/services/generated/models/assetClassCreateData.d.ts +3 -3
  608. package/dist/esm/services/generated/models/assetClassCreateData.js.map +1 -1
  609. package/dist/esm/services/generated/models/assetClassUpdateData.d.ts +1 -1
  610. package/dist/esm/services/generated/models/assetClassUpdateData.js.map +1 -1
  611. package/dist/esm/services/generated/models/assetCreateData.d.ts +4 -4
  612. package/dist/esm/services/generated/models/assetCreateData.js.map +1 -1
  613. package/dist/esm/services/generated/models/assetCreateWithParentData.d.ts +4 -4
  614. package/dist/esm/services/generated/models/assetCreateWithParentData.js.map +1 -1
  615. package/dist/esm/services/generated/models/assetOEEGetData.d.ts +1 -1
  616. package/dist/esm/services/generated/models/assetOEEGetData.js.map +1 -1
  617. package/dist/esm/services/generated/models/assetTemplateCreateData.d.ts +4 -4
  618. package/dist/esm/services/generated/models/assetTemplateCreateData.js.map +1 -1
  619. package/dist/esm/services/generated/models/assetTypeCreateData.d.ts +3 -3
  620. package/dist/esm/services/generated/models/assetTypeCreateData.js.map +1 -1
  621. package/dist/esm/services/generated/models/assetTypeMetadataCreateData.d.ts +2 -2
  622. package/dist/esm/services/generated/models/assetTypeMetadataCreateData.js.map +1 -1
  623. package/dist/esm/services/generated/models/assetTypeMetadataUpdateData.d.ts +1 -1
  624. package/dist/esm/services/generated/models/assetTypeMetadataUpdateData.js.map +1 -1
  625. package/dist/esm/services/generated/models/assetUpdateData.d.ts +1 -1
  626. package/dist/esm/services/generated/models/assetUpdateData.js.map +1 -1
  627. package/dist/{cjs/services/generated/models/siteHierarchyOverviewData.d.ts → esm/services/generated/models/failureOverviewData.d.ts} +2 -2
  628. package/dist/esm/services/generated/models/failureOverviewData.js +1 -0
  629. package/dist/esm/services/generated/models/failureOverviewData.js.map +1 -0
  630. package/dist/esm/services/generated/models/hierarchyUpdateItemData.d.ts +4 -4
  631. package/dist/esm/services/generated/models/hierarchyUpdateItemData.js.map +1 -1
  632. package/dist/esm/services/generated/models/index.d.ts +12 -4
  633. package/dist/esm/services/generated/models/index.js +12 -4
  634. package/dist/esm/services/generated/models/index.js.map +1 -1
  635. package/dist/esm/services/generated/models/{assetOEECreateData.d.ts → mapOEECreateData.d.ts} +1 -1
  636. package/dist/esm/services/generated/models/mapOEECreateData.js +1 -0
  637. package/dist/esm/services/generated/models/mapOEECreateData.js.map +1 -0
  638. package/dist/esm/services/generated/models/mapOEEGetData.d.ts +7 -0
  639. package/dist/esm/services/generated/models/mapOEEGetData.js +1 -0
  640. package/dist/esm/services/generated/models/mapOEEGetData.js.map +1 -0
  641. package/dist/{cjs/services/generated/models/assetShiftCreateData.d.ts → esm/services/generated/models/mapShiftCreateData.d.ts} +1 -1
  642. package/dist/esm/services/generated/models/mapShiftCreateData.js +1 -0
  643. package/dist/esm/services/generated/models/mapShiftCreateData.js.map +1 -0
  644. package/dist/esm/services/generated/models/mapShiftGetData.d.ts +7 -0
  645. package/dist/esm/services/generated/models/mapShiftGetData.js +1 -0
  646. package/dist/esm/services/generated/models/mapShiftGetData.js.map +1 -0
  647. package/dist/esm/services/generated/models/mapUpdateData.d.ts +1 -0
  648. package/dist/esm/services/generated/models/mapUpdateData.js.map +1 -1
  649. package/dist/esm/services/generated/models/parameterUpdateData.d.ts +6 -0
  650. package/dist/esm/services/generated/models/parameterUpdateData.js +1 -0
  651. package/dist/esm/services/generated/models/parameterUpdateData.js.map +1 -0
  652. package/dist/esm/services/generated/models/responsibleForData.d.ts +7 -0
  653. package/dist/esm/services/generated/models/responsibleForData.js +1 -0
  654. package/dist/esm/services/generated/models/responsibleForData.js.map +1 -0
  655. package/dist/esm/services/generated/models/ruleActionData.d.ts +7 -0
  656. package/dist/esm/services/generated/models/ruleActionData.js +1 -0
  657. package/dist/esm/services/generated/models/ruleActionData.js.map +1 -0
  658. package/dist/esm/services/generated/models/ruleCreateData.d.ts +12 -0
  659. package/dist/esm/services/generated/models/ruleCreateData.js +1 -0
  660. package/dist/esm/services/generated/models/ruleCreateData.js.map +1 -0
  661. package/dist/esm/services/generated/models/ruleInputData.d.ts +7 -0
  662. package/dist/esm/services/generated/models/ruleInputData.js +1 -0
  663. package/dist/esm/services/generated/models/ruleInputData.js.map +1 -0
  664. package/dist/esm/services/generated/models/rulePayloadData.d.ts +10 -0
  665. package/dist/esm/services/generated/models/rulePayloadData.js +1 -0
  666. package/dist/esm/services/generated/models/rulePayloadData.js.map +1 -0
  667. package/dist/esm/services/generated/models/ruleUpdateData.d.ts +11 -0
  668. package/dist/esm/services/generated/models/ruleUpdateData.js +1 -0
  669. package/dist/esm/services/generated/models/ruleUpdateData.js.map +1 -0
  670. package/dist/esm/services/generated/models/teamMemberData.d.ts +2 -1
  671. package/dist/esm/services/generated/models/teamMemberData.js.map +1 -1
  672. package/dist/esm/services/generated/types/asset.service.types.d.ts +5 -26
  673. package/dist/esm/services/generated/types/asset.service.types.js.map +1 -1
  674. package/dist/esm/services/generated/types/dataLabel.service.types.d.ts +6 -0
  675. package/dist/esm/services/generated/types/dataLabel.service.types.js.map +1 -1
  676. package/dist/esm/services/generated/types/index.d.ts +3 -0
  677. package/dist/esm/services/generated/types/index.js +3 -0
  678. package/dist/esm/services/generated/types/index.js.map +1 -1
  679. package/dist/esm/services/generated/types/map.service.types.d.ts +30 -1
  680. package/dist/esm/services/generated/types/map.service.types.js.map +1 -1
  681. package/dist/esm/services/generated/types/parameters.service.types.d.ts +30 -0
  682. package/dist/esm/services/generated/types/parameters.service.types.js +1 -0
  683. package/dist/esm/services/generated/types/parameters.service.types.js.map +1 -0
  684. package/dist/esm/services/generated/types/rule.service.types.d.ts +48 -0
  685. package/dist/esm/services/generated/types/rule.service.types.js +1 -0
  686. package/dist/esm/services/generated/types/rule.service.types.js.map +1 -0
  687. package/dist/esm/services/generated/types/uI.service.types.d.ts +6 -0
  688. package/dist/esm/services/generated/types/uI.service.types.js +1 -0
  689. package/dist/esm/services/generated/types/uI.service.types.js.map +1 -0
  690. package/dist/esm/services/generated/types/workload.service.types.d.ts +1 -0
  691. package/dist/esm/services/generated/types/workload.service.types.js.map +1 -1
  692. package/package.json +2 -2
  693. package/dist/cjs/models/generated/assetShift.js.map +0 -1
  694. package/dist/cjs/models/generated/siteHierarchyOverviewItem.d.ts +0 -36
  695. package/dist/cjs/models/generated/siteHierarchyOverviewItem.js.map +0 -1
  696. package/dist/cjs/models/generated/siteHierarchyOverviewPaginated.d.ts +0 -21
  697. package/dist/cjs/models/generated/siteHierarchyOverviewPaginated.js +0 -22
  698. package/dist/cjs/models/generated/siteHierarchyOverviewPaginated.js.map +0 -1
  699. package/dist/cjs/models/generated/siteHierarchyOverviewStatistics.d.ts +0 -21
  700. package/dist/cjs/models/generated/siteHierarchyOverviewStatistics.js.map +0 -1
  701. package/dist/cjs/services/generated/models/assetOEECreateData.js.map +0 -1
  702. package/dist/cjs/services/generated/models/assetShiftCreateData.js.map +0 -1
  703. package/dist/cjs/services/generated/models/assetShiftGetData.js.map +0 -1
  704. package/dist/cjs/services/generated/models/siteHierarchyOverviewData.js.map +0 -1
  705. package/dist/esm/models/generated/assetShift.js.map +0 -1
  706. package/dist/esm/models/generated/siteHierarchyOverviewItem.d.ts +0 -36
  707. package/dist/esm/models/generated/siteHierarchyOverviewItem.js.map +0 -1
  708. package/dist/esm/models/generated/siteHierarchyOverviewPaginated.d.ts +0 -21
  709. package/dist/esm/models/generated/siteHierarchyOverviewPaginated.js.map +0 -1
  710. package/dist/esm/models/generated/siteHierarchyOverviewStatistics.d.ts +0 -21
  711. package/dist/esm/models/generated/siteHierarchyOverviewStatistics.js.map +0 -1
  712. package/dist/esm/services/generated/models/assetOEECreateData.js +0 -1
  713. package/dist/esm/services/generated/models/assetOEECreateData.js.map +0 -1
  714. package/dist/esm/services/generated/models/assetShiftCreateData.js +0 -1
  715. package/dist/esm/services/generated/models/assetShiftCreateData.js.map +0 -1
  716. package/dist/esm/services/generated/models/assetShiftGetData.js +0 -1
  717. package/dist/esm/services/generated/models/assetShiftGetData.js.map +0 -1
  718. package/dist/esm/services/generated/models/siteHierarchyOverviewData.js +0 -1
  719. package/dist/esm/services/generated/models/siteHierarchyOverviewData.js.map +0 -1
@@ -1,4 +1,4 @@
1
- import { Asset, AssetClass, AssetClassListPaginated, AssetDataStreamsListPaginated, AssetHierarchies, AssetHierarchyList, AssetListPaginated, AssetOEE, AssetShift, AssetStatisticsPaginated, AssetStatus, AssetStatusCount, AssetTemplate, AssetTemplateListPaginated, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated, SiteHierarchyOverviewPaginated } from '../../../models';
1
+ import { Asset, AssetClass, AssetClassListPaginated, AssetDataStreamsListPaginated, AssetHierarchies, AssetHierarchyList, AssetListPaginated, AssetOEE, AssetStatisticsPaginated, AssetStatus, AssetStatusCount, AssetTemplate, AssetTemplateListPaginated, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated, FailureOverviewPaginated } from '../../../models';
2
2
  import { BaseService } from '../../base.service';
3
3
  /**
4
4
  * @category Service
@@ -6,9 +6,9 @@ import { BaseService } from '../../base.service';
6
6
  export class AssetService extends BaseService {
7
7
  /**
8
8
  * Create Asset
9
- * Create Asset **Permission Required:** `kelvin.permission.asset.create`
9
+ * 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`
10
10
  * @param asset Asset create schema
11
- * @param dryRun Dry Run
11
+ * @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.
12
12
  * @param {IKvHttpRequestOptions} options Request optional parameters
13
13
  */
14
14
  static createAsset({ asset, dryRun }, options) {
@@ -27,7 +27,7 @@ export class AssetService extends BaseService {
27
27
  }
28
28
  /**
29
29
  * Create Asset Class
30
- * 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`
30
+ * 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`
31
31
  * @param assetClass Asset Class Create Parameters
32
32
  * @param {IKvHttpRequestOptions} options Request optional parameters
33
33
  */
@@ -40,41 +40,9 @@ export class AssetService extends BaseService {
40
40
  requestConfig.options = options;
41
41
  return this.request(`/assets/class/create`, requestConfig, AssetClass);
42
42
  }
43
- /**
44
- * Create Asset OEE
45
- * Create Asset OEE **Permission Required:** `kelvin.permission.asset.create`
46
- * @param assetsOee Asset OEE create schema
47
- * @param assetName Asset name
48
- * @param {IKvHttpRequestOptions} options Request optional parameters
49
- */
50
- static createAssetOEE({ assetsOee, assetName }, options) {
51
- const requestConfig = {
52
- method: 'post'
53
- };
54
- requestConfig.data = assetsOee;
55
- requestConfig.mediaType = 'application/json';
56
- requestConfig.options = options;
57
- return this.request(`/assets/${encodeURIComponent(String(assetName))}/oee/create`, requestConfig, AssetOEE);
58
- }
59
- /**
60
- * Create Asset Shift
61
- * Create Asset Shift **Permission Required:** `kelvin.permission.asset.create`
62
- * @param assetShift Asset Shift create schema
63
- * @param assetName Asset name
64
- * @param {IKvHttpRequestOptions} options Request optional parameters
65
- */
66
- static createAssetShift({ assetShift, assetName }, options) {
67
- const requestConfig = {
68
- method: 'post'
69
- };
70
- requestConfig.data = assetShift;
71
- requestConfig.mediaType = 'application/json';
72
- requestConfig.options = options;
73
- return this.request(`/assets/${encodeURIComponent(String(assetName))}/shift/create`, requestConfig, AssetShift);
74
- }
75
43
  /**
76
44
  * Create Asset Template
77
- * Create Asset Template **Permission Required:** `kelvin.permission.asset.create`
45
+ * 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`
78
46
  * @param assetTemplate Asset Template create schema
79
47
  * @param {IKvHttpRequestOptions} options Request optional parameters
80
48
  */
@@ -89,8 +57,8 @@ export class AssetService extends BaseService {
89
57
  }
90
58
  /**
91
59
  * Create Asset Type
92
- * 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`
93
- * @param assettype AssetType create schema
60
+ * 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`
61
+ * @param assettype Asset Type create schema
94
62
  * @param {IKvHttpRequestOptions} options Request optional parameters
95
63
  */
96
64
  static createAssetType({ assettype }, options) {
@@ -104,8 +72,8 @@ export class AssetService extends BaseService {
104
72
  }
105
73
  /**
106
74
  * Create Asset Type Metadata
107
- * 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`
108
- * @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.
75
+ * 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`
76
+ * @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.
109
77
  * @param assettypemetadata Asset Type Metadata create schema
110
78
  * @param {IKvHttpRequestOptions} options Request optional parameters
111
79
  */
@@ -120,8 +88,8 @@ export class AssetService extends BaseService {
120
88
  }
121
89
  /**
122
90
  * Delete Asset
123
- * Delete Asset **Permission Required:** `kelvin.permission.asset.delete`
124
- * @param assetName Asset name
91
+ * 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`
92
+ * @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.
125
93
  * @param {IKvHttpRequestOptions} options Request optional parameters
126
94
  */
127
95
  static deleteAsset({ assetName }, options) {
@@ -135,7 +103,7 @@ export class AssetService extends BaseService {
135
103
  /**
136
104
  * Delete Asset Class
137
105
  * 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`
138
- * @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>.
106
+ * @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.
139
107
  * @param {IKvHttpRequestOptions} options Request optional parameters
140
108
  */
141
109
  static deleteAssetClass({ assetClassName }, options) {
@@ -148,8 +116,8 @@ export class AssetService extends BaseService {
148
116
  }
149
117
  /**
150
118
  * Delete Asset Template
151
- * Delete Asset Template **Permission Required:** `kelvin.permission.asset.delete`
152
- * @param assetTemplateName Asset Template Name
119
+ * 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`
120
+ * @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>.
153
121
  * @param {IKvHttpRequestOptions} options Request optional parameters
154
122
  */
155
123
  static deleteAssetTemplate({ assetTemplateName }, options) {
@@ -162,8 +130,8 @@ export class AssetService extends BaseService {
162
130
  }
163
131
  /**
164
132
  * Delete Asset Type
165
- * Delete Asset Type **Permission Required:** `kelvin.permission.asset_type.delete`
166
- * @param assetTypeName Asset Type name
133
+ * 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`
134
+ * @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>.
167
135
  * @param {IKvHttpRequestOptions} options Request optional parameters
168
136
  */
169
137
  static deleteAssetType({ assetTypeName }, options) {
@@ -176,9 +144,9 @@ export class AssetService extends BaseService {
176
144
  }
177
145
  /**
178
146
  * Delete Asset Type Metadata
179
- * Delete Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.delete`
180
- * @param assetTypeName Asset Type name
181
- * @param assetTypeMetadataName Asset Type Metadata name
147
+ * 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`
148
+ * @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.
149
+ * @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.
182
150
  * @param {IKvHttpRequestOptions} options Request optional parameters
183
151
  */
184
152
  static deleteAssetTypeMetadata({ assetTypeName, assetTypeMetadataName }, options) {
@@ -191,9 +159,9 @@ export class AssetService extends BaseService {
191
159
  }
192
160
  /**
193
161
  * Get Asset
194
- * Get Asset **Permission Required:** `kelvin.permission.asset.read`
195
- * @param assetName Asset name
196
- * @param metadata Inject metadata into the response
162
+ * 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`
163
+ * @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.
164
+ * @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>.
197
165
  * @param {IKvHttpRequestOptions} options Request optional parameters
198
166
  */
199
167
  static getAsset({ assetName, metadata }, options) {
@@ -212,7 +180,7 @@ export class AssetService extends BaseService {
212
180
  /**
213
181
  * Get Asset Class
214
182
  * 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`
215
- * @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>.
183
+ * @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.
216
184
  * @param {IKvHttpRequestOptions} options Request optional parameters
217
185
  */
218
186
  static getAssetClass({ assetClassName }, options) {
@@ -225,7 +193,7 @@ export class AssetService extends BaseService {
225
193
  }
226
194
  /**
227
195
  * Get Asset Hierarchies
228
- * Get Asset Hierarchies **Permission Required:** `kelvin.permission.asset.read`
196
+ * 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`
229
197
  * @param {IKvHttpRequestOptions} options Request optional parameters
230
198
  */
231
199
  static getAssetHierarchies(options) {
@@ -238,10 +206,10 @@ export class AssetService extends BaseService {
238
206
  }
239
207
  /**
240
208
  * Get Asset Hierarchy
241
- * Get Asset Hierarchy **Permission Required:** `kelvin.permission.asset.read`
242
- * @param assetName Asset name
243
- * @param entityTypeDepth Sets the start entity type depth in which the hierarchy is returned.
244
- * @param assetTypeDepth Sets the start asset type depth in which the hierarchy is returned. Only valid when entity_type_depth = group
209
+ * 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`
210
+ * @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.
211
+ * @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.
212
+ * @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
245
213
  * @param {IKvHttpRequestOptions} options Request optional parameters
246
214
  */
247
215
  static getAssetHierarchy({ assetName, entityTypeDepth, assetTypeDepth }, options) {
@@ -264,7 +232,7 @@ export class AssetService extends BaseService {
264
232
  * Get Asset OEE
265
233
  * Get Asset OEE **Permission Required:** `kelvin.permission.asset.read`
266
234
  * @param assetNames Asset OEE get schema
267
- * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
235
+ * @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.
268
236
  * @param {IKvHttpRequestOptions} options Request optional parameters
269
237
  */
270
238
  static getAssetOEE({ assetNames, timestamp }, options) {
@@ -281,36 +249,15 @@ export class AssetService extends BaseService {
281
249
  requestConfig.options = options;
282
250
  return this.request(`/assets/oee/get`, requestConfig, AssetOEE);
283
251
  }
284
- /**
285
- * Get Asset Shift
286
- * Get Asset Shift **Permission Required:** `kelvin.permission.asset.read`
287
- * @param assetNames Asset Shift get schema
288
- * @param timestamp Timestamp to search for specific Shift information for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
289
- * @param {IKvHttpRequestOptions} options Request optional parameters
290
- */
291
- static getAssetShift({ assetNames, timestamp }, options) {
292
- const requestConfig = {
293
- method: 'post'
294
- };
295
- const queryParameters = {};
296
- if (timestamp != null) {
297
- queryParameters['timestamp'] = timestamp;
298
- }
299
- requestConfig.params = queryParameters;
300
- requestConfig.data = assetNames;
301
- requestConfig.mediaType = 'application/json';
302
- requestConfig.options = options;
303
- return this.request(`/assets/shift/get`, requestConfig, AssetShift);
304
- }
305
252
  /**
306
253
  * Get Asset Statistics
307
- * Get Asset Statistics **Pagination Sortable Columns:** `asset.name`, `asset.asset_type_name`, `asset.device_type_name` **Permission Required:** `kelvin.permission.asset.read`
254
+ * 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`
308
255
  * @param asset Asset statistics schema
309
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
310
- * @param startingAfter Lower bound cursor for use in pagination
311
- * @param endingBefore Upper bound cursor for use in pagination
312
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
313
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
256
+ * @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.
257
+ * @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.
258
+ * @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.
259
+ * @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`
260
+ * @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).
314
261
  * @param {IKvHttpRequestOptions} options Request optional parameters
315
262
  */
316
263
  static getAssetStatistics({ asset, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
@@ -341,7 +288,7 @@ export class AssetService extends BaseService {
341
288
  }
342
289
  /**
343
290
  * Get Asset Status Count
344
- * Get Asset Status Count **Permission Required:** `kelvin.permission.asset.read`
291
+ * 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`
345
292
  * @param {IKvHttpRequestOptions} options Request optional parameters
346
293
  */
347
294
  static getAssetStatusCount(options) {
@@ -354,7 +301,7 @@ export class AssetService extends BaseService {
354
301
  }
355
302
  /**
356
303
  * Get Asset Statuses
357
- * Get Asset Statuses **Permission Required:** `kelvin.permission.asset.read`
304
+ * 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`
358
305
  * @param {IKvHttpRequestOptions} options Request optional parameters
359
306
  */
360
307
  static getAssetStatuses(options) {
@@ -367,8 +314,8 @@ export class AssetService extends BaseService {
367
314
  }
368
315
  /**
369
316
  * Get Asset Template
370
- * Get Asset Template **Permission Required:** `kelvin.permission.asset.read`
371
- * @param assetTemplateName Asset Template Name
317
+ * 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`
318
+ * @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.
372
319
  * @param {IKvHttpRequestOptions} options Request optional parameters
373
320
  */
374
321
  static getAssetTemplate({ assetTemplateName }, options) {
@@ -381,9 +328,9 @@ export class AssetService extends BaseService {
381
328
  }
382
329
  /**
383
330
  * Get Asset Type
384
- * Get Asset Type **Permission Required:** `kelvin.permission.asset_type.read`
385
- * @param assetTypeName Asset Type name
386
- * @param metadata Inject metadata into the response
331
+ * 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`
332
+ * @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.
333
+ * @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>.
387
334
  * @param {IKvHttpRequestOptions} options Request optional parameters
388
335
  */
389
336
  static getAssetType({ assetTypeName, metadata }, options) {
@@ -401,9 +348,9 @@ export class AssetService extends BaseService {
401
348
  }
402
349
  /**
403
350
  * Get Asset Type Metadata
404
- * Get Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.read`
405
- * @param assetTypeName Asset Type name
406
- * @param assetTypeMetadataName Asset Type Metadata name
351
+ * 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`
352
+ * @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.
353
+ * @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.
407
354
  * @param {IKvHttpRequestOptions} options Request optional parameters
408
355
  */
409
356
  static getAssetTypeMetadata({ assetTypeName, assetTypeMetadataName }, options) {
@@ -416,22 +363,23 @@ export class AssetService extends BaseService {
416
363
  }
417
364
  /**
418
365
  * List Asset
419
- * 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`
420
- * @param search Search assets by name or title
421
- * @param names Filter assets matching a list of names
422
- * @param assetTypeName Filter assets by asset type
423
- * @param statusState Filter assets by status state [`online`, `offline`, `partially_online`, `unknown`]
424
- * @param entityTypeName Filter assets by entity type. Prefix any `entity_type_name` with the character `!` for a NOT operation
425
- * @param propertiesFilter Filter assets that have an property.name = property.value. Format `property_name=property_value`
426
- * @param properties Only return specific properties (default: return all properties): Format `property_name`
427
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
428
- * @param startingAfter Lower bound cursor for use in pagination
429
- * @param endingBefore Upper bound cursor for use in pagination
430
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
431
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
432
- * @param {IKvHttpRequestOptions} options Request optional parameters
433
- */
434
- static listAsset({ search, names, assetTypeName, statusState, entityTypeName, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
366
+ * 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`
367
+ * @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`.
368
+ * @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`.
369
+ * @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`.
370
+ * @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`.
371
+ * @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>
372
+ * @param map Filter for assets that belong to the map
373
+ * @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.
374
+ * @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>.
375
+ * @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.
376
+ * @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.
377
+ * @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.
378
+ * @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`
379
+ * @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).
380
+ * @param {IKvHttpRequestOptions} options Request optional parameters
381
+ */
382
+ static listAsset({ search, names, assetTypeName, statusState, entityTypeName, map, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
435
383
  const requestConfig = {
436
384
  method: 'get'
437
385
  };
@@ -451,6 +399,9 @@ export class AssetService extends BaseService {
451
399
  if (entityTypeName != null) {
452
400
  queryParameters['entity_type_name'] = entityTypeName;
453
401
  }
402
+ if (map != null) {
403
+ queryParameters['map'] = map;
404
+ }
454
405
  if (propertiesFilter != null) {
455
406
  queryParameters['properties_filter'] = propertiesFilter;
456
407
  }
@@ -479,15 +430,15 @@ export class AssetService extends BaseService {
479
430
  }
480
431
  /**
481
432
  * List Asset Class
482
- * 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`
483
- * @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`.
484
- * @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.
433
+ * 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`
434
+ * @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`.
435
+ * @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.
485
436
  * @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.
486
437
  * @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.
487
- * @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`
488
- * @param sortAsc Sorting order for the results.</p> There are two options; `true` (ascending order) and `false` (descending order). The default is true (ascending).
489
- * @param owner Filter Kelvin Asset Class by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin asset class).
490
- * @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>
438
+ * @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`
439
+ * @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).
440
+ * @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.
441
+ * @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>
491
442
  * @param {IKvHttpRequestOptions} options Request optional parameters
492
443
  */
493
444
  static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
@@ -526,17 +477,17 @@ export class AssetService extends BaseService {
526
477
  }
527
478
  /**
528
479
  * List Asset Data Streams
529
- * List Asset Data Streams **Pagination Sortable Columns:** `datastream.asset_name`, `datastream.metric_name` **Permission Required:** `kelvin.permission.asset.read`
480
+ * 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`
481
+ * @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.
530
482
  * @param assetDatastreams Asset Data Streams list schema
531
- * @param assetName Asset name
532
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
533
- * @param startingAfter Lower bound cursor for use in pagination
534
- * @param endingBefore Upper bound cursor for use in pagination
535
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
536
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
483
+ * @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.
484
+ * @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.
485
+ * @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.
486
+ * @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`
487
+ * @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).
537
488
  * @param {IKvHttpRequestOptions} options Request optional parameters
538
489
  */
539
- static listAssetDataStreams({ assetDatastreams, assetName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
490
+ static listAssetDataStreams({ assetName, assetDatastreams, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
540
491
  const requestConfig = {
541
492
  method: 'post'
542
493
  };
@@ -564,17 +515,17 @@ export class AssetService extends BaseService {
564
515
  }
565
516
  /**
566
517
  * List Asset Template
567
- * 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`
568
- * @param search Search Asset Template by name or title
569
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
570
- * @param startingAfter Lower bound cursor for use in pagination
571
- * @param endingBefore Upper bound cursor for use in pagination
572
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
573
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
574
- * @param assetTypeNames Asset Type Names
575
- * @param entityTypeNames Entity Type Names. Prefix any `entity_type_name` with the character `!` for a NOT operation
576
- * @param assetClassNames Asset Class Names
577
- * @param owner Owner
518
+ * 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`
519
+ * @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`.
520
+ * @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.
521
+ * @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.
522
+ * @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.
523
+ * @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`
524
+ * @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).
525
+ * @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`.
526
+ * @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>
527
+ * @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`.
528
+ * @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).
578
529
  * @param {IKvHttpRequestOptions} options Request optional parameters
579
530
  */
580
531
  static listAssetTemplate({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, assetTypeNames, entityTypeNames, assetClassNames, owner } = {}, options) {
@@ -619,18 +570,18 @@ export class AssetService extends BaseService {
619
570
  }
620
571
  /**
621
572
  * List Asset Type
622
- * 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`
623
- * @param search Search asset type by name or title
624
- * @param assetClassName Filter asset type by asset class
625
- * @param metadata Inject metadata into the response
626
- * @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>
627
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
628
- * @param startingAfter Lower bound cursor for use in pagination
629
- * @param endingBefore Upper bound cursor for use in pagination
630
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
631
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
632
- * @param owner Filter Asset Class by owner. Possible Values: kelvin/custom
633
- * @param entityTypeName Filter by asset class entity type Name. Prefix any `entity_type_name` with the character `!` for a NOT operation
573
+ * 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`
574
+ * @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`.
575
+ * @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`.
576
+ * @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.
577
+ * @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.
578
+ * @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.
579
+ * @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.
580
+ * @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.
581
+ * @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`
582
+ * @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).
583
+ * @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.
584
+ * @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>
634
585
  * @param {IKvHttpRequestOptions} options Request optional parameters
635
586
  */
636
587
  static listAssetType({ search, assetClassName, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
@@ -678,14 +629,14 @@ export class AssetService extends BaseService {
678
629
  }
679
630
  /**
680
631
  * List Asset Type Metadata
681
- * List Asset Type Metadata **Pagination Sortable Columns:** `asset_type_metadata.name` **Permission Required:** `kelvin.permission.asset_type.read`
682
- * @param assetTypeName Asset Type name
683
- * @param search Search Asset Type Metadata by name
684
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
685
- * @param startingAfter Lower bound cursor for use in pagination
686
- * @param endingBefore Upper bound cursor for use in pagination
687
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
688
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
632
+ * 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`
633
+ * @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`.
634
+ * @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`.
635
+ * @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.
636
+ * @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.
637
+ * @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.
638
+ * @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`
639
+ * @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).
689
640
  * @param {IKvHttpRequestOptions} options Request optional parameters
690
641
  */
691
642
  static listAssetTypeMetadata({ assetTypeName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
@@ -717,18 +668,17 @@ export class AssetService extends BaseService {
717
668
  return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/list`, requestConfig, AssetTypeMetadataListPaginated);
718
669
  }
719
670
  /**
720
- * List Site Hierarchy Overview
721
- * List Site Hierarchy Overview **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.failure_quotient`, `asset_type.title` **Permission Required:** `kelvin.permission.asset.read`
722
- * @param asset Site Hierarchy Overview schema
723
- * @param siteName Site name
724
- * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
725
- * @param startingAfter Lower bound cursor for use in pagination
726
- * @param endingBefore Upper bound cursor for use in pagination
727
- * @param sortBy Parameter to sort by. Must be one of the sortable columns
728
- * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
671
+ * List Failure Overview
672
+ * 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`
673
+ * @param asset Failure Overview schema
674
+ * @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.
675
+ * @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.
676
+ * @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.
677
+ * @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`
678
+ * @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).
729
679
  * @param {IKvHttpRequestOptions} options Request optional parameters
730
680
  */
731
- static listSiteHierarchyOverview({ asset, siteName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
681
+ static listFailureOverview({ asset, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
732
682
  const requestConfig = {
733
683
  method: 'post'
734
684
  };
@@ -752,14 +702,14 @@ export class AssetService extends BaseService {
752
702
  requestConfig.data = asset;
753
703
  requestConfig.mediaType = 'application/json';
754
704
  requestConfig.options = options;
755
- return this.request(`/assets/${encodeURIComponent(String(siteName))}/site-hierarchy-overview/list`, requestConfig, SiteHierarchyOverviewPaginated);
705
+ return this.request(`/assets/failure-overview/list`, requestConfig, FailureOverviewPaginated);
756
706
  }
757
707
  /**
758
708
  * Update Asset
759
- * Update Asset **Permission Required:** `kelvin.permission.asset.update`
709
+ * 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`
760
710
  * @param asset Asset update schema
761
- * @param assetName Asset name
762
- * @param dryRun Dry Run
711
+ * @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>.
712
+ * @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.
763
713
  * @param {IKvHttpRequestOptions} options Request optional parameters
764
714
  */
765
715
  static updateAsset({ asset, assetName, dryRun }, options) {
@@ -778,9 +728,9 @@ export class AssetService extends BaseService {
778
728
  }
779
729
  /**
780
730
  * Update Asset Class
781
- * 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`
731
+ * 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`
782
732
  * @param assetClass AssetClass update schema
783
- * @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>.
733
+ * @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.
784
734
  * @param {IKvHttpRequestOptions} options Request optional parameters
785
735
  */
786
736
  static updateAssetClass({ assetClass, assetClassName }, options) {
@@ -794,9 +744,9 @@ export class AssetService extends BaseService {
794
744
  }
795
745
  /**
796
746
  * Update Asset Hierarchies
797
- * Update Asset Hierarchies **Permission Required:** `kelvin.permission.asset.create`
747
+ * 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`
798
748
  * @param hierarchy Asset Hierarchy update schema
799
- * @param dryRun Dry Run
749
+ * @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.
800
750
  * @param {IKvHttpRequestOptions} options Request optional parameters
801
751
  */
802
752
  static updateAssetHierarchies({ hierarchy, dryRun }, options) {
@@ -815,9 +765,9 @@ export class AssetService extends BaseService {
815
765
  }
816
766
  /**
817
767
  * Update Asset Template
818
- * Update Asset Template **Permission Required:** `kelvin.permission.asset.update`
768
+ * 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`
819
769
  * @param assetTemplate Asset Template update schema
820
- * @param assetTemplateName Asset Template Name
770
+ * @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>.
821
771
  * @param {IKvHttpRequestOptions} options Request optional parameters
822
772
  */
823
773
  static updateAssetTemplate({ assetTemplate, assetTemplateName }, options) {
@@ -831,9 +781,9 @@ export class AssetService extends BaseService {
831
781
  }
832
782
  /**
833
783
  * Update Asset Type
834
- * Update Asset Type **Permission Required:** `kelvin.permission.asset_type.update`
784
+ * 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`
835
785
  * @param assettype AssetType update schema
836
- * @param assetTypeName Asset Type name
786
+ * @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.
837
787
  * @param {IKvHttpRequestOptions} options Request optional parameters
838
788
  */
839
789
  static updateAssetType({ assettype, assetTypeName }, options) {
@@ -847,10 +797,10 @@ export class AssetService extends BaseService {
847
797
  }
848
798
  /**
849
799
  * Update Asset Type Metadata
850
- * Update Asset Type Metadata **Permission Required:** `kelvin.permission.asset_type.update`
800
+ * 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`
851
801
  * @param assettypemetadata Asset Type Metadata update schema
852
- * @param assetTypeName Asset Type name
853
- * @param assetTypeMetadataName Asset Type Metadata name
802
+ * @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.
803
+ * @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.
854
804
  * @param {IKvHttpRequestOptions} options Request optional parameters
855
805
  */
856
806
  static updateAssetTypeMetadata({ assettypemetadata, assetTypeName, assetTypeMetadataName }, options) {
@@ -864,9 +814,9 @@ export class AssetService extends BaseService {
864
814
  }
865
815
  /**
866
816
  * Upload Assets
867
- * Upload Assets **Permission Required:** `kelvin.permission.asset.create`
868
- * @param file CSV File
869
- * @param dryRun If set to true performs only validation
817
+ * 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`
818
+ * @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>.
819
+ * @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>.
870
820
  * @param {IKvHttpRequestOptions} options Request optional parameters
871
821
  */
872
822
  static uploadAssets({ file, dryRun }, options) {