@kelvininc/js-client-sdk 7.8.1 → 7.9.1

package/dist/cjs/services/generated/api/map.service.d.ts

@@ -1,8 +1,8 @@
 import { Observable } from 'rxjs';
 import { IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';
-import { MapListPaginated, MapModel, MapVersionListPaginated, Symbol, SymbolsListPaginated } from '../../../models';
+import { MapListPaginated, MapModel, MapOEE, MapShift, MapVersionListPaginated, Symbol, SymbolsListPaginated } from '../../../models';
 import { BaseService } from '../../base.service';
-import { ICreateMapParams, ICreateSymbolParams, IDeleteMapParams, IDeleteSymbolParams, IGetMapParams, IListMapsParams, IListSymbolsParams, IListVersionsParams, IUpdateMapParams, IUpdateSymbolParams } from '../types';
+import { ICreateMapOEEParams, ICreateMapParams, ICreateMapShiftParams, ICreateSymbolParams, IDeleteMapParams, IDeleteSymbolParams, IGetMapOEEParams, IGetMapParams, IGetMapShiftParams, IListMapsParams, IListSymbolsParams, IListVersionsParams, IUpdateMapParams, IUpdateSymbolParams } from '../types';
 /**
  * @category Service
  */
@@ -14,6 +14,22 @@ export declare class MapService extends BaseService {
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static createMap({ map }: ICreateMapParams, options?: IKvHttpRequestOptions): Observable<MapModel>;
+    /**
+     * Create Map OEE
+     * Create Map OEE  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
+     * @param mapOee Map OEE create schema
+     * @param mapName Map name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createMapOEE({ mapOee, mapName }: ICreateMapOEEParams, options?: IKvHttpRequestOptions): Observable<MapOEE>;
+    /**
+     * Create Map Shift
+     * Create Map Shift  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
+     * @param mapShift Map Shift create schema
+     * @param mapName Map name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createMapShift({ mapShift, mapName }: ICreateMapShiftParams, options?: IKvHttpRequestOptions): Observable<MapShift>;
     /**
      * Create Symbol
      * Create Symbol  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
@@ -43,9 +59,26 @@ export declare class MapService extends BaseService {
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMap({ mapName, timestamp }: IGetMapParams, options?: IKvHttpRequestOptions): Observable<MapModel>;
+    /**
+     * Get Map OEE
+     * Get Map OEE  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * @param mapNames Map OEE get schema
+     * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getMapOEE({ mapNames, timestamp }: IGetMapOEEParams, options?: IKvHttpRequestOptions): Observable<MapOEE[]>;
+    /**
+     * Get Map Shift
+     * Get Map Shift  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * @param mapNames Map Shift get schema
+     * @param timestamp Timestamp to search for specific Shift values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getMapShift({ mapNames, timestamp }: IGetMapShiftParams, options?: IKvHttpRequestOptions): Observable<MapShift[]>;
     /**
      * List Maps
      * List Maps  **Pagination Sortable Columns:** &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;start_date&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * @param entity Filter for maps that contain the entity
      * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
      * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
      * @param startingAfter Lower bound cursor for use in pagination
@@ -54,7 +87,7 @@ export declare class MapService extends BaseService {
      * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listMaps({ timestamp, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListMapsParams, options?: IKvHttpRequestOptions): Observable<MapListPaginated>;
+    static listMaps({ entity, timestamp, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListMapsParams, options?: IKvHttpRequestOptions): Observable<MapListPaginated>;
     /**
      * List Symbols
      * List Symbols  **Pagination Sortable Columns:** &#x60;symbol.name&#x60;, &#x60;symbol.title&#x60;, &#x60;symbol.symbol_type&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;

package/dist/cjs/services/generated/api/map.service.js

@@ -22,6 +22,38 @@ class MapService extends base_service_1.BaseService {
         requestConfig.options = options;
         return this.request(`/maps/create`, requestConfig, models_1.MapModel);
     }
+    /**
+     * Create Map OEE
+     * Create Map OEE  **Permission Required:** `kelvin.permission.maps.create`
+     * @param mapOee Map OEE create schema
+     * @param mapName Map name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createMapOEE({ mapOee, mapName }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = mapOee;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/maps/${encodeURIComponent(String(mapName))}/oee/create`, requestConfig, models_1.MapOEE);
+    }
+    /**
+     * Create Map Shift
+     * Create Map Shift  **Permission Required:** `kelvin.permission.maps.create`
+     * @param mapShift Map Shift create schema
+     * @param mapName Map name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createMapShift({ mapShift, mapName }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = mapShift;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/maps/${encodeURIComponent(String(mapName))}/shift/create`, requestConfig, models_1.MapShift);
+    }
     /**
      * Create Symbol
      * Create Symbol  **Permission Required:** `kelvin.permission.maps.create`
@@ -85,9 +117,52 @@ class MapService extends base_service_1.BaseService {
         requestConfig.options = options;
         return this.request(`/maps/${encodeURIComponent(String(mapName))}/get`, requestConfig, models_1.MapModel);
     }
+    /**
+     * Get Map OEE
+     * Get Map OEE  **Permission Required:** `kelvin.permission.maps.read`
+     * @param mapNames Map OEE get schema
+     * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getMapOEE({ mapNames, timestamp }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        const queryParameters = {};
+        if (timestamp != null) {
+            queryParameters['timestamp'] = timestamp;
+        }
+        requestConfig.params = queryParameters;
+        requestConfig.data = mapNames;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/maps/oee/get`, requestConfig, models_1.MapOEE);
+    }
+    /**
+     * Get Map Shift
+     * Get Map Shift  **Permission Required:** `kelvin.permission.maps.read`
+     * @param mapNames Map Shift get schema
+     * @param timestamp Timestamp to search for specific Shift values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getMapShift({ mapNames, timestamp }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        const queryParameters = {};
+        if (timestamp != null) {
+            queryParameters['timestamp'] = timestamp;
+        }
+        requestConfig.params = queryParameters;
+        requestConfig.data = mapNames;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/maps/shift/get`, requestConfig, models_1.MapShift);
+    }
     /**
      * List Maps
      * List Maps  **Pagination Sortable Columns:** `map.name`, `map.title`, `start_date`  **Permission Required:** `kelvin.permission.maps.read`
+     * @param entity Filter for maps that contain the entity
      * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
      * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
      * @param startingAfter Lower bound cursor for use in pagination
@@ -96,11 +171,14 @@ class MapService extends base_service_1.BaseService {
      * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listMaps({ timestamp, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
+    static listMaps({ entity, timestamp, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
         const requestConfig = {
             method: 'get'
         };
         const queryParameters = {};
+        if (entity != null) {
+            queryParameters['entity'] = entity;
+        }
         if (timestamp != null) {
             queryParameters['timestamp'] = timestamp;
         }

package/dist/cjs/services/generated/api/map.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"map.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/map.service.ts"],"names":[],"mappings":";;;AAEA,4CAAoH;AACpH,qDAAiD;AAGjD;;GAEG;AAEH,MAAa,UAAW,SAAQ,0BAAW;IAE1C;;;;;OAKG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,GAAG,EAAoB,EAAE,OAA+B;QAE1E,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,GAAG,CAAC;QAEzB,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,cAAc,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAuB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC;QAE5B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAS,sBAAsB,EAAE,aAAa,EAAE,eAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,EAAoB,EAAE,OAA+B;QAE9E,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,UAAU,EAAuB,EAAE,OAA+B;QAEvF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,iBAAiB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IACvH,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAiB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,KAAsB,EAAE,EAAE,OAA+B;QAE3I,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAmB,YAAY,EAAE,aAAa,EAAE,yBAAgB,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;OAWG;IAEH,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,KAAyB,EAAE,EAAE,OAA+B;QAE3J,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,WAAW,IAAI,IAAI,EAAE;YACxB,eAAe,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;SAC9C;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAuB,oBAAoB,EAAE,aAAa,EAAE,6BAAoB,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAuB,EAAE,OAA+B;QAE5I,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAA0B,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,aAAa,EAAE,gCAAuB,CAAC,CAAC;IACpJ,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAoB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,GAAG,CAAC;QAEzB,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAuB,EAAE,OAA+B;QAE/F,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC;QAE5B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAS,iBAAiB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,aAAa,EAAE,eAAM,CAAC,CAAC;IACtH,CAAC;CACD;AA9SD,gCA8SC","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';\nimport { MapListPaginated, MapModel, MapVersionListPaginated, Symbol, SymbolsListPaginated } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport { ICreateMapParams, ICreateSymbolParams, IDeleteMapParams, IDeleteSymbolParams, IGetMapParams, IListMapsParams, IListSymbolsParams, IListVersionsParams, IUpdateMapParams, IUpdateSymbolParams } from '../types';\n\n/**\n * @category Service\n */\n\nexport class MapService extends BaseService {\n\n\t/**\n\t * Create Map\n\t * Create Map  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;\n\t * @param map Map create schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic createMap({ map }: ICreateMapParams, options?: IKvHttpRequestOptions): Observable<MapModel> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = map;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapModel>(`/maps/create`, requestConfig, MapModel);\n\t}\n\n\t/**\n\t * Create Symbol\n\t * Create Symbol  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;\n\t * @param symbol Symbol create schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic createSymbol({ symbol }: ICreateSymbolParams, options?: IKvHttpRequestOptions): Observable<Symbol> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = symbol;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<Symbol>(`/maps/symbols/create`, requestConfig, Symbol);\n\t}\n\n\t/**\n\t * Delete Map\n\t * Delete Map  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;\n\t * @param mapName Map name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic deleteMap({ mapName }: IDeleteMapParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/maps/${encodeURIComponent(String(mapName))}/delete`, requestConfig);\n\t}\n\n\t/**\n\t * Delete Symbol\n\t * Delete Symbol  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;\n\t * @param symbolName Symbol name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic deleteSymbol({ symbolName }: IDeleteSymbolParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/maps/symbols/${encodeURIComponent(String(symbolName))}/delete`, requestConfig);\n\t}\n\n\t/**\n\t * Get Map\n\t * Get Map  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param mapName Map name\n\t * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic getMap({ mapName, timestamp }: IGetMapParams, options?: IKvHttpRequestOptions): Observable<MapModel> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (timestamp != null) {\n\t\t\tqueryParameters['timestamp'] = timestamp;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapModel>(`/maps/${encodeURIComponent(String(mapName))}/get`, requestConfig, MapModel);\n\t}\n\n\t/**\n\t * List Maps\n\t * List Maps  **Pagination Sortable Columns:** &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;start_date&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)\n\t * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20\n\t * @param startingAfter Lower bound cursor for use in pagination\n\t * @param endingBefore Upper bound cursor for use in pagination\n\t * @param sortBy Parameter to sort by. Must be one of the sortable columns\n\t * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic listMaps({ timestamp, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListMapsParams = {}, options?: IKvHttpRequestOptions): Observable<MapListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (timestamp != null) {\n\t\t\tqueryParameters['timestamp'] = timestamp;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapListPaginated>(`/maps/list`, requestConfig, MapListPaginated);\n\t}\n\n\t/**\n\t * List Symbols\n\t * List Symbols  **Pagination Sortable Columns:** &#x60;symbol.name&#x60;, &#x60;symbol.title&#x60;, &#x60;symbol.symbol_type&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param search Search symbols by name or title\n\t * @param symbolTypes Search symbols by symbol type\n\t * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20\n\t * @param startingAfter Lower bound cursor for use in pagination\n\t * @param endingBefore Upper bound cursor for use in pagination\n\t * @param sortBy Parameter to sort by. Must be one of the sortable columns\n\t * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic listSymbols({ search, symbolTypes, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListSymbolsParams = {}, options?: IKvHttpRequestOptions): Observable<SymbolsListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\n\t\t}\n\n\t\tif (symbolTypes != null) {\n\t\t\tqueryParameters['symbol_types'] = symbolTypes;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<SymbolsListPaginated>(`/maps/symbols/list`, requestConfig, SymbolsListPaginated);\n\t}\n\n\t/**\n\t * List Versions\n\t * List Versions for a single map  **Pagination Sortable Columns:** &#x60;start_date&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param mapName Map name\n\t * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20\n\t * @param startingAfter Lower bound cursor for use in pagination\n\t * @param endingBefore Upper bound cursor for use in pagination\n\t * @param sortBy Parameter to sort by. Must be one of the sortable columns\n\t * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic listVersions({ mapName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListVersionsParams, options?: IKvHttpRequestOptions): Observable<MapVersionListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapVersionListPaginated>(`/maps/${encodeURIComponent(String(mapName))}/versions/list`, requestConfig, MapVersionListPaginated);\n\t}\n\n\t/**\n\t * Update Map\n\t * Update Map  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;\n\t * @param map Map update schema\n\t * @param mapName Map name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic updateMap({ map, mapName }: IUpdateMapParams, options?: IKvHttpRequestOptions): Observable<MapModel> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = map;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapModel>(`/maps/${encodeURIComponent(String(mapName))}/update`, requestConfig, MapModel);\n\t}\n\n\t/**\n\t * Update Symbol\n\t * Update Symbol  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;\n\t * @param symbol Symbol update schema\n\t * @param symbolName Symbol name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic updateSymbol({ symbol, symbolName }: IUpdateSymbolParams, options?: IKvHttpRequestOptions): Observable<Symbol> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = symbol;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<Symbol>(`/maps/symbols/${encodeURIComponent(String(symbolName))}/update`, requestConfig, Symbol);\n\t}\n}\n"]}
+{"version":3,"file":"map.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/map.service.ts"],"names":[],"mappings":";;;AAEA,4CAAsI;AACtI,qDAAiD;AAajD;;GAEG;AAEH,MAAa,UAAW,SAAQ,0BAAW;IAE1C;;;;;OAKG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,GAAG,EAAoB,EAAE,OAA+B;QAE1E,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,GAAG,CAAC;QAEzB,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,cAAc,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,EAAuB,EAAE,OAA+B;QAE5F,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC;QAE5B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAS,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,aAAa,EAAE,eAAM,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAyB,EAAE,OAA+B;QAElG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,QAAQ,CAAC;QAE9B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IACrH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAuB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC;QAE5B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAS,sBAAsB,EAAE,aAAa,EAAE,eAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,EAAoB,EAAE,OAA+B;QAE9E,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,UAAU,EAAuB,EAAE,OAA+B;QAEvF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,iBAAiB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IACvH,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAiB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAoB,EAAE,OAA+B;QAE1F,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,IAAI,GAAG,QAAQ,CAAC;QAE9B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,eAAe,EAAE,aAAa,EAAE,eAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAsB,EAAE,OAA+B;QAE9F,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,IAAI,GAAG,QAAQ,CAAC;QAE9B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAa,iBAAiB,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;OAWG;IAEH,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,KAAsB,EAAE,EAAE,OAA+B;QAEnJ,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAmB,YAAY,EAAE,aAAa,EAAE,yBAAgB,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;OAWG;IAEH,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,KAAyB,EAAE,EAAE,OAA+B;QAE3J,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,WAAW,IAAI,IAAI,EAAE;YACxB,eAAe,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;SAC9C;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAuB,oBAAoB,EAAE,aAAa,EAAE,6BAAoB,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAuB,EAAE,OAA+B;QAE5I,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAA0B,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB,EAAE,aAAa,EAAE,gCAAuB,CAAC,CAAC;IACpJ,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,EAAoB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,GAAG,CAAC;QAEzB,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAW,SAAS,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,aAAa,EAAE,iBAAQ,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;;OAMG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,EAAuB,EAAE,OAA+B;QAE/F,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC;QAE5B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAS,iBAAiB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,aAAa,EAAE,eAAM,CAAC,CAAC;IACtH,CAAC;CACD;AArZD,gCAqZC","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';\nimport { MapListPaginated, MapModel, MapOEE, MapShift, MapVersionListPaginated, Symbol, SymbolsListPaginated } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tICreateMapOEEParams, ICreateMapParams, ICreateMapShiftParams,\n\tICreateSymbolParams,\n\tIDeleteMapParams,\n\tIDeleteSymbolParams, IGetMapOEEParams, IGetMapParams, IGetMapShiftParams,\n\tIListMapsParams,\n\tIListSymbolsParams,\n\tIListVersionsParams,\n\tIUpdateMapParams,\n\tIUpdateSymbolParams\n} from '../types';\n\n/**\n * @category Service\n */\n\nexport class MapService extends BaseService {\n\n\t/**\n\t * Create Map\n\t * Create Map  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;\n\t * @param map Map create schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic createMap({ map }: ICreateMapParams, options?: IKvHttpRequestOptions): Observable<MapModel> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = map;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapModel>(`/maps/create`, requestConfig, MapModel);\n\t}\n\n\t/**\n\t * Create Map OEE\n\t * Create Map OEE  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;\n\t * @param mapOee Map OEE create schema\n\t * @param mapName Map name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic createMapOEE({ mapOee, mapName }: ICreateMapOEEParams, options?: IKvHttpRequestOptions): Observable<MapOEE> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = mapOee;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapOEE>(`/maps/${encodeURIComponent(String(mapName))}/oee/create`, requestConfig, MapOEE);\n\t}\n\n\t/**\n\t * Create Map Shift\n\t * Create Map Shift  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;\n\t * @param mapShift Map Shift create schema\n\t * @param mapName Map name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic createMapShift({ mapShift, mapName }: ICreateMapShiftParams, options?: IKvHttpRequestOptions): Observable<MapShift> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = mapShift;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapShift>(`/maps/${encodeURIComponent(String(mapName))}/shift/create`, requestConfig, MapShift);\n\t}\n\n\t/**\n\t * Create Symbol\n\t * Create Symbol  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;\n\t * @param symbol Symbol create schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic createSymbol({ symbol }: ICreateSymbolParams, options?: IKvHttpRequestOptions): Observable<Symbol> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = symbol;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<Symbol>(`/maps/symbols/create`, requestConfig, Symbol);\n\t}\n\n\t/**\n\t * Delete Map\n\t * Delete Map  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;\n\t * @param mapName Map name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic deleteMap({ mapName }: IDeleteMapParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/maps/${encodeURIComponent(String(mapName))}/delete`, requestConfig);\n\t}\n\n\t/**\n\t * Delete Symbol\n\t * Delete Symbol  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;\n\t * @param symbolName Symbol name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic deleteSymbol({ symbolName }: IDeleteSymbolParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/maps/symbols/${encodeURIComponent(String(symbolName))}/delete`, requestConfig);\n\t}\n\n\t/**\n\t * Get Map\n\t * Get Map  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param mapName Map name\n\t * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic getMap({ mapName, timestamp }: IGetMapParams, options?: IKvHttpRequestOptions): Observable<MapModel> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (timestamp != null) {\n\t\t\tqueryParameters['timestamp'] = timestamp;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapModel>(`/maps/${encodeURIComponent(String(mapName))}/get`, requestConfig, MapModel);\n\t}\n\n\t/**\n\t * Get Map OEE\n\t * Get Map OEE  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param mapNames Map OEE get schema\n\t * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic getMapOEE({ mapNames, timestamp }: IGetMapOEEParams, options?: IKvHttpRequestOptions): Observable<MapOEE[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (timestamp != null) {\n\t\t\tqueryParameters['timestamp'] = timestamp;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.data = mapNames;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapOEE[]>(`/maps/oee/get`, requestConfig, MapOEE);\n\t}\n\n\t/**\n\t * Get Map Shift\n\t * Get Map Shift  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param mapNames Map Shift get schema\n\t * @param timestamp Timestamp to search for specific Shift values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic getMapShift({ mapNames, timestamp }: IGetMapShiftParams, options?: IKvHttpRequestOptions): Observable<MapShift[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (timestamp != null) {\n\t\t\tqueryParameters['timestamp'] = timestamp;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.data = mapNames;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapShift[]>(`/maps/shift/get`, requestConfig, MapShift);\n\t}\n\n\t/**\n\t * List Maps\n\t * List Maps  **Pagination Sortable Columns:** &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;start_date&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param entity Filter for maps that contain the entity\n\t * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)\n\t * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20\n\t * @param startingAfter Lower bound cursor for use in pagination\n\t * @param endingBefore Upper bound cursor for use in pagination\n\t * @param sortBy Parameter to sort by. Must be one of the sortable columns\n\t * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic listMaps({ entity, timestamp, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListMapsParams = {}, options?: IKvHttpRequestOptions): Observable<MapListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (entity != null) {\n\t\t\tqueryParameters['entity'] = entity;\n\t\t}\n\n\t\tif (timestamp != null) {\n\t\t\tqueryParameters['timestamp'] = timestamp;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapListPaginated>(`/maps/list`, requestConfig, MapListPaginated);\n\t}\n\n\t/**\n\t * List Symbols\n\t * List Symbols  **Pagination Sortable Columns:** &#x60;symbol.name&#x60;, &#x60;symbol.title&#x60;, &#x60;symbol.symbol_type&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param search Search symbols by name or title\n\t * @param symbolTypes Search symbols by symbol type\n\t * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20\n\t * @param startingAfter Lower bound cursor for use in pagination\n\t * @param endingBefore Upper bound cursor for use in pagination\n\t * @param sortBy Parameter to sort by. Must be one of the sortable columns\n\t * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic listSymbols({ search, symbolTypes, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListSymbolsParams = {}, options?: IKvHttpRequestOptions): Observable<SymbolsListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\n\t\t}\n\n\t\tif (symbolTypes != null) {\n\t\t\tqueryParameters['symbol_types'] = symbolTypes;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<SymbolsListPaginated>(`/maps/symbols/list`, requestConfig, SymbolsListPaginated);\n\t}\n\n\t/**\n\t * List Versions\n\t * List Versions for a single map  **Pagination Sortable Columns:** &#x60;start_date&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;\n\t * @param mapName Map name\n\t * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20\n\t * @param startingAfter Lower bound cursor for use in pagination\n\t * @param endingBefore Upper bound cursor for use in pagination\n\t * @param sortBy Parameter to sort by. Must be one of the sortable columns\n\t * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic listVersions({ mapName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListVersionsParams, options?: IKvHttpRequestOptions): Observable<MapVersionListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapVersionListPaginated>(`/maps/${encodeURIComponent(String(mapName))}/versions/list`, requestConfig, MapVersionListPaginated);\n\t}\n\n\t/**\n\t * Update Map\n\t * Update Map  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;\n\t * @param map Map update schema\n\t * @param mapName Map name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic updateMap({ map, mapName }: IUpdateMapParams, options?: IKvHttpRequestOptions): Observable<MapModel> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = map;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MapModel>(`/maps/${encodeURIComponent(String(mapName))}/update`, requestConfig, MapModel);\n\t}\n\n\t/**\n\t * Update Symbol\n\t * Update Symbol  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;\n\t * @param symbol Symbol update schema\n\t * @param symbolName Symbol name\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic updateSymbol({ symbol, symbolName }: IUpdateSymbolParams, options?: IKvHttpRequestOptions): Observable<Symbol> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = symbol;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<Symbol>(`/maps/symbols/${encodeURIComponent(String(symbolName))}/update`, requestConfig, Symbol);\n\t}\n}\n"]}

package/dist/cjs/services/generated/api/metric.service.d.ts

@@ -9,64 +9,64 @@ import { ICreateMetricParams, IDeleteMetricParams, IGetMetricParams, IListMetric
 export declare class MetricService extends BaseService {
     /**
      * Create Metric
-     * Create Metric  **Permission Required:** `kelvin.permission.metric.create`
+     * Create Metric  Create a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.  **Permission Required:** `kelvin.permission.metric.create`
      * @param metric Metric create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static createMetric({ metric }: ICreateMetricParams, options?: IKvHttpRequestOptions): Observable<Metric>;
     /**
      * Delete Metric
-     * Delete Metric  **Permission Required:** &#x60;kelvin.permission.metric.delete&#x60;
-     * @param metricName Metric name
+     * Delete Metric  Permanently delete an existing &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;. This cannot be undone once the API request has been submitted.  **Permission Required:** &#x60;kelvin.permission.metric.delete&#x60;
+     * @param metricName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static deleteMetric({ metricName }: IDeleteMetricParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
     /**
      * Get Metric
-     * Get Metric  **Permission Required:** &#x60;kelvin.permission.metric.read&#x60;
-     * @param metricName Metric name
+     * Get Metric  Retrieve the properties of a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.  **Permission Required:** &#x60;kelvin.permission.metric.read&#x60;
+     * @param metricName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMetric({ metricName }: IGetMetricParams, options?: IKvHttpRequestOptions): Observable<Metric>;
     /**
      * List Metric
-     * List Metric  **Pagination Sortable Columns:** &#x60;metric.name&#x60;, &#x60;metric.title&#x60;, &#x60;metric.data_type_name&#x60;, &#x60;metric.data_type_version&#x60;, &#x60;metric.display_unit&#x60;, &#x60;metric.semantic_type_name&#x60;, &#x60;metric.write&#x60;, &#x60;metric.created&#x60;, &#x60;metric.updated&#x60;, &#x60;semantic_type.title&#x60;  **Permission Required:** &#x60;kelvin.permission.metric.read&#x60;
-     * @param names Filter metrics by Name
-     * @param dataTypeName Filter metrics by Data Type Name
-     * @param dataTypeVersion Filter metrics by Data Type Version
-     * @param semanticTypeName Filter metrics by Semantic Type Name
-     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
-     * @param startingAfter Lower bound cursor for use in pagination
-     * @param endingBefore Upper bound cursor for use in pagination
-     * @param sortBy Parameter to sort by. Must be one of the sortable columns
-     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
-     * @param search Search metric by name, title
+     * List Metric  Returns a dictionary with a data property containing a list of all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.  **Pagination Sortable Columns:** &#x60;metric.name&#x60;, &#x60;metric.title&#x60;, &#x60;metric.data_type_name&#x60;, &#x60;metric.data_type_version&#x60;, &#x60;metric.display_unit&#x60;, &#x60;metric.semantic_type_name&#x60;, &#x60;metric.write&#x60;, &#x60;metric.created&#x60;, &#x60;metric.updated&#x60;, &#x60;semantic_type.title&#x60;  **Permission Required:** &#x60;kelvin.permission.metric.read&#x60;
+     * @param names Filter on the parameter &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; by its name. This is given as an array, for example &#x60;[extruder,tank]&#x60;.&lt;/p&gt; The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space but not at the beginning or end).&lt;/p&gt; For example a filter with &#x60;[extruder,tank]&#x60; will return &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; with the name &#x60;extruder&#x60; but not with the names &#x60;demo-ch-extruder-gear-setpoint&#x60; or &#x60;demo-og-gas-tank-level&#x60;.
+     * @param dataTypeName Array of data type names to filter the list. Each string will only return a Data Type Type object with exact matches on the &#x60;name&#x60; parameter.&lt;/p&gt; There are 13 types of data type options; &#x60;raw.boolean&#x60;, &#x60;raw.dynacard&#x60;, &#x60;raw.float32&#x60;, &#x60;raw.float64&#x60;, &#x60;raw.int8&#x60;, &#x60;raw.int16&#x60;, &#x60;raw.int32&#x60;, &#x60;raw.int64&#x60;, &#x60;raw.uint8&#x60;, &#x60;raw.uint16&#x60;, &#x60;raw.uint32&#x60;, &#x60;raw.uint64&#x60; and &#x60;raw.text&#x60;.
+     * @param dataTypeVersion Array of data type versions to filter the list. Each string will only return a Data Type Type object with exact matches on the &#x60;name&#x60; parameter.&lt;/p&gt; For example; &#x60;2.0.0&#x60; will return results, but &#x60;2.0&#x60; will not.
+     * @param semanticTypeName Array of names to filter the list. Each string will only return a Sematic Type object with exact matches on the &#x60;name&#x60; parameter.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; objects.
+     * @param startingAfter An alphanumeric string to move to the next page of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; in the list.&lt;/p&gt; The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; next_page alphanumeric string should be used here to show a list of the next page of results.
+     * @param endingBefore An alphanumeric string to move to the previous page of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; in the list.&lt;/p&gt; The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; previous_page alphanumeric string should be used here to show a list of the previous page of results.
+     * @param sortBy Sort the results by one of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; parameters. Only one parameter can be selected.&lt;/p&gt; There are ten parameter options; &#x60;metric.name&#x60;, &#x60;metric.title&#x60;, &#x60;metric.data_type_name&#x60;, &#x60;metric.data_type_version&#x60;, &#x60;metric.display_unit&#x60;, &#x60;metric.semantic_type_name&#x60;, &#x60;metric.write&#x60;, &#x60;metric.created&#x60;, &#x60;metric.updated&#x60; and &#x60;semantic_type.title&#x60;.&lt;/p&gt; The default is &#x60;metric.name&#x60;
+     * @param sortAsc Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;true&#x60; (ascending order) and &#x60;false&#x60; (descending order).&lt;/p&gt; The default is &#x60;true&#x60; (ascending).
+     * @param search Search and filter the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; list. Both the Display Name and the Name will be included in the filter field criteria. This is given as an array, for example &#x60;[extruder,tank]&#x60;.&lt;/p&gt; The search is case insensitive and will find partial matches as well. For example if a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; name or display name is &#x60;demo-og-centrifugal-pump-speed&#x60;, then a match will be made if the filter string is &#x60;demo&#x60; or &#x60;FUGaL&#x60;.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listMetric({ names, dataTypeName, dataTypeVersion, semanticTypeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc, search }?: IListMetricParams, options?: IKvHttpRequestOptions): Observable<MetricListPaginated>;
     /**
      * List Semantic Type
-     * List Semantic Type  **Sortable Columns:** &#x60;semantic_type.name&#x60;, &#x60;semantic_type.title&#x60;, &#x60;semantic_type.created&#x60;, &#x60;semantic_type.updated&#x60;  **Permission Required:** &#x60;kelvin.permission.metric.read&#x60;
-     * @param names Filter semantic types by name
-     * @param search Search semantic types by name or title
-     * @param sortBy Parameter to sort by. Must be one of the sortable columns
-     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
+     * List Semantic Type  Returns a dictionary with a data property containing a list of all available Semantic Type options on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.  Sematic Types are sensors that stream data to the Kelvin Metric. Depending on the options chosen, there may be more properties available which will be saved to the SemanticTypeProperties parameters.  **Sortable Columns:** &#x60;semantic_type.name&#x60;, &#x60;semantic_type.title&#x60;, &#x60;semantic_type.created&#x60;, &#x60;semantic_type.updated&#x60;  **Permission Required:** &#x60;kelvin.permission.metric.read&#x60;
+     * @param names Array of names to filter the list. Each string will only return a Sematic Type object with exact matches on the &#x60;name&#x60; parameter.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param search Search and filter the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example &#x60;[accelerometer,event]&#x60;.&lt;/p&gt; The search is case insensitive and will find partial matches as well. For example if a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; name or display name is &#x60;Accelerometer&#x60;, then a match will be made if the search string is &#x60;acc&#x60; or &#x60;rOmeT&#x60;.
+     * @param sortBy Sort the results by one of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; parameters. Only one parameter can be selected.&lt;/p&gt; There are four parameter options; &#x60;semantic_type.name&#x60;, &#x60;semantic_type.title&#x60;, &#x60;semantic_type.created&#x60;, &#x60;semantic_type.updated&#x60;.&lt;/p&gt; The default is &#x60;semantic_type.name&#x60;
+     * @param sortAsc Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;true&#x60; (ascending order) and &#x60;false&#x60; (descending order).&lt;/p&gt; The default is &#x60;true&#x60; (ascending).
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listSemanticType({ names, search, sortBy, sortAsc }?: IListSemanticTypeParams, options?: IKvHttpRequestOptions): Observable<SemanticTypeList>;
     /**
      * Update Metric
-     * Update Metric  **Permission Required:** &#x60;kelvin.permission.metric.update&#x60;
+     * Update Metric  Update an existing &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; with any new values passed through the body parameters.  **Permission Required:** &#x60;kelvin.permission.metric.update&#x60;
      * @param metric Metric update schema
-     * @param metricName Metric name
+     * @param metricName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static updateMetric({ metric, metricName }: IUpdateMetricParams, options?: IKvHttpRequestOptions): Observable<Metric>;
     /**
      * Upload Metrics
-     * Upload Metrics  **Permission Required:** &#x60;kelvin.permission.metric.create&#x60;
-     * @param file CSV File
-     * @param dryRun If set to true performs only validation
+     * Upload Metrics  Upload a csv (comma-separated values) file with up to 20,000 metrics to add as &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; into the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;. Each row represents one &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.  The first row of the csv file needs to be the header of the columns. &#x60;DISPLAY NAME,NAME,SEMANTIC TYPE,DATA TYPE,UNIT DISPLAY,WRITE&#x60;.  Details of the options for each column are explained in this &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/metrics/metrics/#importing-metrics-in-bulk&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Documentation&lt;/a&gt; link.  The file needs to be saved in UTF-8 format with a comma separating each field. Do not use other separation options available in Microsoft Excel or Google Sheets such as semi-colons or colons. Strings in the csv file can be with or without quotation marks.  **Permission Required:** &#x60;kelvin.permission.metric.create&#x60;
+     * @param file Path and name of the CSV File to upload to the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.&lt;/p&gt; You can download a blank copy of the template from the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/control-manager-ui-overview/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Manager UI&lt;/a&gt;. Instructions can be found in the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/metrics/metrics#1.-download-the-metrics-csv-template&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Documentation&lt;/a&gt;.
+     * @param dryRun Perform a trial run to create the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; without saving the changes.&lt;/p&gt; This is very useful when you want to test your new &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; bulk upload without making any changes on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static uploadMetrics({ file, dryRun }: IUploadMetricsParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;

package/dist/cjs/services/generated/api/metric.service.js

@@ -9,7 +9,7 @@ const base_service_1 = require("../../base.service");
 class MetricService extends base_service_1.BaseService {
     /**
      * Create Metric
-     * Create Metric  **Permission Required:** `kelvin.permission.metric.create`
+     * Create Metric  Create a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.  **Permission Required:** `kelvin.permission.metric.create`
      * @param metric Metric create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -24,8 +24,8 @@ class MetricService extends base_service_1.BaseService {
     }
     /**
      * Delete Metric
-     * Delete Metric  **Permission Required:** `kelvin.permission.metric.delete`
-     * @param metricName Metric name
+     * Delete Metric  Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>. This cannot be undone once the API request has been submitted.  **Permission Required:** `kelvin.permission.metric.delete`
+     * @param metricName 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 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.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static deleteMetric({ metricName }, options) {
@@ -38,8 +38,8 @@ class MetricService extends base_service_1.BaseService {
     }
     /**
      * Get Metric
-     * Get Metric  **Permission Required:** `kelvin.permission.metric.read`
-     * @param metricName Metric name
+     * Get Metric  Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.  **Permission Required:** `kelvin.permission.metric.read`
+     * @param metricName 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 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.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMetric({ metricName }, options) {
@@ -52,17 +52,17 @@ class MetricService extends base_service_1.BaseService {
     }
     /**
      * List Metric
-     * List Metric  **Pagination Sortable Columns:** `metric.name`, `metric.title`, `metric.data_type_name`, `metric.data_type_version`, `metric.display_unit`, `metric.semantic_type_name`, `metric.write`, `metric.created`, `metric.updated`, `semantic_type.title`  **Permission Required:** `kelvin.permission.metric.read`
-     * @param names Filter metrics by Name
-     * @param dataTypeName Filter metrics by Data Type Name
-     * @param dataTypeVersion Filter metrics by Data Type Version
-     * @param semanticTypeName Filter metrics by Semantic Type Name
-     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
-     * @param startingAfter Lower bound cursor for use in pagination
-     * @param endingBefore Upper bound cursor for use in pagination
-     * @param sortBy Parameter to sort by. Must be one of the sortable columns
-     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
-     * @param search Search metric by name, title
+     * List Metric  Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.  **Pagination Sortable Columns:** `metric.name`, `metric.title`, `metric.data_type_name`, `metric.data_type_version`, `metric.display_unit`, `metric.semantic_type_name`, `metric.write`, `metric.created`, `metric.updated`, `semantic_type.title`  **Permission Required:** `kelvin.permission.metric.read`
+     * @param names Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> by its name. This is given as an array, for example `[extruder,tank]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `[extruder,tank]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> with the name `extruder` but not with the names `demo-ch-extruder-gear-setpoint` or `demo-og-gas-tank-level`.
+     * @param dataTypeName Array of data type names to filter the list. Each string will only return a Data Type Type object with exact matches on the `name` parameter.</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`.
+     * @param dataTypeVersion Array of data type versions to filter the list. Each string will only return a Data Type Type object with exact matches on the `name` parameter.</p> For example; `2.0.0` will return results, but `2.0` will not.
+     * @param semanticTypeName Array of names to filter the list. Each string will only return a Sematic Type object with exact matches on the `name` parameter.</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.
+     * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> objects.
+     * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
+     * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
+     * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `metric.name`, `metric.title`, `metric.data_type_name`, `metric.data_type_version`, `metric.display_unit`, `metric.semantic_type_name`, `metric.write`, `metric.created`, `metric.updated` and `semantic_type.title`.</p> The default is `metric.name`
+     * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
+     * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> list. Both the Display Name and the Name will be included in the filter field criteria. This is given as an array, for example `[extruder,tank]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> name or display name is `demo-og-centrifugal-pump-speed`, then a match will be made if the filter string is `demo` or `FUGaL`.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listMetric({ names, dataTypeName, dataTypeVersion, semanticTypeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc, search } = {}, options) {
@@ -107,11 +107,11 @@ class MetricService extends base_service_1.BaseService {
     }
     /**
      * List Semantic Type
-     * List Semantic Type  **Sortable Columns:** `semantic_type.name`, `semantic_type.title`, `semantic_type.created`, `semantic_type.updated`  **Permission Required:** `kelvin.permission.metric.read`
-     * @param names Filter semantic types by name
-     * @param search Search semantic types by name or title
-     * @param sortBy Parameter to sort by. Must be one of the sortable columns
-     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
+     * List Semantic Type  Returns a dictionary with a data property containing a list of all available Semantic Type options on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.  Sematic Types are sensors that stream data to the Kelvin Metric. Depending on the options chosen, there may be more properties available which will be saved to the SemanticTypeProperties parameters.  **Sortable Columns:** `semantic_type.name`, `semantic_type.title`, `semantic_type.created`, `semantic_type.updated`  **Permission Required:** `kelvin.permission.metric.read`
+     * @param names Array of names to filter the list. Each string will only return a Sematic Type object with exact matches on the `name` parameter.</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.
+     * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[accelerometer,event]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> name or display name is `Accelerometer`, then a match will be made if the search string is `acc` or `rOmeT`.
+     * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> parameters. Only one parameter can be selected.</p> There are four parameter options; `semantic_type.name`, `semantic_type.title`, `semantic_type.created`, `semantic_type.updated`.</p> The default is `semantic_type.name`
+     * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listSemanticType({ names, search, sortBy, sortAsc } = {}, options) {
@@ -138,9 +138,9 @@ class MetricService extends base_service_1.BaseService {
     }
     /**
      * Update Metric
-     * Update Metric  **Permission Required:** `kelvin.permission.metric.update`
+     * Update Metric  Update an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> with any new values passed through the body parameters.  **Permission Required:** `kelvin.permission.metric.update`
      * @param metric Metric update schema
-     * @param metricName Metric name
+     * @param metricName 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 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.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static updateMetric({ metric, metricName }, options) {
@@ -154,9 +154,9 @@ class MetricService extends base_service_1.BaseService {
     }
     /**
      * Upload Metrics
-     * Upload Metrics  **Permission Required:** `kelvin.permission.metric.create`
-     * @param file CSV File
-     * @param dryRun If set to true performs only validation
+     * Upload Metrics  Upload a csv (comma-separated values) file with up to 20,000 metrics to add as <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> into the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Each row represents one <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a>.  The first row of the csv file needs to be the header of the columns. `DISPLAY NAME,NAME,SEMANTIC TYPE,DATA TYPE,UNIT DISPLAY,WRITE`.  Details of the options for each column are explained in this <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/metrics/metrics/#importing-metrics-in-bulk' target='_blank'>Kelvin Documentation</a> link.  The file needs to be saved in UTF-8 format with a comma separating each field. Do not use other separation options available in Microsoft Excel or Google Sheets such as semi-colons or colons. Strings in the csv file can be with or without quotation marks.  **Permission Required:** `kelvin.permission.metric.create`
+     * @param file Path and name of the CSV File to upload to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.</p> You can download a blank copy of the template from the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/control-manager-ui-overview/' target='_blank'>Kelvin Manager UI</a>. Instructions can be found in the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-manager-ui/management/metrics/metrics#1.-download-the-metrics-csv-template' target='_blank'>Kelvin Documentation</a>.
+     * @param dryRun Perform a trial run to create the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> without saving the changes.</p> This is very useful when you want to test your new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> bulk upload without making any changes on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static uploadMetrics({ file, dryRun }, options) {