@kelvininc/js-client-sdk 7.9.1 → 7.12.0

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

@@ -9,7 +9,7 @@ const base_service_1 = require("../../base.service");
 class StorageService extends base_service_1.BaseService {
     /**
      * Create Historian Metric
-     * Create Historian Metric persists time series data.  **Note:** * If a Metric timestamp already exists on the database, this endpoint will overwrite the stored payload with the new payload value.  **Payload Details:** * `name`: name of the Metric * `source`: application that generated the data. Example: `modbus` * `asset_name`: name of the Asset * `payload`: data to persist * `timestamp`: RFC3339 timestamps with added micro-second precision  **Permission Required:** `kelvin.permission.storage.create`
+     * 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`
      * @param storage Storage create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -24,7 +24,7 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Delete Historian Range
-     * Delete Historian Range will delete all associated time series values between a given time-range.  **Payload Details:** * `start_time`: supports RFC3339 timestamps with added micro-second precision * `end_time`: supports RFC3339 timestamps with added micro-second precision  **Permission Required:** `kelvin.permission.storage.delete`
+     * 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`
      * @param storage Body of the request
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -39,7 +39,7 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Download Historian Metrics
-     * Download Historian Metrics returns a **CSV file** with time series data for a given time range List of Metric selectors.  **Payload Description:** * `start_time` supports RFC3339 timestamps with added micro-second precision * `end_time` supports RFC3339 timestamps with added micro-second precision * `time_bucket` uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: `5m`, `1h`, `1w` * `time_shift` is used to 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` * `fill` allows you to fill missing points from a time bucket. Check below for supported fill values. * `agg` allows you to choose an aggregation. Check below for supported aggregations.  **Supported Fill:** * `none`: Default behaviour. * `null`: Fills the missing points with null string * `linear`: Performs a linear regression * `previous`: Uses the previous non-empty value * `int value`: Fills the missing points with the specified number  **Supported Aggregations:** * Numeric types (`int32`, `int64`, etc) are: `none`, `count`, `distinct`, `integral`, `mean`, `median`, `mode`, `spread`, `stddev`, `sum`, `max` & `min` * Non-numeric types (`text`, etc) are: `count`, `distinct` and `mode`  **Permission Required:** `kelvin.permission.storage.read`
+     * 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`
      * @param query Request Schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -54,7 +54,7 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Get Historian Metric Advanced Range
-     * Get Historian Metric Advanced Range returns time series data for a given time range and a list of Metric selectors.  **Payload Description:** * `start_time` supports RFC3339 timestamps with added micro-second precision * `end_time` supports RFC3339 timestamps with added micro-second precision * `time_bucket` uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: `5m`, `1h`, `1w` * `time_shift` is used to 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` * `fill` allows you to fill missing points from a time bucket. Check below for supported fill values. * `agg` allows you to choose an aggregation. Check below for supported aggregations.  **Supported Fill:** * `none`: Default behaviour. * `null`: Fills the missing points with null string * `linear`: Performs a linear regression * `previous`: Uses the previous non-empty value * `int value`: Fills the missing points with the specified number  **Supported Aggregations:** * Numeric types (`int32`, `int64`, etc) are: `none`, `count`, `distinct`, `integral`, `mean`, `median`, `mode`, `spread`, `stddev`, `sum`, `max` & `min` * Non-numeric types (`text`, etc) are: `count`, `distinct` and `mode`  **Permission Required:** `kelvin.permission.storage.read`
+     * 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`
      * @param body Advanced range schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -69,10 +69,10 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Get Historian Metric Last
-     * Get Historian Metric Last returns the last value inserted on the time series database for a single Metric. The calculation is based on the most recent timestamp available for the Metric.  **Permission Required:** `kelvin.permission.storage.read`
-     * @param name Metric Name
-     * @param assetName Asset name
-     * @param fields List of field identifiers
+     * 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`
+     * @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.
+     * @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.
+     * @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`.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getHistorianMetricLast({ name, assetName, fields }, options) {
@@ -96,7 +96,7 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Get Historian Metric Last Advanced
-     * Get Historian Metric Last Advanced returns the last values inserted on the time series database for a list of Metric selectors. The calculation is based on the most recent timestamp available for each Metric.  **Permission Required:** `kelvin.permission.storage.read`
+     * 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`
      * @param query Request for multiple Metric selectors
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -111,17 +111,17 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Get Historian Metric Range
-     * Get Historian Metric Range returns time series data for a given time range and a list of Metric selectors.  **Payload Description:** * `start_time` supports RFC3339 timestamps with added micro-second precision * `end_time` supports RFC3339 timestamps with added micro-second precision * `time_bucket` uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: `5m`, `1h`, `1w` * `time_shift` is used to 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` * `fill` allows you to fill missing points from a time bucket. Check below for supported fill values. * `agg` allows you to choose an aggregation. Check below for supported aggregations.  **Supported Fill:** * `none`: Default behaviour. * `null`: Fills the missing points with null string * `linear`: Performs a linear regression * `previous`: Uses the previous non-empty value * `int value`: Fills the missing points with the specified number  **Supported Aggregations:** * Numeric types (`int32`, `int64`, etc) are: `none`, `count`, `distinct`, `integral`, `mean`, `median`, `mode`, `spread`, `stddev`, `sum`, `max` & `min` * Non-numeric types (`text`, etc) are: `count`, `distinct` and `mode`  **Permission Required:** `kelvin.permission.storage.read`
-     * @param name Metric Name
-     * @param assetName Asset name
-     * @param startTime Value for the start of the range for which to get data
-     * @param endTime Value for the end of the range for which to get data
-     * @param agg Aggregation
-     * @param timeBucket Interval for which to group by, in human readable format
-     * @param timeShift Interval by which to shift the time buckets, from epoch
-     * @param fill Filling for empty time buckets (check description for possible values)
-     * @param order Order of the data
-     * @param fields Fields
+     * 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`
+     * @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.
+     * @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.
+     * @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'.
+     * @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'.
+     * @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.
+     * @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.
+     * @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`.
+     * @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`.
+     * @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`.
+     * @param fields Array of strings which each string representing one key inside the payload. Normally there will be only one key labeled `value`.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getHistorianMetricRange({ name, assetName, startTime, endTime, agg, timeBucket, timeShift, fill, order, fields }, options) {
@@ -166,15 +166,15 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * List Historian Metric
-     * List Historian Metric  **Pagination Sortable Columns:** `storage_metric.name`, `storage_metric.asset_name`  **Permission Required:** `kelvin.permission.storage.read`
-     * @param name Metric name
-     * @param assetName Asset name
-     * @param search Search metrics by name or asset_name
-     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
-     * @param startingAfter Lower bound cursor for use in pagination
-     * @param endingBefore Upper bound cursor for use in pagination
-     * @param sortBy Parameter to sort by. Must be one of the sortable columns
-     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
+     * 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`
+     * @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.
+     * @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.
+     * @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`.
+     * @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.
+     * @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.
+     * @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.
+     * @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`
+     * @param sortAsc Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listHistorianMetric({ name, assetName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
@@ -213,7 +213,7 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Update Historian Metric
-     * Update Historian Metric allows updating the **title** of a Metric.  **Permission Required:** `kelvin.permission.storage.update`
+     * 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`
      * @param storage Body of the request
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -228,7 +228,7 @@ class StorageService extends base_service_1.BaseService {
     }
     /**
      * Upload Historian Metrics
-     * Upload Historian Metrics allows sending a **CSV file** with time series data to be persisted.  **Permission Required:** `kelvin.permission.storage.create`
+     * 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`
      * @param file CSV File
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */

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

@@ -1 +1 @@
-{"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/storage.service.ts"],"names":[],"mappings":";;;AAEA,4CAA0E;AAC1E,qDAAiD;AAWjD;;GAEG;AAEH,MAAa,cAAe,SAAQ,0BAAW;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;QAE7B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAE7B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAE3B,aAAa,CAAC,SAAS,GAAG,UAAU,CAAC;QACrC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAE1B,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QACtD,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,oBAAW,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;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAc,6BAA6B,EAAE,aAAa,EAAE,oBAAW,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;QAE3B,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QACtD,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgB,6BAA6B,EAAE,aAAa,EAAE,oBAAW,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;QAEvC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QACtD,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,oBAAW,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;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAA6B,yBAAyB,EAAE,aAAa,EAAE,mCAA0B,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;QAE7B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAEhC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;CACD;AAzTD,wCAyTC","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 persists time series data.  **Note:** * If a Metric timestamp already exists on the database, this endpoint will overwrite the stored payload with the new payload value.  **Payload Details:** * &#x60;name&#x60;: name of the Metric * &#x60;source&#x60;: application that generated the data. Example: &#x60;modbus&#x60; * &#x60;asset_name&#x60;: name of the Asset * &#x60;payload&#x60;: data to persist * &#x60;timestamp&#x60;: RFC3339 timestamps with added micro-second precision  **Permission Required:** &#x60;kelvin.permission.storage.create&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 between a given time-range.  **Payload Details:** * &#x60;start_time&#x60;: supports RFC3339 timestamps with added micro-second precision * &#x60;end_time&#x60;: supports RFC3339 timestamps with added micro-second precision  **Permission Required:** &#x60;kelvin.permission.storage.delete&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 for a given time range List of Metric selectors.  **Payload Description:** * &#x60;start_time&#x60; supports RFC3339 timestamps with added micro-second precision * &#x60;end_time&#x60; supports RFC3339 timestamps with added micro-second precision * &#x60;time_bucket&#x60; uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: &#x60;5m&#x60;, &#x60;1h&#x60;, &#x60;1w&#x60; * &#x60;time_shift&#x60; is used to 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&#39;ll need to set this. Example: &#x60;5m&#x60;, &#x60;1h&#x60;, &#x60;1w&#x60; * &#x60;fill&#x60; allows you to fill missing points from a time bucket. Check below for supported fill values. * &#x60;agg&#x60; allows you to choose an aggregation. Check below for supported aggregations.  **Supported Fill:** * &#x60;none&#x60;: Default behaviour. * &#x60;null&#x60;: Fills the missing points with null string * &#x60;linear&#x60;: Performs a linear regression * &#x60;previous&#x60;: Uses the previous non-empty value * &#x60;int value&#x60;: Fills the missing points with the specified number  **Supported Aggregations:** * Numeric types (&#x60;int32&#x60;, &#x60;int64&#x60;, etc) are: &#x60;none&#x60;, &#x60;count&#x60;, &#x60;distinct&#x60;, &#x60;integral&#x60;, &#x60;mean&#x60;, &#x60;median&#x60;, &#x60;mode&#x60;, &#x60;spread&#x60;, &#x60;stddev&#x60;, &#x60;sum&#x60;, &#x60;max&#x60; &amp; &#x60;min&#x60; * Non-numeric types (&#x60;text&#x60;, etc) are: &#x60;count&#x60;, &#x60;distinct&#x60; and &#x60;mode&#x60;  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\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\n\t\trequestConfig.mediaType = 'text/csv';\n\t\trequestConfig.options = options;\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 time series data for a given time range and a list of Metric selectors.  **Payload Description:** * &#x60;start_time&#x60; supports RFC3339 timestamps with added micro-second precision * &#x60;end_time&#x60; supports RFC3339 timestamps with added micro-second precision * &#x60;time_bucket&#x60; uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: &#x60;5m&#x60;, &#x60;1h&#x60;, &#x60;1w&#x60; * &#x60;time_shift&#x60; is used to 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&#39;ll need to set this. Example: &#x60;5m&#x60;, &#x60;1h&#x60;, &#x60;1w&#x60; * &#x60;fill&#x60; allows you to fill missing points from a time bucket. Check below for supported fill values. * &#x60;agg&#x60; allows you to choose an aggregation. Check below for supported aggregations.  **Supported Fill:** * &#x60;none&#x60;: Default behaviour. * &#x60;null&#x60;: Fills the missing points with null string * &#x60;linear&#x60;: Performs a linear regression * &#x60;previous&#x60;: Uses the previous non-empty value * &#x60;int value&#x60;: Fills the missing points with the specified number  **Supported Aggregations:** * Numeric types (&#x60;int32&#x60;, &#x60;int64&#x60;, etc) are: &#x60;none&#x60;, &#x60;count&#x60;, &#x60;distinct&#x60;, &#x60;integral&#x60;, &#x60;mean&#x60;, &#x60;median&#x60;, &#x60;mode&#x60;, &#x60;spread&#x60;, &#x60;stddev&#x60;, &#x60;sum&#x60;, &#x60;max&#x60; &amp; &#x60;min&#x60; * Non-numeric types (&#x60;text&#x60;, etc) are: &#x60;count&#x60;, &#x60;distinct&#x60; and &#x60;mode&#x60;  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\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\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\trequestConfig.options = options;\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 value inserted on the time series database for a single Metric. The calculation is based on the most recent timestamp available for the Metric.  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\n\t * @param name Metric Name\n\t * @param assetName Asset name\n\t * @param fields List of field identifiers\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 the last values inserted on the time series database for a list of Metric selectors. The calculation is based on the most recent timestamp available for each Metric.  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\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\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\trequestConfig.options = options;\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 time series data for a given time range and a list of Metric selectors.  **Payload Description:** * &#x60;start_time&#x60; supports RFC3339 timestamps with added micro-second precision * &#x60;end_time&#x60; supports RFC3339 timestamps with added micro-second precision * &#x60;time_bucket&#x60; uses an human readable format which is covered in more detail in https://golang.org/pkg/time/#ParseDuration. Example: &#x60;5m&#x60;, &#x60;1h&#x60;, &#x60;1w&#x60; * &#x60;time_shift&#x60; is used to 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&#39;ll need to set this. Example: &#x60;5m&#x60;, &#x60;1h&#x60;, &#x60;1w&#x60; * &#x60;fill&#x60; allows you to fill missing points from a time bucket. Check below for supported fill values. * &#x60;agg&#x60; allows you to choose an aggregation. Check below for supported aggregations.  **Supported Fill:** * &#x60;none&#x60;: Default behaviour. * &#x60;null&#x60;: Fills the missing points with null string * &#x60;linear&#x60;: Performs a linear regression * &#x60;previous&#x60;: Uses the previous non-empty value * &#x60;int value&#x60;: Fills the missing points with the specified number  **Supported Aggregations:** * Numeric types (&#x60;int32&#x60;, &#x60;int64&#x60;, etc) are: &#x60;none&#x60;, &#x60;count&#x60;, &#x60;distinct&#x60;, &#x60;integral&#x60;, &#x60;mean&#x60;, &#x60;median&#x60;, &#x60;mode&#x60;, &#x60;spread&#x60;, &#x60;stddev&#x60;, &#x60;sum&#x60;, &#x60;max&#x60; &amp; &#x60;min&#x60; * Non-numeric types (&#x60;text&#x60;, etc) are: &#x60;count&#x60;, &#x60;distinct&#x60; and &#x60;mode&#x60;  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\n\t * @param name Metric Name\n\t * @param assetName Asset name\n\t * @param startTime Value for the start of the range for which to get data\n\t * @param endTime Value for the end of the range for which to get data\n\t * @param agg Aggregation\n\t * @param timeBucket Interval for which to group by, in human readable format\n\t * @param timeShift Interval by which to shift the time buckets, from epoch\n\t * @param fill Filling for empty time buckets (check description for possible values)\n\t * @param order Order of the data\n\t * @param fields Fields\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\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\trequestConfig.options = options;\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  **Pagination Sortable Columns:** &#x60;storage_metric.name&#x60;, &#x60;storage_metric.asset_name&#x60;  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\n\t * @param name Metric name\n\t * @param assetName Asset name\n\t * @param search Search metrics by name or asset_name\n\t * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20\n\t * @param startingAfter Lower bound cursor for use in pagination\n\t * @param endingBefore Upper bound cursor for use in pagination\n\t * @param sortBy Parameter to sort by. Must be one of the sortable columns\n\t * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic 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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 allows updating the **title** of a Metric.  **Permission Required:** &#x60;kelvin.permission.storage.update&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 allows sending a **CSV file** with time series data to be persisted.  **Permission Required:** &#x60;kelvin.permission.storage.create&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/upload`, requestConfig);\n\t}\n}\n"]}
+{"version":3,"file":"storage.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/storage.service.ts"],"names":[],"mappings":";;;AAEA,4CAA0E;AAC1E,qDAAiD;AAWjD;;GAEG;AAEH,MAAa,cAAe,SAAQ,0BAAW;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;QAE7B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAE7B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAE3B,aAAa,CAAC,SAAS,GAAG,UAAU,CAAC;QACrC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAE1B,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QACtD,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,oBAAW,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;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAc,6BAA6B,EAAE,aAAa,EAAE,oBAAW,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;QAE3B,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QACtD,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgB,6BAA6B,EAAE,aAAa,EAAE,oBAAW,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;QAEvC,aAAa,CAAC,SAAS,GAAG,2BAA2B,CAAC;QACtD,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgB,8BAA8B,EAAE,aAAa,EAAE,oBAAW,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;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAA6B,yBAAyB,EAAE,aAAa,EAAE,mCAA0B,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;QAE7B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,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;QAEhC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,2BAA2B,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC;CACD;AAzTD,wCAyTC","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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.  &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 overwriten with the new payload value. The old value will be lost and is not recoverable !  **Permission Required:** &#x60;kelvin.permission.storage.create&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs between a given time range.  **Permission Required:** &#x60;kelvin.permission.storage.delete&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs in the parameter &#x60;selectors&#x60;.  The downloaded csv file will contain six columns; &#x60;name&#x60; ( &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; ), &#x60;time&#x60; ( Timestamp when the data was recorded from source ), &#x60;asset_name&#x60; ( &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; ), &#x60;source&#x60; ( &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin App&lt;/a&gt; or &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Bridge&lt;/a&gt; that has recorded the data ), &#x60;target&#x60; ( Custom parameter set by user ), &#x60;value&#x60; ( value recorded ).  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\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\n\t\trequestConfig.mediaType = 'text/csv';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs based on a time range.  This does not rely on the workload (&lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Bridge&lt;/a&gt; or &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin App&lt;/a&gt;) that records the data to be online.  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\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\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pair.  This does not rely on the workload (&lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Bridge&lt;/a&gt; or &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin App&lt;/a&gt;) that records the data to be online.  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\n\t * @param name Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.\n\t * @param assetName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.\n\t * @param fields List of wanted field keys that are recorded in the payload. Normally this will be value.&lt;/p&gt; 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. &#39;value, key2&#39;. If the key does not exist in the stored payload, that key will return with a value &#x60;null&#x60;.\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs in the POST.  This does not rely on the workload (&lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Bridge&lt;/a&gt; or &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin App&lt;/a&gt;) that records the data to be online.  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\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\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pair based on a time range.  This does not rely on the workload (&lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Bridge&lt;/a&gt; or &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin App&lt;/a&gt;) that records the data to be online.  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\n\t * @param name Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.\n\t * @param assetName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.\n\t * @param startTime Start time of the recorded time to collect the payload data from the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt; in ISO 8601 UTC date/time format. Example; &#39;2022-07-08T08:41:01.657916Z&#39;.\n\t * @param endTime End time of the recorded time to collect the payload data from the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt; in ISO 8601 UTC date/time format. Example; &#39;2022-07-08T08:41:01.657916Z&#39;.\n\t * @param agg Perform mathematical calculations on a group of data.&lt;/p&gt; For numerical data there are twelve mathematical options available; &#x60;none&#x60; , &#x60;count&#x60;,&#x60;distinct&#x60;, &#x60;integral&#x60;, &#x60;mean&#x60;, &#x60;median&#x60;, &#x60;mode&#x60;, &#x60;spread&#x60;, &#x60;stddev&#x60;, &#x60;sum&#x60;, &#x60;max&#x60;, &#x60;min&#x60;.&lt;/p&gt; For text based data there are three types of mathematical options available; &#x60;count&#x60;, &#x60;distinct&#x60;, &#x60;mode&#x60;. The default is &#x60;none&#x60;.&lt;/p&gt; When using this parameter, you must also use the parameters &#x60;time_bucket&#x60; which defines how to group the data and &#x60;fields&#x60; which defines which payload data to use.\n\t * @param timeBucket Group the data by time frame for the &#x60;agg&#x60; parameter calculations.&lt;/p&gt; The time can be adjusted with these time units &#x60;ns&#x60;, &#x60;ms&#x60;, &#x60;s&#x60;, &#x60;m&#x60;, &#x60;h&#x60;. e.g. &#x60;8765h&#x60; 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&#39;ll need to set this. Example: &#x60;5m&#x60;, &#x60;1h&#x60;, &#x60;1w&#x60;.\n\t * @param fill Fills any group of data, which is defined by the &#x60;time_bucket&#x60; parameter, with a calculated value when there is no data in the database.&lt;/p&gt; There are five options available; &#x60;none&#x60;, &#x60;null&#x60;, &#x60;linear&#x60;, &#x60;previous&#x60;, fixed integer value.&lt;/p&gt; &#x60;none&#x60; will ignore the group. &#x60;null&#x60;, &#x60;previous&#x60; and fixed integer value will be added as the value for the empty group. &#x60;linear&#x60; will perform a linear regression to calculated the groups&#39; value.&lt;/p&gt; The default is &#x60;none&#x60;.\n\t * @param order Order of the results for the timestamp parameter.&lt;/p&gt; There are two options available (capital letters is required); &#x60;ASC&#x60; for ascending and &#x60;DESC&#x60; for descending. The default is &#x60;ASC&#x60;.\n\t * @param fields Array of strings which each string representing one key inside the payload. Normally there will be only one key labeled &#x60;value&#x60;.\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\n\t\trequestConfig.mediaType = 'application/x-json-stream';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pair objects on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.  **Pagination Sortable Columns:** &#x60;storage_metric.name&#x60;, &#x60;storage_metric.asset_name&#x60;  **Permission Required:** &#x60;kelvin.permission.storage.read&#x60;\n\t * @param name Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.\n\t * @param assetName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.\n\t * @param search Search and filter the return list. Both the Display Name and the Name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; and &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; will be included in the search field criteria. This is given as an array, for example &#x60;[pump,fan]&#x60;.&lt;/p&gt; The search is case insensitive and will find partial matches as well. For example if a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; name or display name is &#x60;centrifugal_pump&#x60;, then a match will be made if the search string is &#x60;pum&#x60; or &#x60;FUGaL&#x60;.\n\t * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pair objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pair objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs 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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs 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.\n\t * @param sortBy Sort the results by one of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; parameters. Only one parameter can be selected.&lt;/p&gt; There are two parameter options; &#x60;name&#x60; and &#x60;asset.name&#x60;.&lt;/p&gt; The default is &#x60;asset.name&#x60;\n\t * @param sortAsc Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;true&#x60; (ascending order) and &#x60;false&#x60; (descending order).&lt;/p&gt; The default is &#x60;true&#x60; (ascending).\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 &#x60;title&#x60; parameter of a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pair.  **Permission Required:** &#x60;kelvin.permission.storage.update&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs in the parameter &#x60;selectors&#x60;.  The csv file should contain six columns in a comma delimited csv file; &#x60;name&#x60; ( &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; ), &#x60;time&#x60; ( Timestamp when the data was recorded from source ), &#x60;asset_name&#x60; ( &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; ), &#x60;source&#x60; ( &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-apps/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin App&lt;/a&gt; or &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Bridge&lt;/a&gt; that has recorded the data - this value is optional ), &#x60;target&#x60; ( Custom parameter set by user  - this value is optional ), &#x60;value&#x60; ( value recorded ).  The first row must contain the column headers; &#x60;name,time,asset_name,source,target,value&#x60;.  **Permission Required:** &#x60;kelvin.permission.storage.create&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/storage/historian/upload`, requestConfig);\n\t}\n}\n"]}

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

