@kelvininc/js-client-sdk 5.3.0 → 5.9.0

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

@@ -1,4 +1,4 @@
-import { Asset, AssetClass, AssetClassListPaginated, AssetHierarchyList, AssetListPaginated, AssetMetadata, AssetMetadataListPaginated, AssetProperty, AssetPropertyListPaginated, AssetStatus, AssetStatusCount, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated } from '../../../models';
+import { Asset, AssetClass, AssetClassListPaginated, AssetHierarchyList, AssetHierarchyListFull, AssetListPaginated, AssetStatus, AssetStatusCount, AssetTemplate, AssetTemplateListPaginated, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated } from '../../../models';
 import { BaseService } from '../../base.service';
 /**
  * @category Service
@@ -8,12 +8,18 @@ export class AssetService extends BaseService {
      * Create Asset
      * Create Asset  **Permission Required:** `kelvin.permission.asset.create`
      * @param asset Asset create schema
+     * @param dryRun Dry Run
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static createAsset({ asset }, options) {
+    static createAsset({ asset, dryRun }, options) {
         const requestConfig = {
             method: 'post'
         };
+        const queryParameters = {};
+        if (dryRun != null) {
+            queryParameters['dry_run'] = dryRun;
+        }
+        requestConfig.params = queryParameters;
         requestConfig.data = asset;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
@@ -35,36 +41,19 @@ export class AssetService extends BaseService {
         return this.request(`/assets/class/create`, requestConfig, AssetClass);
     }
     /**
-     * Create Asset Metadata
-     * Create Asset Metadata  **Permission Required:** `kelvin.permission.asset.create`
-     * @param assetName Asset name
-     * @param assetmetadata Asset Metadata create schema
-     * @param {IKvHttpRequestOptions} options Request optional parameters
-     */
-    static createAssetMetadata({ assetName, assetmetadata }, options) {
-        const requestConfig = {
-            method: 'post'
-        };
-        requestConfig.data = assetmetadata;
-        requestConfig.mediaType = 'application/json';
-        requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/metadata/create`, requestConfig, AssetMetadata);
-    }
-    /**
-     * Create Asset Property
-     * Create Asset Property  **Permission Required:** `kelvin.permission.asset.create`
-     * @param assetName Asset name
-     * @param assetproperty Asset Property create schema
+     * Create Asset Template
+     * Create Asset Template  **Permission Required:** `kelvin.permission.asset.create`
+     * @param assetTemplate Asset Template create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static createAssetProperty({ assetName, assetproperty }, options) {
+    static createAssetTemplate({ assetTemplate }, options) {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.data = assetproperty;
+        requestConfig.data = assetTemplate;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/properties/create`, requestConfig, AssetProperty);
+        return this.request(`/assets/templates/create`, requestConfig, AssetTemplate);
     }
     /**
      * Create Asset Type
@@ -126,34 +115,18 @@ export class AssetService extends BaseService {
         return this.request(`/assets/class/${encodeURIComponent(String(assetClassName))}/delete`, requestConfig);
     }
     /**
-     * Delete Asset Metadata
-     * Delete Asset Metadata  **Permission Required:** `kelvin.permission.asset.delete`
-     * @param assetName Asset name
-     * @param assetMetadataName Asset Metadata name
-     * @param {IKvHttpRequestOptions} options Request optional parameters
-     */
-    static deleteAssetMetadata({ assetName, assetMetadataName }, options) {
-        const requestConfig = {
-            method: 'post'
-        };
-        requestConfig.mediaType = 'application/json';
-        requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/metadata/${encodeURIComponent(String(assetMetadataName))}/delete`, requestConfig);
-    }
-    /**
-     * Delete Asset Property
-     * Delete Asset Property  **Permission Required:** `kelvin.permission.asset.delete`
-     * @param assetName Asset name
-     * @param assetPropertyName Asset Property name
+     * Delete Asset Template
+     * Delete Asset Template  **Permission Required:** `kelvin.permission.asset.delete`
+     * @param assetTemplateName Asset Template Name
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static deleteAssetProperty({ assetName, assetPropertyName }, options) {
+    static deleteAssetTemplate({ assetTemplateName }, options) {
         const requestConfig = {
             method: 'post'
         };
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/properties/${encodeURIComponent(String(assetPropertyName))}/delete`, requestConfig);
+        return this.request(`/assets/templates/${encodeURIComponent(String(assetTemplateName))}/delete`, requestConfig);
     }
     /**
      * Delete Asset Type
@@ -221,71 +194,56 @@ export class AssetService extends BaseService {
     /**
      * Get Asset Hierarchy
      * Get Asset Hierarchy  **Permission Required:** `kelvin.permission.asset.read`
-     * @param {IKvHttpRequestOptions} options Request optional parameters
-     */
-    static getAssetHierarchy(options) {
-        const requestConfig = {
-            method: 'get'
-        };
-        requestConfig.mediaType = 'application/json';
-        requestConfig.options = options;
-        return this.request(`/assets/hierarchy/tree/get`, requestConfig, AssetHierarchyList);
-    }
-    /**
-     * Get Asset Metadata
-     * Get Asset Metadata  **Permission Required:** `kelvin.permission.asset.read`
      * @param assetName Asset name
-     * @param assetMetadataName Asset Metadata name
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getAssetMetadata({ assetName, assetMetadataName }, options) {
+    static getAssetHierarchy({ assetName }, options) {
         const requestConfig = {
             method: 'get'
         };
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/metadata/${encodeURIComponent(String(assetMetadataName))}/get`, requestConfig, AssetMetadata);
+        return this.request(`/assets/${encodeURIComponent(String(assetName))}/hierarchy/get`, requestConfig, Asset);
     }
     /**
-     * Get Asset Property
-     * Get Asset Property  **Permission Required:** `kelvin.permission.asset.read`
-     * @param assetName Asset name
-     * @param assetPropertyName Asset Property name
+     * Get Asset Status Count
+     * Get Asset Status Count  **Permission Required:** `kelvin.permission.asset.read`
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getAssetProperty({ assetName, assetPropertyName }, options) {
+    static getAssetStatusCount(options) {
         const requestConfig = {
             method: 'get'
         };
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/properties/${encodeURIComponent(String(assetPropertyName))}/get`, requestConfig, AssetProperty);
+        return this.request(`/assets/status/count/get`, requestConfig, AssetStatusCount);
     }
     /**
-     * Get Asset Status Count
-     * Get Asset Status Count  **Permission Required:** `kelvin.permission.asset.read`
+     * Get Asset Statuses
+     * Get Asset Statuses  **Permission Required:** `kelvin.permission.asset.read`
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getAssetStatusCount(options) {
+    static getAssetStatuses(options) {
         const requestConfig = {
             method: 'get'
         };
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/status/count/get`, requestConfig, AssetStatusCount);
+        return this.request(`/assets/status/get`, requestConfig, AssetStatus);
     }
     /**
-     * Get Asset Statuses
-     * Get Asset Statuses  **Permission Required:** `kelvin.permission.asset.read`
+     * Get Asset Template
+     * Get Asset Template  **Permission Required:** `kelvin.permission.asset.read`
+     * @param assetTemplateName Asset Template Name
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getAssetStatuses(options) {
+    static getAssetTemplate({ assetTemplateName }, options) {
         const requestConfig = {
             method: 'get'
         };
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/status/get`, requestConfig, AssetStatus);
+        return this.request(`/assets/templates/${encodeURIComponent(String(assetTemplateName))}/get`, requestConfig, AssetTemplate);
     }
     /**
      * Get Asset Type
@@ -328,8 +286,7 @@ export class AssetService extends BaseService {
      * @param search Search assets by name or title
      * @param assetTypeName Filter assets by asset type
      * @param statusState Filter assets by status state [`online`, `offline`, `partially_online`, `unknown`]
-     * @param metadata Inject metadata into the response
-     * @param metadataFilter Dot separated string to filter by metadata values Same <metadata_name> will result in OR queries. Different <metadata_name> will result in AND queries. Example: <metadata_name>.<payload_key_to_search>=<payload_value_to_search>
+     * @param deviceTypeName Filter assets by device type
      * @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
@@ -337,7 +294,7 @@ export class AssetService extends 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, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
+    static listAsset({ search, assetTypeName, statusState, deviceTypeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
         const requestConfig = {
             method: 'get'
         };
@@ -351,11 +308,8 @@ export class AssetService extends BaseService {
         if (statusState != null) {
             queryParameters['status_state'] = statusState;
         }
-        if (metadata != null) {
-            queryParameters['metadata'] = metadata;
-        }
-        if (metadataFilter != null) {
-            queryParameters['metadata_filter'] = metadataFilter;
+        if (deviceTypeName != null) {
+            queryParameters['device_type_name'] = deviceTypeName;
         }
         if (pageSize != null) {
             queryParameters['page_size'] = pageSize;
@@ -379,16 +333,17 @@ export class AssetService extends BaseService {
     }
     /**
      * List Asset Class
-     * List Asset Class  **Pagination Sortable Columns:** `asset_class.name`, `asset_class.title`, `asset_class.created`, `asset_class.updated`  **Permission Required:** `kelvin.permission.asset_class.read`
+     * 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 {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
+    static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner } = {}, options) {
         const requestConfig = {
             method: 'get'
         };
@@ -411,64 +366,43 @@ export class AssetService extends BaseService {
         if (sortAsc != null) {
             queryParameters['sort_asc'] = sortAsc;
         }
+        if (owner != null) {
+            queryParameters['owner'] = owner;
+        }
         requestConfig.params = queryParameters;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
         return this.request(`/assets/class/list`, requestConfig, AssetClassListPaginated);
     }
     /**
-     * List Asset Metadata
-     * List Asset Metadata  **Pagination Sortable Columns:** `asset_metadata.name`, `asset_metadata.title`, `asset_metadata.value`, `asset_metadata.created`, `asset_metadata.updated`  **Permission Required:** `kelvin.permission.asset.read`
-     * @param assetName Asset name
-     * @param search Search Asset Metadata by name, title or value
-     * @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 Asset Hierarchies
+     * List Asset Hierarchies  **Permission Required:** `kelvin.permission.asset.read`
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listAssetMetadata({ assetName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
+    static listAssetHierarchies(options) {
         const requestConfig = {
             method: 'get'
         };
-        const queryParameters = {};
-        if (search != null) {
-            queryParameters['search'] = search;
-        }
-        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.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/metadata/list`, requestConfig, AssetMetadataListPaginated);
+        return this.request(`/assets/hierarchy/list`, requestConfig, AssetHierarchyListFull);
     }
     /**
-     * List Asset Property
-     * List Asset Property  **Pagination Sortable Columns:** `asset_property.name`, `asset_property.title`, `asset_property.value`, `asset_property.created`, `asset_property.updated`  **Permission Required:** `kelvin.permission.asset.read`
-     * @param assetName Asset name
-     * @param search Search Asset Property by name, title or value
+     * 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`
+     * @param search Search Asset Template 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 assetTypeNames Asset Type Names
+     * @param deviceTypeNames Device Type Names
+     * @param assetClassNames Asset Class Names
+     * @param owner Owner
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listAssetProperty({ assetName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
+    static listAssetTemplate({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, assetTypeNames, deviceTypeNames, assetClassNames, owner } = {}, options) {
         const requestConfig = {
             method: 'get'
         };
@@ -491,14 +425,26 @@ export class AssetService extends BaseService {
         if (sortAsc != null) {
             queryParameters['sort_asc'] = sortAsc;
         }
+        if (assetTypeNames != null) {
+            queryParameters['asset_type_names'] = assetTypeNames;
+        }
+        if (deviceTypeNames != null) {
+            queryParameters['device_type_names'] = deviceTypeNames;
+        }
+        if (assetClassNames != null) {
+            queryParameters['asset_class_names'] = assetClassNames;
+        }
+        if (owner != null) {
+            queryParameters['owner'] = owner;
+        }
         requestConfig.params = queryParameters;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/properties/list`, requestConfig, AssetPropertyListPaginated);
+        return this.request(`/assets/templates/list`, requestConfig, AssetTemplateListPaginated);
     }
     /**
      * List Asset Type
-     * List Asset Type  **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_class.name`, `asset_class.title`  **Permission Required:** `kelvin.permission.asset_type.read`
+     * List Asset Type  **Pagination Sortable Columns:** `asset_type.name`, `asset_type.title`, `asset_type.created`, `asset_type.updated`, `asset_class.name`, `asset_class.title`, `asset_type.owner`  **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
@@ -508,9 +454,10 @@ export class AssetService extends BaseService {
      * @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 {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listAssetType({ search, assetClassName, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
+    static listAssetType({ search, assetClassName, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner } = {}, options) {
         const requestConfig = {
             method: 'get'
         };
@@ -542,6 +489,9 @@ export class AssetService extends BaseService {
         if (sortAsc != null) {
             queryParameters['sort_asc'] = sortAsc;
         }
+        if (owner != null) {
+            queryParameters['owner'] = owner;
+        }
         requestConfig.params = queryParameters;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
@@ -592,12 +542,18 @@ export class AssetService extends BaseService {
      * Update Asset  **Permission Required:** `kelvin.permission.asset.update`
      * @param asset Asset update schema
      * @param assetName Asset name
+     * @param dryRun Dry Run
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static updateAsset({ asset, assetName }, options) {
+    static updateAsset({ asset, assetName, dryRun }, options) {
         const requestConfig = {
             method: 'post'
         };
+        const queryParameters = {};
+        if (dryRun != null) {
+            queryParameters['dry_run'] = dryRun;
+        }
+        requestConfig.params = queryParameters;
         requestConfig.data = asset;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
@@ -620,53 +576,20 @@ export class AssetService extends BaseService {
         return this.request(`/assets/class/${encodeURIComponent(String(assetClassName))}/update`, requestConfig, AssetClass);
     }
     /**
-     * Update Asset Hierarchy
-     * Update Asset Hierarchy  **Permission Required:** `kelvin.permission.asset.create`
-     * @param assetHierarchy AssetHierarchy update schema
+     * Update Asset Template
+     * Update Asset Template  **Permission Required:** `kelvin.permission.asset.update`
+     * @param assetTemplate Asset Template update schema
+     * @param assetTemplateName Asset Template Name
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static updateAssetHierarchy({ assetHierarchy }, options) {
+    static updateAssetTemplate({ assetTemplate, assetTemplateName }, options) {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.data = assetHierarchy;
+        requestConfig.data = assetTemplate;
         requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
-        return this.request(`/assets/hierarchy/tree/update`, requestConfig);
-    }
-    /**
-     * Update Asset Metadata
-     * Update Asset Metadata  **Permission Required:** `kelvin.permission.asset.update`
-     * @param assetmetadata Asset Metadata update schema
-     * @param assetName Asset name
-     * @param assetMetadataName Asset Metadata name
-     * @param {IKvHttpRequestOptions} options Request optional parameters
-     */
-    static updateAssetMetadata({ assetmetadata, assetName, assetMetadataName }, options) {
-        const requestConfig = {
-            method: 'post'
-        };
-        requestConfig.data = assetmetadata;
-        requestConfig.mediaType = 'application/json';
-        requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/metadata/${encodeURIComponent(String(assetMetadataName))}/update`, requestConfig, AssetMetadata);
-    }
-    /**
-     * Update Asset Property
-     * Update Asset Property  **Permission Required:** `kelvin.permission.asset.update`
-     * @param assetproperty Asset Property update schema
-     * @param assetName Asset name
-     * @param assetPropertyName Asset Property name
-     * @param {IKvHttpRequestOptions} options Request optional parameters
-     */
-    static updateAssetProperty({ assetproperty, assetName, assetPropertyName }, options) {
-        const requestConfig = {
-            method: 'post'
-        };
-        requestConfig.data = assetproperty;
-        requestConfig.mediaType = 'application/json';
-        requestConfig.options = options;
-        return this.request(`/assets/${encodeURIComponent(String(assetName))}/properties/${encodeURIComponent(String(assetPropertyName))}/update`, requestConfig, AssetProperty);
+        return this.request(`/assets/templates/${encodeURIComponent(String(assetTemplateName))}/update`, requestConfig, AssetTemplate);
     }
     /**
      * Update Asset Type
@@ -701,5 +624,30 @@ export class AssetService extends BaseService {
         requestConfig.options = options;
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/${encodeURIComponent(String(assetTypeMetadataName))}/update`, requestConfig, AssetTypeMetadata);
     }
+    /**
+     * Upload Assets
+     * Upload Assets  **Permission Required:** `kelvin.permission.asset.create`
+     * @param file CSV File
+     * @param dryRun If set to true performs only validation
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static uploadAssets({ file, dryRun }, options) {
+        const requestConfig = {
+            method: 'post'
+        };
+        const queryParameters = {};
+        if (dryRun != null) {
+            queryParameters['dry_run'] = dryRun;
+        }
+        requestConfig.params = queryParameters;
+        const formParams = new FormData();
+        if (file != null) {
+            formParams.append('file', file);
+        }
+        requestConfig.data = formParams;
+        requestConfig.mediaType = 'application/json';
+        requestConfig.options = options;
+        return this.request(`/assets/create/upload`, requestConfig, AssetHierarchyList);
+    }
 }
 //# sourceMappingURL=asset.service.js.map