@kelvininc/js-client-sdk 7.8.1 → 7.11.0

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

@@ -11,8 +11,17 @@ export interface IAssetProperty {
  * @category Service Response Model Object
  */
 export declare class AssetProperty extends Model {
+    /**
+        * 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;
+    /**
+        * Value for this property.
+    */
     value: 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;
     constructor(model?: IAssetProperty);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetProperty.js","sourceRoot":"","sources":["../../../../src/models/generated/assetProperty.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAWjC;;GAEG;AACH,MAAa,aAAc,SAAQ,aAAK;IAKvC,YAAY,KAAsB;QACjC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAhBD,sCAgBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetProperty {\n\tname?: string;\n\tvalue?: string;\n\ttitle?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetProperty extends Model {\n\tname: string;\n\tvalue: string;\n\ttitle: string;\n\n\tconstructor(model?: IAssetProperty) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tname: 'name',\n\t\t\tvalue: 'value',\n\t\t\ttitle: 'title'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetProperty.js","sourceRoot":"","sources":["../../../../src/models/generated/assetProperty.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAWjC;;GAEG;AACH,MAAa,aAAc,SAAQ,aAAK;IAcvC,YAAY,KAAsB;QACjC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAzBD,sCAyBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetProperty {\n\tname?: string;\n\tvalue?: string;\n\ttitle?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetProperty extends Model {\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* Value for this property.\n\t*/\n\tvalue: 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\n\tconstructor(model?: IAssetProperty) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tname: 'name',\n\t\t\tvalue: 'value',\n\t\t\ttitle: 'title'\n\t\t};\n\t}\n}\n"]}

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

@@ -18,14 +18,38 @@ export interface IAssetStatisticsItem {
  * @category Service Response Model Object
  */
 export declare class AssetStatisticsItem 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>.
+    */
     assetTypeName: string;
+    /**
+        * 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;
+    /**
+        * 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;
+    /**
+        * Total number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that are direct children.</p> This will not count more than one level below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> in the `name`. So direct children that have children of their own will only be counted as 1.
+    */
     childrenCount: number;
+    /**
+        * Display name of the entity type. This is the chosen display name (title) from a fixed list defined by Kelvin.
+    */
     entityTypeTitle: string;
+    /**
+        * The current percentage failure time of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> compared to the total failure time of all <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-groups\" target=\"_blank\">Kelvin Group</a>.
+    */
     failureQuotient: number;
     oee: AssetOEE;
+    /**
+        * 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>.
+    */
     assetTypeTitle: string;
+    /**
+        * Unique identifier name of the entity type. This is the chosen name from a fixed list defined by Kelvin.
+    */
     entityTypeName: string;
     constructor(model?: IAssetStatisticsItem);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetStatisticsItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatisticsItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,yCAAiD;AAiBjD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAK;IAW7C,YAAY,KAA4B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,eAAe;YAC/B,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,iBAAiB;YACnC,GAAG,EAAE,CAAC,KAAK,EAAE,mBAAQ,CAAC;YACtB,gBAAgB,EAAE,gBAAgB;YAClC,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AA5BD,kDA4BC","sourcesContent":["import { Model } from '../model';\nimport { AssetOEE, IAssetOEE } from './assetOEE';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatisticsItem {\n\tasset_type_name?: string;\n\tname?: string;\n\ttitle?: string;\n\tchildren_count?: number;\n\tentity_type_title?: string;\n\tfailure_quotient?: number;\n\toee?: AssetOEE | IAssetOEE;\n\tasset_type_title?: string;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatisticsItem extends Model {\n\tassetTypeName: string;\n\tname: string;\n\ttitle: string;\n\tchildrenCount: number;\n\tentityTypeTitle: string;\n\tfailureQuotient: number;\n\toee: AssetOEE;\n\tassetTypeTitle: string;\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetStatisticsItem) {\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\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\tchildren_count: 'childrenCount',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tfailure_quotient: 'failureQuotient',\n\t\t\toee: ['oee', AssetOEE],\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetStatisticsItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatisticsItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,yCAAiD;AAiBjD;;GAEG;AACH,MAAa,mBAAoB,SAAQ,aAAK;IAmC7C,YAAY,KAA4B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,eAAe;YAC/B,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,iBAAiB;YACnC,GAAG,EAAE,CAAC,KAAK,EAAE,mBAAQ,CAAC;YACtB,gBAAgB,EAAE,gBAAgB;YAClC,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD;AApDD,kDAoDC","sourcesContent":["import { Model } from '../model';\nimport { AssetOEE, IAssetOEE } from './assetOEE';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatisticsItem {\n\tasset_type_name?: string;\n\tname?: string;\n\ttitle?: string;\n\tchildren_count?: number;\n\tentity_type_title?: string;\n\tfailure_quotient?: number;\n\toee?: AssetOEE | IAssetOEE;\n\tasset_type_title?: string;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatisticsItem 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>.\n\t*/\n\tassetTypeName: string;\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* 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* Total number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> that are direct children.</p> This will not count more than one level below the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> in the `name`. So direct children that have children of their own will only be counted as 1.\n\t*/\n\tchildrenCount: number;\n\t/**\n\t\t* Display name of the entity type. This is the chosen display name (title) from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeTitle: string;\n\t/**\n\t\t* The current percentage failure time of this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a> compared to the total failure time of all <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-groups\\\" target=\\\"_blank\\\">Kelvin Group</a>.\n\t*/\n\tfailureQuotient: number;\n\toee: AssetOEE;\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>.\n\t*/\n\tassetTypeTitle: string;\n\t/**\n\t\t* Unique identifier name of the entity type. This is the chosen name from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeName: string;\n\n\tconstructor(model?: IAssetStatisticsItem) {\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\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\tchildren_count: 'childrenCount',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tfailure_quotient: 'failureQuotient',\n\t\t\toee: ['oee', AssetOEE],\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}

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

@@ -13,6 +13,9 @@ export interface IAssetStatisticsPaginated {
  */
 export declare class AssetStatisticsPaginated 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> statistics. If a bookmark has been used, then the array will start or end based on the `starting_after` or `ending_before` parameters.
+    */
     data: Array<AssetStatisticsItem>;
     constructor(model?: IAssetStatisticsPaginated);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetStatisticsPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatisticsPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,+DAAkF;AAClF,6CAAuD;AAUvD;;GAEG;AACH,MAAa,wBAAyB,SAAQ,aAAK;IAIlD,YAAY,KAAiC;QAC5C,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,4DAcC","sourcesContent":["import { Model } from '../model';\nimport { AssetStatisticsItem, IAssetStatisticsItem } from './assetStatisticsItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatisticsPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetStatisticsItem | IAssetStatisticsItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatisticsPaginated extends Model {\n\tpagination: Pagination;\n\tdata: Array<AssetStatisticsItem>;\n\n\tconstructor(model?: IAssetStatisticsPaginated) {\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', AssetStatisticsItem]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetStatisticsPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatisticsPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,+DAAkF;AAClF,6CAAuD;AAUvD;;GAEG;AACH,MAAa,wBAAyB,SAAQ,aAAK;IAOlD,YAAY,KAAiC;QAC5C,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,4DAiBC","sourcesContent":["import { Model } from '../model';\nimport { AssetStatisticsItem, IAssetStatisticsItem } from './assetStatisticsItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatisticsPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetStatisticsItem | IAssetStatisticsItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatisticsPaginated 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> statistics. 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<AssetStatisticsItem>;\n\n\tconstructor(model?: IAssetStatisticsPaginated) {\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', AssetStatisticsItem]\n\t\t};\n\t}\n}\n"]}

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

@@ -10,6 +10,9 @@ export interface IAssetStatus {
  * @category Service Response Model Object
  */
 export declare class AssetStatus extends Model {
+    /**
+        * Array of dictionary objects of the status 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>.
+    */
     data: Array<SimpleAsset>;
     constructor(model?: IAssetStatus);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetStatus.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatus.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,+CAA0D;AAS1D;;GAEG;AACH,MAAa,WAAY,SAAQ,aAAK;IAGrC,YAAY,KAAoB;QAC/B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,yBAAW,CAAC;SAC3B,CAAC;IACH,CAAC;CACD;AAZD,kCAYC","sourcesContent":["import { Model } from '../model';\nimport { ISimpleAsset, SimpleAsset } from './simpleAsset';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatus {\n\tdata?: Array<SimpleAsset | ISimpleAsset>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatus extends Model {\n\tdata: Array<SimpleAsset>;\n\n\tconstructor(model?: IAssetStatus) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', SimpleAsset]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetStatus.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatus.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,+CAA0D;AAS1D;;GAEG;AACH,MAAa,WAAY,SAAQ,aAAK;IAMrC,YAAY,KAAoB;QAC/B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,yBAAW,CAAC;SAC3B,CAAC;IACH,CAAC;CACD;AAfD,kCAeC","sourcesContent":["import { Model } from '../model';\nimport { ISimpleAsset, SimpleAsset } from './simpleAsset';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatus {\n\tdata?: Array<SimpleAsset | ISimpleAsset>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatus extends Model {\n\t/**\n\t\t* Array of dictionary objects of the status 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>.\n\t*/\n\tdata: Array<SimpleAsset>;\n\n\tconstructor(model?: IAssetStatus) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', SimpleAsset]\n\t\t};\n\t}\n}\n"]}

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

@@ -13,10 +13,25 @@ export interface IAssetStatusCount {
  * @category Service Response Model Object
  */
 export declare class AssetStatusCount extends Model {
+    /**
+        * Count 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> that have at least one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> receiving active data. </p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> only has <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a>, then it will be classed at Online, not partially online.
+    */
     partiallyOnline: number;
+    /**
+        * Count 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> that has no associated <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metrics</a> or the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> has never received data. i.e. It has not been established if this connection is a valid address.
+    */
     unknown: number;
+    /**
+        * Count 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> that have all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> inactive and not receiving data.
+    */
     offline: number;
+    /**
+        * Count 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>.
+    */
     total: number;
+    /**
+        * Count 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> that have all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> receiving active data.
+    */
     online: number;
     constructor(model?: IAssetStatusCount);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetStatusCount.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatusCount.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAajC;;GAEG;AACH,MAAa,gBAAiB,SAAQ,aAAK;IAO1C,YAAY,KAAyB;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,gBAAgB,EAAE,iBAAiB;YACnC,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;SAChB,CAAC;IACH,CAAC;CACD;AApBD,4CAoBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatusCount {\n\tpartially_online?: number;\n\tunknown?: number;\n\toffline?: number;\n\ttotal?: number;\n\tonline?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatusCount extends Model {\n\tpartiallyOnline: number;\n\tunknown: number;\n\toffline: number;\n\ttotal: number;\n\tonline: number;\n\n\tconstructor(model?: IAssetStatusCount) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tpartially_online: 'partiallyOnline',\n\t\t\tunknown: 'unknown',\n\t\t\toffline: 'offline',\n\t\t\ttotal: 'total',\n\t\t\tonline: 'online'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetStatusCount.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatusCount.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAajC;;GAEG;AACH,MAAa,gBAAiB,SAAQ,aAAK;IAsB1C,YAAY,KAAyB;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,gBAAgB,EAAE,iBAAiB;YACnC,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;SAChB,CAAC;IACH,CAAC;CACD;AAnCD,4CAmCC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatusCount {\n\tpartially_online?: number;\n\tunknown?: number;\n\toffline?: number;\n\ttotal?: number;\n\tonline?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatusCount extends Model {\n\t/**\n\t\t* Count 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> that have at least one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> receiving active data. </p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> only has <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a>, then it will be classed at Online, not partially online.\n\t*/\n\tpartiallyOnline: number;\n\t/**\n\t\t* Count 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> that has no associated <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metrics</a> or the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> has never received data. i.e. It has not been established if this connection is a valid address.\n\t*/\n\tunknown: number;\n\t/**\n\t\t* Count 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> that have all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> inactive and not receiving data.\n\t*/\n\toffline: number;\n\t/**\n\t\t* Count 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>.\n\t*/\n\ttotal: number;\n\t/**\n\t\t* Count 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> that have all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics' target='_blank'>Kelvin Metric</a> receiving active data.\n\t*/\n\tonline: number;\n\n\tconstructor(model?: IAssetStatusCount) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tpartially_online: 'partiallyOnline',\n\t\t\tunknown: 'unknown',\n\t\t\toffline: 'offline',\n\t\t\ttotal: 'total',\n\t\t\tonline: 'online'\n\t\t};\n\t}\n}\n"]}

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

@@ -10,7 +10,13 @@ export interface IAssetStatusItem {
  * @category Service Response Model Object
  */
 export declare class AssetStatusItem extends Model {
+    /**
+        * 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`.
+    */
     state: string;
+    /**
+        * Time when the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> was last seen in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+    */
     lastSeen: Date;
     constructor(model?: IAssetStatusItem);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetStatusItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatusItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAUjC;;GAEG;AACH,MAAa,eAAgB,SAAQ,aAAK;IAIzC,YAAY,KAAwB;QACnC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC;SAC7B,CAAC;IACH,CAAC;CACD;AAdD,0CAcC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatusItem {\n\tstate?: string;\n\tlast_seen?: Date | string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatusItem extends Model {\n\tstate: string;\n\tlastSeen: Date;\n\n\tconstructor(model?: IAssetStatusItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tstate: 'state',\n\t\t\tlast_seen: ['lastSeen', Date]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetStatusItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetStatusItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAUjC;;GAEG;AACH,MAAa,eAAgB,SAAQ,aAAK;IAUzC,YAAY,KAAwB;QACnC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC;SAC7B,CAAC;IACH,CAAC;CACD;AApBD,0CAoBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetStatusItem {\n\tstate?: string;\n\tlast_seen?: Date | string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetStatusItem extends Model {\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\tstate: string;\n\t/**\n\t\t* Time when the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a> was last seen in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tlastSeen: Date;\n\n\tconstructor(model?: IAssetStatusItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tstate: 'state',\n\t\t\tlast_seen: ['lastSeen', Date]\n\t\t};\n\t}\n}\n"]}

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

@@ -32,24 +32,72 @@ export interface IAssetTemplate {
  * @category Service Response Model Object
  */
 export declare class AssetTemplate extends Model {
+    /**
+        * The name (not the Display Name / Title) of the default <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetTypeName: string;
     visualization: Visualization;
+    /**
+        * 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;
+    /**
+        * Detailed description of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>
+    */
     description: 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;
+    /**
+        * Full details of all <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> in the Kelvin Template <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>.
+    */
     hierarchy: Array<AssetTemplateHierarchy>;
+    /**
+        * The name (not the Display Name / Title) of the default <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <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/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>.
+    */
     title: string;
+    /**
+        * Entity type display name (title) that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `Group`, `Asset`, `Component`, `Part` and `Sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.
+    */
     entityTypeTitle: string;
+    /**
+        * 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>.
+    */
     name: string;
+    /**
+        * Unused. This is reserved as a future feature.
+    */
     metrics: Array<AssetMetricItem>;
+    /**
+        * Who created the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>. 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/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>).
+    */
     owner: string;
     failureDetection: FailureDetection;
+    /**
+        * A http(s) URL link to an image to visually display your template picture next to the description.</p> The file can be in any web-compatible format including jpg, png, gif, animated gif and apng. Even though any size is allowed as it will be automatically resized, it is advised to keep it below 400 x 400 px.</p> If the link is behind a secure login, all login or token details must be incorporated into the URL here.
+    */
     imageUrl: string;
+    /**
+        * The Display Name (Title) of the default <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetTypeTitle: string;
+    /**
+        * The Display Name (Title) of the default <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetClassTitle: string;
     properties: Array<AssetTemplateProperties>;
+    /**
+        * Entity type name that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `group`, `asset`, `component`, `part` and `sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.
+    */
     entityTypeName: string;
+    /**
+        * Unused. This is reserved as a future feature.
+    */
     hints: any;
     constructor(model?: IAssetTemplate);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetTemplate.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplate.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uDAAsE;AACtE,qEAA2F;AAC3F,uEAA8F;AAC9F,yDAAyE;AACzE,mDAAgE;AA2BhE;;GAEG;AACH,MAAa,aAAc,SAAQ,aAAK;IAqBvC,YAAY,KAAsB;QACjC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,SAAS,EAAE,CAAC,WAAW,EAAE,+CAAsB,CAAC;YAChD,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,SAAS,EAAE,UAAU;YACrB,gBAAgB,EAAE,gBAAgB;YAClC,iBAAiB,EAAE,iBAAiB;YACpC,UAAU,EAAE,CAAC,YAAY,EAAE,iDAAuB,CAAC;YACnD,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAhDD,sCAgDC","sourcesContent":["import { Model } from '../model';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { AssetTemplateHierarchy, IAssetTemplateHierarchy } from './assetTemplateHierarchy';\nimport { AssetTemplateProperties, IAssetTemplateProperties } from './assetTemplateProperties';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplate {\n\tasset_type_name?: string;\n\tvisualization?: Visualization | IVisualization;\n\tupdated?: Date | string;\n\tdescription?: string;\n\tcreated?: Date | string;\n\thierarchy?: Array<AssetTemplateHierarchy | IAssetTemplateHierarchy>;\n\tasset_class_name?: string;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tname?: string;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\towner?: string;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\timage_url?: string;\n\tasset_type_title?: string;\n\tasset_class_title?: string;\n\tproperties?: Array<AssetTemplateProperties | IAssetTemplateProperties>;\n\tentity_type_name?: string;\n\thints?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplate extends Model {\n\tassetTypeName: string;\n\tvisualization: Visualization;\n\tupdated: Date;\n\tdescription: string;\n\tcreated: Date;\n\thierarchy: Array<AssetTemplateHierarchy>;\n\tassetClassName: string;\n\ttitle: string;\n\tentityTypeTitle: string;\n\tname: string;\n\tmetrics: Array<AssetMetricItem>;\n\towner: string;\n\tfailureDetection: FailureDetection;\n\timageUrl: string;\n\tassetTypeTitle: string;\n\tassetClassTitle: string;\n\tproperties: Array<AssetTemplateProperties>;\n\tentityTypeName: string;\n\thints: any;\n\n\tconstructor(model?: IAssetTemplate) {\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\tvisualization: ['visualization', Visualization],\n\t\t\tupdated: ['updated', Date],\n\t\t\tdescription: 'description',\n\t\t\tcreated: ['created', Date],\n\t\t\thierarchy: ['hierarchy', AssetTemplateHierarchy],\n\t\t\tasset_class_name: 'assetClassName',\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tname: 'name',\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\towner: 'owner',\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\timage_url: 'imageUrl',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tasset_class_title: 'assetClassTitle',\n\t\t\tproperties: ['properties', AssetTemplateProperties],\n\t\t\tentity_type_name: 'entityTypeName',\n\t\t\thints: 'hints'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetTemplate.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplate.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uDAAsE;AACtE,qEAA2F;AAC3F,uEAA8F;AAC9F,yDAAyE;AACzE,mDAAgE;AA2BhE;;GAEG;AACH,MAAa,aAAc,SAAQ,aAAK;IAqEvC,YAAY,KAAsB;QACjC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,SAAS,EAAE,CAAC,WAAW,EAAE,+CAAsB,CAAC;YAChD,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,SAAS,EAAE,UAAU;YACrB,gBAAgB,EAAE,gBAAgB;YAClC,iBAAiB,EAAE,iBAAiB;YACpC,UAAU,EAAE,CAAC,YAAY,EAAE,iDAAuB,CAAC;YACnD,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAhGD,sCAgGC","sourcesContent":["import { Model } from '../model';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { AssetTemplateHierarchy, IAssetTemplateHierarchy } from './assetTemplateHierarchy';\nimport { AssetTemplateProperties, IAssetTemplateProperties } from './assetTemplateProperties';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplate {\n\tasset_type_name?: string;\n\tvisualization?: Visualization | IVisualization;\n\tupdated?: Date | string;\n\tdescription?: string;\n\tcreated?: Date | string;\n\thierarchy?: Array<AssetTemplateHierarchy | IAssetTemplateHierarchy>;\n\tasset_class_name?: string;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tname?: string;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\towner?: string;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\timage_url?: string;\n\tasset_type_title?: string;\n\tasset_class_title?: string;\n\tproperties?: Array<AssetTemplateProperties | IAssetTemplateProperties>;\n\tentity_type_name?: string;\n\thints?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplate extends Model {\n\t/**\n\t\t* The name (not the Display Name / Title) of the default <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\\\" target=\\\"_blank\\\">Kelvin Asset Type</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetTypeName: string;\n\tvisualization: Visualization;\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* Detailed description of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>\n\t*/\n\tdescription: 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* Full details of all <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> in the Kelvin Template <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a>.\n\t*/\n\thierarchy: Array<AssetTemplateHierarchy>;\n\t/**\n\t\t* The name (not the Display Name / Title) of the default <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <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/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Entity type display name (title) that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `Group`, `Asset`, `Component`, `Part` and `Sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.\n\t*/\n\tentityTypeTitle: string;\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>.\n\t*/\n\tname: string;\n\t/**\n\t\t* Unused. This is reserved as a future feature.\n\t*/\n\tmetrics: Array<AssetMetricItem>;\n\t/**\n\t\t* Who created the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>. 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/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>).\n\t*/\n\towner: string;\n\tfailureDetection: FailureDetection;\n\t/**\n\t\t* A http(s) URL link to an image to visually display your template picture next to the description.</p> The file can be in any web-compatible format including jpg, png, gif, animated gif and apng. Even though any size is allowed as it will be automatically resized, it is advised to keep it below 400 x 400 px.</p> If the link is behind a secure login, all login or token details must be incorporated into the URL here.\n\t*/\n\timageUrl: string;\n\t/**\n\t\t* The Display Name (Title) of the default <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\\\" target=\\\"_blank\\\">Kelvin Asset Type</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <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* The Display Name (Title) of the default <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\\\" target=\\\"_blank\\\">Kelvin Asset Class</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetClassTitle: string;\n\tproperties: Array<AssetTemplateProperties>;\n\t/**\n\t\t* Entity type name that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `group`, `asset`, `component`, `part` and `sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.\n\t*/\n\tentityTypeName: string;\n\t/**\n\t\t* Unused. This is reserved as a future feature.\n\t*/\n\thints: any;\n\n\tconstructor(model?: IAssetTemplate) {\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\tvisualization: ['visualization', Visualization],\n\t\t\tupdated: ['updated', Date],\n\t\t\tdescription: 'description',\n\t\t\tcreated: ['created', Date],\n\t\t\thierarchy: ['hierarchy', AssetTemplateHierarchy],\n\t\t\tasset_class_name: 'assetClassName',\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tname: 'name',\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\towner: 'owner',\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\timage_url: 'imageUrl',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tasset_class_title: 'assetClassTitle',\n\t\t\tproperties: ['properties', AssetTemplateProperties],\n\t\t\tentity_type_name: 'entityTypeName',\n\t\t\thints: 'hints'\n\t\t};\n\t}\n}\n"]}

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

@@ -23,16 +23,40 @@ export interface IAssetTemplateHierarchy {
  * @category Service Response Model Object
  */
 export declare class AssetTemplateHierarchy extends Model {
+    /**
+        * The name (not the Display Name / Title) of the default <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     assetTypeName: string;
     visualization: Visualization;
+    /**
+        * Name of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a> to copy its full <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> to this location.</p> If this parameter is used, no other parameter in this structure is required.
+    */
     fromTemplateName: string;
+    /**
+        * This is a recursive array that can reach unlimited levels of <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> to be able to accurately describe all items in your <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     hierarchy: Array<AssetTemplateHierarchy>;
+    /**
+        * Default display name (title) for this property in the new Kelvin Template. This is a friendly name displayed in lists and in references.</p> You can use any character, numeric, space and special character in this parameter.</p> This is shown as an example Display Name parameter field.</p> If you use `from_template_name parameter` this parameter is not required.
+    */
     title: string;
+    /**
+        * Entity type display name that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `Group`, `Asset`, `Component`, `Part` and `Sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.
+    */
     entityTypeTitle: string;
+    /**
+        * Unused. This is reserved as a future feature.
+    */
     metrics: Array<AssetMetricItem>;
     failureDetection: FailureDetection;
     properties: Array<AssetTemplateProperties>;
+    /**
+        * Entity type name that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `group`, `asset`, `component`, `part` and `sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.
+    */
     entityTypeName: string;
+    /**
+        * Unused. This is reserved as a future feature.
+    */
     hints: any;
     constructor(model?: IAssetTemplateHierarchy);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetTemplateHierarchy.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateHierarchy.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uDAAsE;AACtE,uEAA8F;AAC9F,yDAAyE;AACzE,mDAAgE;AAmBhE;;GAEG;AACH,MAAa,sBAAuB,SAAQ,aAAK;IAahD,YAAY,KAA+B;QAC1C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,kBAAkB,EAAE,kBAAkB;YACtC,SAAS,EAAE,CAAC,WAAW,EAAE,sBAAsB,CAAC;YAChD,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,UAAU,EAAE,CAAC,YAAY,EAAE,iDAAuB,CAAC;YACnD,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAhCD,wDAgCC","sourcesContent":["import { Model } from '../model';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { AssetTemplateProperties, IAssetTemplateProperties } from './assetTemplateProperties';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateHierarchy {\n\tasset_type_name?: string;\n\tvisualization?: Visualization | IVisualization;\n\tfrom_template_name?: string;\n\thierarchy?: Array<AssetTemplateHierarchy | IAssetTemplateHierarchy>;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\tproperties?: Array<AssetTemplateProperties | IAssetTemplateProperties>;\n\tentity_type_name?: string;\n\thints?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateHierarchy extends Model {\n\tassetTypeName: string;\n\tvisualization: Visualization;\n\tfromTemplateName: string;\n\thierarchy: Array<AssetTemplateHierarchy>;\n\ttitle: string;\n\tentityTypeTitle: string;\n\tmetrics: Array<AssetMetricItem>;\n\tfailureDetection: FailureDetection;\n\tproperties: Array<AssetTemplateProperties>;\n\tentityTypeName: string;\n\thints: any;\n\n\tconstructor(model?: IAssetTemplateHierarchy) {\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\tvisualization: ['visualization', Visualization],\n\t\t\tfrom_template_name: 'fromTemplateName',\n\t\t\thierarchy: ['hierarchy', AssetTemplateHierarchy],\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\tproperties: ['properties', AssetTemplateProperties],\n\t\t\tentity_type_name: 'entityTypeName',\n\t\t\thints: 'hints'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetTemplateHierarchy.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateHierarchy.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,uDAAsE;AACtE,uEAA8F;AAC9F,yDAAyE;AACzE,mDAAgE;AAmBhE;;GAEG;AACH,MAAa,sBAAuB,SAAQ,aAAK;IAqChD,YAAY,KAA+B;QAC1C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,aAAa,EAAE,CAAC,eAAe,EAAE,6BAAa,CAAC;YAC/C,kBAAkB,EAAE,kBAAkB;YACtC,SAAS,EAAE,CAAC,WAAW,EAAE,sBAAsB,CAAC;YAChD,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,OAAO,EAAE,CAAC,SAAS,EAAE,iCAAe,CAAC;YACrC,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,UAAU,EAAE,CAAC,YAAY,EAAE,iDAAuB,CAAC;YACnD,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAxDD,wDAwDC","sourcesContent":["import { Model } from '../model';\nimport { AssetMetricItem, IAssetMetricItem } from './assetMetricItem';\nimport { AssetTemplateProperties, IAssetTemplateProperties } from './assetTemplateProperties';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\nimport { IVisualization, Visualization } from './visualization';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateHierarchy {\n\tasset_type_name?: string;\n\tvisualization?: Visualization | IVisualization;\n\tfrom_template_name?: string;\n\thierarchy?: Array<AssetTemplateHierarchy | IAssetTemplateHierarchy>;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tmetrics?: Array<AssetMetricItem | IAssetMetricItem>;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\tproperties?: Array<AssetTemplateProperties | IAssetTemplateProperties>;\n\tentity_type_name?: string;\n\thints?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateHierarchy extends Model {\n\t/**\n\t\t* The name (not the Display Name / Title) of the default <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\\\" target=\\\"_blank\\\">Kelvin Asset Type</a> that will be selected.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tassetTypeName: string;\n\tvisualization: Visualization;\n\t/**\n\t\t* Name of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a> to copy its full <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> to this location.</p> If this parameter is used, no other parameter in this structure is required.\n\t*/\n\tfromTemplateName: string;\n\t/**\n\t\t* This is a recursive array that can reach unlimited levels of <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Assets</a> to be able to accurately describe all items in your <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\thierarchy: Array<AssetTemplateHierarchy>;\n\t/**\n\t\t* Default display name (title) for this property in the new Kelvin Template. This is a friendly name displayed in lists and in references.</p> You can use any character, numeric, space and special character in this parameter.</p> This is shown as an example Display Name parameter field.</p> If you use `from_template_name parameter` this parameter is not required.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Entity type display name that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `Group`, `Asset`, `Component`, `Part` and `Sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.\n\t*/\n\tentityTypeTitle: string;\n\t/**\n\t\t* Unused. This is reserved as a future feature.\n\t*/\n\tmetrics: Array<AssetMetricItem>;\n\tfailureDetection: FailureDetection;\n\tproperties: Array<AssetTemplateProperties>;\n\t/**\n\t\t* Entity type name that is linked to this new Kelvin Template.</p> There are 5 entity type options available to choose from; `group`, `asset`, `component`, `part` and `sensor`.</p> Detailed information about the asset hierarchy and function of each entity type 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>.\n\t*/\n\tentityTypeName: string;\n\t/**\n\t\t* Unused. This is reserved as a future feature.\n\t*/\n\thints: any;\n\n\tconstructor(model?: IAssetTemplateHierarchy) {\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\tvisualization: ['visualization', Visualization],\n\t\t\tfrom_template_name: 'fromTemplateName',\n\t\t\thierarchy: ['hierarchy', AssetTemplateHierarchy],\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tmetrics: ['metrics', AssetMetricItem],\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\tproperties: ['properties', AssetTemplateProperties],\n\t\t\tentity_type_name: 'entityTypeName',\n\t\t\thints: 'hints'\n\t\t};\n\t}\n}\n"]}

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

@@ -24,20 +24,62 @@ export interface IAssetTemplateItem {
  * @category Service Response Model Object
  */
 export declare class AssetTemplateItem 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>.
+    */
     assetTypeName: string;
+    /**
+        * 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;
+    /**
+        * Detailed description of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>
+    */
     description: 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;
+    /**
+        * 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>.
+    */
     assetClassName: string;
+    /**
+        * 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>.
+    */
     title: string;
+    /**
+        * Display name of the entity type. This is the chosen display name (title) from a fixed list defined by Kelvin.
+    */
     entityTypeTitle: string;
+    /**
+        * 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>.
+    */
     name: string;
+    /**
+        * Who created the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>. 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/#kelvin-templates\" target=\"_blank\">Kelvin Template</a>).
+    */
     owner: string;
     failureDetection: FailureDetection;
+    /**
+        * A http(s) URL link to an image to visually display your template picture next to the description.</p> The file can be in any web-compatible format including jpg, png, gif, animated gif and apng. Even though any size is allowed as it will be automatically resized, it is advised to keep it below 400 x 400 px.</p> If the link is behind a secure login, all login or token details must be incorporated into the URL here.
+    */
     imageUrl: 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>.
+    */
     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>.
+    */
     assetClassTitle: string;
+    /**
+        * Unique identifier name of the entity type. This is the chosen name from a fixed list defined by Kelvin.
+    */
     entityTypeName: string;
+    /**
+        * Unused. This is reserved as a future feature.
+    */
     hints: any;
     constructor(model?: IAssetTemplateItem);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetTemplateItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,yDAAyE;AAuBzE;;GAEG;AACH,MAAa,iBAAkB,SAAQ,aAAK;IAiB3C,YAAY,KAA0B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,SAAS,EAAE,UAAU;YACrB,gBAAgB,EAAE,gBAAgB;YAClC,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAxCD,8CAwCC","sourcesContent":["import { Model } from '../model';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateItem {\n\tasset_type_name?: string;\n\tupdated?: Date | string;\n\tdescription?: string;\n\tcreated?: Date | string;\n\tasset_class_name?: string;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tname?: string;\n\towner?: string;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\timage_url?: string;\n\tasset_type_title?: string;\n\tasset_class_title?: string;\n\tentity_type_name?: string;\n\thints?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateItem extends Model {\n\tassetTypeName: string;\n\tupdated: Date;\n\tdescription: string;\n\tcreated: Date;\n\tassetClassName: string;\n\ttitle: string;\n\tentityTypeTitle: string;\n\tname: string;\n\towner: string;\n\tfailureDetection: FailureDetection;\n\timageUrl: string;\n\tassetTypeTitle: string;\n\tassetClassTitle: string;\n\tentityTypeName: string;\n\thints: any;\n\n\tconstructor(model?: IAssetTemplateItem) {\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\tupdated: ['updated', Date],\n\t\t\tdescription: 'description',\n\t\t\tcreated: ['created', Date],\n\t\t\tasset_class_name: 'assetClassName',\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tname: 'name',\n\t\t\towner: 'owner',\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\timage_url: 'imageUrl',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tasset_class_title: 'assetClassTitle',\n\t\t\tentity_type_name: 'entityTypeName',\n\t\t\thints: 'hints'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetTemplateItem.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateItem.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,yDAAyE;AAuBzE;;GAEG;AACH,MAAa,iBAAkB,SAAQ,aAAK;IA2D3C,YAAY,KAA0B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;YACpC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,CAAC,kBAAkB,EAAE,mCAAgB,CAAC;YACzD,SAAS,EAAE,UAAU;YACrB,gBAAgB,EAAE,gBAAgB;YAClC,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAlFD,8CAkFC","sourcesContent":["import { Model } from '../model';\nimport { FailureDetection, IFailureDetection } from './failureDetection';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateItem {\n\tasset_type_name?: string;\n\tupdated?: Date | string;\n\tdescription?: string;\n\tcreated?: Date | string;\n\tasset_class_name?: string;\n\ttitle?: string;\n\tentity_type_title?: string;\n\tname?: string;\n\towner?: string;\n\tfailure_detection?: FailureDetection | IFailureDetection;\n\timage_url?: string;\n\tasset_type_title?: string;\n\tasset_class_title?: string;\n\tentity_type_name?: string;\n\thints?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateItem 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>.\n\t*/\n\tassetTypeName: string;\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* Detailed description of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>\n\t*/\n\tdescription: 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* 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\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/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Display name of the entity type. This is the chosen display name (title) from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeTitle: string;\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>.\n\t*/\n\tname: string;\n\t/**\n\t\t* Who created the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>. 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/#kelvin-templates\\\" target=\\\"_blank\\\">Kelvin Template</a>).\n\t*/\n\towner: string;\n\tfailureDetection: FailureDetection;\n\t/**\n\t\t* A http(s) URL link to an image to visually display your template picture next to the description.</p> The file can be in any web-compatible format including jpg, png, gif, animated gif and apng. Even though any size is allowed as it will be automatically resized, it is advised to keep it below 400 x 400 px.</p> If the link is behind a secure login, all login or token details must be incorporated into the URL here.\n\t*/\n\timageUrl: 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>.\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>.\n\t*/\n\tassetClassTitle: string;\n\t/**\n\t\t* Unique identifier name of the entity type. This is the chosen name from a fixed list defined by Kelvin.\n\t*/\n\tentityTypeName: string;\n\t/**\n\t\t* Unused. This is reserved as a future feature.\n\t*/\n\thints: any;\n\n\tconstructor(model?: IAssetTemplateItem) {\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\tupdated: ['updated', Date],\n\t\t\tdescription: 'description',\n\t\t\tcreated: ['created', Date],\n\t\t\tasset_class_name: 'assetClassName',\n\t\t\ttitle: 'title',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tname: 'name',\n\t\t\towner: 'owner',\n\t\t\tfailure_detection: ['failureDetection', FailureDetection],\n\t\t\timage_url: 'imageUrl',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tasset_class_title: 'assetClassTitle',\n\t\t\tentity_type_name: 'entityTypeName',\n\t\t\thints: 'hints'\n\t\t};\n\t}\n}\n"]}

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

@@ -13,6 +13,9 @@ export interface IAssetTemplateListPaginated {
  */
 export declare class AssetTemplateListPaginated 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/#kelvin-templates' target='_blank'>Kelvin Templates</a> 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<AssetTemplateItem>;
     constructor(model?: IAssetTemplateListPaginated);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetTemplateListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateListPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,2DAA4E;AAC5E,6CAAuD;AAUvD;;GAEG;AACH,MAAa,0BAA2B,SAAQ,aAAK;IAIpD,YAAY,KAAmC;QAC9C,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,qCAAiB,CAAC;SACjC,CAAC;IACH,CAAC;CACD;AAdD,gEAcC","sourcesContent":["import { Model } from '../model';\nimport { AssetTemplateItem, IAssetTemplateItem } from './assetTemplateItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateListPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetTemplateItem | IAssetTemplateItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateListPaginated extends Model {\n\tpagination: Pagination;\n\tdata: Array<AssetTemplateItem>;\n\n\tconstructor(model?: IAssetTemplateListPaginated) {\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', AssetTemplateItem]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetTemplateListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateListPaginated.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AACjC,2DAA4E;AAC5E,6CAAuD;AAUvD;;GAEG;AACH,MAAa,0BAA2B,SAAQ,aAAK;IAOpD,YAAY,KAAmC;QAC9C,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,qCAAiB,CAAC;SACjC,CAAC;IACH,CAAC;CACD;AAjBD,gEAiBC","sourcesContent":["import { Model } from '../model';\nimport { AssetTemplateItem, IAssetTemplateItem } from './assetTemplateItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateListPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<AssetTemplateItem | IAssetTemplateItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateListPaginated 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/#kelvin-templates' target='_blank'>Kelvin Templates</a> 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<AssetTemplateItem>;\n\n\tconstructor(model?: IAssetTemplateListPaginated) {\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', AssetTemplateItem]\n\t\t};\n\t}\n}\n"]}

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

@@ -11,8 +11,17 @@ export interface IAssetTemplateProperties {
  * @category Service Response Model Object
  */
 export declare class AssetTemplateProperties extends Model {
+    /**
+        * Default unique identifier name for this property in the new Kelvin Template.</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.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     name: string;
+    /**
+        * Default value for this property. This can be a string, integer, float or boolean.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     value: string;
+    /**
+        * Default display name (title) for this property in the new Kelvin Template. This is a friendly name displayed in lists and in references.</p> You can use any character, numeric, space and special character in this parameter.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     title: string;
     constructor(model?: IAssetTemplateProperties);
     mapping(): {

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

@@ -1 +1 @@
-{"version":3,"file":"assetTemplateProperties.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateProperties.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAWjC;;GAEG;AACH,MAAa,uBAAwB,SAAQ,aAAK;IAKjD,YAAY,KAAgC;QAC3C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAhBD,0DAgBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateProperties {\n\tname?: string;\n\tvalue?: string;\n\ttitle?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateProperties extends Model {\n\tname: string;\n\tvalue: string;\n\ttitle: string;\n\n\tconstructor(model?: IAssetTemplateProperties) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tname: 'name',\n\t\t\tvalue: 'value',\n\t\t\ttitle: 'title'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"assetTemplateProperties.js","sourceRoot":"","sources":["../../../../src/models/generated/assetTemplateProperties.ts"],"names":[],"mappings":";;;AAAA,oCAAiC;AAWjC;;GAEG;AACH,MAAa,uBAAwB,SAAQ,aAAK;IAcjD,YAAY,KAAgC;QAC3C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD;AAzBD,0DAyBC","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IAssetTemplateProperties {\n\tname?: string;\n\tvalue?: string;\n\ttitle?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class AssetTemplateProperties extends Model {\n\t/**\n\t\t* Default unique identifier name for this property in the new Kelvin Template.</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.</p> This can be changed by the user when adding the Kelvin Template as a new <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* Default value for this property. This can be a string, integer, float or boolean.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tvalue: string;\n\t/**\n\t\t* Default display name (title) for this property in the new Kelvin Template. This is a friendly name displayed in lists and in references.</p> You can use any character, numeric, space and special character in this parameter.</p> This can be changed by the user when adding the Kelvin Template as a new <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\ttitle: string;\n\n\tconstructor(model?: IAssetTemplateProperties) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tname: 'name',\n\t\t\tvalue: 'value',\n\t\t\ttitle: 'title'\n\t\t};\n\t}\n}\n"]}

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

@@ -18,15 +18,45 @@ export interface IAssetType {
  * @category Service Response Model Object
  */
 export declare class AssetType extends Model {
+    /**
+        * Time of modifying any variable of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</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-type\" target=\"_blank\">Kelvin Asset Type</a>.
+    */
     name: string;
+    /**
+        * Time of creation of this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</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> that is linked to this new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>.
+    */
     assetClassName: 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>.
+    */
     title: string;
+    /**
+        * Who created the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. 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-type\" target=\"_blank\">Kelvin Asset Type</a>).
+    */
     owner: string;
+    /**
+        * Unique identifier name of the entity type linked to the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. This is the chosen name from a fixed list defined by Kelvin.
+    */
     assetClassEntityTypeName: string;
+    /**
+        * 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> that is linked to this new <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>.
+    */
     assetClassTitle: string;
+    /**
+        * Display name of the entity type linked to the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. This is the chosen display name (title) from a fixed list defined by Kelvin.
+    */
     assetClassEntityTypeTitle: string;
+    /**
+        * Custom dictionary keys/values returned for use by clients.</p> This <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets#asset-type-metadata' target='_blank'>Kelvin Asset Type Metadata</a> object is created using the API endpoint `/assets/types/{asset_type_name}/metadata/` and is linked to the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. So anytime the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> is referenced in responses the metadata will also be included.
+    */
     metadata: any;
     constructor(model?: IAssetType);
     mapping(): {