@kelvininc/js-client-sdk 7.13.2 → 7.18.0

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

@@ -7,18 +7,21 @@ import { IOEEValues, OEEValues } from './oEEValues';
  */
 export interface IMapOEE {
     map_name?: string;
-    oee_values?: OEEValues | IOEEValues;
     oee_calculation?: OEECalculation | IOEECalculation;
     oee_thresholds?: OEEThresholds | IOEEThresholds;
+    oee_values?: OEEValues | IOEEValues;
 }
 /**
  * @category Service Response Model Object
  */
 export declare class MapOEE extends Model {
+    /**
+        * Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</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.
+    */
     mapName: string;
-    oeeValues: OEEValues;
     oeeCalculation: OEECalculation;
     oeeThresholds: OEEThresholds;
+    oeeValues: OEEValues;
     constructor(model?: IMapOEE);
     mapping(): {
         [key: string]: Object;

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

@@ -12,9 +12,9 @@ export class MapOEE extends Model {
     mapping() {
         return {
             map_name: 'mapName',
-            oee_values: ['oeeValues', OEEValues],
             oee_calculation: ['oeeCalculation', OEECalculation],
-            oee_thresholds: ['oeeThresholds', OEEThresholds]
+            oee_thresholds: ['oeeThresholds', OEEThresholds],
+            oee_values: ['oeeValues', OEEValues]
         };
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"mapOEE.js","sourceRoot":"","sources":["../../../../src/models/generated/mapOEE.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAkB,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AAYpD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,KAAK;IAMhC,YAAY,KAAe;QAC1B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,QAAQ,EAAE,SAAS;YACnB,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;YACpC,eAAe,EAAE,CAAC,gBAAgB,EAAE,cAAc,CAAC;YACnD,cAAc,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC;SAChD,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { IOEECalculation, OEECalculation } from './oEECalculation';\nimport { IOEEThresholds, OEEThresholds } from './oEEThresholds';\nimport { IOEEValues, OEEValues } from './oEEValues';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapOEE {\n\tmap_name?: string;\n\toee_values?: OEEValues | IOEEValues;\n\toee_calculation?: OEECalculation | IOEECalculation;\n\toee_thresholds?: OEEThresholds | IOEEThresholds;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapOEE extends Model {\n\tmapName: string;\n\toeeValues: OEEValues;\n\toeeCalculation: OEECalculation;\n\toeeThresholds: OEEThresholds;\n\n\tconstructor(model?: IMapOEE) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tmap_name: 'mapName',\n\t\t\toee_values: ['oeeValues', OEEValues],\n\t\t\toee_calculation: ['oeeCalculation', OEECalculation],\n\t\t\toee_thresholds: ['oeeThresholds', OEEThresholds]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"mapOEE.js","sourceRoot":"","sources":["../../../../src/models/generated/mapOEE.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAkB,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AAYpD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,KAAK;IAShC,YAAY,KAAe;QAC1B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,QAAQ,EAAE,SAAS;YACnB,eAAe,EAAE,CAAC,gBAAgB,EAAE,cAAc,CAAC;YACnD,cAAc,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC;YAChD,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;SACpC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { IOEECalculation, OEECalculation } from './oEECalculation';\nimport { IOEEThresholds, OEEThresholds } from './oEEThresholds';\nimport { IOEEValues, OEEValues } from './oEEValues';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapOEE {\n\tmap_name?: string;\n\toee_calculation?: OEECalculation | IOEECalculation;\n\toee_thresholds?: OEEThresholds | IOEEThresholds;\n\toee_values?: OEEValues | IOEEValues;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapOEE extends Model {\n\t/**\n\t\t* Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</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\tmapName: string;\n\toeeCalculation: OEECalculation;\n\toeeThresholds: OEEThresholds;\n\toeeValues: OEEValues;\n\n\tconstructor(model?: IMapOEE) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tmap_name: 'mapName',\n\t\t\toee_calculation: ['oeeCalculation', OEECalculation],\n\t\t\toee_thresholds: ['oeeThresholds', OEEThresholds],\n\t\t\toee_values: ['oeeValues', OEEValues]\n\t\t};\n\t}\n}\n"]}

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

@@ -4,17 +4,29 @@ import { Model } from '../model';
  */
 export interface IMapRelationship {
     source?: string;
-    type?: string;
     target?: string;
+    type?: string;
     visualization?: any;
 }
 /**
  * @category Service Response Model Object
  */
 export declare class MapRelationship extends Model {
+    /**
+        * Name of the source entity which send data.</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.
+    */
     source: string;
-    type: string;
+    /**
+        * Name of the target entity which receives data.</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.
+    */
     target: string;
+    /**
+        * Type of relationship between the `source` key and the `target` key.</p> There is only one option;  `connection`.
+    */
+    type: string;
+    /**
+        * For internal use only.
+    */
     visualization: any;
     constructor(model?: IMapRelationship);
     mapping(): {

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

@@ -9,8 +9,8 @@ export class MapRelationship extends Model {
     mapping() {
         return {
             source: 'source',
-            type: 'type',
             target: 'target',
+            type: 'type',
             visualization: 'visualization'
         };
     }

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

@@ -1 +1 @@
-{"version":3,"file":"mapRelationship.js","sourceRoot":"","sources":["../../../../src/models/generated/mapRelationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAYjC;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAMzC,YAAY,KAAwB;QACnC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,eAAe;SAC9B,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapRelationship {\n\tsource?: string;\n\ttype?: string;\n\ttarget?: string;\n\tvisualization?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapRelationship extends Model {\n\tsource: string;\n\ttype: string;\n\ttarget: string;\n\tvisualization: any;\n\n\tconstructor(model?: IMapRelationship) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tsource: 'source',\n\t\t\ttype: 'type',\n\t\t\ttarget: 'target',\n\t\t\tvisualization: 'visualization'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"mapRelationship.js","sourceRoot":"","sources":["../../../../src/models/generated/mapRelationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAYjC;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAkBzC,YAAY,KAAwB;QACnC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,MAAM;YACZ,aAAa,EAAE,eAAe;SAC9B,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapRelationship {\n\tsource?: string;\n\ttarget?: string;\n\ttype?: string;\n\tvisualization?: any;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapRelationship extends Model {\n\t/**\n\t\t* Name of the source entity which send data.</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\tsource: string;\n\t/**\n\t\t* Name of the target entity which receives data.</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\ttarget: string;\n\t/**\n\t\t* Type of relationship between the `source` key and the `target` key.</p> There is only one option;  `connection`.\n\t*/\n\ttype: string;\n\t/**\n\t\t* For internal use only.\n\t*/\n\tvisualization: any;\n\n\tconstructor(model?: IMapRelationship) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tsource: 'source',\n\t\t\ttarget: 'target',\n\t\t\ttype: 'type',\n\t\t\tvisualization: 'visualization'\n\t\t};\n\t}\n}\n"]}

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

@@ -7,18 +7,24 @@ import { ITeamMember, TeamMember } from './teamMember';
  */
 export interface IMapShift {
     map_name?: string;
+    production_info?: ProductionInfo | IProductionInfo;
     shift_info?: ShiftInfo | IShiftInfo;
     team_info?: Array<TeamMember | ITeamMember>;
-    production_info?: ProductionInfo | IProductionInfo;
 }
 /**
  * @category Service Response Model Object
  */
 export declare class MapShift extends Model {
+    /**
+        * Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</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.
+    */
     mapName: string;
+    productionInfo: ProductionInfo;
     shiftInfo: ShiftInfo;
+    /**
+        * Array of the team members working in this shift.
+    */
     teamInfo: Array<TeamMember>;
-    productionInfo: ProductionInfo;
     constructor(model?: IMapShift);
     mapping(): {
         [key: string]: Object;

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

@@ -12,9 +12,9 @@ export class MapShift extends Model {
     mapping() {
         return {
             map_name: 'mapName',
+            production_info: ['productionInfo', ProductionInfo],
             shift_info: ['shiftInfo', ShiftInfo],
-            team_info: ['teamInfo', TeamMember],
-            production_info: ['productionInfo', ProductionInfo]
+            team_info: ['teamInfo', TeamMember]
         };
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"mapShift.js","sourceRoot":"","sources":["../../../../src/models/generated/mapShift.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAe,UAAU,EAAE,MAAM,cAAc,CAAC;AAYvD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IAMlC,YAAY,KAAiB;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,QAAQ,EAAE,SAAS;YACnB,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;YACpC,SAAS,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;YACnC,eAAe,EAAE,CAAC,gBAAgB,EAAE,cAAc,CAAC;SACnD,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { IProductionInfo, ProductionInfo } from './productionInfo';\nimport { IShiftInfo, ShiftInfo } from './shiftInfo';\nimport { ITeamMember, TeamMember } from './teamMember';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapShift {\n\tmap_name?: string;\n\tshift_info?: ShiftInfo | IShiftInfo;\n\tteam_info?: Array<TeamMember | ITeamMember>;\n\tproduction_info?: ProductionInfo | IProductionInfo;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapShift extends Model {\n\tmapName: string;\n\tshiftInfo: ShiftInfo;\n\tteamInfo: Array<TeamMember>;\n\tproductionInfo: ProductionInfo;\n\n\tconstructor(model?: IMapShift) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tmap_name: 'mapName',\n\t\t\tshift_info: ['shiftInfo', ShiftInfo],\n\t\t\tteam_info: ['teamInfo', TeamMember],\n\t\t\tproduction_info: ['productionInfo', ProductionInfo]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"mapShift.js","sourceRoot":"","sources":["../../../../src/models/generated/mapShift.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAe,UAAU,EAAE,MAAM,cAAc,CAAC;AAYvD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IAYlC,YAAY,KAAiB;QAC5B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,QAAQ,EAAE,SAAS;YACnB,eAAe,EAAE,CAAC,gBAAgB,EAAE,cAAc,CAAC;YACnD,UAAU,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;YACpC,SAAS,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;SACnC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { IProductionInfo, ProductionInfo } from './productionInfo';\nimport { IShiftInfo, ShiftInfo } from './shiftInfo';\nimport { ITeamMember, TeamMember } from './teamMember';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapShift {\n\tmap_name?: string;\n\tproduction_info?: ProductionInfo | IProductionInfo;\n\tshift_info?: ShiftInfo | IShiftInfo;\n\tteam_info?: Array<TeamMember | ITeamMember>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapShift extends Model {\n\t/**\n\t\t* Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</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\tmapName: string;\n\tproductionInfo: ProductionInfo;\n\tshiftInfo: ShiftInfo;\n\t/**\n\t\t* Array of the team members working in this shift.\n\t*/\n\tteamInfo: Array<TeamMember>;\n\n\tconstructor(model?: IMapShift) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tmap_name: 'mapName',\n\t\t\tproduction_info: ['productionInfo', ProductionInfo],\n\t\t\tshift_info: ['shiftInfo', ShiftInfo],\n\t\t\tteam_info: ['teamInfo', TeamMember]\n\t\t};\n\t}\n}\n"]}

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

@@ -3,21 +3,36 @@ import { Model } from '../model';
  * @category Service Response Model
  */
 export interface IMapVersionItem {
-    name?: string;
-    start_date?: Date | string;
-    id?: string;
     end_date?: Date | string;
+    id?: string;
     mode?: string;
+    name?: string;
+    start_date?: Date | string;
 }
 /**
  * @category Service Response Model Object
  */
 export declare class MapVersionItem extends Model {
-    name: string;
-    startDate: Date;
-    id: string;
+    /**
+        * Date when this version of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> version was superseded with a newer version.</p> This will be shown in ISO 8601 format. e.g \"2023-02-27T10:20:31.194Z\".</p> This will not be return for the current (latest) version.
+    */
     endDate: Date;
+    /**
+        * Unique identifier id for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> request.
+    */
+    id: string;
+    /**
+        * The mode of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.</p> There are two options available; `simulation` and `production`.</p> For production mode, all entities must be linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> that exists on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.</p> For simulation mode, entities do not need to be linked to any existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>.
+    */
     mode: string;
+    /**
+        * Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process</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;
+    /**
+        * Date when this version of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> was created.</p> This will be shown in ISO 8601 format. e.g \"2023-02-27T10:20:31.194Z\".
+    */
+    startDate: Date;
     constructor(model?: IMapVersionItem);
     mapping(): {
         [key: string]: Object;

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

@@ -8,11 +8,11 @@ export class MapVersionItem extends Model {
     }
     mapping() {
         return {
-            name: 'name',
-            start_date: ['startDate', Date],
-            id: 'id',
             end_date: ['endDate', Date],
-            mode: 'mode'
+            id: 'id',
+            mode: 'mode',
+            name: 'name',
+            start_date: ['startDate', Date]
         };
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"mapVersionItem.js","sourceRoot":"","sources":["../../../../src/models/generated/mapVersionItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAajC;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,KAAK;IAOxC,YAAY,KAAuB;QAClC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC;YAC/B,EAAE,EAAE,IAAI;YACR,QAAQ,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC3B,IAAI,EAAE,MAAM;SACZ,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapVersionItem {\n\tname?: string;\n\tstart_date?: Date | string;\n\tid?: string;\n\tend_date?: Date | string;\n\tmode?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapVersionItem extends Model {\n\tname: string;\n\tstartDate: Date;\n\tid: string;\n\tendDate: Date;\n\tmode: string;\n\n\tconstructor(model?: IMapVersionItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tname: 'name',\n\t\t\tstart_date: ['startDate', Date],\n\t\t\tid: 'id',\n\t\t\tend_date: ['endDate', Date],\n\t\t\tmode: 'mode'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"mapVersionItem.js","sourceRoot":"","sources":["../../../../src/models/generated/mapVersionItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAajC;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,KAAK;IAsBxC,YAAY,KAAuB;QAClC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,QAAQ,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC3B,EAAE,EAAE,IAAI;YACR,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC;SAC/B,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapVersionItem {\n\tend_date?: Date | string;\n\tid?: string;\n\tmode?: string;\n\tname?: string;\n\tstart_date?: Date | string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapVersionItem extends Model {\n\t/**\n\t\t* Date when this version of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> version was superseded with a newer version.</p> This will be shown in ISO 8601 format. e.g \\\"2023-02-27T10:20:31.194Z\\\".</p> This will not be return for the current (latest) version.\n\t*/\n\tendDate: Date;\n\t/**\n\t\t* Unique identifier id for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> request.\n\t*/\n\tid: string;\n\t/**\n\t\t* The mode of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.</p> There are two options available; `simulation` and `production`.</p> For production mode, all entities must be linked to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> that exists on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.</p> For simulation mode, entities do not need to be linked to any existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>.\n\t*/\n\tmode: string;\n\t/**\n\t\t* Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process</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* Date when this version of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> was created.</p> This will be shown in ISO 8601 format. e.g \\\"2023-02-27T10:20:31.194Z\\\".\n\t*/\n\tstartDate: Date;\n\n\tconstructor(model?: IMapVersionItem) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tend_date: ['endDate', Date],\n\t\t\tid: 'id',\n\t\t\tmode: 'mode',\n\t\t\tname: 'name',\n\t\t\tstart_date: ['startDate', Date]\n\t\t};\n\t}\n}\n"]}

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

@@ -5,15 +5,18 @@ import { IPagination, Pagination } from './pagination';
  * @category Service Response Model
  */
 export interface IMapVersionListPaginated {
-    pagination?: Pagination | IPagination;
     data?: Array<MapVersionItem | IMapVersionItem>;
+    pagination?: Pagination | IPagination;
 }
 /**
  * @category Service Response Model Object
  */
 export declare class MapVersionListPaginated 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-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a>. If a bookmark has been used, then the array will start or end based on the `starting_after` or `ending_before` parameters.
+    */
     data: Array<MapVersionItem>;
+    pagination: Pagination;
     constructor(model?: IMapVersionListPaginated);
     mapping(): {
         [key: string]: Object;

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

@@ -10,8 +10,8 @@ export class MapVersionListPaginated extends Model {
     }
     mapping() {
         return {
-            pagination: ['pagination', Pagination],
-            data: ['data', MapVersionItem]
+            data: ['data', MapVersionItem],
+            pagination: ['pagination', Pagination]
         };
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"mapVersionListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/mapVersionListPaginated.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAe,UAAU,EAAE,MAAM,cAAc,CAAC;AAUvD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAIjD,YAAY,KAAgC;QAC3C,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,cAAc,CAAC;SAC9B,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { IMapVersionItem, MapVersionItem } from './mapVersionItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapVersionListPaginated {\n\tpagination?: Pagination | IPagination;\n\tdata?: Array<MapVersionItem | IMapVersionItem>;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapVersionListPaginated extends Model {\n\tpagination: Pagination;\n\tdata: Array<MapVersionItem>;\n\n\tconstructor(model?: IMapVersionListPaginated) {\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', MapVersionItem]\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"mapVersionListPaginated.js","sourceRoot":"","sources":["../../../../src/models/generated/mapVersionListPaginated.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAmB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAe,UAAU,EAAE,MAAM,cAAc,CAAC;AAUvD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAOjD,YAAY,KAAgC;QAC3C,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,IAAI,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC;YAC9B,UAAU,EAAE,CAAC,YAAY,EAAE,UAAU,CAAC;SACtC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\nimport { IMapVersionItem, MapVersionItem } from './mapVersionItem';\nimport { IPagination, Pagination } from './pagination';\n\n/**\n * @category Service Response Model\n */\nexport interface IMapVersionListPaginated {\n\tdata?: Array<MapVersionItem | IMapVersionItem>;\n\tpagination?: Pagination | IPagination;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class MapVersionListPaginated extends Model {\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-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a>. If a bookmark has been used, then the array will start or end based on the `starting_after` or `ending_before` parameters.\n\t*/\n\tdata: Array<MapVersionItem>;\n\tpagination: Pagination;\n\n\tconstructor(model?: IMapVersionListPaginated) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tdata: ['data', MapVersionItem],\n\t\t\tpagination: ['pagination', Pagination]\n\t\t};\n\t}\n}\n"]}

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

@@ -3,61 +3,61 @@ import { Model } from '../model';
  * @category Service Response Model
  */
 export interface IMetric {
-    semantic_type_name?: string;
-    updated?: Date | string;
-    name?: string;
     created?: Date | string;
     data_type_name?: string;
-    title?: string;
-    semantic_type_properties?: any;
+    data_type_version?: string;
     display_unit?: string;
+    name?: string;
+    semantic_type_name?: string;
+    semantic_type_properties?: any;
+    title?: string;
+    updated?: Date | string;
     write?: boolean;
-    data_type_version?: string;
 }
 /**
  * @category Service Response Model Object
  */
 export declare class Metric extends Model {
     /**
-        * Type of sensor that is streaming data to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>. Depending on the options chosen, there may be more properties available which will be saved to the `SemanticTypeProperties` parameters.</p> There are currently 28 Semantic Type Names available; `None`, `Accelerometer`, `Current`, `Dynacard`, `Event Flow Rate`, `Force`, `Frequency`, `Gas Flow Rate`, `Gas Volume`, `Humidity`, `Latitude`, `Length`, `Location`, `Longitude`, `Mass`, `Power`, `Pressure`, `Relative Humidity`, `State`, `Temperature`, `Time Date`, `Time Span`, `Torque`, `Velocity`, `Vibration`, `Voltage`, `Volume`, `Volume Flow Rate`.
+        * Time of creation of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
     */
-    semanticTypeName: string;
+    created: Date;
     /**
-        * Time of modifying any variable of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+        * Type of data being recorded to this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> there are 13 types of data type options; `raw.boolean`, `raw.dynacard`, `raw.float32`, `raw.float64`, `raw.int8`, `raw.int16`, `raw.int32`, `raw.int64`, `raw.uint8`, `raw.uint16`, `raw.uint32`, `raw.uint64` and `raw.text`.
     */
-    updated: Date;
+    dataTypeName: string;
     /**
-        * Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This contains 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.
+        * Version of the data type.</p> For example `2.0.0`.
     */
-    name: string;
+    dataTypeVersion: string;
     /**
-        * Time of creation of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+        * Units for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This can be anything to describe the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> units. For example `Amp`, `Hz`, `॰F`, etc.
     */
-    created: Date;
+    displayUnit: string;
     /**
-        * Type of data being recorded to this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> there are 13 types of data type options; `raw.boolean`, `raw.dynacard`, `raw.float32`, `raw.float64`, `raw.int8`, `raw.int16`, `raw.int32`, `raw.int64`, `raw.uint8`, `raw.uint16`, `raw.uint32`, `raw.uint64` and `raw.text`.
+        * Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This contains 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.
     */
-    dataTypeName: string;
+    name: string;
     /**
-        * Display name (title) for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> . This is the friendly name displayed.</p> It can use any character, numeric, space and special character in this parameter.
+        * Type of sensor that is streaming data to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>. Depending on the options chosen, there may be more properties available which will be saved to the `SemanticTypeProperties` parameters.</p> There are currently 28 Semantic Type Names available; `None`, `Accelerometer`, `Current`, `Dynacard`, `Event Flow Rate`, `Force`, `Frequency`, `Gas Flow Rate`, `Gas Volume`, `Humidity`, `Latitude`, `Length`, `Location`, `Longitude`, `Mass`, `Power`, `Pressure`, `Relative Humidity`, `State`, `Temperature`, `Time Date`, `Time Span`, `Torque`, `Velocity`, `Vibration`, `Voltage`, `Volume`, `Volume Flow Rate`.
     */
-    title: string;
+    semanticTypeName: string;
     /**
         * Additional properties depending on the selected `SemanticTypeName` parameter chosen.</p> For example; if the semantic type chosen is `temperature`, then there will be an additional parameter in semantic type properties for `temperature unit` where fahrenheit or celsius can be chosen.
     */
     semanticTypeProperties: any;
     /**
-        * Units for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This can be anything to describe the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> units. For example `Amp`, `Hz`, `॰F`, etc.
+        * Display name (title) for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> . This is the friendly name displayed.</p> It can use any character, numeric, space and special character in this parameter.
     */
-    displayUnit: string;
+    title: string;
     /**
-        * Defines whether this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> is read only (`false`) or read/write (`true`).</p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/' target='_blank'>Kelvin Control Change</a> feature is used on this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>, then this parameter must be `true`.
+        * Time of modifying any variable of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
     */
-    write: boolean;
+    updated: Date;
     /**
-        * Version of the data type.</p> For example `2.0.0`.
+        * Defines whether this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> is read only (`false`) or read/write (`true`).</p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/' target='_blank'>Kelvin Control Change</a> feature is used on this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>, then this parameter must be `true`.
     */
-    dataTypeVersion: string;
+    write: boolean;
     constructor(model?: IMetric);
     mapping(): {
         [key: string]: Object;

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

@@ -8,16 +8,16 @@ export class Metric extends Model {
     }
     mapping() {
         return {
-            semantic_type_name: 'semanticTypeName',
-            updated: ['updated', Date],
-            name: 'name',
             created: ['created', Date],
             data_type_name: 'dataTypeName',
-            title: 'title',
-            semantic_type_properties: 'semanticTypeProperties',
+            data_type_version: 'dataTypeVersion',
             display_unit: 'displayUnit',
-            write: 'write',
-            data_type_version: 'dataTypeVersion'
+            name: 'name',
+            semantic_type_name: 'semanticTypeName',
+            semantic_type_properties: 'semanticTypeProperties',
+            title: 'title',
+            updated: ['updated', Date],
+            write: 'write'
         };
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"metric.js","sourceRoot":"","sources":["../../../../src/models/generated/metric.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAkBjC;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,KAAK;IA0ChC,YAAY,KAAe;QAC1B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,kBAAkB,EAAE,kBAAkB;YACtC,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,cAAc,EAAE,cAAc;YAC9B,KAAK,EAAE,OAAO;YACd,wBAAwB,EAAE,wBAAwB;YAClD,YAAY,EAAE,aAAa;YAC3B,KAAK,EAAE,OAAO;YACd,iBAAiB,EAAE,iBAAiB;SACpC,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IMetric {\n\tsemantic_type_name?: string;\n\tupdated?: Date | string;\n\tname?: string;\n\tcreated?: Date | string;\n\tdata_type_name?: string;\n\ttitle?: string;\n\tsemantic_type_properties?: any;\n\tdisplay_unit?: string;\n\twrite?: boolean;\n\tdata_type_version?: string;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class Metric extends Model {\n\t/**\n\t\t* Type of sensor that is streaming data to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>. Depending on the options chosen, there may be more properties available which will be saved to the `SemanticTypeProperties` parameters.</p> There are currently 28 Semantic Type Names available; `None`, `Accelerometer`, `Current`, `Dynacard`, `Event Flow Rate`, `Force`, `Frequency`, `Gas Flow Rate`, `Gas Volume`, `Humidity`, `Latitude`, `Length`, `Location`, `Longitude`, `Mass`, `Power`, `Pressure`, `Relative Humidity`, `State`, `Temperature`, `Time Date`, `Time Span`, `Torque`, `Velocity`, `Vibration`, `Voltage`, `Volume`, `Volume Flow Rate`.\n\t*/\n\tsemanticTypeName: 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-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \\\"2022-07-08T08:41:01.657916Z\\\".\n\t*/\n\tupdated: Date;\n\t/**\n\t\t* Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This contains 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* Time of creation of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</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* Type of data being recorded to this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> there are 13 types of data type options; `raw.boolean`, `raw.dynacard`, `raw.float32`, `raw.float64`, `raw.int8`, `raw.int16`, `raw.int32`, `raw.int64`, `raw.uint8`, `raw.uint16`, `raw.uint32`, `raw.uint64` and `raw.text`.\n\t*/\n\tdataTypeName: string;\n\t/**\n\t\t* Display name (title) for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> . This is the friendly name displayed.</p> It can use any character, numeric, space and special character in this parameter.\n\t*/\n\ttitle: string;\n\t/**\n\t\t* Additional properties depending on the selected `SemanticTypeName` parameter chosen.</p> For example; if the semantic type chosen is `temperature`, then there will be an additional parameter in semantic type properties for `temperature unit` where fahrenheit or celsius can be chosen.\n\t*/\n\tsemanticTypeProperties: any;\n\t/**\n\t\t* Units for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This can be anything to describe the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> units. For example `Amp`, `Hz`, `॰F`, etc.\n\t*/\n\tdisplayUnit: string;\n\t/**\n\t\t* Defines whether this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> is read only (`false`) or read/write (`true`).</p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/' target='_blank'>Kelvin Control Change</a> feature is used on this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>, then this parameter must be `true`.\n\t*/\n\twrite: boolean;\n\t/**\n\t\t* Version of the data type.</p> For example `2.0.0`.\n\t*/\n\tdataTypeVersion: string;\n\n\tconstructor(model?: IMetric) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tsemantic_type_name: 'semanticTypeName',\n\t\t\tupdated: ['updated', Date],\n\t\t\tname: 'name',\n\t\t\tcreated: ['created', Date],\n\t\t\tdata_type_name: 'dataTypeName',\n\t\t\ttitle: 'title',\n\t\t\tsemantic_type_properties: 'semanticTypeProperties',\n\t\t\tdisplay_unit: 'displayUnit',\n\t\t\twrite: 'write',\n\t\t\tdata_type_version: 'dataTypeVersion'\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"metric.js","sourceRoot":"","sources":["../../../../src/models/generated/metric.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAkBjC;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,KAAK;IA0ChC,YAAY,KAAe;QAC1B,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,OAAO;QACN,OAAO;YACN,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,cAAc,EAAE,cAAc;YAC9B,iBAAiB,EAAE,iBAAiB;YACpC,YAAY,EAAE,aAAa;YAC3B,IAAI,EAAE,MAAM;YACZ,kBAAkB,EAAE,kBAAkB;YACtC,wBAAwB,EAAE,wBAAwB;YAClD,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC;YAC1B,KAAK,EAAE,OAAO;SACd,CAAC;IACH,CAAC;CACD","sourcesContent":["import { Model } from '../model';\n\n/**\n * @category Service Response Model\n */\nexport interface IMetric {\n\tcreated?: Date | string;\n\tdata_type_name?: string;\n\tdata_type_version?: string;\n\tdisplay_unit?: string;\n\tname?: string;\n\tsemantic_type_name?: string;\n\tsemantic_type_properties?: any;\n\ttitle?: string;\n\tupdated?: Date | string;\n\twrite?: boolean;\n}\n\n/**\n * @category Service Response Model Object\n */\nexport class Metric extends Model {\n\t/**\n\t\t* Time of creation of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</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* Type of data being recorded to this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> there are 13 types of data type options; `raw.boolean`, `raw.dynacard`, `raw.float32`, `raw.float64`, `raw.int8`, `raw.int16`, `raw.int32`, `raw.int64`, `raw.uint8`, `raw.uint16`, `raw.uint32`, `raw.uint64` and `raw.text`.\n\t*/\n\tdataTypeName: string;\n\t/**\n\t\t* Version of the data type.</p> For example `2.0.0`.\n\t*/\n\tdataTypeVersion: string;\n\t/**\n\t\t* Units for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This can be anything to describe the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> units. For example `Amp`, `Hz`, `॰F`, etc.\n\t*/\n\tdisplayUnit: string;\n\t/**\n\t\t* Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This contains 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* Type of sensor that is streaming data to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>. Depending on the options chosen, there may be more properties available which will be saved to the `SemanticTypeProperties` parameters.</p> There are currently 28 Semantic Type Names available; `None`, `Accelerometer`, `Current`, `Dynacard`, `Event Flow Rate`, `Force`, `Frequency`, `Gas Flow Rate`, `Gas Volume`, `Humidity`, `Latitude`, `Length`, `Location`, `Longitude`, `Mass`, `Power`, `Pressure`, `Relative Humidity`, `State`, `Temperature`, `Time Date`, `Time Span`, `Torque`, `Velocity`, `Vibration`, `Voltage`, `Volume`, `Volume Flow Rate`.\n\t*/\n\tsemanticTypeName: string;\n\t/**\n\t\t* Additional properties depending on the selected `SemanticTypeName` parameter chosen.</p> For example; if the semantic type chosen is `temperature`, then there will be an additional parameter in semantic type properties for `temperature unit` where fahrenheit or celsius can be chosen.\n\t*/\n\tsemanticTypeProperties: any;\n\t/**\n\t\t* Display name (title) for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> . This is the friendly name displayed.</p> It can use any character, numeric, space and special character in this parameter.\n\t*/\n\ttitle: 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-metrics/' target='_blank'>Kelvin Metric</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* Defines whether this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> is read only (`false`) or read/write (`true`).</p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/' target='_blank'>Kelvin Control Change</a> feature is used on this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>, then this parameter must be `true`.\n\t*/\n\twrite: boolean;\n\n\tconstructor(model?: IMetric) {\n\t\tsuper(model);\n\t}\n\n\tmapping(): { [key: string]: Object } {\n\t\treturn {\n\t\t\tcreated: ['created', Date],\n\t\t\tdata_type_name: 'dataTypeName',\n\t\t\tdata_type_version: 'dataTypeVersion',\n\t\t\tdisplay_unit: 'displayUnit',\n\t\t\tname: 'name',\n\t\t\tsemantic_type_name: 'semanticTypeName',\n\t\t\tsemantic_type_properties: 'semanticTypeProperties',\n\t\t\ttitle: 'title',\n\t\t\tupdated: ['updated', Date],\n\t\t\twrite: 'write'\n\t\t};\n\t}\n}\n"]}

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

@@ -3,61 +3,61 @@ import { Model } from '../model';
  * @category Service Response Model
  */
 export interface IMetricItem {
-    semantic_type_name?: string;
-    updated?: Date | string;
-    name?: string;
     created?: Date | string;
     data_type_name?: string;
-    title?: string;
-    semantic_type_properties?: any;
+    data_type_version?: string;
     display_unit?: string;
+    name?: string;
+    semantic_type_name?: string;
+    semantic_type_properties?: any;
+    title?: string;
+    updated?: Date | string;
     write?: boolean;
-    data_type_version?: string;
 }
 /**
  * @category Service Response Model Object
  */
 export declare class MetricItem extends Model {
     /**
-        * Type of sensor that is streaming data to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>. Depending on the options chosen, there may be more properties available which will be saved to the `SemanticTypeProperties` parameters.</p> There are currently 28 Semantic Type Names available; `None`, `Accelerometer`, `Current`, `Dynacard`, `Event Flow Rate`, `Force`, `Frequency`, `Gas Flow Rate`, `Gas Volume`, `Humidity`, `Latitude`, `Length`, `Location`, `Longitude`, `Mass`, `Power`, `Pressure`, `Relative Humidity`, `State`, `Temperature`, `Time Date`, `Time Span`, `Torque`, `Velocity`, `Vibration`, `Voltage`, `Volume`, `Volume Flow Rate`.
+        * Time of creation of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
     */
-    semanticTypeName: string;
+    created: Date;
     /**
-        * Time of modifying any variable of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+        * Type of data being recorded to this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> there are 13 types of data type options; `raw.boolean`, `raw.dynacard`, `raw.float32`, `raw.float64`, `raw.int8`, `raw.int16`, `raw.int32`, `raw.int64`, `raw.uint8`, `raw.uint16`, `raw.uint32`, `raw.uint64` and `raw.text`.
     */
-    updated: Date;
+    dataTypeName: string;
     /**
-        * Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This contains 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.
+        * Version of the data type.</p> For example `2.0.0`.
     */
-    name: string;
+    dataTypeVersion: string;
     /**
-        * Time of creation of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
+        * Units for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This can be anything to describe the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> units. For example `Amp`, `Hz`, `॰F`, etc.
     */
-    created: Date;
+    displayUnit: string;
     /**
-        * Type of data being recorded to this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> there are 13 types of data type options; `raw.boolean`, `raw.dynacard`, `raw.float32`, `raw.float64`, `raw.int8`, `raw.int16`, `raw.int32`, `raw.int64`, `raw.uint8`, `raw.uint16`, `raw.uint32`, `raw.uint64` and `raw.text`.
+        * Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This contains 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.
     */
-    dataTypeName: string;
+    name: string;
     /**
-        * Display name (title) for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> . This is the friendly name displayed.</p> It can use any character, numeric, space and special character in this parameter.
+        * Type of sensor that is streaming data to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>. Depending on the options chosen, there may be more properties available which will be saved to the `SemanticTypeProperties` parameters.</p> There are currently 28 Semantic Type Names available; `None`, `Accelerometer`, `Current`, `Dynacard`, `Event Flow Rate`, `Force`, `Frequency`, `Gas Flow Rate`, `Gas Volume`, `Humidity`, `Latitude`, `Length`, `Location`, `Longitude`, `Mass`, `Power`, `Pressure`, `Relative Humidity`, `State`, `Temperature`, `Time Date`, `Time Span`, `Torque`, `Velocity`, `Vibration`, `Voltage`, `Volume`, `Volume Flow Rate`.
     */
-    title: string;
+    semanticTypeName: string;
     /**
         * Additional properties depending on the selected `SemanticTypeName` parameter chosen.</p> For example; if the semantic type chosen is `temperature`, then there will be an additional parameter in semantic type properties for `temperature unit` where fahrenheit or celsius can be chosen.
     */
     semanticTypeProperties: any;
     /**
-        * Units for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.</p> This can be anything to describe the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> units. For example `Amp`, `Hz`, `॰F`, etc.
+        * Display name (title) for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> . This is the friendly name displayed.</p> It can use any character, numeric, space and special character in this parameter.
     */
-    displayUnit: string;
+    title: string;
     /**
-        * Defines whether this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> is read only (`false`) or read/write (`true`).</p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/' target='_blank'>Kelvin Control Change</a> feature is used on this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>, then this parameter must be `true`.
+        * Time of modifying any variable of this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> in ISO 8601 UTC date/time format. Example; \"2022-07-08T08:41:01.657916Z\".
     */
-    write: boolean;
+    updated: Date;
     /**
-        * Version of the data type.</p> For example `2.0.0`.
+        * Defines whether this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> is read only (`false`) or read/write (`true`).</p> If the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/' target='_blank'>Kelvin Control Change</a> feature is used on this <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>, then this parameter must be `true`.
     */
-    dataTypeVersion: string;
+    write: boolean;
     constructor(model?: IMetricItem);
     mapping(): {
         [key: string]: Object;

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

@@ -8,16 +8,16 @@ export class MetricItem extends Model {
     }
     mapping() {
         return {
-            semantic_type_name: 'semanticTypeName',
-            updated: ['updated', Date],
-            name: 'name',
             created: ['created', Date],
             data_type_name: 'dataTypeName',
-            title: 'title',
-            semantic_type_properties: 'semanticTypeProperties',
+            data_type_version: 'dataTypeVersion',
             display_unit: 'displayUnit',
-            write: 'write',
-            data_type_version: 'dataTypeVersion'
+            name: 'name',
+            semantic_type_name: 'semanticTypeName',
+            semantic_type_properties: 'semanticTypeProperties',
+            title: 'title',
+            updated: ['updated', Date],
+            write: 'write'
         };
     }
 }