npm - @kelvininc/js-client-sdk - Versions diffs - 7.13.2 → 7.18.0 - Mend

@kelvininc/js-client-sdk 7.13.2 → 7.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2590) hide show

package/dist/esm/services/generated/api/storage.service.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/storage.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAWjD;;GAEG;AAEH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAE9C;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,OAAO,EAAgC,EAAE,OAA+B;QAEtG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAA+B,EAAE,OAA+B;QAEpG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,iCAAiC,EAAE,aAAa,CAAC,CAAC;IACxF,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,wBAAwB,CAAC,EAAE,KAAK,EAAmC,EAAE,OAA+B;QAE1G,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,KAAK,CAAC;QAC3B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,UAAU,CAAC;QAErC,OAAO,IAAI,CAAC,OAAO,CAAkB,mCAAmC,EAAE,aAAa,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,+BAA+B,CAAC,EAAE,IAAI,EAA0C,EAAE,OAA+B;QAEvH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;OAOG;IAEH,MAAM,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAiC,EAAE,OAA+B;QAExH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAc,6BAA6B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,8BAA8B,CAAC,EAAE,KAAK,EAAyC,EAAE,OAA+B;QAEtH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,KAAK,CAAC;QAC3B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAgB,6BAA6B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;OAcG;IAEH,MAAM,CAAC,uBAAuB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAkC,EAAE,OAA+B;QAEvL,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;SACxD;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;SACpD;QAED,IAAI,GAAG,IAAI,IAAI,EAAE;YAChB,eAAe,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;SAC7B;QAED,IAAI,UAAU,IAAI,IAAI,EAAE;YACvB,eAAe,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;SAC5C;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,eAAe,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;SACjC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,KAAiC,EAAE,EAAE,OAA+B;QAE/K,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;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;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAA6B,yBAAyB,EAAE,aAAa,EAAE,0BAA0B,CAAC,CAAC;IACvH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,OAAO,EAAgC,EAAE,OAA+B;QAEtG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAiC,EAAE,OAA+B;QAErG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,MAAM,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAClC,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,UAAU,CAAC,MAAM,CAAC,MAAM,EAAO,IAAI,CAAC,CAAC;SACrC;QACD,aAAa,CAAC,IAAI,GAAG,UAAU,CAAC;QAChC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;CACD","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';\nimport { StorageData, StorageMetricListPaginated } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tICreateHistorianMetricParams,\n\tIDeleteHistorianRangeParams,\n\tIDownloadHistorianMetricsParams,\n\tIGetHistorianMetricAdvancedRangeParams, IGetHistorianMetricLastAdvancedParams, IGetHistorianMetricLastParams, IGetHistorianMetricRangeParams,\n\tIListHistorianMetricParams,\n\tIUpdateHistorianMetricParams,\n\tIUploadHistorianMetricsParams\n} from '../types';\n\n/*\n @category Service\n /\n\nexport class StorageService extends BaseService {\n\n\t/\n\t Create Historian Metric\n\t * Create Historian Metric Create one or more data values for defined times for one or more specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. <span style=\\"color: #ff0000;font-weight: bold;\\">WARNING</span> : If a value already exists at the defined time, then it will be overwriten with the new payload value. The old value will be lost and is not recoverable ! Permission Required: `kelvin.permission.storage.create`\n\t * @param storage Storage create schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic createHistorianMetric({ storage }: ICreateHistorianMetricParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/create`, requestConfig);\n\t}\n\n\t/\n\t Delete Historian Range\n\t * Delete Historian Range will delete all associated time series values for selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs between a given time range. Permission Required: `kelvin.permission.storage.delete`\n\t * @param storage Body of the request\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic deleteHistorianRange({ storage }: IDeleteHistorianRangeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/range/delete`, requestConfig);\n\t}\n\n\t/\n\t Download Historian Metrics\n\t * Download Historian Metrics Returns a CSV file with time series data within a for a given time range and given list of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs in the parameter `selectors`. The downloaded csv file will contain six columns; `name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> ), `time` ( Timestamp when the data was recorded from source ), `asset_name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> ), `source` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> that has recorded the data ), `target` ( Custom parameter set by user ), `value` ( value recorded ). Permission Required: `kelvin.permission.storage.read`\n\t * @param query Request Schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic downloadHistorianMetrics({ query }: IDownloadHistorianMetricsParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = query;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'text/csv';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/range/download`, requestConfig);\n\t}\n\n\t/\n\t Get Historian Metric Advanced Range\n\t * Get Historian Metric Advanced Range Returns a list of recorded values or calculated statistics from the database for one or multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs based on a time range. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param body Advanced range schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricAdvancedRange({ body }: IGetHistorianMetricAdvancedRangeParams, options?: IKvHttpRequestOptions): Observable<StorageData[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = body;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<StorageData[]>(`/storage/historian/range/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t Get Historian Metric Last\n\t * Get Historian Metric Last Returns the last recorded value in the database for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param name 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.\n\t * @param assetName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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 * @param fields List of wanted field keys that are recorded in the payload. Normally this will be value.</p> If there are other unique keys/value pairs in the payload, then you can create a list of all keys to retrieve the values. e.g. 'value, key2'. If the key does not exist in the stored payload, that key will return with a value `null`.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricLast({ name, assetName, fields }: IGetHistorianMetricLastParams, options?: IKvHttpRequestOptions): Observable<StorageData> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (name != null) {\n\t\t\tqueryParameters['name'] = name;\n\t\t}\n\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (fields != null) {\n\t\t\tqueryParameters['fields'] = fields;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<StorageData>(`/storage/historian/last/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t Get Historian Metric Last Advanced\n\t * Get Historian Metric Last Advanced Returns an array of last recorded values in the database for each of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs in the POST. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param query Request for multiple Metric selectors\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricLastAdvanced({ query }: IGetHistorianMetricLastAdvancedParams, options?: IKvHttpRequestOptions): Observable<StorageData[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = query;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<StorageData[]>(`/storage/historian/last/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t Get Historian Metric Range\n\t * Get Historian Metric Range Returns a list of recorded values or calculated statistics from the database for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair based on a time range. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param name 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.\n\t * @param assetName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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 * @param startTime Start time of the recorded time to collect the payload data from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> in ISO 8601 UTC date/time format. Example; '2022-07-08T08:41:01.657916Z'.\n\t * @param endTime End time of the recorded time to collect the payload data from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> in ISO 8601 UTC date/time format. Example; '2022-07-08T08:41:01.657916Z'.\n\t * @param agg Perform mathematical calculations on a group of data.</p> For numerical data there are twelve mathematical options available; `none` , `count`,`distinct`, `integral`, `mean`, `median`, `mode`, `spread`, `stddev`, `sum`, `max`, `min`.</p> For text based data there are three types of mathematical options available; `count`, `distinct`, `mode`. The default is `none`.</p> When using this parameter, you must also use the parameters `time_bucket` which defines how to group the data and `fields` which defines which payload data to use.\n\t * @param timeBucket Group the data by time frame for the `agg` parameter calculations.</p> The time can be adjusted with these time units `ns`, `ms`, `s`, `m`, `h`. e.g. `8765h` equates to is 8,765 hours which is approximately one year.\n\t * @param timeShift Shift the time buckets from the epoch. Every time bucket starts from epoch so, if you want to calculate the time bucket starting on a different date and time, you'll need to set this. Example: `5m`, `1h`, `1w`.\n\t * @param fill Fills any group of data, which is defined by the `time_bucket` parameter, with a calculated value when there is no data in the database.</p> There are five options available; `none`, `null`, `linear`, `previous`, fixed integer value.</p> `none` will ignore the group. `null`, `previous` and fixed integer value will be added as the value for the empty group. `linear` will perform a linear regression to calculated the groups' value.</p> The default is `none`.\n\t * @param order Order of the results for the timestamp parameter.</p> There are two options available (capital letters is required); `ASC` for ascending and `DESC` for descending. The default is `ASC`.\n\t * @param fields Array of strings which each string representing one key inside the payload. Normally there will be only one key labeled `value`.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricRange({ name, assetName, startTime, endTime, agg, timeBucket, timeShift, fill, order, fields }: IGetHistorianMetricRangeParams, options?: IKvHttpRequestOptions): Observable<StorageData[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (name != null) {\n\t\t\tqueryParameters['name'] = name;\n\t\t}\n\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (startTime != null) {\n\t\t\tqueryParameters['start_time'] = startTime.toISOString();\n\t\t}\n\n\t\tif (endTime != null) {\n\t\t\tqueryParameters['end_time'] = endTime.toISOString();\n\t\t}\n\n\t\tif (agg != null) {\n\t\t\tqueryParameters['agg'] = agg;\n\t\t}\n\n\t\tif (timeBucket != null) {\n\t\t\tqueryParameters['time_bucket'] = timeBucket;\n\t\t}\n\n\t\tif (timeShift != null) {\n\t\t\tqueryParameters['time_shift'] = timeShift;\n\t\t}\n\n\t\tif (fill != null) {\n\t\t\tqueryParameters['fill'] = fill;\n\t\t}\n\n\t\tif (order != null) {\n\t\t\tqueryParameters['order'] = order;\n\t\t}\n\n\t\tif (fields != null) {\n\t\t\tqueryParameters['fields'] = fields;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<StorageData[]>(`/storage/historian/range/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t List Historian Metric\n\t * List Historian Metric Returns a dictionary with a data property containing a filtered array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Pagination Sortable Columns: `storage_metric.name`, `storage_metric.asset_name` Permission Required: `kelvin.permission.storage.read`\n\t * @param name 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.\n\t * @param assetName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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 * @param search Search and filter the return list. Both the Display Name and the Name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</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-assets/#asset' target='_blank'>Kelvin Asset</a> name or display name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair objects 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-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs 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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs 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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are two parameter options; `name` and `asset.name`.</p> The default is `asset.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listHistorianMetric({ name, assetName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListHistorianMetricParams = {}, options?: IKvHttpRequestOptions): Observable<StorageMetricListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (name != null) {\n\t\t\tqueryParameters['name'] = name;\n\t\t}\n\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\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\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<StorageMetricListPaginated>(`/storage/historian/list`, requestConfig, StorageMetricListPaginated);\n\t}\n\n\t/\n\t Update Historian Metric\n\t * Update Historian Metric Updates the `title` parameter of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair. Permission Required: `kelvin.permission.storage.update`\n\t * @param storage Body of the request\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic updateHistorianMetric({ storage }: IUpdateHistorianMetricParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/update`, requestConfig);\n\t}\n\n\t/\n\t Upload Historian Metrics\n\t * Upload Historian Metrics Accepts a CSV file with time series data within a for a given time range and given list of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs in the parameter `selectors`. The csv file should contain six columns in a comma delimited csv file; `name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> ), `time` ( Timestamp when the data was recorded from source ), `asset_name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> ), `source` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> that has recorded the data - this value is optional ), `target` ( Custom parameter set by user - this value is optional ), `value` ( value recorded ). The first row must contain the column headers; `name,time,asset_name,source,target,value`. Permission Required: `kelvin.permission.storage.create`\n\t * @param file CSV File\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic uploadHistorianMetrics({ file }: IUploadHistorianMetricsParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\tconst formParams = new FormData();\n\t\tif (file != null) {\n\t\t\tformParams.append('file', <any>file);\n\t\t}\n\t\trequestConfig.data = formParams;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/upload`, requestConfig);\n\t}\n}\n"]}
1	+ {"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/storage.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAYlE;;GAEG;AAEH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAE9C;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,OAAO,EAAgC,EAAE,OAA+B;QAEtG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAA+B,EAAE,OAA+B;QAEpG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,iCAAiC,EAAE,aAAa,CAAC,CAAC;IACxF,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,wBAAwB,CAAC,EAAE,KAAK,EAAmC,EAAE,OAA+B;QAE1G,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,KAAK,CAAC;QAC3B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,UAAU,CAAC;QAErC,OAAO,IAAI,CAAC,OAAO,CAAkB,mCAAmC,EAAE,aAAa,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,+BAA+B,CAAC,EAAE,IAAI,EAA0C,EAAE,OAA+B;QAEvH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;OAOG;IAEH,MAAM,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAiC,EAAE,OAA+B;QAExH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAc,6BAA6B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,8BAA8B,CAAC,EAAE,KAAK,EAAyC,EAAE,OAA+B;QAEtH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,KAAK,CAAC;QAC3B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAgB,6BAA6B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;;;OAcG;IAEH,MAAM,CAAC,uBAAuB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAkC,EAAE,OAA+B;QAEvL,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;SACxD;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;SACpD;QAED,IAAI,GAAG,IAAI,IAAI,EAAE;YAChB,eAAe,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;SAC7B;QAED,IAAI,UAAU,IAAI,IAAI,EAAE;YACvB,eAAe,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;SAC5C;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,eAAe,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;SACjC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IAEH,MAAM,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,KAAiC,EAAE,EAAE,OAA+B;QAE1L,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,cAAc,IAAI,IAAI,EAAE;YAC3B,eAAe,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC;SACpD;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;SACvC;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,IAAI,cAAc,KAAK,cAAc,CAAC,MAAM,EAAE;YAC7C,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;SACtD;aAAM;YACN,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;SAC7C;QAED,OAAO,IAAI,CAAC,OAAO,CAA6B,yBAAyB,EAAE,aAAa,EAAE,0BAA0B,CAAC,CAAC;IACvH,CAAC;IAED;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAC,uBAAuB,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAkC,EAAE,OAA+B;QAE7K,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,cAAc,IAAI,IAAI,EAAE;YAC3B,eAAe,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC;SACpD;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;SACvC;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,IAAI,cAAc,KAAK,cAAc,CAAC,MAAM,EAAE;YAC7C,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;SACtD;aAAM;YACN,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;SAC7C;QAED,OAAO,IAAI,CAAC,OAAO,CAA6B,yBAAyB,EAAE,aAAa,EAAE,0BAA0B,CAAC,CAAC;IACvH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,OAAO,EAAgC,EAAE,OAA+B;QAEtG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,sBAAsB,CAAC,EAAE,IAAI,EAAiC,EAAE,OAA+B;QAErG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,MAAM,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAClC,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,UAAU,CAAC,MAAM,CAAC,MAAM,EAAO,IAAI,CAAC,CAAC;SACrC;QACD,aAAa,CAAC,IAAI,GAAG,UAAU,CAAC;QAChC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;CACD","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';\nimport { StorageData, StorageMetricListPaginated } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport { EPaginatorType } from '../../pagination/paginator.types';\nimport {\n\tICreateHistorianMetricParams,\n\tIDeleteHistorianRangeParams,\n\tIDownloadHistorianMetricsParams,\n\tIGetHistorianMetricAdvancedRangeParams, IGetHistorianMetricLastAdvancedParams, IGetHistorianMetricLastParams, IGetHistorianMetricRangeParams,\n\tIListHistorianMetricParams,\n\tIListHistorianMetricPOSTParams,\n\tIUpdateHistorianMetricParams,\n\tIUploadHistorianMetricsParams\n} from '../types';\n\n/*\n @category Service\n /\n\nexport class StorageService extends BaseService {\n\n\t/\n\t Create Historian Metric\n\t * Create Historian Metric Create one or more data values for defined times for one or more specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. <span style=\\"color: #ff0000;font-weight: bold;\\">WARNING</span> : If a value already exists at the defined time, then it will be overwriten with the new payload value. The old value will be lost and is not recoverable ! Permission Required: `kelvin.permission.storage.create`\n\t * @param storage Storage create schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic createHistorianMetric({ storage }: ICreateHistorianMetricParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/create`, requestConfig);\n\t}\n\n\t/\n\t Delete Historian Range\n\t * Delete Historian Range will delete all associated time series values for selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs between a given time range. Permission Required: `kelvin.permission.storage.delete`\n\t * @param storage Body of the request\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic deleteHistorianRange({ storage }: IDeleteHistorianRangeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/range/delete`, requestConfig);\n\t}\n\n\t/\n\t Download Historian Metrics\n\t * Download Historian Metrics Returns a CSV file with time series data within a for a given time range and given list of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs in the parameter `selectors`. The downloaded csv file will contain six columns; `name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> ), `time` ( Timestamp when the data was recorded from source ), `asset_name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> ), `source` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> that has recorded the data ), `target` ( Custom parameter set by user ), `value` ( value recorded ). Permission Required: `kelvin.permission.storage.read`\n\t * @param query Request Schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic downloadHistorianMetrics({ query }: IDownloadHistorianMetricsParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = query;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'text/csv';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/range/download`, requestConfig);\n\t}\n\n\t/\n\t Get Historian Metric Advanced Range\n\t * Get Historian Metric Advanced Range Returns a list of recorded values or calculated statistics from the database for one or multiple <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs based on a time range. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param body Advanced range schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricAdvancedRange({ body }: IGetHistorianMetricAdvancedRangeParams, options?: IKvHttpRequestOptions): Observable<StorageData[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = body;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<StorageData[]>(`/storage/historian/range/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t Get Historian Metric Last\n\t * Get Historian Metric Last Returns the last recorded value in the database for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param name 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.\n\t * @param assetName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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 * @param fields List of wanted field keys that are recorded in the payload. Normally this will be value.</p> If there are other unique keys/value pairs in the payload, then you can create a list of all keys to retrieve the values. e.g. 'value, key2'. If the key does not exist in the stored payload, that key will return with a value `null`.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricLast({ name, assetName, fields }: IGetHistorianMetricLastParams, options?: IKvHttpRequestOptions): Observable<StorageData> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (name != null) {\n\t\t\tqueryParameters['name'] = name;\n\t\t}\n\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (fields != null) {\n\t\t\tqueryParameters['fields'] = fields;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<StorageData>(`/storage/historian/last/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t Get Historian Metric Last Advanced\n\t * Get Historian Metric Last Advanced Returns an array of last recorded values in the database for each of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs in the POST. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param query Request for multiple Metric selectors\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricLastAdvanced({ query }: IGetHistorianMetricLastAdvancedParams, options?: IKvHttpRequestOptions): Observable<StorageData[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = query;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<StorageData[]>(`/storage/historian/last/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t Get Historian Metric Range\n\t * Get Historian Metric Range Returns a list of recorded values or calculated statistics from the database for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair based on a time range. This does not rely on the workload (<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a>) that records the data to be online. Permission Required: `kelvin.permission.storage.read`\n\t * @param name 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.\n\t * @param assetName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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 * @param startTime Start time of the recorded time to collect the payload data from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> in ISO 8601 UTC date/time format. Example; '2022-07-08T08:41:01.657916Z'.\n\t * @param endTime End time of the recorded time to collect the payload data from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> in ISO 8601 UTC date/time format. Example; '2022-07-08T08:41:01.657916Z'.\n\t * @param agg Perform mathematical calculations on a group of data.</p> For numerical data there are twelve mathematical options available; `none` , `count`,`distinct`, `integral`, `mean`, `median`, `mode`, `spread`, `stddev`, `sum`, `max`, `min`.</p> For text based data there are three types of mathematical options available; `count`, `distinct`, `mode`. The default is `none`.</p> When using this parameter, you must also use the parameters `time_bucket` which defines how to group the data and `fields` which defines which payload data to use.\n\t * @param timeBucket Group the data by time frame for the `agg` parameter calculations.</p> The time can be adjusted with these time units `ns`, `ms`, `s`, `m`, `h`. e.g. `8765h` equates to is 8,765 hours which is approximately one year.\n\t * @param timeShift Shift the time buckets from the epoch. Every time bucket starts from epoch so, if you want to calculate the time bucket starting on a different date and time, you'll need to set this. Example: `5m`, `1h`, `1w`.\n\t * @param fill Fills any group of data, which is defined by the `time_bucket` parameter, with a calculated value when there is no data in the database.</p> There are five options available; `none`, `null`, `linear`, `previous`, fixed integer value.</p> `none` will ignore the group. `null`, `previous` and fixed integer value will be added as the value for the empty group. `linear` will perform a linear regression to calculated the groups' value.</p> The default is `none`.\n\t * @param order Order of the results for the timestamp parameter.</p> There are two options available (capital letters is required); `ASC` for ascending and `DESC` for descending. The default is `ASC`.\n\t * @param fields Array of strings which each string representing one key inside the payload. Normally there will be only one key labeled `value`.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getHistorianMetricRange({ name, assetName, startTime, endTime, agg, timeBucket, timeShift, fill, order, fields }: IGetHistorianMetricRangeParams, options?: IKvHttpRequestOptions): Observable<StorageData[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (name != null) {\n\t\t\tqueryParameters['name'] = name;\n\t\t}\n\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (startTime != null) {\n\t\t\tqueryParameters['start_time'] = startTime.toISOString();\n\t\t}\n\n\t\tif (endTime != null) {\n\t\t\tqueryParameters['end_time'] = endTime.toISOString();\n\t\t}\n\n\t\tif (agg != null) {\n\t\t\tqueryParameters['agg'] = agg;\n\t\t}\n\n\t\tif (timeBucket != null) {\n\t\t\tqueryParameters['time_bucket'] = timeBucket;\n\t\t}\n\n\t\tif (timeShift != null) {\n\t\t\tqueryParameters['time_shift'] = timeShift;\n\t\t}\n\n\t\tif (fill != null) {\n\t\t\tqueryParameters['fill'] = fill;\n\t\t}\n\n\t\tif (order != null) {\n\t\t\tqueryParameters['order'] = order;\n\t\t}\n\n\t\tif (fields != null) {\n\t\t\tqueryParameters['fields'] = fields;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<StorageData[]>(`/storage/historian/range/get`, requestConfig, StorageData);\n\t}\n\n\t/\n\t List Historian Metric\n\t * List Historian Metric Returns a dictionary with a data property containing a filtered array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Pagination Sortable Columns: `resource` (asset+metric), `data_type`,`last_timestamp`,`created`, `updated` Permission Required: `kelvin.permission.storage.read`\n\t * @param name 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.\n\t * @param assetName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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 * @param search Search and filter the return list. Both the Display Name and the Name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> and <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</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-assets/#asset' target='_blank'>Kelvin Asset</a> name or display name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.\n\t * @param paginationType Method of handling pages in the returned data. There are three options available:</p> limits: This is used with the query parameters `page` to select which page of data to return. The start of the data returned will be calculated using the `page_size` and `page` query parameters for the location to start and the query parameters `sort_by` and `direction` will determine the order of the data.</p> cursor: This is used with the query parameters `next` and `previous` which uses a string as the start or end location reference. The string to use is returned in the previous query json response in the keys `next_page` and `previous_page`.</p> stream: This will return all the data in one response.\n\t * @param pageSize Number of workload objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20\n\t * @param page Used only with query parameter `pagination_type` set as `limits`.</p> An integer for the wanted page of results. The start of the data returned will be calculated using the `page_size` and `page` query parameters for the location to start and the query parameters `sort_by` and `direction` will determine the order of the data.\n\t * @param next Used only with query parameter `pagination_type` set as `cursor`.</p> An alphanumeric string to move to the next page of workloads 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.\n\t * @param previous Used only with query parameter `pagination_type` set as `cursor`.</p> An alphanumeric string to move to the previous page of workloads 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.\n\t * @param direction Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `asc` (ascending order) and `desc` (descending order).</p> The default is `asc` (ascending).\n\t * @param sortBy Sort the results by one of the workload parameters. Only one parameter can be selected.</p> Allowed options: `resource`, `data_type`,`last_timestamp`,`created`, `updated`.</p> The default is `resource`\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listHistorianMetric({ name, assetName, search, paginationType, pageSize, page, next, previous, direction, sortBy }: IListHistorianMetricParams = {}, options?: IKvHttpRequestOptions): Observable<StorageMetricListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (name != null) {\n\t\t\tqueryParameters['name'] = name;\n\t\t}\n\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\n\t\t}\n\n\t\tif (paginationType != null) {\n\t\t\tqueryParameters['pagination_type'] = paginationType;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (page != null) {\n\t\t\tqueryParameters['page'] = page;\n\t\t}\n\n\t\tif (next != null) {\n\t\t\tqueryParameters['next'] = next;\n\t\t}\n\n\t\tif (previous != null) {\n\t\t\tqueryParameters['previous'] = previous;\n\t\t}\n\n\t\tif (direction != null) {\n\t\t\tqueryParameters['direction'] = direction;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\n\t\tif (paginationType === EPaginatorType.Stream) {\n\t\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\t} else {\n\t\t\trequestConfig.mediaType = 'application/json';\n\t\t}\n\n\t\treturn this.request<StorageMetricListPaginated>(`/storage/historian/list`, requestConfig, StorageMetricListPaginated);\n\t}\n\n\t/\n\t List Historian Metric POST\n\t * List Historian Metric POST Returns a dictionary with a data property containing a filtered array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Pagination Sortable Columns: `resource` (asset+metric), `data_type`,`last_timestamp`,`created`, `updated` Permission Required: `kelvin.permission.storage.read`\n\t * @param storage Storage list schema\n\t * @param paginationType Method of handling pages in the returned data. There are three options available:</p> limits: This is used with the query parameters `page` to select which page of data to return. The start of the data returned will be calculated using the `page_size` and `page` query parameters for the location to start and the query parameters `sort_by` and `direction` will determine the order of the data.</p> cursor: This is used with the query parameters `next` and `previous` which uses a string as the start or end location reference. The string to use is returned in the previous query json response in the keys `next_page` and `previous_page`.</p> stream: This will return all the data in one response.\n\t * @param pageSize Number of workload objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20\n\t * @param page Used only with query parameter `pagination_type` set as `limits`.</p> An integer for the wanted page of results. The start of the data returned will be calculated using the `page_size` and `page` query parameters for the location to start and the query parameters `sort_by` and `direction` will determine the order of the data.\n\t * @param next Used only with query parameter `pagination_type` set as `cursor`.</p> An alphanumeric string to move to the next page of workloads 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.\n\t * @param previous Used only with query parameter `pagination_type` set as `cursor`.</p> An alphanumeric string to move to the previous page of workloads 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.\n\t * @param direction Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `asc` (ascending order) and `desc` (descending order).</p> The default is `asc` (ascending).\n\t * @param sortBy Sort the results by one of the workload parameters. Only one parameter can be selected.</p> Allowed options: `resource`, `data_type`,`last_timestamp`,`created`, `updated`.</p> The default is `resource`\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listHistorianMetricPOST({ storage, paginationType, pageSize, page, next, previous, direction, sortBy }: IListHistorianMetricPOSTParams, options?: IKvHttpRequestOptions): Observable<StorageMetricListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (paginationType != null) {\n\t\t\tqueryParameters['pagination_type'] = paginationType;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (page != null) {\n\t\t\tqueryParameters['page'] = page;\n\t\t}\n\n\t\tif (next != null) {\n\t\t\tqueryParameters['next'] = next;\n\t\t}\n\n\t\tif (previous != null) {\n\t\t\tqueryParameters['previous'] = previous;\n\t\t}\n\n\t\tif (direction != null) {\n\t\t\tqueryParameters['direction'] = direction;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\n\t\tif (paginationType === EPaginatorType.Stream) {\n\t\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\t} else {\n\t\t\trequestConfig.mediaType = 'application/json';\n\t\t}\n\n\t\treturn this.request<StorageMetricListPaginated>(`/storage/historian/list`, requestConfig, StorageMetricListPaginated);\n\t}\n\n\t/\n\t Update Historian Metric\n\t * Update Historian Metric Updates the `title` parameter of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pair. Permission Required: `kelvin.permission.storage.update`\n\t * @param storage Body of the request\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic updateHistorianMetric({ storage }: IUpdateHistorianMetricParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/update`, requestConfig);\n\t}\n\n\t/\n\t Upload Historian Metrics\n\t * Upload Historian Metrics Accepts a CSV file with time series data within a for a given time range and given list of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs in the parameter `selectors`. The csv file should contain six columns in a comma delimited csv file; `name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> ), `time` ( Timestamp when the data was recorded from source ), `asset_name` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> ), `source` ( <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/' target='_blank'>Kelvin App</a> or <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> that has recorded the data - this value is optional ), `target` ( Custom parameter set by user - this value is optional ), `value` ( value recorded ). The first row must contain the column headers; `name,time,asset_name,source,target,value`. Permission Required: `kelvin.permission.storage.create`\n\t * @param file The CSV File in a standard formData object in a binary format.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic uploadHistorianMetrics({ file }: IUploadHistorianMetricsParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\tconst formParams = new FormData();\n\t\tif (file != null) {\n\t\t\tformParams.append('file', <any>file);\n\t\t}\n\t\trequestConfig.data = formParams;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/upload`, requestConfig);\n\t}\n}\n"]}

