@kelvininc/js-client-sdk 7.8.1 → 7.9.1

package/dist/esm/models/generated/emissionsDashboardAnalytics.d.ts

@@ -0,0 +1,26 @@
+import { Model } from '../model';
+import { EmissionsDashboardAnalyticsHistorian, IEmissionsDashboardAnalyticsHistorian } from './emissionsDashboardAnalyticsHistorian';
+/**
+ * @category Service Response Model
+ */
+export interface IEmissionsDashboardAnalytics {
+    total_inefficient_consumed_energy?: number;
+    total_scope2_cost?: number;
+    historian?: Array<EmissionsDashboardAnalyticsHistorian | IEmissionsDashboardAnalyticsHistorian>;
+    total_scope2_emission?: number;
+    total_inefficient_cost?: number;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class EmissionsDashboardAnalytics extends Model {
+    totalInefficientConsumedEnergy: number;
+    totalScope2Cost: number;
+    historian: Array<EmissionsDashboardAnalyticsHistorian>;
+    totalScope2Emission: number;
+    totalInefficientCost: number;
+    constructor(model?: IEmissionsDashboardAnalytics);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/esm/models/generated/emissionsDashboardAnalytics.js

@@ -0,0 +1,20 @@
+import { Model } from '../model';
+import { EmissionsDashboardAnalyticsHistorian } from './emissionsDashboardAnalyticsHistorian';
+/**
+ * @category Service Response Model Object
+ */
+export class EmissionsDashboardAnalytics extends Model {
+    constructor(model) {
+        super(model);
+    }
+    mapping() {
+        return {
+            total_inefficient_consumed_energy: 'totalInefficientConsumedEnergy',
+            total_scope2_cost: 'totalScope2Cost',
+            historian: ['historian', EmissionsDashboardAnalyticsHistorian],
+            total_scope2_emission: 'totalScope2Emission',
+            total_inefficient_cost: 'totalInefficientCost'
+        };
+    }
+}
+//# sourceMappingURL=emissionsDashboardAnalytics.js.map

package/dist/esm/models/generated/emissionsDashboardAnalytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emissionsDashboardAnalytics.js","sourceRoot":"","sources":["../../../../src/models/generated/emissionsDashboardAnalytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,oCAAoC,EAAyC,MAAM,wCAAwC,CAAC;AAarI;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IAOrD,YAAY,KAAoC;QAC/C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,iCAAiC,EAAE,gCAAgC;YACnE,iBAAiB,EAAE,iBAAiB;YACpC,SAAS,EAAE,CAAC,WAAW,EAAE,oCAAoC,CAAC;YAC9D,qBAAqB,EAAE,qBAAqB;YAC5C,sBAAsB,EAAE,sBAAsB;SAC9C,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { EmissionsDashboardAnalyticsHistorian, IEmissionsDashboardAnalyticsHistorian } from './emissionsDashboardAnalyticsHistorian';\n\n/**\n * @category Service Response Model\n */\nexport interface IEmissionsDashboardAnalytics {\n\ttotal_inefficient_consumed_energy?: number;\n\ttotal_scope2_cost?: number;\n\thistorian?: Array<EmissionsDashboardAnalyticsHistorian | IEmissionsDashboardAnalyticsHistorian>;\n\ttotal_scope2_emission?: number;\n\ttotal_inefficient_cost?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class EmissionsDashboardAnalytics extends Model {\n\ttotalInefficientConsumedEnergy: number;\n\ttotalScope2Cost: number;\n\thistorian: Array<EmissionsDashboardAnalyticsHistorian>;\n\ttotalScope2Emission: number;\n\ttotalInefficientCost: number;\n\n\tconstructor(model?: IEmissionsDashboardAnalytics) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\ttotal_inefficient_consumed_energy: 'totalInefficientConsumedEnergy',\n\t\t\ttotal_scope2_cost: 'totalScope2Cost',\n\t\t\thistorian: ['historian', EmissionsDashboardAnalyticsHistorian],\n\t\t\ttotal_scope2_emission: 'totalScope2Emission',\n\t\t\ttotal_inefficient_cost: 'totalInefficientCost'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.d.ts

@@ -0,0 +1,25 @@
+import { Model } from '../model';
+/**
+ * @category Service Response Model
+ */
+export interface IEmissionsDashboardAnalyticsHistorian {
+    month_long_name?: string;
+    year?: number;
+    month_short_name?: string;
+    value?: number;
+    month?: number;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class EmissionsDashboardAnalyticsHistorian extends Model {
+    monthLongName: string;
+    year: number;
+    monthShortName: string;
+    value: number;
+    month: number;
+    constructor(model?: IEmissionsDashboardAnalyticsHistorian);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js

@@ -0,0 +1,19 @@
+import { Model } from '../model';
+/**
+ * @category Service Response Model Object
+ */
+export class EmissionsDashboardAnalyticsHistorian extends Model {
+    constructor(model) {
+        super(model);
+    }
+    mapping() {
+        return {
+            month_long_name: 'monthLongName',
+            year: 'year',
+            month_short_name: 'monthShortName',
+            value: 'value',
+            month: 'month'
+        };
+    }
+}
+//# sourceMappingURL=emissionsDashboardAnalyticsHistorian.js.map

package/dist/esm/models/generated/emissionsDashboardAnalyticsHistorian.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emissionsDashboardAnalyticsHistorian.js","sourceRoot":"","sources":["../../../../src/models/generated/emissionsDashboardAnalyticsHistorian.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAajC;;GAEG;AACH,MAAM,OAAO,oCAAqC,SAAQ,KAAK;IAO9D,YAAY,KAA6C;QACxD,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,IAAI,EAAE,MAAM;YACZ,gBAAgB,EAAE,gBAAgB;YAClC,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IEmissionsDashboardAnalyticsHistorian {\n\tmonth_long_name?: string;\n\tyear?: number;\n\tmonth_short_name?: string;\n\tvalue?: number;\n\tmonth?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class EmissionsDashboardAnalyticsHistorian extends Model {\n\tmonthLongName: string;\n\tyear: number;\n\tmonthShortName: string;\n\tvalue: number;\n\tmonth: number;\n\n\tconstructor(model?: IEmissionsDashboardAnalyticsHistorian) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tmonth_long_name: 'monthLongName',\n\t\t\tyear: 'year',\n\t\t\tmonth_short_name: 'monthShortName',\n\t\t\tvalue: 'value',\n\t\t\tmonth: 'month'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/emissionsDashboardTotals.d.ts

@@ -0,0 +1,27 @@
+import { Model } from '../model';
+/**
+ * @category Service Response Model
+ */
+export interface IEmissionsDashboardTotals {
+    non_assessed_assets?: number;
+    assets?: number;
+    inefficient_assets?: number;
+    assessed_assets?: number;
+    assets_with_motor?: number;
+    efficient_assets?: number;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class EmissionsDashboardTotals extends Model {
+    nonAssessedAssets: number;
+    assets: number;
+    inefficientAssets: number;
+    assessedAssets: number;
+    assetsWithMotor: number;
+    efficientAssets: number;
+    constructor(model?: IEmissionsDashboardTotals);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/esm/models/generated/emissionsDashboardTotals.js

@@ -0,0 +1,20 @@
+import { Model } from '../model';
+/**
+ * @category Service Response Model Object
+ */
+export class EmissionsDashboardTotals extends Model {
+    constructor(model) {
+        super(model);
+    }
+    mapping() {
+        return {
+            non_assessed_assets: 'nonAssessedAssets',
+            assets: 'assets',
+            inefficient_assets: 'inefficientAssets',
+            assessed_assets: 'assessedAssets',
+            assets_with_motor: 'assetsWithMotor',
+            efficient_assets: 'efficientAssets'
+        };
+    }
+}
+//# sourceMappingURL=emissionsDashboardTotals.js.map

package/dist/esm/models/generated/emissionsDashboardTotals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emissionsDashboardTotals.js","sourceRoot":"","sources":["../../../../src/models/generated/emissionsDashboardTotals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAcjC;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAQlD,YAAY,KAAiC;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,mBAAmB,EAAE,mBAAmB;YACxC,MAAM,EAAE,QAAQ;YAChB,kBAAkB,EAAE,mBAAmB;YACvC,eAAe,EAAE,gBAAgB;YACjC,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,iBAAiB;SACnC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IEmissionsDashboardTotals {\n\tnon_assessed_assets?: number;\n\tassets?: number;\n\tinefficient_assets?: number;\n\tassessed_assets?: number;\n\tassets_with_motor?: number;\n\tefficient_assets?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class EmissionsDashboardTotals extends Model {\n\tnonAssessedAssets: number;\n\tassets: number;\n\tinefficientAssets: number;\n\tassessedAssets: number;\n\tassetsWithMotor: number;\n\tefficientAssets: number;\n\n\tconstructor(model?: IEmissionsDashboardTotals) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tnon_assessed_assets: 'nonAssessedAssets',\n\t\t\tassets: 'assets',\n\t\t\tinefficient_assets: 'inefficientAssets',\n\t\t\tassessed_assets: 'assessedAssets',\n\t\t\tassets_with_motor: 'assetsWithMotor',\n\t\t\tefficient_assets: 'efficientAssets'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/emissionsGreenhouse.d.ts

@@ -0,0 +1,21 @@
+import { Model } from '../model';
+/**
+ * @category Service Response Model
+ */
+export interface IEmissionsGreenhouse {
+    forest_acres_preserved?: number;
+    forest_acres?: number;
+    tree_seedlings?: number;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class EmissionsGreenhouse extends Model {
+    forestAcresPreserved: number;
+    forestAcres: number;
+    treeSeedlings: number;
+    constructor(model?: IEmissionsGreenhouse);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/esm/models/generated/emissionsGreenhouse.js

@@ -0,0 +1,17 @@
+import { Model } from '../model';
+/**
+ * @category Service Response Model Object
+ */
+export class EmissionsGreenhouse extends Model {
+    constructor(model) {
+        super(model);
+    }
+    mapping() {
+        return {
+            forest_acres_preserved: 'forestAcresPreserved',
+            forest_acres: 'forestAcres',
+            tree_seedlings: 'treeSeedlings'
+        };
+    }
+}
+//# sourceMappingURL=emissionsGreenhouse.js.map

package/dist/esm/models/generated/emissionsGreenhouse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emissionsGreenhouse.js","sourceRoot":"","sources":["../../../../src/models/generated/emissionsGreenhouse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAWjC;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAK7C,YAAY,KAA4B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,sBAAsB,EAAE,sBAAsB;YAC9C,YAAY,EAAE,aAAa;YAC3B,cAAc,EAAE,eAAe;SAC/B,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IEmissionsGreenhouse {\n\tforest_acres_preserved?: number;\n\tforest_acres?: number;\n\ttree_seedlings?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class EmissionsGreenhouse extends Model {\n\tforestAcresPreserved: number;\n\tforestAcres: number;\n\ttreeSeedlings: number;\n\n\tconstructor(model?: IEmissionsGreenhouse) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tforest_acres_preserved: 'forestAcresPreserved',\n\t\t\tforest_acres: 'forestAcres',\n\t\t\ttree_seedlings: 'treeSeedlings'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/errorMessage.d.ts

@@ -11,8 +11,17 @@ export interface IErrorMessage {
  * @category Service Response Model Object
  */
 export declare class ErrorMessage extends Model {
+    /**
+        * Detailed description of the error.
+    */
     message: Array<string>;
+    /**
+        * Internal Kelvin error code (used for internal purposes).
+    */
     errorCode: number;
+    /**
+        * HTTP status error code.
+    */
     httpStatusCode: number;
     constructor(model?: IErrorMessage);
     mapping(): {

package/dist/esm/models/generated/errorMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorMessage.js","sourceRoot":"","sources":["../../../../src/models/generated/errorMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAWjC;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IAKtC,YAAY,KAAqB;QAChC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,WAAW;YACvB,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorMessage {\n\tmessage?: Array<string>;\n\terror_code?: number;\n\thttp_status_code?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorMessage extends Model {\n\tmessage: Array<string>;\n\terrorCode: number;\n\thttpStatusCode: number;\n\n\tconstructor(model?: IErrorMessage) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tmessage: 'message',\n\t\t\terror_code: 'errorCode',\n\t\t\thttp_status_code: 'httpStatusCode'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"errorMessage.js","sourceRoot":"","sources":["../../../../src/models/generated/errorMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAWjC;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IActC,YAAY,KAAqB;QAChC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,WAAW;YACvB,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorMessage {\n\tmessage?: Array<string>;\n\terror_code?: number;\n\thttp_status_code?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorMessage extends Model {\n\t/**\n\t\t* Detailed description of the error.\n\t*/\n\tmessage: Array<string>;\n\t/**\n\t\t* Internal Kelvin error code (used for internal purposes).\n\t*/\n\terrorCode: number;\n\t/**\n\t\t* HTTP status error code.\n\t*/\n\thttpStatusCode: number;\n\n\tconstructor(model?: IErrorMessage) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tmessage: 'message',\n\t\t\terror_code: 'errorCode',\n\t\t\thttp_status_code: 'httpStatusCode'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/errorMessages.d.ts

@@ -10,6 +10,9 @@ export interface IErrorMessages {
  * @category Service Response Model Object
  */
 export declare class ErrorMessages extends Model {
+    /**
+        * Array of dictionary objects detailing all errors that were found in the request data.
+    */
     errors: Array<ErrorMessage>;
     constructor(model?: IErrorMessages);
     mapping(): {

package/dist/esm/models/generated/errorMessages.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorMessages.js","sourceRoot":"","sources":["../../../../src/models/generated/errorMessages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,YAAY,EAAiB,MAAM,gBAAgB,CAAC;AAS7D;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAGvC,YAAY,KAAsB;QACjC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,MAAM,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC;SAChC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { ErrorMessage, IErrorMessage } from './errorMessage';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorMessages {\n\terrors?: Array<ErrorMessage | IErrorMessage>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorMessages extends Model {\n\terrors: Array<ErrorMessage>;\n\n\tconstructor(model?: IErrorMessages) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\terrors: ['errors', ErrorMessage]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"errorMessages.js","sourceRoot":"","sources":["../../../../src/models/generated/errorMessages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,YAAY,EAAiB,MAAM,gBAAgB,CAAC;AAS7D;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAMvC,YAAY,KAAsB;QACjC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,MAAM,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC;SAChC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { ErrorMessage, IErrorMessage } from './errorMessage';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorMessages {\n\terrors?: Array<ErrorMessage | IErrorMessage>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorMessages extends Model {\n\t/**\n\t\t* Array of dictionary objects detailing all errors that were found in the request data.\n\t*/\n\terrors: Array<ErrorMessage>;\n\n\tconstructor(model?: IErrorMessages) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\terrors: ['errors', ErrorMessage]\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/errorsError.d.ts

@@ -14,11 +14,29 @@ export interface IErrorsError {
  * @category Service Response Model Object
  */
 export declare class ErrorsError extends Model {
+    /**
+        * Description of what the error is about.
+    */
     description: string;
+    /**
+        * The Display name (title) of the error.
+    */
     title: string;
+    /**
+        * Possible solutions to resolve the error.
+    */
     solution: string;
+    /**
+        * The type of error that has occured, e.g. `system`.
+    */
     type: string;
+    /**
+        * A dictionary of all the individual error names, error titles, descriptions and solutions within the submitted information.
+    */
     payload: Array<string>;
+    /**
+        * Unique identifier name of the error.
+    */
     name: string;
     constructor(model?: IErrorsError);
     mapping(): {

package/dist/esm/models/generated/errorsError.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorsError.js","sourceRoot":"","sources":["../../../../src/models/generated/errorsError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAcjC;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IAQrC,YAAY,KAAoB;QAC/B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,WAAW,EAAE,aAAa;YAC1B,KAAK,EAAE,OAAO;YACd,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,MAAM;SACZ,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorsError {\n\tdescription?: string;\n\ttitle?: string;\n\tsolution?: string;\n\ttype?: string;\n\tpayload?: Array<string>;\n\tname?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorsError extends Model {\n\tdescription: string;\n\ttitle: string;\n\tsolution: string;\n\ttype: string;\n\tpayload: Array<string>;\n\tname: string;\n\n\tconstructor(model?: IErrorsError) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdescription: 'description',\n\t\t\ttitle: 'title',\n\t\t\tsolution: 'solution',\n\t\t\ttype: 'type',\n\t\t\tpayload: 'payload',\n\t\t\tname: 'name'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"errorsError.js","sourceRoot":"","sources":["../../../../src/models/generated/errorsError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAcjC;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,KAAK;IA0BrC,YAAY,KAAoB;QAC/B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,WAAW,EAAE,aAAa;YAC1B,KAAK,EAAE,OAAO;YACd,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,MAAM;SACZ,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorsError {\n\tdescription?: string;\n\ttitle?: string;\n\tsolution?: string;\n\ttype?: string;\n\tpayload?: Array<string>;\n\tname?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorsError extends Model {\n\t/**\n\t\t* Description of what the error is about.\n\t*/\n\tdescription: string;\n\t/**\n\t\t* The Display name (title) of the error.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Possible solutions to resolve the error.\n\t*/\n\tsolution: string;\n\t/**\n\t\t* The type of error that has occured, e.g. `system`.\n\t*/\n\ttype: string;\n\t/**\n\t\t* A dictionary of all the individual error names, error titles, descriptions and solutions within the submitted information.\n\t*/\n\tpayload: Array<string>;\n\t/**\n\t\t* Unique identifier name of the error.\n\t*/\n\tname: string;\n\n\tconstructor(model?: IErrorsError) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdescription: 'description',\n\t\t\ttitle: 'title',\n\t\t\tsolution: 'solution',\n\t\t\ttype: 'type',\n\t\t\tpayload: 'payload',\n\t\t\tname: 'name'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/errorsErrorMessage.d.ts

@@ -10,6 +10,9 @@ export interface IErrorsErrorMessage {
  * @category Service Response Model Object
  */
 export declare class ErrorsErrorMessage extends Model {
+    /**
+        * Array of dictionary objects detailing all errors that were found in the request data.
+    */
     errors: Array<ErrorsError>;
     constructor(model?: IErrorsErrorMessage);
     mapping(): {

package/dist/esm/models/generated/errorsErrorMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorsErrorMessage.js","sourceRoot":"","sources":["../../../../src/models/generated/errorsErrorMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,WAAW,EAAgB,MAAM,eAAe,CAAC;AAS1D;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAG5C,YAAY,KAA2B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,MAAM,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC;SAC/B,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { ErrorsError, IErrorsError } from './errorsError';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorsErrorMessage {\n\terrors?: Array<ErrorsError | IErrorsError>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorsErrorMessage extends Model {\n\terrors: Array<ErrorsError>;\n\n\tconstructor(model?: IErrorsErrorMessage) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\terrors: ['errors', ErrorsError]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"errorsErrorMessage.js","sourceRoot":"","sources":["../../../../src/models/generated/errorsErrorMessage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,WAAW,EAAgB,MAAM,eAAe,CAAC;AAS1D;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAM5C,YAAY,KAA2B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,MAAM,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC;SAC/B,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { ErrorsError, IErrorsError } from './errorsError';\n\n/**\n * @category Service Response Model\n */\nexport interface IErrorsErrorMessage {\n\terrors?: Array<ErrorsError | IErrorsError>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class ErrorsErrorMessage extends Model {\n\t/**\n\t\t* Array of dictionary objects detailing all errors that were found in the request data.\n\t*/\n\terrors: Array<ErrorsError>;\n\n\tconstructor(model?: IErrorsErrorMessage) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\terrors: ['errors', ErrorsError]\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/failureDetection.d.ts

@@ -13,9 +13,21 @@ export interface IFailureDetection {
  * @category Service Response Model Object
  */
 export declare class FailureDetection extends Model {
+    /**
+        * The name (not the Display Name / Title) of the default <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection Class</a>.</p> This parameter is only used when <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection AI</a> is enabled.
+    */
     failureClassName: string;
+    /**
+        * The default activation state of the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection AI</a> for this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.</p>  `true` (enabled) and `false` (disabled).</p> The default is `false` (disabled).
+    */
     enabled: boolean;
+    /**
+        * List of properties required by the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection AI</a> model.</p> For example if you have a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> and select the  `Vibration Piezo` failure class, then you will need to include information about the sampling rate, sample duration, axial/horizontal/vertical orientations. Any default values not set here must be filled in by the user when adding this <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a>.
+    */
     properties: Array<FailureDetectionProperty>;
+    /**
+        * 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;
     constructor(model?: IFailureDetection);
     mapping(): {

package/dist/esm/models/generated/failureDetection.js.map

@@ -1 +1 @@
-{"version":3,"file":"failureDetection.js","sourceRoot":"","sources":["../../../../src/models/generated/failureDetection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,wBAAwB,EAA6B,MAAM,4BAA4B,CAAC;AAYjG;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAM1C,YAAY,KAAyB;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,kBAAkB,EAAE,kBAAkB;YACtC,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,CAAC,YAAY,EAAE,wBAAwB,CAAC;YACpD,gBAAgB,EAAE,iBAAiB;SACnC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { FailureDetectionProperty, IFailureDetectionProperty } from './failureDetectionProperty';\n\n/**\n * @category Service Response Model\n */\nexport interface IFailureDetection {\n\tfailure_class_name?: string;\n\tenabled?: boolean;\n\tproperties?: Array<FailureDetectionProperty | IFailureDetectionProperty>;\n\tfailure_quotient?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class FailureDetection extends Model {\n\tfailureClassName: string;\n\tenabled: boolean;\n\tproperties: Array<FailureDetectionProperty>;\n\tfailureQuotient: number;\n\n\tconstructor(model?: IFailureDetection) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tfailure_class_name: 'failureClassName',\n\t\t\tenabled: 'enabled',\n\t\t\tproperties: ['properties', FailureDetectionProperty],\n\t\t\tfailure_quotient: 'failureQuotient'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"failureDetection.js","sourceRoot":"","sources":["../../../../src/models/generated/failureDetection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,wBAAwB,EAA6B,MAAM,4BAA4B,CAAC;AAYjG;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAkB1C,YAAY,KAAyB;QACpC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,kBAAkB,EAAE,kBAAkB;YACtC,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,CAAC,YAAY,EAAE,wBAAwB,CAAC;YACpD,gBAAgB,EAAE,iBAAiB;SACnC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { FailureDetectionProperty, IFailureDetectionProperty } from './failureDetectionProperty';\n\n/**\n * @category Service Response Model\n */\nexport interface IFailureDetection {\n\tfailure_class_name?: string;\n\tenabled?: boolean;\n\tproperties?: Array<FailureDetectionProperty | IFailureDetectionProperty>;\n\tfailure_quotient?: number;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class FailureDetection 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-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection Class</a>.</p> This parameter is only used when <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection AI</a> is enabled.\n\t*/\n\tfailureClassName: string;\n\t/**\n\t\t* The default activation state of the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection AI</a> for this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.</p>  `true` (enabled) and `false` (disabled).</p> The default is `false` (disabled).\n\t*/\n\tenabled: boolean;\n\t/**\n\t\t* List of properties required by the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection AI</a> model.</p> For example if you have a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#sensor' target='_blank'>Kelvin Sensor</a> and select the  `Vibration Piezo` failure class, then you will need to include information about the sampling rate, sample duration, axial/horizontal/vertical orientations. Any default values not set here must be filled in by the user when adding this <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\\\" target=\\\"_blank\\\">Kelvin Asset</a>.\n\t*/\n\tproperties: Array<FailureDetectionProperty>;\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\n\tconstructor(model?: IFailureDetection) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tfailure_class_name: 'failureClassName',\n\t\t\tenabled: 'enabled',\n\t\t\tproperties: ['properties', FailureDetectionProperty],\n\t\t\tfailure_quotient: 'failureQuotient'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/failureDetectionProperty.d.ts

@@ -11,8 +11,17 @@ export interface IFailureDetectionProperty {
  * @category Service Response Model Object
  */
 export declare class FailureDetectionProperty extends Model {
+    /**
+        * The default value for the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection AI</a> property.
+    */
     value: string;
+    /**
+        * Unique identifier name for the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection AI</a> property.</p> This must match the existing available properties for each type of <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection AI</a> model.</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;
+    /**
+        * The units for the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\" target=\"_blank\">Kelvin Failure Detection AI</a> property.
+    */
     unit: string;
     constructor(model?: IFailureDetectionProperty);
     mapping(): {

package/dist/esm/models/generated/failureDetectionProperty.js.map

@@ -1 +1 @@
-{"version":3,"file":"failureDetectionProperty.js","sourceRoot":"","sources":["../../../../src/models/generated/failureDetectionProperty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAWjC;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAKlD,YAAY,KAAiC;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;SACZ,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IFailureDetectionProperty {\n\tvalue?: string;\n\tname?: string;\n\tunit?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class FailureDetectionProperty extends Model {\n\tvalue: string;\n\tname: string;\n\tunit: string;\n\n\tconstructor(model?: IFailureDetectionProperty) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tvalue: 'value',\n\t\t\tname: 'name',\n\t\t\tunit: 'unit'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"failureDetectionProperty.js","sourceRoot":"","sources":["../../../../src/models/generated/failureDetectionProperty.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAWjC;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAclD,YAAY,KAAiC;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;SACZ,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IFailureDetectionProperty {\n\tvalue?: string;\n\tname?: string;\n\tunit?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class FailureDetectionProperty extends Model {\n\t/**\n\t\t* The default value for the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection AI</a> property.\n\t*/\n\tvalue: string;\n\t/**\n\t\t* Unique identifier name for the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection AI</a> property.</p> This must match the existing available properties for each type of <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection AI</a> model.</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* The units for the <a href=\\\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-ai-failure-detection/\\\" target=\\\"_blank\\\">Kelvin Failure Detection AI</a> property.\n\t*/\n\tunit: string;\n\n\tconstructor(model?: IFailureDetectionProperty) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tvalue: 'value',\n\t\t\tname: 'name',\n\t\t\tunit: 'unit'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/failureOverviewItem.d.ts

@@ -0,0 +1,58 @@
+import { Model } from '../model';
+import { FailureOverviewStatistics, IFailureOverviewStatistics } from './failureOverviewStatistics';
+/**
+ * @category Service Response Model
+ */
+export interface IFailureOverviewItem {
+    asset_type_name?: string;
+    statistics?: FailureOverviewStatistics | IFailureOverviewStatistics;
+    name?: string;
+    title?: string;
+    map_names?: Array<string>;
+    entity_type_title?: string;
+    failure_quotient?: number;
+    asset_type_title?: string;
+    entity_type_name?: string;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class FailureOverviewItem 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;
+    statistics: FailureOverviewStatistics;
+    /**
+        * 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;
+    /**
+        * List of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> names where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> is linked.
+    */
+    mapNames: Array<string>;
+    /**
+        * 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;
+    /**
+        * 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?: IFailureOverviewItem);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/esm/models/generated/{siteHierarchyOverviewItem.js → failureOverviewItem.js}

@@ -1,20 +1,19 @@
 import { Model } from '../model';
-import { SiteHierarchyOverviewStatistics } from './siteHierarchyOverviewStatistics';
+import { FailureOverviewStatistics } from './failureOverviewStatistics';
 /**
  * @category Service Response Model Object
  */
-export class SiteHierarchyOverviewItem extends Model {
+export class FailureOverviewItem extends Model {
     constructor(model) {
         super(model);
     }
     mapping() {
         return {
             asset_type_name: 'assetTypeName',
-            statistics: ['statistics', SiteHierarchyOverviewStatistics],
-            production_line_title: 'productionLineTitle',
+            statistics: ['statistics', FailureOverviewStatistics],
             name: 'name',
             title: 'title',
-            production_line_name: 'productionLineName',
+            map_names: 'mapNames',
             entity_type_title: 'entityTypeTitle',
             failure_quotient: 'failureQuotient',
             asset_type_title: 'assetTypeTitle',
@@ -22,4 +21,4 @@ export class SiteHierarchyOverviewItem extends Model {
         };
     }
 }
-//# sourceMappingURL=siteHierarchyOverviewItem.js.map
+//# sourceMappingURL=failureOverviewItem.js.map

package/dist/esm/models/generated/failureOverviewItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"failureOverviewItem.js","sourceRoot":"","sources":["../../../../src/models/generated/failureOverviewItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,yBAAyB,EAA8B,MAAM,6BAA6B,CAAC;AAiBpG;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAmC7C,YAAY,KAA4B;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,eAAe,EAAE,eAAe;YAChC,UAAU,EAAE,CAAC,YAAY,EAAE,yBAAyB,CAAC;YACrD,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,UAAU;YACrB,iBAAiB,EAAE,iBAAiB;YACpC,gBAAgB,EAAE,iBAAiB;YACnC,gBAAgB,EAAE,gBAAgB;YAClC,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { FailureOverviewStatistics, IFailureOverviewStatistics } from './failureOverviewStatistics';\n\n/**\n * @category Service Response Model\n */\nexport interface IFailureOverviewItem {\n\tasset_type_name?: string;\n\tstatistics?: FailureOverviewStatistics | IFailureOverviewStatistics;\n\tname?: string;\n\ttitle?: string;\n\tmap_names?: Array<string>;\n\tentity_type_title?: string;\n\tfailure_quotient?: number;\n\tasset_type_title?: string;\n\tentity_type_name?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class FailureOverviewItem 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\tstatistics: FailureOverviewStatistics;\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* List of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> names where the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> is linked.\n\t*/\n\tmapNames: Array<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* 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\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?: IFailureOverviewItem) {\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\tstatistics: ['statistics', FailureOverviewStatistics],\n\t\t\tname: 'name',\n\t\t\ttitle: 'title',\n\t\t\tmap_names: 'mapNames',\n\t\t\tentity_type_title: 'entityTypeTitle',\n\t\t\tfailure_quotient: 'failureQuotient',\n\t\t\tasset_type_title: 'assetTypeTitle',\n\t\t\tentity_type_name: 'entityTypeName'\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/failureOverviewPaginated.d.ts

@@ -0,0 +1,24 @@
+import { Model } from '../model';
+import { FailureOverviewItem, IFailureOverviewItem } from './failureOverviewItem';
+import { IPagination, Pagination } from './pagination';
+/**
+ * @category Service Response Model
+ */
+export interface IFailureOverviewPaginated {
+    pagination?: Pagination | IPagination;
+    data?: Array<FailureOverviewItem | IFailureOverviewItem>;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class FailureOverviewPaginated 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<FailureOverviewItem>;
+    constructor(model?: IFailureOverviewPaginated);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/esm/models/generated/{siteHierarchyOverviewPaginated.js → failureOverviewPaginated.js}

@@ -1,18 +1,18 @@
 import { Model } from '../model';
+import { FailureOverviewItem } from './failureOverviewItem';
 import { Pagination } from './pagination';
-import { SiteHierarchyOverviewItem } from './siteHierarchyOverviewItem';
 /**
  * @category Service Response Model Object
  */
-export class SiteHierarchyOverviewPaginated extends Model {
+export class FailureOverviewPaginated extends Model {
     constructor(model) {
         super(model);
     }
     mapping() {
         return {
             pagination: ['pagination', Pagination],
-            data: ['data', SiteHierarchyOverviewItem]
+            data: ['data', FailureOverviewItem]
         };
     }
 }
-//# sourceMappingURL=siteHierarchyOverviewPaginated.js.map
+//# sourceMappingURL=failureOverviewPaginated.js.map

package/dist/esm/models/generated/failureOverviewPaginated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"failureOverviewPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/failureOverviewPaginated.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAwB,MAAM,uBAAuB,CAAC;AAClF,OAAO,EAAe,UAAU,EAAE,MAAM,cAAc,CAAC;AAUvD;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAOlD,YAAY,KAAiC;QAC5C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,UAAU,EAAE,CAAC,YAAY,EAAE,UAAU,CAAC;YACtC,IAAI,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC;SACnC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { FailureOverviewItem, IFailureOverviewItem } from './failureOverviewItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IFailureOverviewPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<FailureOverviewItem | IFailureOverviewItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class FailureOverviewPaginated 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<FailureOverviewItem>;\n\n\tconstructor(model?: IFailureOverviewPaginated) {\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', FailureOverviewItem]\n\t\t};\n\t}\n}\n"]}

package/dist/esm/models/generated/failureOverviewStatistics.d.ts

@@ -0,0 +1,24 @@
+import { Model } from '../model';
+import { ISeverityStatistics, SeverityStatistics } from './severityStatistics';
+import { IStatusStatistics, StatusStatistics } from './statusStatistics';
+/**
+ * @category Service Response Model
+ */
+export interface IFailureOverviewStatistics {
+    status?: StatusStatistics | IStatusStatistics;
+    severity?: Array<SeverityStatistics | ISeverityStatistics>;
+}
+/**
+ * @category Service Response Model Object
+ */
+export declare class FailureOverviewStatistics extends Model {
+    status: StatusStatistics;
+    /**
+        * Summary of the failure alarms for the selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> per <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-alarms#alarm-severity' target='_blank'>Kelvin Maps Alarm Severity</a>.</p> The summary is separated into three groups `active`, `acknowledged` or `resolved`.
+    */
+    severity: Array<SeverityStatistics>;
+    constructor(model?: IFailureOverviewStatistics);
+    mapping(): {
+        [key: string]: Object;
+    };
+}

package/dist/esm/models/generated/{siteHierarchyOverviewStatistics.js → failureOverviewStatistics.js}

@@ -4,7 +4,7 @@ import { StatusStatistics } from './statusStatistics';
 /**
  * @category Service Response Model Object
  */
-export class SiteHierarchyOverviewStatistics extends Model {
+export class FailureOverviewStatistics extends Model {
     constructor(model) {
         super(model);
     }
@@ -15,4 +15,4 @@ export class SiteHierarchyOverviewStatistics extends Model {
         };
     }
 }
-//# sourceMappingURL=siteHierarchyOverviewStatistics.js.map
+//# sourceMappingURL=failureOverviewStatistics.js.map

package/dist/esm/models/generated/failureOverviewStatistics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"failureOverviewStatistics.js","sourceRoot":"","sources":["../../../../src/models/generated/failureOverviewStatistics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAuB,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAqB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAUzE;;GAEG;AACH,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAOnD,YAAY,KAAkC;QAC7C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,MAAM,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YACpC,QAAQ,EAAE,CAAC,UAAU,EAAE,kBAAkB,CAAC;SAC1C,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { ISeverityStatistics, SeverityStatistics } from './severityStatistics';\nimport { IStatusStatistics, StatusStatistics } from './statusStatistics';\n\n/**\n * @category Service Response Model\n */\nexport interface IFailureOverviewStatistics {\n\tstatus?: StatusStatistics | IStatusStatistics;\n\tseverity?: Array<SeverityStatistics | ISeverityStatistics>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class FailureOverviewStatistics extends Model {\n\tstatus: StatusStatistics;\n\t/**\n\t\t* Summary of the failure alarms for the selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> per <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-alarms#alarm-severity' target='_blank'>Kelvin Maps Alarm Severity</a>.</p> The summary is separated into three groups `active`, `acknowledged` or `resolved`.\n\t*/\n\tseverity: Array<SeverityStatistics>;\n\n\tconstructor(model?: IFailureOverviewStatistics) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tstatus: ['status', StatusStatistics],\n\t\t\tseverity: ['severity', SeverityStatistics]\n\t\t};\n\t}\n}\n"]}