@@ -1,8 +1,8 @@
 import { Observable } from 'rxjs';
 import { IKvHttpRequestOptions } from '../../../core/http';
-import { EmissionsDashboard } from '../../../models';
+import { EmissionsDashboard, FullMapListPaginated } from '../../../models';
 import { BaseService } from '../../base.service';
-import { IGetEmissionsDashboardParams } from '../types';
+import { IGetEmissionsDashboardParams, IListProcessesParams } from '../types';
 /**
  * @category Service
  */
@@ -10,8 +10,20 @@ export declare class UIService extends BaseService {
     /**
      * Get Emissions Dashboard
      * Get Emissions Dashboard endpoint that will provide the data to be presented in the maps/emissions dashboard  **Permission Required:** `kelvin.permission.ui.read`
-     * @param siteName The assets site name filter
+     * @param groupName The assets group name filter
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getEmissionsDashboard({ siteName }?: IGetEmissionsDashboardParams, options?: IKvHttpRequestOptions): Observable<EmissionsDashboard>;
+    static getEmissionsDashboard({ groupName }: IGetEmissionsDashboardParams, options?: IKvHttpRequestOptions): Observable<EmissionsDashboard>;
+    /**
+     * List Processes
+     * List Processes  **Pagination Sortable Columns:** &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;start_date&#x60;, &#x60;mode&#x60;, &#x60;map.asset_name&#x60;  **Permission Required:** &#x60;kelvin.permission.ui.read&#x60;
+     * @param processes Processes list schema
+     * @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 {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static listProcesses({ processes, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListProcessesParams, options?: IKvHttpRequestOptions): Observable<FullMapListPaginated>;
 }

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

@@ -10,22 +10,59 @@ class UIService extends base_service_1.BaseService {
     /**
      * Get Emissions Dashboard
      * Get Emissions Dashboard endpoint that will provide the data to be presented in the maps/emissions dashboard  **Permission Required:** `kelvin.permission.ui.read`
-     * @param siteName The assets site name filter
+     * @param groupName The assets group name filter
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getEmissionsDashboard({ siteName } = {}, options) {
+    static getEmissionsDashboard({ groupName }, options) {
         const requestConfig = {
             method: 'get'
         };
         const queryParameters = {};
-        if (siteName != null) {
-            queryParameters['site_name'] = siteName;
+        if (groupName != null) {
+            queryParameters['group_name'] = groupName;
         }
         requestConfig.params = queryParameters;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
         return this.request(`/ui/emissions/dashboard/get`, requestConfig, models_1.EmissionsDashboard);
     }
+    /**
+     * List Processes
+     * List Processes  **Pagination Sortable Columns:** `map.name`, `map.title`, `start_date`, `mode`, `map.asset_name`  **Permission Required:** `kelvin.permission.ui.read`
+     * @param processes Processes list schema
+     * @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 {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static listProcesses({ processes, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        const queryParameters = {};
+        if (pageSize != null) {
+            queryParameters['page_size'] = pageSize;
+        }
+        if (startingAfter != null) {
+            queryParameters['starting_after'] = startingAfter;
+        }
+        if (endingBefore != null) {
+            queryParameters['ending_before'] = endingBefore;
+        }
+        if (sortBy != null) {
+            queryParameters['sort_by'] = sortBy;
+        }
+        if (sortAsc != null) {
+            queryParameters['sort_asc'] = sortAsc;
+        }
+        requestConfig.params = queryParameters;
+        requestConfig.data = processes;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/ui/processes/list`, requestConfig, models_1.FullMapListPaginated);
+    }
 }
 exports.UIService = UIService;
 //# sourceMappingURL=uI.service.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"uI.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/uI.service.ts"],"names":[],"mappings":";;;AAEA,4CAAqD;AACrD,qDAAiD;AAKjD;;GAEG;AAEH,MAAa,SAAU,SAAQ,0BAAW;IAEzC;;;;;OAKG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,QAAQ,KAAmC,EAAE,EAAE,OAA+B;QAE5G,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAqB,6BAA6B,EAAE,aAAa,EAAE,2BAAkB,CAAC,CAAC;IAC3G,CAAC;CACD;AA3BD,8BA2BC","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions } from '../../../core/http';\nimport { EmissionsDashboard } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tIGetEmissionsDashboardParams\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:** &#x60;kelvin.permission.ui.read&#x60;\n\t * @param siteName The assets site name filter\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic getEmissionsDashboard({ siteName }: 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 (siteName != null) {\n\t\t\tqueryParameters['site_name'] = siteName;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<EmissionsDashboard>(`/ui/emissions/dashboard/get`, requestConfig, EmissionsDashboard);\n\t}\n}\n"]}
+{"version":3,"file":"uI.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/uI.service.ts"],"names":[],"mappings":";;;AAEA,4CAA2E;AAC3E,qDAAiD;AAMjD;;GAEG;AAEH,MAAa,SAAU,SAAQ,0BAAW;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;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAqB,6BAA6B,EAAE,aAAa,EAAE,2BAAkB,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;QAE/B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAuB,oBAAoB,EAAE,aAAa,EAAE,6BAAoB,CAAC,CAAC;IACtG,CAAC;CACD;AA3ED,8BA2EC","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:** &#x60;kelvin.permission.ui.read&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\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:** &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;start_date&#x60;, &#x60;mode&#x60;, &#x60;map.asset_name&#x60;  **Permission Required:** &#x60;kelvin.permission.ui.read&#x60;\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\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<FullMapListPaginated>(`/ui/processes/list`, requestConfig, FullMapListPaginated);\n\t}\n}\n"]}

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

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs';
 import { IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';
 import { Workload, WorkloadListPaginated, WorkloadLogs, WorkloadTelemetry } from '../../../models';
 import { BaseService } from '../../base.service';
-import { IDeployWorkloadParams, IGetWorkloadLogsParams, IGetWorkloadParams, IGetWorkloadTelemetryParams, IListWorkloadParams, IStartWorkloadParams, IStopWorkloadParams, IUndeployWorkloadParams } from '../types';
+import { IDeployWorkloadParams, IDownloadWorkloadPackageFileParams, IGetWorkloadLogsParams, IGetWorkloadParams, IGetWorkloadTelemetryParams, IListWorkloadParams, IStartWorkloadParams, IStopWorkloadParams, IUndeployWorkloadParams } from '../types';
 /**
  * @category Service
  */
@@ -14,6 +14,13 @@ export declare class WorkloadService extends BaseService {
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static deployWorkload({ workload }: IDeployWorkloadParams, options?: IKvHttpRequestOptions): Observable<Workload>;
+    /**
+     * Download Workload Package File
+     * Download Workload Package File  **Permission Required:** &#x60;kelvin.permission.workload.read&#x60;
+     * @param workloadName Workload name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static downloadWorkloadPackageFile({ workloadName }: IDownloadWorkloadPackageFileParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
     /**
      * Get Workload
      * Get Workload  **Permission Required:** &#x60;kelvin.permission.workload.read&#x60;

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

@@ -22,6 +22,20 @@ class WorkloadService extends base_service_1.BaseService {
         requestConfig.options = options;
         return this.request(`/workloads/deploy`, requestConfig, models_1.Workload);
     }
+    /**
+     * Download Workload Package File
+     * Download Workload Package File  **Permission Required:** `kelvin.permission.workload.read`
+     * @param workloadName Workload name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static downloadWorkloadPackageFile({ workloadName }, options) {
+        const requestConfig = {
+            method: 'get'
+        };
+        requestConfig.mediaType = 'application/zip';
+        requestConfig.options = options;
+        return this.request(`/workloads/${encodeURIComponent(String(workloadName))}/download`, requestConfig);
+    }
     /**
      * Get Workload
      * Get Workload  **Permission Required:** `kelvin.permission.workload.read`