package/dist/esm/services/generated/api/timeseries.service.d.ts ADDED Viewed

@@ -0,0 +1,45 @@
+import { Observable } from 'rxjs';
+import { IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';
+import { Data, ModelsStorageProjection, StoragePaginatedResponse } from '../../../models';
+import { BaseService } from '../../base.service';
+import { ICreateTimeseriesDataParams, IGetLastTimeseriesDataParams, IGetRangeTimeseriesDataParams, IListTimeseriesDataParams } from '../types';
+/**
+ * @category Service
+ */
+export declare class TimeseriesService extends BaseService {
+    /**
+     * Create Timeseries Data
+     * Create Timeseries Data   &lt;span style&#x3D;\&quot;color: #ff0000;font-weight: bold;\&quot;&gt;WARNING&lt;/span&gt; : If a value already exists at the defined time, then it will be overwritten with the new payload value. The old value will be lost and is not recoverable !  **Permission Required:** &#x60;kelvin.permission.storage.create&#x60;
+     * @param storage Timeseries create schema
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createTimeseriesData({ storage }: ICreateTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
+    /**
+     * Get Last Timeseries Data
+     * Get Last Timeseries Data   **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;
+     * @param resources Storage get last schema
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getLastTimeseriesData({ resources }: IGetLastTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<ModelsStorageProjection[]>;
+    /**
+     * Get Range Timeseries Data
+     * Get Range Timeseries Data   **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;
+     * @param resources Storage get range schema
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getRangeTimeseriesData({ resources }: IGetRangeTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<Data[]>;
+    /**
+     * List Timeseries Data
+     * List Timeseries Data  **Pagination Sortable Columns:** &#x60;resource&#x60;, &#x60;data_type&#x60;,&#x60;last_timestamp&#x60;,&#x60;created&#x60;, &#x60;updated&#x60;  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;
+     * @param resources Storage list schema
+     * @param paginationType Method of handling pages in the returned data. There are three options available;&lt;/p&gt; limits: This is used with the query parameters &#x60;page“ to select which page of data to return. The start of the data returned will be calculated using the &#x60;page_size“ and &#x60;page&#x60; query parameters for the location to start and the query parameters &#x60;sort_by&#x60; and &#x60;direction&#x60; will determine the order of the data.&lt;/p&gt; cursor: This is used with the query parameters &#x60;next&#x60; and &#x60;previous&#x60; which uses a string as the start or end location reference. The string to use is returned in the previous query json response in the keys &#x60;next_page&#x60; and &#x60;previous_page&#x60;.&lt;/p&gt; stream: This will return all the data in one response.
+     * @param pageSize Number of items to be returned in each page. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20
+     * @param page Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;limits&#x60;.&lt;/p&gt; An integer for the wanted page of results. The start of the data returned will be calculated using the &#x60;page_size“ and &#x60;page&#x60; query parameters for the location to start and the query parameters &#x60;sort_by&#x60; and &#x60;direction&#x60; will determine the order of the data.
+     * @param next Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;cursor&#x60;.&lt;/p&gt; An alphanumeric string to move to the next page 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 previous Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;cursor&#x60;.&lt;/p&gt; An alphanumeric string to move to the previous page 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 direction Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;asc&#x60; (ascending order) and &#x60;desc&#x60; (descending order).&lt;/p&gt; The default is &#x60;asc&#x60; (ascending).
+     * @param sortBy Sort the results by one of the workload parameters. Only one parameter can be selected.&lt;/p&gt; Allowed options: &#x60;resource&#x60;, &#x60;data_type&#x60;,&#x60;last_timestamp&#x60;,&#x60;created&#x60;, &#x60;updated&#x60;.&lt;/p&gt; The default is &#x60;resource&#x60;
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static listTimeseriesData({ resources, paginationType, pageSize, page, next, previous, direction, sortBy }: IListTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<StoragePaginatedResponse[]>;
+}

package/dist/esm/services/generated/api/timeseries.service.js ADDED Viewed

@@ -0,0 +1,98 @@
+import { Data, ModelsStorageProjection, StoragePaginatedResponse } from '../../../models';
+import { BaseService } from '../../base.service';
+/**
+ * @category Service
+ */
+export class TimeseriesService extends BaseService {
+    /**
+     * Create Timeseries Data
+     * Create Timeseries Data   &lt;span style&#x3D;\&quot;color: #ff0000;font-weight: bold;\&quot;&gt;WARNING&lt;/span&gt; : If a value already exists at the defined time, then it will be overwritten with the new payload value. The old value will be lost and is not recoverable !  **Permission Required:** &#x60;kelvin.permission.storage.create&#x60;
+     * @param storage Timeseries create schema
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createTimeseriesData({ storage }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = storage;
+        requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
+        return this.request(`/timeseries/create`, requestConfig);
+    }
+    /**
+     * Get Last Timeseries Data
+     * Get Last Timeseries Data   **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;
+     * @param resources Storage get last schema
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getLastTimeseriesData({ resources }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = resources;
+        requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
+        return this.request(`/timeseries/last/get`, requestConfig, ModelsStorageProjection);
+    }
+    /**
+     * Get Range Timeseries Data
+     * Get Range Timeseries Data   **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;
+     * @param resources Storage get range schema
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getRangeTimeseriesData({ resources }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = resources;
+        requestConfig.options = options;
+        requestConfig.mediaType = 'application/x-json-stream';
+        return this.request(`/timeseries/range/get`, requestConfig, Data);
+    }
+    /**
+     * List Timeseries Data
+     * List Timeseries Data  **Pagination Sortable Columns:** &#x60;resource&#x60;, &#x60;data_type&#x60;,&#x60;last_timestamp&#x60;,&#x60;created&#x60;, &#x60;updated&#x60;  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;
+     * @param resources Storage list schema
+     * @param paginationType Method of handling pages in the returned data. There are three options available;&lt;/p&gt; limits: This is used with the query parameters &#x60;page“ to select which page of data to return. The start of the data returned will be calculated using the &#x60;page_size“ and &#x60;page&#x60; query parameters for the location to start and the query parameters &#x60;sort_by&#x60; and &#x60;direction&#x60; will determine the order of the data.&lt;/p&gt; cursor: This is used with the query parameters &#x60;next&#x60; and &#x60;previous&#x60; which uses a string as the start or end location reference. The string to use is returned in the previous query json response in the keys &#x60;next_page&#x60; and &#x60;previous_page&#x60;.&lt;/p&gt; stream: This will return all the data in one response.
+     * @param pageSize Number of items to be returned in each page. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20
+     * @param page Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;limits&#x60;.&lt;/p&gt; An integer for the wanted page of results. The start of the data returned will be calculated using the &#x60;page_size“ and &#x60;page&#x60; query parameters for the location to start and the query parameters &#x60;sort_by&#x60; and &#x60;direction&#x60; will determine the order of the data.
+     * @param next Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;cursor&#x60;.&lt;/p&gt; An alphanumeric string to move to the next page 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 previous Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;cursor&#x60;.&lt;/p&gt; An alphanumeric string to move to the previous page 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 direction Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;asc&#x60; (ascending order) and &#x60;desc&#x60; (descending order).&lt;/p&gt; The default is &#x60;asc&#x60; (ascending).
+     * @param sortBy Sort the results by one of the workload parameters. Only one parameter can be selected.&lt;/p&gt; Allowed options: &#x60;resource&#x60;, &#x60;data_type&#x60;,&#x60;last_timestamp&#x60;,&#x60;created&#x60;, &#x60;updated&#x60;.&lt;/p&gt; The default is &#x60;resource&#x60;
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static listTimeseriesData({ resources, paginationType, pageSize, page, next, previous, direction, sortBy }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        const queryParameters = {};
+        if (paginationType != null) {
+            queryParameters['pagination_type'] = paginationType;
+        }
+        if (pageSize != null) {
+            queryParameters['page_size'] = pageSize;
+        }
+        if (page != null) {
+            queryParameters['page'] = page;
+        }
+        if (next != null) {
+            queryParameters['next'] = next;
+        }
+        if (previous != null) {
+            queryParameters['previous'] = previous;
+        }
+        if (direction != null) {
+            queryParameters['direction'] = direction;
+        }
+        if (sortBy != null) {
+            queryParameters['sort_by'] = sortBy;
+        }
+        requestConfig.params = queryParameters;
+        requestConfig.data = resources;
+        requestConfig.options = options;
+        requestConfig.mediaType = 'application/x-json-stream';
+        return this.request(`/timeseries/list`, requestConfig, StoragePaginatedResponse);
+    }
+}
+//# sourceMappingURL=timeseries.service.js.map

package/dist/esm/services/generated/api/timeseries.service.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"timeseries.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/timeseries.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC1F,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAQjD;;GAEG;AAEH,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAEjD;;;;;OAKG;IAEH,MAAM,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAA+B,EAAE,OAA+B;QAEpG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC;QAC7B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,oBAAoB,EAAE,aAAa,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,SAAS,EAAgC,EAAE,OAA+B;QAExG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC;QAC/B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAA4B,sBAAsB,EAAE,aAAa,EAAE,uBAAuB,CAAC,CAAC;IAChH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,sBAAsB,CAAC,EAAE,SAAS,EAAiC,EAAE,OAA+B;QAE1G,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC;QAC/B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAAS,uBAAuB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAA6B,EAAE,OAA+B;QAErK,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,cAAc,IAAI,IAAI,EAAE;YAC3B,eAAe,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC;SACpD;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,IAAI,IAAI,IAAI,EAAE;YACjB,eAAe,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;SACvC;QAED,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;SACzC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC;QAC/B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QAEtD,OAAO,IAAI,CAAC,OAAO,CAA6B,kBAAkB,EAAE,aAAa,EAAE,wBAAwB,CAAC,CAAC;IAC9G,CAAC;CACD","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';\nimport { Data, ModelsStorageProjection, StoragePaginatedResponse } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tICreateTimeseriesDataParams,\n\tIGetLastTimeseriesDataParams,\n\tIGetRangeTimeseriesDataParams,\n\tIListTimeseriesDataParams\n} from '../types';\n\n/**\n * @category Service\n */\n\nexport class TimeseriesService extends BaseService {\n\n\t/**\n\t * Create Timeseries Data\n\t * Create Timeseries Data WARNING : If a value already exists at the defined time, then it will be overwritten with the new payload value. The old value will be lost and is not recoverable ! **Permission Required:** `kelvin.permission.storage.create`\n\t * @param storage Timeseries create schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic createTimeseriesData({ storage }: ICreateTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = storage;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/timeseries/create`, requestConfig);\n\t}\n\n\t/**\n\t * Get Last Timeseries Data\n\t * Get Last Timeseries Data **Permission Required:** `kelvin.permission.storage.read`\n\t * @param resources Storage get last schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic getLastTimeseriesData({ resources }: IGetLastTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<ModelsStorageProjection[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = resources;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<ModelsStorageProjection[]>(`/timeseries/last/get`, requestConfig, ModelsStorageProjection);\n\t}\n\n\t/**\n\t * Get Range Timeseries Data\n\t * Get Range Timeseries Data **Permission Required:** `kelvin.permission.storage.read`\n\t * @param resources Storage get range schema\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic getRangeTimeseriesData({ resources }: IGetRangeTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<Data[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = resources;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<Data[]>(`/timeseries/range/get`, requestConfig, Data);\n\t}\n\n\t/**\n\t * List Timeseries Data\n\t * List Timeseries Data **Pagination Sortable Columns:** `resource`, `data_type`,`last_timestamp`,`created`, `updated` **Permission Required:** `kelvin.permission.storage.read`\n\t * @param resources Storage list schema\n\t * @param paginationType Method of handling pages in the returned data. There are three options available; limits: This is used with the query parameters `page“ to select which page of data to return. The start of the data returned will be calculated using the `page_size“ and `page` query parameters for the location to start and the query parameters `sort_by` and `direction` will determine the order of the data. cursor: This is used with the query parameters `next` and `previous` which uses a string as the start or end location reference. The string to use is returned in the previous query json response in the keys `next_page` and `previous_page`. stream: This will return all the data in one response.\n\t * @param pageSize Number of items to be returned in each page. Page size can be between 1 and 1000 objects. The default is 20\n\t * @param page Used only with query parameter `pagination_type` set as `limits`. An integer for the wanted page of results. The start of the data returned will be calculated using the `page_size“ and `page` query parameters for the location to start and the query parameters `sort_by` and `direction` will determine the order of the data.\n\t * @param next Used only with query parameter `pagination_type` set as `cursor`. An alphanumeric string to move to the next page in the list. 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. The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.\n\t * @param previous Used only with query parameter `pagination_type` set as `cursor`. An alphanumeric string to move to the previous page in the list. 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. The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.\n\t * @param direction Sorting order for the results according to the `sort_by` parameter. There are two options; `asc` (ascending order) and `desc` (descending order). The default is `asc` (ascending).\n\t * @param sortBy Sort the results by one of the workload parameters. Only one parameter can be selected. Allowed options: `resource`, `data_type`,`last_timestamp`,`created`, `updated`. The default is `resource`\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic listTimeseriesData({ resources, paginationType, pageSize, page, next, previous, direction, sortBy }: IListTimeseriesDataParams, options?: IKvHttpRequestOptions): Observable<StoragePaginatedResponse[]> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (paginationType != null) {\n\t\t\tqueryParameters['pagination_type'] = paginationType;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (page != null) {\n\t\t\tqueryParameters['page'] = page;\n\t\t}\n\n\t\tif (next != null) {\n\t\t\tqueryParameters['next'] = next;\n\t\t}\n\n\t\tif (previous != null) {\n\t\t\tqueryParameters['previous'] = previous;\n\t\t}\n\n\t\tif (direction != null) {\n\t\t\tqueryParameters['direction'] = direction;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.data = resources;\n\t\trequestConfig.options = options;\n\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\n\t\treturn this.request<StoragePaginatedResponse[]>(`/timeseries/list`, requestConfig, StoragePaginatedResponse);\n\t}\n}\n"]}

package/dist/esm/services/generated/api/uI.service.d.ts CHANGED Viewed

@@ -1,12 +1,19 @@
 import { Observable } from 'rxjs';
 import { IKvHttpRequestOptions } from '../../../core/http';
-import { EmissionsDashboard, FullMapListPaginated } from '../../../models';
+import { CSVFile, EmissionsDashboard, FullMapListPaginated } from '../../../models';
 import { BaseService } from '../../base.service';
-import { IGetEmissionsDashboardParams, IListProcessesParams } from '../types';
+import { IGetCSVParams, IGetEmissionsDashboardParams, IListProcessesParams } from '../types';
 /**
  * @category Service
  */
 export declare class UIService extends BaseService {
+    /**
+     * Get CSV
+     * Get CSV parsed file from remote public source  **Permission Required:** &#x60;kelvin.permission.ui.read&#x60;
+     * @param processes URL of CSV to parse
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getCSV({ processes }: IGetCSVParams, options?: IKvHttpRequestOptions): Observable<CSVFile>;
     /**
      * Get Emissions Dashboard
      * Get Emissions Dashboard endpoint that will provide the data to be presented in the maps/emissions dashboard  **Permission Required:** &#x60;kelvin.permission.ui.read&#x60;

package/dist/esm/services/generated/api/uI.service.js CHANGED Viewed

@@ -1,9 +1,24 @@
-import { EmissionsDashboard, FullMapListPaginated } from '../../../models';
+import { CSVFile, EmissionsDashboard, FullMapListPaginated } from '../../../models';
 import { BaseService } from '../../base.service';
 /**
  * @category Service
  */
 export class UIService extends BaseService {
+    /**
+     * Get CSV
+     * Get CSV parsed file from remote public source  **Permission Required:** &#x60;kelvin.permission.ui.read&#x60;
+     * @param processes URL of CSV to parse
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getCSV({ processes }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = processes;
+        requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
+        return this.request(`/ui/rules-engine/csv/get`, requestConfig, CSVFile);
+    }
     /**
      * Get Emissions Dashboard
      * Get Emissions Dashboard endpoint that will provide the data to be presented in the maps/emissions dashboard  **Permission Required:** &#x60;kelvin.permission.ui.read&#x60;

package/dist/esm/services/generated/api/uI.service.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"uI.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/uI.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;~~AAC3E~~,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;~~AAMjD~~;;GAEG;AAEH,MAAM,OAAO,SAAU,SAAQ,WAAW;IAEzC;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,SAAS,EAAgC,EAAE,OAA+B;QAExG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAqB,6BAA6B,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAwB,EAAE,OAA+B;QAEhJ,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,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;QACvC,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC;QAC/B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAuB,oBAAoB,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;IACtG,CAAC;CACD","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions } from '../../../core/http';\nimport { EmissionsDashboard, FullMapListPaginated } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tIGetEmissionsDashboardParams,\n\tIListProcessesParams\n} from '../types';\n\n/*\n @category Service\n /\n\nexport class UIService extends BaseService {\n\n\t/\n\t Get Emissions Dashboard\n\t * Get Emissions Dashboard endpoint that will provide the data to be presented in the maps/emissions dashboard Permission Required: `kelvin.permission.ui.read`\n\t * @param groupName The assets group name filter\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getEmissionsDashboard({ groupName }: IGetEmissionsDashboardParams, options?: IKvHttpRequestOptions): Observable<EmissionsDashboard> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (groupName != null) {\n\t\t\tqueryParameters['group_name'] = groupName;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<EmissionsDashboard>(`/ui/emissions/dashboard/get`, requestConfig, EmissionsDashboard);\n\t}\n\n\t/\n\t List Processes\n\t * List Processes Pagination Sortable Columns: `map.name`, `map.title`, `start_date`, `mode`, `map.asset_name` Permission Required: `kelvin.permission.ui.read`\n\t * @param processes Processes list schema\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 listProcesses({ processes, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListProcessesParams, options?: IKvHttpRequestOptions): Observable<FullMapListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' 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\t\trequestConfig.data = processes;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<FullMapListPaginated>(`/ui/processes/list`, requestConfig, FullMapListPaginated);\n\t}\n}\n"]}
1	+ {"version":3,"file":"uI.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/uI.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAOjD;;GAEG;AAEH,MAAM,OAAO,SAAU,SAAQ,WAAW;IAEzC;;;;;OAKG;IAEH,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAiB,EAAE,OAA+B;QAE1E,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC;QAC/B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAU,0BAA0B,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,SAAS,EAAgC,EAAE,OAA+B;QAExG,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAqB,6BAA6B,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAwB,EAAE,OAA+B;QAEhJ,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,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;QACvC,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC;QAC/B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAuB,oBAAoB,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;IACtG,CAAC;CACD","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions } from '../../../core/http';\nimport { CSVFile, EmissionsDashboard, FullMapListPaginated } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tIGetCSVParams,\n\tIGetEmissionsDashboardParams,\n\tIListProcessesParams\n} from '../types';\n\n/*\n @category Service\n /\n\nexport class UIService extends BaseService {\n\n\t/\n\t Get CSV\n\t * Get CSV parsed file from remote public source Permission Required: `kelvin.permission.ui.read`\n\t * @param processes URL of CSV to parse\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getCSV({ processes }: IGetCSVParams, options?: IKvHttpRequestOptions): Observable<CSVFile> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = processes;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<CSVFile>(`/ui/rules-engine/csv/get`, requestConfig, CSVFile);\n\t}\n\n\t/\n\t Get Emissions Dashboard\n\t * Get Emissions Dashboard endpoint that will provide the data to be presented in the maps/emissions dashboard Permission Required: `kelvin.permission.ui.read`\n\t * @param groupName The assets group name filter\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getEmissionsDashboard({ groupName }: IGetEmissionsDashboardParams, options?: IKvHttpRequestOptions): Observable<EmissionsDashboard> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (groupName != null) {\n\t\t\tqueryParameters['group_name'] = groupName;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<EmissionsDashboard>(`/ui/emissions/dashboard/get`, requestConfig, EmissionsDashboard);\n\t}\n\n\t/\n\t List Processes\n\t * List Processes Pagination Sortable Columns: `map.name`, `map.title`, `start_date`, `mode`, `map.asset_name` Permission Required: `kelvin.permission.ui.read`\n\t * @param processes Processes list schema\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 listProcesses({ processes, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListProcessesParams, options?: IKvHttpRequestOptions): Observable<FullMapListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' 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\t\trequestConfig.data = processes;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<FullMapListPaginated>(`/ui/processes/list`, requestConfig, FullMapListPaginated);\n\t}\n}\n"]}

package/dist/esm/services/generated/api/workload.service.d.ts CHANGED Viewed

@@ -9,7 +9,7 @@ import { IDeployWorkloadParams, IDownloadWorkloadPackageFileParams, IGetWorkload
 export declare class WorkloadService extends BaseService {
     /**
      * Deploy Workload
-     * Deploy Workload  **Permission Required:** &#x60;kelvin.permission.workload.update&#x60;
+     * Deploy Workload  **Permission Required:** &#x60;kelvin.permission.workload.update&#x60;  **Note:** &#x60;acp_name&#x60; is deprecated. If &#x60;cluster_name&#x60; is set, it will override &#x60;acp_name&#x60;
      * @param workload Workload deploy schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -46,22 +46,26 @@ export declare class WorkloadService extends BaseService {
     static getWorkloadTelemetry({ workloadName }: IGetWorkloadTelemetryParams, options?: IKvHttpRequestOptions): Observable<WorkloadTelemetry>;
     /**
      * List Workload
-     * List Workload  **Pagination Sortable Columns:** &#x60;workload.name&#x60;, &#x60;workload.enabled  **Permission Required:** &#x60;kelvin.permission.workload.read&#x60;
+     * List Workload  **Pagination Sortable Columns:** &#x60;name&#x60;, &#x60;title&#x60;, &#x60;cluster_name&#x60;, &#x60;node_name&#x60;, &#x60;enabled&#x60;, &#x60;created&#x60;, &#x60;updated&#x60;  **Permission Required:** &#x60;kelvin.permission.workload.read&#x60;
+     * @param search Search workloads by name, title, App name, Cluster name and Node name
      * @param appName App Name
      * @param appVersion App Version
-     * @param acpName ACP Name
+     * @param acpName ACP Name **&#x60;[Deprecated]&#x60;**
+     * @param clusterName Cluster Name. &#x60;If set, it will override acp_name&#x60;
+     * @param nodeName Node Name
      * @param workloadName Workload Name
      * @param enabled Filter workloads by enabled status
      * @param assetName Filter workloads with given asset
-     * @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 workloads by name, title, App name and ACP name
+     * @param paginationType Method of handling pages in the returned data. There are three options available:&lt;/p&gt; limits: This is used with the query parameters &#x60;page&#x60; to select which page of data to return. The start of the data returned will be calculated using the &#x60;page_size&#x60; and &#x60;page&#x60; query parameters for the location to start and the query parameters &#x60;sort_by&#x60; and &#x60;direction&#x60; will determine the order of the data.&lt;/p&gt; cursor: This is used with the query parameters &#x60;next&#x60; and &#x60;previous&#x60; which uses a string as the start or end location reference. The string to use is returned in the previous query json response in the keys &#x60;next_page&#x60; and &#x60;previous_page&#x60;.&lt;/p&gt; stream: This will return all the data in one response.
+     * @param pageSize Number of workload objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20
+     * @param page Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;limits&#x60;.&lt;/p&gt; An integer for the wanted page of results. The start of the data returned will be calculated using the &#x60;page_size&#x60; and &#x60;page&#x60; query parameters for the location to start and the query parameters &#x60;sort_by&#x60; and &#x60;direction&#x60; will determine the order of the data.
+     * @param next Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;cursor&#x60;.&lt;/p&gt; An alphanumeric string to move to the next page of workloads 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 &#x60;pagination -&gt; previous_page&#x60; and &#x60;pagination -&gt; next_page&#x60; respectively.&lt;/p&gt; The &#x60;pagination -&gt; next_page&#x60; alphanumeric string should be used here to show a list of the next page of results.
+     * @param previous Used only with query parameter &#x60;pagination_type&#x60; set as &#x60;cursor&#x60;.&lt;/p&gt; An alphanumeric string to move to the previous page of workloads 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 &#x60;pagination -&gt; previous_page&#x60; and &#x60;pagination -&gt; next_page&#x60; respectively.&lt;/p&gt; The &#x60;pagination -&gt; previous_page&#x60; alphanumeric string should be used here to show a list of the previous page of results.
+     * @param direction Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;asc&#x60; (ascending order) and &#x60;desc&#x60; (descending order).&lt;/p&gt; The default is &#x60;asc&#x60; (ascending).
+     * @param sortBy Sort the results by one of the workload parameters. Only one parameter can be selected.&lt;/p&gt; Allowed options: &#x60;name&#x60;, &#x60;title&#x60;, &#x60;cluster_name&#x60;, &#x60;node_name&#x60;, &#x60;enabled&#x60;, &#x60;created&#x60;, &#x60;updated&#x60;.&lt;/p&gt; The default is &#x60;name&#x60;
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listWorkload({ appName, appVersion, acpName, workloadName, enabled, assetName, pageSize, startingAfter, endingBefore, sortBy, sortAsc, search }?: IListWorkloadParams, options?: IKvHttpRequestOptions): Observable<WorkloadListPaginated>;
+    static listWorkload({ search, appName, appVersion, acpName, clusterName, nodeName, workloadName, enabled, assetName, paginationType, pageSize, page, next, previous, direction, sortBy }?: IListWorkloadParams, options?: IKvHttpRequestOptions): Observable<WorkloadListPaginated>;
     /**
      * Start Workload
      * Start Workload  **Permission Required:** &#x60;kelvin.permission.workload.update&#x60;