@kelvininc/js-client-sdk 7.8.1 → 7.9.1

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.9.1](https://bitbucket.org/kelvininc/kelvinjs/compare/v7.9.0...v7.9.1) (2022-09-01)
+
+
+### Bug Fixes
+
+* fix datalabels last endpoint to return latest datalabels and documentation [KMAPS-412] ([8f43ebf](https://bitbucket.org/kelvininc/kelvinjs/commits/8f43ebfcad4f8405f24fa4aef77ca408ce159c32))
+
+
+
+
+
+# [7.9.0](https://bitbucket.org/kelvininc/kelvinjs/compare/v7.8.1...v7.9.0) (2022-08-19)
+
+
+### Features
+
+* **kelvin-js-sdk:** add emissions api service and more endpoints documented [KMAPS-264] ([a7254c0](https://bitbucket.org/kelvininc/kelvinjs/commits/a7254c02075a772a350e7f2cb3b1667efda01711))
+* **kelvin-js-sdk:** add new filter properties to assets and map service ([ad7062b](https://bitbucket.org/kelvininc/kelvinjs/commits/ad7062bd5c093a3f0deb2dbcf905c6035818ad9a))
+* **kelvin-js-sdk:** mapItem with failure detections and acps with new configuration [KMAPS-264] ([d91cb7f](https://bitbucket.org/kelvininc/kelvinjs/commits/d91cb7f9d3386cba6cc15b1f45973911956f054b))
+
+
+
+
+
 ## [7.8.1](https://bitbucket.org/kelvininc/kelvinjs/compare/v7.8.0...v7.8.1) (2022-07-25)
 
 

package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.d.ts

@@ -0,0 +1,19 @@
+import { Model } from '../model';
+/**
+ * @category Service Response Model
+ */
+export interface IACPWorkloadManifestConfigItem {
+    name?: string;
+    payload?: any;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class ACPWorkloadManifestConfigItem extends Model {
+    name: string;
+    payload: any;
+    constructor(model?: IACPWorkloadManifestConfigItem);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACPWorkloadManifestConfigItem = void 0;
+const model_1 = require("../model");
+/**
+ * @category Service Response Model Object
+ */
+class ACPWorkloadManifestConfigItem extends model_1.Model {
+    constructor(model) {
+        super(model);
+    }
+    mapping() {
+        return {
+            name: 'name',
+            payload: 'payload'
+        };
+    }
+}
+exports.ACPWorkloadManifestConfigItem = ACPWorkloadManifestConfigItem;
+//# sourceMappingURL=aCPWorkloadManifestConfigItem.js.map

package/dist/cjs/models/generated/aCPWorkloadManifestConfigItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aCPWorkloadManifestConfigItem.js","sourceRoot":"","sources":["../../../../src/models/generated/aCPWorkloadManifestConfigItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAUjC;;GAEG;AACH,MAAa,6BAA8B,SAAQ,aAAK;IAIvD,YAAY,KAAsC;QACjD,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;SAClB,CAAC;IACH,CAAC;CACD;AAdD,sEAcC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IACPWorkloadManifestConfigItem {\n\tname?: string;\n\tpayload?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ACPWorkloadManifestConfigItem extends Model {\n\tname: string;\n\tpayload: any;\n\n\tconstructor(model?: IACPWorkloadManifestConfigItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tname: 'name',\n\t\t\tpayload: 'payload'\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/aCPWorkloadManifests.d.ts

@@ -1,10 +1,12 @@
 import { Model } from '../model';
+import { ACPWorkloadManifestConfigItem, IACPWorkloadManifestConfigItem } from './aCPWorkloadManifestConfigItem';
 import { ACPWorkloadManifestItem, IACPWorkloadManifestItem } from './aCPWorkloadManifestItem';
 /**
  * @category Service Response Model
  */
 export interface IACPWorkloadManifests {
     data?: Array<ACPWorkloadManifestItem | IACPWorkloadManifestItem>;
+    config?: Array<ACPWorkloadManifestConfigItem | IACPWorkloadManifestConfigItem>;
     names?: Array<string>;
 }
 /**
@@ -12,6 +14,7 @@ export interface IACPWorkloadManifests {
  */
 export declare class ACPWorkloadManifests extends Model {
     data: Array<ACPWorkloadManifestItem>;
+    config: Array<ACPWorkloadManifestConfigItem>;
     names: Array<string>;
     constructor(model?: IACPWorkloadManifests);
     mapping(): {

package/dist/cjs/models/generated/aCPWorkloadManifests.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ACPWorkloadManifests = void 0;
 const model_1 = require("../model");
+const aCPWorkloadManifestConfigItem_1 = require("./aCPWorkloadManifestConfigItem");
 const aCPWorkloadManifestItem_1 = require("./aCPWorkloadManifestItem");
 /**
  * @category Service Response Model Object
@@ -13,6 +14,7 @@ class ACPWorkloadManifests extends model_1.Model {
     mapping() {
         return {
             data: ['data', aCPWorkloadManifestItem_1.ACPWorkloadManifestItem],
+            config: ['config', aCPWorkloadManifestConfigItem_1.ACPWorkloadManifestConfigItem],
             names: 'names'
         };
     }

package/dist/cjs/models/generated/aCPWorkloadManifests.js.map

@@ -1 +1 @@
-{"version":3,"file":"aCPWorkloadManifests.js","sourceRoot":"","sources":["../../../../src/models/generated/aCPWorkloadManifests.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uEAA8F;AAU9F;;GAEG;AACH,MAAa,oBAAqB,SAAQ,aAAK;IAI9C,YAAY,KAA6B;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,iDAAuB,CAAC;YACvC,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAdD,oDAcC","sourcesContent":["import { Model } from '../model';\nimport { ACPWorkloadManifestItem, IACPWorkloadManifestItem } from './aCPWorkloadManifestItem';\n\n/**\n * @category Service Response Model\n */\nexport interface IACPWorkloadManifests {\n\tdata?: Array<ACPWorkloadManifestItem | IACPWorkloadManifestItem>;\n\tnames?: Array<string>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ACPWorkloadManifests extends Model {\n\tdata: Array<ACPWorkloadManifestItem>;\n\tnames: Array<string>;\n\n\tconstructor(model?: IACPWorkloadManifests) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', ACPWorkloadManifestItem],\n\t\t\tnames: 'names'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"aCPWorkloadManifests.js","sourceRoot":"","sources":["../../../../src/models/generated/aCPWorkloadManifests.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,mFAAgH;AAChH,uEAA8F;AAW9F;;GAEG;AACH,MAAa,oBAAqB,SAAQ,aAAK;IAK9C,YAAY,KAA6B;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,iDAAuB,CAAC;YACvC,MAAM,EAAE,CAAC,QAAQ,EAAE,6DAA6B,CAAC;YACjD,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAhBD,oDAgBC","sourcesContent":["import { Model } from '../model';\nimport { ACPWorkloadManifestConfigItem, IACPWorkloadManifestConfigItem } from './aCPWorkloadManifestConfigItem';\nimport { ACPWorkloadManifestItem, IACPWorkloadManifestItem } from './aCPWorkloadManifestItem';\n\n/**\n * @category Service Response Model\n */\nexport interface IACPWorkloadManifests {\n\tdata?: Array<ACPWorkloadManifestItem | IACPWorkloadManifestItem>;\n\tconfig?: Array<ACPWorkloadManifestConfigItem | IACPWorkloadManifestConfigItem>;\n\tnames?: Array<string>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ACPWorkloadManifests extends Model {\n\tdata: Array<ACPWorkloadManifestItem>;\n\tconfig: Array<ACPWorkloadManifestConfigItem>;\n\tnames: Array<string>;\n\n\tconstructor(model?: IACPWorkloadManifests) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', ACPWorkloadManifestItem],\n\t\t\tconfig: ['config', ACPWorkloadManifestConfigItem],\n\t\t\tnames: 'names'\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/asset.d.ts

@@ -32,23 +32,74 @@ export interface IAsset {
  * @category Service Response Model Object
  */
 export declare class Asset extends Model {
+    /**
+        * 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> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetTypeName: string;
+    /**
+        * Current status (state) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. There are four status options; `online`, `offline`, `partially_online` and `unknown`.
+    */
     status: AssetStatusItem;
+    /**
+        * Time of modifying any variable of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+    */
     updated: Date;
+    /**
+        * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     name: string;
+    /**
+        * Time of creation of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+    */
     created: Date;
+    /**
+        * A list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> which will include any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</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> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</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 this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a>.
+    */
     hierarchy: Array<Asset>;
+    /**
+        * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> linked to the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetClassName: string;
+    /**
+        * Display name (title) of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     title: string;
+    /**
+        * Display name of the entity type linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.
+    */
     entityTypeTitle: string;
+    /**
+        * List of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/\" target=\"_blank\">Kelvin Metrics</a> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     metrics: Array<AssetMetricItem>;
+    /**
+        * 2D and 3D information and links to the models for displaying in <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/\" target=\"_blank\">Kelvin Maps</a>. More details about the use of these models can be found in the <a href=\"https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#2d-3d-option\" target=\"_blank\">Kelvin Maps Documentation</a>.
+    */
     visualization: Visualization;
+    /**
+        * Failure detection settings for this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>. This will show all parameters and settings associated with this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     failureDetection: FailureDetection;
     location: AssetLocationItem;
+    /**
+        * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a> used to create this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.</p> If this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> was created from scratch, then this parameter will be `null`.
+    */
     assetTemplateName: string;
+    /**
+        * 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> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetTypeTitle: string;
+    /**
+        * 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> linked to the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetClassTitle: string;
+    /**
+        * List of any custom properties for this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     properties: Array<AssetProperty>;
+    /**
+        * Unique identifier name of the entity type linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.
+    */
     entityTypeName: string;
     constructor(model?: IAsset);
     mapping(): {

package/dist/cjs/models/generated/asset.js.map

@@ -1 +1 @@
-{"version":3,"file":"asset.js","sourceRoot":"","sources":["../../../../src/models/generated/asset.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,2DAA4E;AAC5E,uDAAsE;AACtE,mDAAgE;AAChE,uDAAsE;AACtE,yDAAyE;AACzE,mDAAgE;AA0BhE;;GAEG;AACH,MAAa,KAAM,SAAQ,aAAK;IAoB/B,YAAY,KAAc;QACzB,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,MAAM,EAAE,CAAC,QAAQ,EAAE,iCAAe,CAAC;YACnC,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,SAAS,EAAE,CAAC,WAAW,EAAE,KAAK,CAAC;YAC/B,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,QAAQ,EAAE,CAAC,UAAU,EAAE,qCAAiB,CAAC;YACzC,mBAAmB,EAAE,mBAAmB;YACxC,gBAAgB,EAAE,gBAAgB;YAClC,iBAAiB,EAAE,iBAAiB;YACpC,UAAU,EAAE,CAAC,YAAY,EAAE,6BAAa,CAAC;YACzC,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AA9CD,sBA8CC","sourcesContent":["import { Model } from '../model';\nimport { AssetLocationItem, IAssetLocationItem } from './assetLocationItem';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { AssetProperty, IAssetProperty } from './assetProperty';\nimport { AssetStatusItem, IAssetStatusItem } from './assetStatusItem';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAsset {\n\tasset_type_name?: string;\n\tstatus?: AssetStatusItem | IAssetStatusItem;\n\tupdated?: Date | string;\n\tname?: string;\n\tcreated?: Date | string;\n\thierarchy?: Array<Asset | IAsset>;\n\tasset_class_name?: string;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\tvisualization?: Visualization | IVisualization;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\tlocation?: AssetLocationItem | IAssetLocationItem;\n\tasset_template_name?: string;\n\tasset_type_title?: string;\n\tasset_class_title?: string;\n\tproperties?: Array<AssetProperty | IAssetProperty>;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class Asset extends Model {\n\tassetTypeName: string;\n\tstatus: AssetStatusItem;\n\tupdated: Date;\n\tname: string;\n\tcreated: Date;\n\thierarchy: Array<Asset>;\n\tassetClassName: string;\n\ttitle: string;\n\tentityTypeTitle: string;\n\tmetrics: Array<AssetMetricItem>;\n\tvisualization: Visualization;\n\tfailureDetection: FailureDetection;\n\tlocation: AssetLocationItem;\n\tassetTemplateName: string;\n\tassetTypeTitle: string;\n\tassetClassTitle: string;\n\tproperties: Array<AssetProperty>;\n\tentityTypeName: string;\n\n\tconstructor(model?: IAsset) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tasset_type_name: 'assetTypeName',\n\t\t\tstatus: ['status', AssetStatusItem],\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\tcreated: ['created', Date],\n\t\t\thierarchy: ['hierarchy', Asset],\n\t\t\tasset_class_name: 'assetClassName',\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\tvisualization: ['visualization', Visualization],\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\tlocation: ['location', AssetLocationItem],\n\t\t\tasset_template_name: 'assetTemplateName',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tasset_class_title: 'assetClassTitle',\n\t\t\tproperties: ['properties', AssetProperty],\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"asset.js","sourceRoot":"","sources":["../../../../src/models/generated/asset.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,2DAA4E;AAC5E,uDAAsE;AACtE,mDAAgE;AAChE,uDAAsE;AACtE,yDAAyE;AACzE,mDAAgE;AA0BhE;;GAEG;AACH,MAAa,KAAM,SAAQ,aAAK;IAuE/B,YAAY,KAAc;QACzB,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,MAAM,EAAE,CAAC,QAAQ,EAAE,iCAAe,CAAC;YACnC,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,SAAS,EAAE,CAAC,WAAW,EAAE,KAAK,CAAC;YAC/B,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,QAAQ,EAAE,CAAC,UAAU,EAAE,qCAAiB,CAAC;YACzC,mBAAmB,EAAE,mBAAmB;YACxC,gBAAgB,EAAE,gBAAgB;YAClC,iBAAiB,EAAE,iBAAiB;YACpC,UAAU,EAAE,CAAC,YAAY,EAAE,6BAAa,CAAC;YACzC,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AAjGD,sBAiGC","sourcesContent":["import { Model } from '../model';\nimport { AssetLocationItem, IAssetLocationItem } from './assetLocationItem';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { AssetProperty, IAssetProperty } from './assetProperty';\nimport { AssetStatusItem, IAssetStatusItem } from './assetStatusItem';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAsset {\n\tasset_type_name?: string;\n\tstatus?: AssetStatusItem | IAssetStatusItem;\n\tupdated?: Date | string;\n\tname?: string;\n\tcreated?: Date | string;\n\thierarchy?: Array<Asset | IAsset>;\n\tasset_class_name?: string;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\tvisualization?: Visualization | IVisualization;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\tlocation?: AssetLocationItem | IAssetLocationItem;\n\tasset_template_name?: string;\n\tasset_type_title?: string;\n\tasset_class_title?: string;\n\tproperties?: Array<AssetProperty | IAssetProperty>;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class Asset extends Model {\n\t/**\n\t\t* 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> linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetTypeName: string;\n\t/**\n\t\t* Current status (state) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. There are four status options; `online`, `offline`, `partially_online` and `unknown`.\n\t*/\n\tstatus: AssetStatusItem;\n\t/**\n\t\t* Time of modifying any variable of this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a> in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tupdated: Date;\n\t/**\n\t\t* Unique identifier name of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tname: string;\n\t/**\n\t\t* Time of creation of this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a> in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tcreated: Date;\n\t/**\n\t\t* A list of all <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Assets</a> which will include any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</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> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</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 this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Assets</a>.\n\t*/\n\thierarchy: Array<Asset>;\n\t/**\n\t\t* Unique identifier name of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a> linked to the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetClassName: string;\n\t/**\n\t\t* Display name (title) of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Display name of the entity type linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a>.\n\t*/\n\tentityTypeTitle: string;\n\t/**\n\t\t* List of all <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/\\\" target=\\\"_blank\\\">Kelvin Metrics</a> linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tmetrics: Array<AssetMetricItem>;\n\t/**\n\t\t* 2D and 3D information and links to the models for displaying in <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/\\\" target=\\\"_blank\\\">Kelvin Maps</a>. More details about the use of these models can be found in the <a href=\\\"https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#2d-3d-option\\\" target=\\\"_blank\\\">Kelvin Maps Documentation</a>.\n\t*/\n\tvisualization: Visualization;\n\t/**\n\t\t* Failure detection settings for this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>. This will show all parameters and settings associated with this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tfailureDetection: FailureDetection;\n\tlocation: AssetLocationItem;\n\t/**\n\t\t* Unique identifier name of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a> used to create this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.</p> If this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a> was created from scratch, then this parameter will be `null`.\n\t*/\n\tassetTemplateName: string;\n\t/**\n\t\t* 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> linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetTypeTitle: string;\n\t/**\n\t\t* 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> linked to the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetClassTitle: string;\n\t/**\n\t\t* List of any custom properties for this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tproperties: Array<AssetProperty>;\n\t/**\n\t\t* Unique identifier name of the entity type linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a>.\n\t*/\n\tentityTypeName: string;\n\n\tconstructor(model?: IAsset) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tasset_type_name: 'assetTypeName',\n\t\t\tstatus: ['status', AssetStatusItem],\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\tcreated: ['created', Date],\n\t\t\thierarchy: ['hierarchy', Asset],\n\t\t\tasset_class_name: 'assetClassName',\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\tvisualization: ['visualization', Visualization],\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\tlocation: ['location', AssetLocationItem],\n\t\t\tasset_template_name: 'assetTemplateName',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tasset_class_title: 'assetClassTitle',\n\t\t\tproperties: ['properties', AssetProperty],\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetClass.d.ts

@@ -15,12 +15,33 @@ export interface IAssetClass {
  * @category Service Response Model Object
  */
 export declare class AssetClass extends Model {
+    /**
+        * Time of modifying any variable of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+    */
     updated: Date;
+    /**
+        * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.
+    */
     name: string;
+    /**
+        * 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>.
+    */
     title: string;
+    /**
+        * Time of creation of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+    */
     created: Date;
+    /**
+        * Display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen display name (title) from a fixed list defined by Kelvin.
+    */
     entityTypeTitle: string;
+    /**
+        * Who created the Kelvin Class. 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>).
+    */
     owner: string;
+    /**
+        * Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen name from a fixed list defined by Kelvin.
+    */
     entityTypeName: string;
     constructor(model?: IAssetClass);
     mapping(): {

package/dist/cjs/models/generated/assetClass.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetClass.js","sourceRoot":"","sources":["../../../../src/models/generated/assetClass.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAejC;;GAEG;AACH,MAAa,UAAW,SAAQ,aAAK;IASpC,YAAY,KAAmB;QAC9B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,iBAAiB,EAAE,iBAAiB;YACpC,KAAK,EAAE,OAAO;YACd,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AAxBD,gCAwBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetClass {\n\tupdated?: Date | string;\n\tname?: string;\n\ttitle?: string;\n\tcreated?: Date | string;\n\tentity_type_title?: string;\n\towner?: string;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetClass extends Model {\n\tupdated: Date;\n\tname: string;\n\ttitle: string;\n\tcreated: Date;\n\tentityTypeTitle: string;\n\towner: string;\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetClass) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\tcreated: ['created', Date],\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\towner: 'owner',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetClass.js","sourceRoot":"","sources":["../../../../src/models/generated/assetClass.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAejC;;GAEG;AACH,MAAa,UAAW,SAAQ,aAAK;IA8BpC,YAAY,KAAmB;QAC9B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,iBAAiB,EAAE,iBAAiB;YACpC,KAAK,EAAE,OAAO;YACd,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AA7CD,gCA6CC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetClass {\n\tupdated?: Date | string;\n\tname?: string;\n\ttitle?: string;\n\tcreated?: Date | string;\n\tentity_type_title?: string;\n\towner?: string;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetClass extends Model {\n\t/**\n\t\t* Time of modifying any variable of this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tupdated: Date;\n\t/**\n\t\t* Unique identifier name of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a>.\n\t*/\n\tname: string;\n\t/**\n\t\t* 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>.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Time of creation of this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tcreated: Date;\n\t/**\n\t\t* Display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen display name (title) from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeTitle: string;\n\t/**\n\t\t* Who created the Kelvin Class. 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>).\n\t*/\n\towner: string;\n\t/**\n\t\t* Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen name from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetClass) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\tcreated: ['created', Date],\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\towner: 'owner',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetClassItem.d.ts

@@ -15,12 +15,33 @@ export interface IAssetClassItem {
  * @category Service Response Model Object
  */
 export declare class AssetClassItem extends Model {
+    /**
+        * Time of modifying any variable of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+    */
     updated: Date;
+    /**
+        * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.
+    */
     name: string;
+    /**
+        * 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>.
+    */
     title: string;
+    /**
+        * Time of creation of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+    */
     created: Date;
+    /**
+        * Display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen display name (title) from a fixed list defined by Kelvin.
+    */
     entityTypeTitle: string;
+    /**
+        * Who created the Kelvin Class. 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>).
+    */
     owner: string;
+    /**
+        * Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen name from a fixed list defined by Kelvin.
+    */
     entityTypeName: string;
     constructor(model?: IAssetClassItem);
     mapping(): {

package/dist/cjs/models/generated/assetClassItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetClassItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetClassItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAejC;;GAEG;AACH,MAAa,cAAe,SAAQ,aAAK;IASxC,YAAY,KAAuB;QAClC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,iBAAiB,EAAE,iBAAiB;YACpC,KAAK,EAAE,OAAO;YACd,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AAxBD,wCAwBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetClassItem {\n\tupdated?: Date | string;\n\tname?: string;\n\ttitle?: string;\n\tcreated?: Date | string;\n\tentity_type_title?: string;\n\towner?: string;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetClassItem extends Model {\n\tupdated: Date;\n\tname: string;\n\ttitle: string;\n\tcreated: Date;\n\tentityTypeTitle: string;\n\towner: string;\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetClassItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\tcreated: ['created', Date],\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\towner: 'owner',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetClassItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetClassItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAejC;;GAEG;AACH,MAAa,cAAe,SAAQ,aAAK;IA8BxC,YAAY,KAAuB;QAClC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,iBAAiB,EAAE,iBAAiB;YACpC,KAAK,EAAE,OAAO;YACd,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AA7CD,wCA6CC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetClassItem {\n\tupdated?: Date | string;\n\tname?: string;\n\ttitle?: string;\n\tcreated?: Date | string;\n\tentity_type_title?: string;\n\towner?: string;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetClassItem extends Model {\n\t/**\n\t\t* Time of modifying any variable of this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tupdated: Date;\n\t/**\n\t\t* Unique identifier name of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a>.\n\t*/\n\tname: string;\n\t/**\n\t\t* 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>.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Time of creation of this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a> in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tcreated: Date;\n\t/**\n\t\t* Display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen display name (title) from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeTitle: string;\n\t/**\n\t\t* Who created the Kelvin Class. 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>).\n\t*/\n\towner: string;\n\t/**\n\t\t* Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#entity-type' target='_blank'>Entity Type</a>. This is the chosen name from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetClassItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\tcreated: ['created', Date],\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\towner: 'owner',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetClassListPaginated.d.ts

@@ -13,6 +13,9 @@ export interface IAssetClassListPaginated {
  */
 export declare class AssetClassListPaginated extends Model {
     pagination: Pagination;
+    /**
+        * A dictionary which contains an array of up to `page_size` <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a>. If a bookmark has been used, then the array will start or end based on the `starting_after` or `ending_before` parameters.
+    */
     data: Array<AssetClassItem>;
     constructor(model?: IAssetClassListPaginated);
     mapping(): {

package/dist/cjs/models/generated/assetClassListPaginated.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetClassListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetClassListPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,qDAAmE;AACnE,6CAAuD;AAUvD;;GAEG;AACH,MAAa,uBAAwB,SAAQ,aAAK;IAIjD,YAAY,KAAgC;QAC3C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,UAAU,EAAE,CAAC,YAAY,EAAE,uBAAU,CAAC;YACtC,IAAI,EAAE,CAAC,MAAM,EAAE,+BAAc,CAAC;SAC9B,CAAC;IACH,CAAC;CACD;AAdD,0DAcC","sourcesContent":["import { Model } from '../model';\nimport { AssetClassItem, IAssetClassItem } from './assetClassItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetClassListPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetClassItem | IAssetClassItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetClassListPaginated extends Model {\n\tpagination: Pagination;\n\tdata: Array<AssetClassItem>;\n\n\tconstructor(model?: IAssetClassListPaginated) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tpagination: ['pagination', Pagination],\n\t\t\tdata: ['data', AssetClassItem]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetClassListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetClassListPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,qDAAmE;AACnE,6CAAuD;AAUvD;;GAEG;AACH,MAAa,uBAAwB,SAAQ,aAAK;IAOjD,YAAY,KAAgC;QAC3C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,UAAU,EAAE,CAAC,YAAY,EAAE,uBAAU,CAAC;YACtC,IAAI,EAAE,CAAC,MAAM,EAAE,+BAAc,CAAC;SAC9B,CAAC;IACH,CAAC;CACD;AAjBD,0DAiBC","sourcesContent":["import { Model } from '../model';\nimport { AssetClassItem, IAssetClassItem } from './assetClassItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetClassListPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetClassItem | IAssetClassItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetClassListPaginated extends Model {\n\tpagination: Pagination;\n\t/**\n\t\t* A dictionary which contains an array of up to `page_size` <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a>. If a bookmark has been used, then the array will start or end based on the `starting_after` or `ending_before` parameters.\n\t*/\n\tdata: Array<AssetClassItem>;\n\n\tconstructor(model?: IAssetClassListPaginated) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tpagination: ['pagination', Pagination],\n\t\t\tdata: ['data', AssetClassItem]\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetDataStreamItem.d.ts

@@ -10,7 +10,13 @@ export interface IAssetDataStreamItem {
  * @category Service Response Model Object
  */
 export declare class AssetDataStreamItem extends Model {
+    /**
+        * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetName: string;
+    /**
+        * Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a>.
+    */
     metricName: string;
     constructor(model?: IAssetDataStreamItem);
     mapping(): {

package/dist/cjs/models/generated/assetDataStreamItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetDataStreamItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetDataStreamItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAUjC;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAK;IAI7C,YAAY,KAA4B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,UAAU,EAAE,WAAW;YACvB,WAAW,EAAE,YAAY;SACzB,CAAC;IACH,CAAC;CACD;AAdD,kDAcC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetDataStreamItem {\n\tasset_name?: string;\n\tmetric_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetDataStreamItem extends Model {\n\tassetName: string;\n\tmetricName: string;\n\n\tconstructor(model?: IAssetDataStreamItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tasset_name: 'assetName',\n\t\t\tmetric_name: 'metricName'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetDataStreamItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetDataStreamItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAUjC;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAK;IAU7C,YAAY,KAA4B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,UAAU,EAAE,WAAW;YACvB,WAAW,EAAE,YAAY;SACzB,CAAC;IACH,CAAC;CACD;AApBD,kDAoBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetDataStreamItem {\n\tasset_name?: string;\n\tmetric_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetDataStreamItem extends Model {\n\t/**\n\t\t* Unique identifier name of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetName: string;\n\t/**\n\t\t* Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a>.\n\t*/\n\tmetricName: string;\n\n\tconstructor(model?: IAssetDataStreamItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tasset_name: 'assetName',\n\t\t\tmetric_name: 'metricName'\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetDataStreamsListPaginated.d.ts

@@ -13,6 +13,9 @@ export interface IAssetDataStreamsListPaginated {
  */
 export declare class AssetDataStreamsListPaginated extends Model {
     pagination: Pagination;
+    /**
+        * A dictionary which contains an array of up to `page_size` <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects. If a bookmark has been used, then the array will start or end based on the `starting_after` or `ending_before` parameters.
+    */
     data: Array<AssetDataStreamItem>;
     constructor(model?: IAssetDataStreamsListPaginated);
     mapping(): {

package/dist/cjs/models/generated/assetDataStreamsListPaginated.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetDataStreamsListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetDataStreamsListPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,+DAAkF;AAClF,6CAAuD;AAUvD;;GAEG;AACH,MAAa,6BAA8B,SAAQ,aAAK;IAIvD,YAAY,KAAsC;QACjD,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,UAAU,EAAE,CAAC,YAAY,EAAE,uBAAU,CAAC;YACtC,IAAI,EAAE,CAAC,MAAM,EAAE,yCAAmB,CAAC;SACnC,CAAC;IACH,CAAC;CACD;AAdD,sEAcC","sourcesContent":["import { Model } from '../model';\nimport { AssetDataStreamItem, IAssetDataStreamItem } from './assetDataStreamItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetDataStreamsListPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetDataStreamItem | IAssetDataStreamItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetDataStreamsListPaginated extends Model {\n\tpagination: Pagination;\n\tdata: Array<AssetDataStreamItem>;\n\n\tconstructor(model?: IAssetDataStreamsListPaginated) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tpagination: ['pagination', Pagination],\n\t\t\tdata: ['data', AssetDataStreamItem]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetDataStreamsListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetDataStreamsListPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,+DAAkF;AAClF,6CAAuD;AAUvD;;GAEG;AACH,MAAa,6BAA8B,SAAQ,aAAK;IAOvD,YAAY,KAAsC;QACjD,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,UAAU,EAAE,CAAC,YAAY,EAAE,uBAAU,CAAC;YACtC,IAAI,EAAE,CAAC,MAAM,EAAE,yCAAmB,CAAC;SACnC,CAAC;IACH,CAAC;CACD;AAjBD,sEAiBC","sourcesContent":["import { Model } from '../model';\nimport { AssetDataStreamItem, IAssetDataStreamItem } from './assetDataStreamItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetDataStreamsListPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetDataStreamItem | IAssetDataStreamItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetDataStreamsListPaginated extends Model {\n\tpagination: Pagination;\n\t/**\n\t\t* A dictionary which contains an array of up to `page_size` <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> pair objects. If a bookmark has been used, then the array will start or end based on the `starting_after` or `ending_before` parameters.\n\t*/\n\tdata: Array<AssetDataStreamItem>;\n\n\tconstructor(model?: IAssetDataStreamsListPaginated) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tpagination: ['pagination', Pagination],\n\t\t\tdata: ['data', AssetDataStreamItem]\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetHierarchies.d.ts

@@ -10,6 +10,9 @@ export interface IAssetHierarchies {
  * @category Service Response Model Object
  */
 export declare class AssetHierarchies extends Model {
+    /**
+        * A dictionary with a data property of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> created on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> with their <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> structure.
+    */
     data: Array<Asset>;
     constructor(model?: IAssetHierarchies);
     mapping(): {

package/dist/cjs/models/generated/assetHierarchies.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetHierarchies.js","sourceRoot":"","sources":["../../../../src/models/generated/assetHierarchies.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,mCAAwC;AASxC;;GAEG;AACH,MAAa,gBAAiB,SAAQ,aAAK;IAG1C,YAAY,KAAyB;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,aAAK,CAAC;SACrB,CAAC;IACH,CAAC;CACD;AAZD,4CAYC","sourcesContent":["import { Model } from '../model';\nimport { Asset, IAsset } from './asset';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetHierarchies {\n\tdata?: Array<Asset | IAsset>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetHierarchies extends Model {\n\tdata: Array<Asset>;\n\n\tconstructor(model?: IAssetHierarchies) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', Asset]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetHierarchies.js","sourceRoot":"","sources":["../../../../src/models/generated/assetHierarchies.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,mCAAwC;AASxC;;GAEG;AACH,MAAa,gBAAiB,SAAQ,aAAK;IAM1C,YAAY,KAAyB;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,aAAK,CAAC;SACrB,CAAC;IACH,CAAC;CACD;AAfD,4CAeC","sourcesContent":["import { Model } from '../model';\nimport { Asset, IAsset } from './asset';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetHierarchies {\n\tdata?: Array<Asset | IAsset>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetHierarchies extends Model {\n\t/**\n\t\t* A dictionary with a data property of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> created on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> with their <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> structure.\n\t*/\n\tdata: Array<Asset>;\n\n\tconstructor(model?: IAssetHierarchies) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', Asset]\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetHierarchyItem.d.ts

@@ -19,14 +19,38 @@ export interface IAssetHierarchyItem {
  * @category Service Response Model Object
  */
 export declare class AssetHierarchyItem extends Model {
+    /**
+        * 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> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetTypeName: string;
+    /**
+        * Current status (state) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. There are four status options; `online`, `offline`, `partially_online` and `unknown`.
+    */
     status: string;
+    /**
+        * Unique identifier name for this property in the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" 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.
+    */
     name: string;
+    /**
+        * Display name (title) for this property in the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target=\"_blank\">Kelvin Asset</a>. This is a friendly name displayed in lists and in references within asset details.</p> You can use any character, numeric, space and special character in this parameter.
+    */
     title: string;
+    /**
+        * A list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> which will include any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</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> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</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 this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a>.
+    */
     hierarchy: Array<AssetHierarchyItem>;
+    /**
+        * List of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/\" target=\"_blank\">Kelvin Metrics</a> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     metrics: Array<AssetMetricItem>;
+    /**
+        * 2D and 3D information and links to the models for displaying in <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/\" target=\"_blank\">Kelvin Maps</a>. More details about the use of these models can be found in the <a href=\"https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#2d-3d-option\" target=\"_blank\">Kelvin Maps Documentation</a>.
+    */
     visualization: Visualization;
     _new: boolean;
+    /**
+        * Unique identifier name of the entity type linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.
+    */
     entityTypeName: string;
     constructor(model?: IAssetHierarchyItem);
     mapping(): {

package/dist/cjs/models/generated/assetHierarchyItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetHierarchyItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetHierarchyItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uDAAsE;AACtE,mDAAgE;AAiBhE;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAK;IAW5C,YAAY,KAA2B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,CAAC,WAAW,EAAE,kBAAkB,CAAC;YAC5C,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,GAAG,EAAE,MAAM;YACX,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AA5BD,gDA4BC","sourcesContent":["import { Model } from '../model';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetHierarchyItem {\n\tasset_type_name?: string;\n\tstatus?: string;\n\tname?: string;\n\ttitle?: string;\n\thierarchy?: Array<AssetHierarchyItem | IAssetHierarchyItem>;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\tvisualization?: Visualization | IVisualization;\n\tnew?: boolean;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetHierarchyItem extends Model {\n\tassetTypeName: string;\n\tstatus: string;\n\tname: string;\n\ttitle: string;\n\thierarchy: Array<AssetHierarchyItem>;\n\tmetrics: Array<AssetMetricItem>;\n\tvisualization: Visualization;\n\t_new: boolean;\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetHierarchyItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tasset_type_name: 'assetTypeName',\n\t\t\tstatus: 'status',\n\t\t\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\thierarchy: ['hierarchy', AssetHierarchyItem],\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\tvisualization: ['visualization', Visualization],\n\t\t\tnew: '_new',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetHierarchyItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetHierarchyItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uDAAsE;AACtE,mDAAgE;AAiBhE;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAK;IAmC5C,YAAY,KAA2B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,CAAC,WAAW,EAAE,kBAAkB,CAAC;YAC5C,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,GAAG,EAAE,MAAM;YACX,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AApDD,gDAoDC","sourcesContent":["import { Model } from '../model';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetHierarchyItem {\n\tasset_type_name?: string;\n\tstatus?: string;\n\tname?: string;\n\ttitle?: string;\n\thierarchy?: Array<AssetHierarchyItem | IAssetHierarchyItem>;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\tvisualization?: Visualization | IVisualization;\n\tnew?: boolean;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetHierarchyItem extends Model {\n\t/**\n\t\t* 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> linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetTypeName: string;\n\t/**\n\t\t* Current status (state) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. There are four status options; `online`, `offline`, `partially_online` and `unknown`.\n\t*/\n\tstatus: string;\n\t/**\n\t\t* Unique identifier name for this property in the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\\\" 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.\n\t*/\n\tname: string;\n\t/**\n\t\t* Display name (title) for this property in the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\\\" target=\\\"_blank\\\">Kelvin Asset</a>. This is a friendly name displayed in lists and in references within asset details.</p> You can use any character, numeric, space and special character in this parameter.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* A list of all <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Assets</a> which will include any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</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> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensors</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 this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Assets</a>.\n\t*/\n\thierarchy: Array<AssetHierarchyItem>;\n\t/**\n\t\t* List of all <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/\\\" target=\\\"_blank\\\">Kelvin Metrics</a> linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tmetrics: Array<AssetMetricItem>;\n\t/**\n\t\t* 2D and 3D information and links to the models for displaying in <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/\\\" target=\\\"_blank\\\">Kelvin Maps</a>. More details about the use of these models can be found in the <a href=\\\"https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#2d-3d-option\\\" target=\\\"_blank\\\">Kelvin Maps Documentation</a>.\n\t*/\n\tvisualization: Visualization;\n\t_new: boolean;\n\t/**\n\t\t* Unique identifier name of the entity type linked to this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a>.\n\t*/\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetHierarchyItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tasset_type_name: 'assetTypeName',\n\t\t\tstatus: 'status',\n\t\t\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\thierarchy: ['hierarchy', AssetHierarchyItem],\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\tvisualization: ['visualization', Visualization],\n\t\t\tnew: '_new',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetHierarchyList.d.ts

@@ -10,6 +10,9 @@ export interface IAssetHierarchyList {
  * @category Service Response Model Object
  */
 export declare class AssetHierarchyList extends Model {
+    /**
+        * A dictionary with a data property of 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> with their <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> structure.
+    */
     data: Array<AssetHierarchyItem>;
     constructor(model?: IAssetHierarchyList);
     mapping(): {

package/dist/cjs/models/generated/assetHierarchyList.js.map

@@ -1 +1 @@
-{"version":3,"file":"assetHierarchyList.js","sourceRoot":"","sources":["../../../../src/models/generated/assetHierarchyList.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,6DAA+E;AAS/E;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAK;IAG5C,YAAY,KAA2B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,uCAAkB,CAAC;SAClC,CAAC;IACH,CAAC;CACD;AAZD,gDAYC","sourcesContent":["import { Model } from '../model';\nimport { AssetHierarchyItem, IAssetHierarchyItem } from './assetHierarchyItem';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetHierarchyList {\n\tdata?: Array<AssetHierarchyItem | IAssetHierarchyItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetHierarchyList extends Model {\n\tdata: Array<AssetHierarchyItem>;\n\n\tconstructor(model?: IAssetHierarchyList) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', AssetHierarchyItem]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetHierarchyList.js","sourceRoot":"","sources":["../../../../src/models/generated/assetHierarchyList.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,6DAA+E;AAS/E;;GAEG;AACH,MAAa,kBAAmB,SAAQ,aAAK;IAM5C,YAAY,KAA2B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,uCAAkB,CAAC;SAClC,CAAC;IACH,CAAC;CACD;AAfD,gDAeC","sourcesContent":["import { Model } from '../model';\nimport { AssetHierarchyItem, IAssetHierarchyItem } from './assetHierarchyItem';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetHierarchyList {\n\tdata?: Array<AssetHierarchyItem | IAssetHierarchyItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetHierarchyList extends Model {\n\t/**\n\t\t* A dictionary with a data property of 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> with their <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> structure.\n\t*/\n\tdata: Array<AssetHierarchyItem>;\n\n\tconstructor(model?: IAssetHierarchyList) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', AssetHierarchyItem]\n\t\t};\n\t}\n}\n"]}

package/dist/cjs/models/generated/assetItem.d.ts

@@ -22,17 +22,50 @@ export interface IAssetItem {
  * @category Service Response Model Object
  */
 export declare class AssetItem extends Model {
+    /**
+     * 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> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+     */
     assetTypeName: string;
+    /**
+     * Current status (state) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a>. There are four status options; `online`, `offline`, `partially_online` and `unknown`.
+     */
     status: AssetStatusItem;
+    /**
+     * Time of modifying any variable of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+     */
     updated: Date;
+    /**
+     * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+     */
     name: string;
+    /**
+     * Time of creation of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+     */
     created: Date;
+    /**
+     * Unique identifier name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+     */
     assetClassName: string;
+    /**
+     * Display name (title) of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+     */
     title: string;
+    /**
+     * Display name of the entity type linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.
+     */
     entityTypeTitle: string;
+    /**
+     * 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> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+     */
     assetTypeTitle: string;
+    /**
+     * 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> linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+     */
     assetClassTitle: string;
     properties: Array<AssetProperty>;
+    /**
+     * Unique identifier name of the entity type linked to this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.
+     */
     entityTypeName: string;
     constructor(model?: IAssetItem);
     mapping(): {