@kelvininc/js-client-sdk 7.3.0 → 7.8.1

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

@@ -30,8 +30,8 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * Create Asset Class
-     * Create Asset Class  **Permission Required:** `kelvin.permission.asset_class.create`
-     * @param assetClass AssetClass create schema
+     * Create Asset Class  To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A Kelvin Asset Class is linked to an entity type which defines how the Kelvin Asset will be referenced in Kelvin Assets. for example: Kelvin Assets that is defined as a Group can only be linked to a Kelvin Type and Kelvin Class that is saved as entity type **group**.  There are five entity types; `group`, `asset`, `component`, `part` and `sensor`. Detailed information about these entity types and how they are used can be found at <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/</a>.  **Permission Required:** `kelvin.permission.asset_class.create`
+     * @param assetClass Asset Class Create Parameters
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static createAssetClass({ assetClass }, options) {
@@ -43,6 +43,38 @@ class AssetService extends base_service_1.BaseService {
         requestConfig.options = options;
         return this.request(`/assets/class/create`, requestConfig, models_1.AssetClass);
     }
+    /**
+     * Create Asset OEE
+     * Create Asset OEE  **Permission Required:** `kelvin.permission.asset.create`
+     * @param assetsOee Asset OEE create schema
+     * @param assetName Asset name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createAssetOEE({ assetsOee, assetName }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = assetsOee;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/assets/${encodeURIComponent(String(assetName))}/oee/create`, requestConfig, models_1.AssetOEE);
+    }
+    /**
+     * Create Asset Shift
+     * Create Asset Shift  **Permission Required:** `kelvin.permission.asset.create`
+     * @param assetShift Asset Shift create schema
+     * @param assetName Asset name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createAssetShift({ assetShift, assetName }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        requestConfig.data = assetShift;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/assets/${encodeURIComponent(String(assetName))}/shift/create`, requestConfig, models_1.AssetShift);
+    }
     /**
      * Create Asset Template
      * Create Asset Template  **Permission Required:** `kelvin.permission.asset.create`
@@ -60,7 +92,7 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * Create Asset Type
-     * Create Asset Type  **Permission Required:** `kelvin.permission.asset_type.create`
+     * Create Asset Type  To create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> you first need to create a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> and <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. A <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> is linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>. You can have many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> linked to a single <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.  A <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Asset</a> is directly linked to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. There can be many <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> linked to one <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>.  **Permission Required:** `kelvin.permission.asset_type.create`
      * @param assettype AssetType create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -75,8 +107,8 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * Create Asset Type Metadata
-     * Create Asset Type Metadata  **Permission Required:** `kelvin.permission.asset_type.create`
-     * @param assetTypeName Asset Type name
+     * Create Asset Type Metadata  Creates a custom JSON payload that can be attached to a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a>. You can create multiple different types of metadata payloads for each <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a>.  When performing a `get` or `list` API request on <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> or <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target=\"_blank\">Kelvin Assets</a> then you can also add a metadata parameter to return this custom information for your own use.  This metadata does not affect the operation of the Kelvin Platform.  **Permission Required:** `kelvin.permission.asset_type.create`
+     * @param assetTypeName Unique identifier name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> to attach the metadata to.
      * @param assettypemetadata Asset Type Metadata create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -105,8 +137,8 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * Delete Asset Class
-     * Delete Asset Class  **Permission Required:** `kelvin.permission.asset_class.delete`
-     * @param assetClassName Asset Class Name
+     * Delete Asset Class  Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>. This cannot be undone once the API request has been submitted.  This command can not delete <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Classes</a> that are currently linked to any <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> and will return an error 403.  **Permission Required:** `kelvin.permission.asset_class.delete`
+     * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to delete.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static deleteAssetClass({ assetClassName }, options) {
@@ -182,8 +214,8 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * Get Asset Class
-     * Get Asset Class  **Permission Required:** `kelvin.permission.asset_class.read`
-     * @param assetClassName Asset Class Name
+     * Get Asset Class  Retrieves the properties of a <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a>.  **Permission Required:** `kelvin.permission.asset_class.read`
+     * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to retrieve.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getAssetClass({ assetClassName }, options) {
@@ -211,29 +243,104 @@ class AssetService extends base_service_1.BaseService {
      * Get Asset Hierarchy
      * Get Asset Hierarchy  **Permission Required:** `kelvin.permission.asset.read`
      * @param assetName Asset name
+     * @param entityTypeDepth Sets the start entity type depth in which the hierarchy is returned.
+     * @param assetTypeDepth Sets the start asset type depth in which the hierarchy is returned. Only valid when entity_type_depth = group
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getAssetHierarchy({ assetName }, options) {
+    static getAssetHierarchy({ assetName, entityTypeDepth, assetTypeDepth }, options) {
         const requestConfig = {
             method: 'get'
         };
+        const queryParameters = {};
+        if (entityTypeDepth != null) {
+            queryParameters['entity_type_depth'] = entityTypeDepth;
+        }
+        if (assetTypeDepth != null) {
+            queryParameters['asset_type_depth'] = assetTypeDepth;
+        }
+        requestConfig.params = queryParameters;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
         return this.request(`/assets/${encodeURIComponent(String(assetName))}/hierarchy/get`, requestConfig, models_1.Asset);
     }
+    /**
+     * Get Asset OEE
+     * Get Asset OEE  **Permission Required:** `kelvin.permission.asset.read`
+     * @param assetNames Asset OEE get schema
+     * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getAssetOEE({ assetNames, timestamp }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        const queryParameters = {};
+        if (timestamp != null) {
+            queryParameters['timestamp'] = timestamp;
+        }
+        requestConfig.params = queryParameters;
+        requestConfig.data = assetNames;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/assets/oee/get`, requestConfig, models_1.AssetOEE);
+    }
     /**
      * Get Asset Shift
      * Get Asset Shift  **Permission Required:** `kelvin.permission.asset.read`
-     * @param assetName Asset name
+     * @param assetNames Asset Shift get schema
+     * @param timestamp Timestamp to search for specific Shift information for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getAssetShift({ assetName }, options) {
+    static getAssetShift({ assetNames, timestamp }, options) {
         const requestConfig = {
-            method: 'get'
+            method: 'post'
+        };
+        const queryParameters = {};
+        if (timestamp != null) {
+            queryParameters['timestamp'] = timestamp;
+        }
+        requestConfig.params = queryParameters;
+        requestConfig.data = assetNames;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/assets/shift/get`, requestConfig, models_1.AssetShift);
+    }
+    /**
+     * Get Asset Statistics
+     * Get Asset Statistics  **Pagination Sortable Columns:** `asset.name`, `asset.asset_type_name`, `asset.device_type_name`  **Permission Required:** `kelvin.permission.asset.read`
+     * @param asset Asset statistics 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 getAssetStatistics({ asset, 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 = asset;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/shift/get`, requestConfig, models_1.AssetShift);
+        return this.request(`/assets/statistics/get`, requestConfig, models_1.AssetStatisticsPaginated);
     }
     /**
      * Get Asset Status Count
@@ -314,9 +421,12 @@ class AssetService extends base_service_1.BaseService {
      * List Asset
      * List Asset  **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.name`, `asset_type.title`, `status_state`, `status_last_seen`  **Permission Required:** `kelvin.permission.asset.read`
      * @param search Search assets by name or title
+     * @param names Filter assets matching a list of names
      * @param assetTypeName Filter assets by asset type
      * @param statusState Filter assets by status state [`online`, `offline`, `partially_online`, `unknown`]
      * @param entityTypeName Filter assets by entity type. Prefix any `entity_type_name` with the character `!` for a NOT operation
+     * @param propertiesFilter Filter assets that have an property.name = property.value. Format `property_name=property_value`
+     * @param properties Only return specific properties (default: return all properties): Format `property_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
@@ -324,7 +434,7 @@ class AssetService extends base_service_1.BaseService {
      * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listAsset({ search, assetTypeName, statusState, entityTypeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
+    static listAsset({ search, names, assetTypeName, statusState, entityTypeName, propertiesFilter, properties, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
         const requestConfig = {
             method: 'get'
         };
@@ -332,6 +442,9 @@ class AssetService extends base_service_1.BaseService {
         if (search != null) {
             queryParameters['search'] = search;
         }
+        if (names != null) {
+            queryParameters['names'] = names;
+        }
         if (assetTypeName != null) {
             queryParameters['asset_type_name'] = assetTypeName;
         }
@@ -341,6 +454,12 @@ class AssetService extends base_service_1.BaseService {
         if (entityTypeName != null) {
             queryParameters['entity_type_name'] = entityTypeName;
         }
+        if (propertiesFilter != null) {
+            queryParameters['properties_filter'] = propertiesFilter;
+        }
+        if (properties != null) {
+            queryParameters['properties'] = properties;
+        }
         if (pageSize != null) {
             queryParameters['page_size'] = pageSize;
         }
@@ -363,15 +482,15 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * List Asset Class
-     * List Asset Class  **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`  **Permission Required:** `kelvin.permission.asset_class.read`
-     * @param search Search Asset Class by name or title
-     * @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 owner Filter Asset Class by owner. Possible Values: kelvin/custom
-     * @param entityTypeName Filter by Entity Type Name. Prefix any `entity_type_name` with the character `!` for a NOT operation
+     * List Asset Class  Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> on the Kelvin Platform.  If no query parameters are given with the API request, then the defaults will be used to return the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Class</a> list. The defaults are the first 20 <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target=\"_blank\">Kelvin Asset Classes</a> returned in alphabetical order by the unique identifier name.  **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner`, `asset_class.device_type_name`  **Permission Required:** `kelvin.permission.asset_class.read`
+     * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Kelvin Asset Class 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/#asset-class' target='_blank'>Kelvin Asset Class</a> objects to be returned. Page size can be between 1 and 1000. The default is 20 Kelvin Asset Class 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/#asset-class' target='_blank'>Kelvin Asset Classes</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under 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/#asset-class' target='_blank'>Kelvin Asset Classes</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under 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 Kelvin Asset Class parameters. Only one parameter can be selected.</p> There are six parameter options; `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`, `asset_class.owner` and `asset_class.device_type_name`. The default is `asset_class.name`
+     * @param sortAsc Sorting order for the results.</p> There are two options; `true` (ascending order) and `false` (descending order). The default is true (ascending).
+     * @param owner Filter Kelvin Asset Class by owner.</p> There are two types of owners; `custom` (any user) or `kelvin` (core kelvin asset class).
+     * @param entityTypeName Filter and return the results of one or more of the entity type names. This is given as an array, for example `[group,asset]`. Prefix any entity type name with the character `!` for a NOT operation.</p> There are five entity type names available to choose from; `group`, `asset`, `component`, `part`, `sensor`.</p> The default will select all available entity type name options.</p>
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner, entityTypeName } = {}, options) {
@@ -408,6 +527,44 @@ class AssetService extends base_service_1.BaseService {
         requestConfig.options = options;
         return this.request(`/assets/class/list`, requestConfig, models_1.AssetClassListPaginated);
     }
+    /**
+     * List Asset Data Streams
+     * List Asset Data Streams  **Pagination Sortable Columns:** `datastream.asset_name`, `datastream.metric_name`  **Permission Required:** `kelvin.permission.asset.read`
+     * @param assetDatastreams Asset Data Streams list schema
+     * @param assetName 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
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static listAssetDataStreams({ assetDatastreams, assetName, 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 = assetDatastreams;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/assets/${encodeURIComponent(String(assetName))}/datastreams/list`, requestConfig, models_1.AssetDataStreamsListPaginated);
+    }
     /**
      * List Asset Template
      * List Asset Template  **Pagination Sortable Columns:** `asset_template.name`, `asset_template.title`, `asset_template.created`, `asset_template.updated`, `asset_template.asset_type_name`, `asset_template.device_type_name`  **Permission Required:** `kelvin.permission.asset.read`
@@ -465,7 +622,7 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * List Asset Type
-     * List Asset Type  **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_type.owner`, `asset_class.name`, `asset_class.title`, `asset_class.device_type_name`  **Permission Required:** `kelvin.permission.asset_type.read`
+     * List Asset Type  Returns a filtered list of all <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> on the Kelvin Platform.  If no query parameters are given with the API request, then the defaults will be used to return the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Type</a> list. The defaults are the first 20 <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target=\"_blank\">Kelvin Asset Types</a> returned in alphabetical order by the unique identifier name.  **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_type.owner`, `asset_class.name`, `asset_class.title`, `asset_class.device_type_name`  **Permission Required:** `kelvin.permission.asset_type.read`
      * @param search Search asset type by name or title
      * @param assetClassName Filter asset type by asset class
      * @param metadata Inject metadata into the response
@@ -562,6 +719,44 @@ class AssetService extends base_service_1.BaseService {
         requestConfig.options = options;
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/list`, requestConfig, models_1.AssetTypeMetadataListPaginated);
     }
+    /**
+     * List Site Hierarchy Overview
+     * List Site Hierarchy Overview  **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.failure_quotient`, `asset_type.title`  **Permission Required:** `kelvin.permission.asset.read`
+     * @param asset Site Hierarchy Overview schema
+     * @param siteName Site name
+     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
+     * @param startingAfter Lower bound cursor for use in pagination
+     * @param endingBefore Upper bound cursor for use in pagination
+     * @param sortBy Parameter to sort by. Must be one of the sortable columns
+     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static listSiteHierarchyOverview({ asset, siteName, 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 = asset;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/assets/${encodeURIComponent(String(siteName))}/site-hierarchy-overview/list`, requestConfig, models_1.SiteHierarchyOverviewPaginated);
+    }
     /**
      * Update Asset
      * Update Asset  **Permission Required:** `kelvin.permission.asset.update`
@@ -586,9 +781,9 @@ class AssetService extends base_service_1.BaseService {
     }
     /**
      * Update Asset Class
-     * Update Asset Class  **Permission Required:** `kelvin.permission.asset_class.update`
+     * Update Asset Class  Updates an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> with any new values passed through the body parameters.</p> Only the Display Name (title) body parameter is required. If this body parameter does not need to be changed, it should still have the original Display Name (title) given. Any other body parameters that are not required and not provided will remain unchanged.</p> Only the unique identifier name can not be changed. If you need to change this parameter, then you will need to make a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a> and relink all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Types</a> to the new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.  **Permission Required:** `kelvin.permission.asset_class.update`
      * @param assetClass AssetClass update schema
-     * @param assetClassName Asset Class Name
+     * @param assetClassName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class </a> name to retrieve.</p> This is the unique identifier name and not the display name of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class' target='_blank'>Kelvin Asset Class</a>.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static updateAssetClass({ assetClass, assetClassName }, options) {
@@ -621,22 +816,6 @@ class AssetService extends base_service_1.BaseService {
         requestConfig.options = options;
         return this.request(`/assets/hierarchy/update`, requestConfig);
     }
-    /**
-     * Update Asset Shift
-     * Update Asset Shift  **Permission Required:** `kelvin.permission.asset.update`
-     * @param assetShift Asset Shift update schema
-     * @param assetName Asset name
-     * @param {IKvHttpRequestOptions} options Request optional parameters
-     */
-    static updateAssetShift({ assetShift, assetName }, options) {
-        const requestConfig = {
-            method: 'post'
-        };
-        requestConfig.data = assetShift;
-        requestConfig.mediaType = 'application/json';
-        requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/shift/update`, requestConfig, models_1.AssetShift);
-    }
     /**
      * Update Asset Template
      * Update Asset Template  **Permission Required:** `kelvin.permission.asset.update`