@kelvininc/js-client-sdk 5.0.0 → 5.5.0

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

@@ -1,8 +1,8 @@
 import { Observable } from 'rxjs';
 import { IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';
-import { Asset, AssetListPaginated, AssetMetadata, AssetMetadataListPaginated, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated, WorkloadListPaginated } from '../../../models';
+import { Asset, AssetClass, AssetClassListPaginated, AssetHierarchyList, AssetHierarchyListFull, AssetListPaginated, AssetStatus, AssetStatusCount, AssetTemplate, AssetTemplateListPaginated, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated } from '../../../models';
 import { BaseService } from '../../base.service';
-import { ICreateAssetMetadataParams, ICreateAssetParams, ICreateAssetTypeMetadataParams, ICreateAssetTypeParams, IDeleteAssetMetadataParams, IDeleteAssetParams, IDeleteAssetTypeMetadataParams, IDeleteAssetTypeParams, IGetAssetMetadataParams, IGetAssetParams, IGetAssetTypeMetadataParams, IGetAssetTypeParams, IListAssetMetadataParams, IListAssetParams, IListAssetTypeMetadataParams, IListAssetTypeParams, IListAssetWorkloadsParams, IUpdateAssetMetadataParams, IUpdateAssetParams, IUpdateAssetTypeMetadataParams, IUpdateAssetTypeParams } from '../types';
+import { ICreateAssetClassParams, ICreateAssetParams, ICreateAssetTemplateParams, ICreateAssetTypeMetadataParams, ICreateAssetTypeParams, IDeleteAssetClassParams, IDeleteAssetParams, IDeleteAssetTemplateParams, IDeleteAssetTypeMetadataParams, IDeleteAssetTypeParams, IGetAssetClassParams, IGetAssetHierarchyParams, IGetAssetParams, IGetAssetTemplateParams, IGetAssetTypeMetadataParams, IGetAssetTypeParams, IListAssetClassParams, IListAssetParams, IListAssetTemplateParams, IListAssetTypeMetadataParams, IListAssetTypeParams, IUpdateAssetClassParams, IUpdateAssetParams, IUpdateAssetTemplateParams, IUpdateAssetTypeMetadataParams, IUpdateAssetTypeParams, IUploadAssetsParams } from '../types';
 /**
  * @category Service
  */
@@ -11,17 +11,24 @@ export declare 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 }: ICreateAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
+    static createAsset({ asset, dryRun }: ICreateAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
     /**
-     * Create Asset Metadata
-     * Create Asset Metadata  **Permission Required:** &#x60;kelvin.permission.asset.create&#x60;
-     * @param assetName Asset name
-     * @param assetmetadata Asset Metadata create schema
+     * Create Asset Class
+     * Create Asset Class  **Permission Required:** &#x60;kelvin.permission.asset_class.create&#x60;
+     * @param assetClass AssetClass create schema
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static createAssetClass({ assetClass }: ICreateAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClass>;
+    /**
+     * Create Asset Template
+     * Create Asset Template  **Permission Required:** &#x60;kelvin.permission.asset.create&#x60;
+     * @param assetTemplate Asset Template create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static createAssetMetadata({ assetName, assetmetadata }: ICreateAssetMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetMetadata>;
+    static createAssetTemplate({ assetTemplate }: ICreateAssetTemplateParams, options?: IKvHttpRequestOptions): Observable<AssetTemplate>;
     /**
      * Create Asset Type
      * Create Asset Type  **Permission Required:** &#x60;kelvin.permission.asset_type.create&#x60;
@@ -45,13 +52,19 @@ export declare class AssetService extends BaseService {
      */
     static deleteAsset({ assetName }: IDeleteAssetParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
     /**
-     * Delete Asset Metadata
-     * Delete Asset Metadata  **Permission Required:** &#x60;kelvin.permission.asset.delete&#x60;
-     * @param assetName Asset name
-     * @param assetMetadataName Asset Metadata name
+     * Delete Asset Class
+     * Delete Asset Class  **Permission Required:** &#x60;kelvin.permission.asset_class.delete&#x60;
+     * @param assetClassName Asset Class Name
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static deleteAssetMetadata({ assetName, assetMetadataName }: IDeleteAssetMetadataParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
+    static deleteAssetClass({ assetClassName }: IDeleteAssetClassParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
+    /**
+     * Delete Asset Template
+     * Delete Asset Template  **Permission Required:** &#x60;kelvin.permission.asset.delete&#x60;
+     * @param assetTemplateName Asset Template Name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static deleteAssetTemplate({ assetTemplateName }: IDeleteAssetTemplateParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
     /**
      * Delete Asset Type
      * Delete Asset Type  **Permission Required:** &#x60;kelvin.permission.asset_type.delete&#x60;
@@ -76,13 +89,38 @@ export declare class AssetService extends BaseService {
      */
     static getAsset({ assetName, metadata }: IGetAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
     /**
-     * Get Asset Metadata
-     * Get Asset Metadata  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
+     * Get Asset Class
+     * Get Asset Class  **Permission Required:** &#x60;kelvin.permission.asset_class.read&#x60;
+     * @param assetClassName Asset Class Name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getAssetClass({ assetClassName }: IGetAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClass>;
+    /**
+     * Get Asset Hierarchy
+     * Get Asset Hierarchy  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
      * @param assetName Asset name
-     * @param assetMetadataName Asset Metadata name
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getAssetMetadata({ assetName, assetMetadataName }: IGetAssetMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetMetadata>;
+    static getAssetHierarchy({ assetName }: IGetAssetHierarchyParams, options?: IKvHttpRequestOptions): Observable<Asset>;
+    /**
+     * Get Asset Status Count
+     * Get Asset Status Count  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getAssetStatusCount(options?: IKvHttpRequestOptions): Observable<AssetStatusCount>;
+    /**
+     * Get Asset Statuses
+     * Get Asset Statuses  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getAssetStatuses(options?: IKvHttpRequestOptions): Observable<AssetStatus>;
+    /**
+     * Get Asset Template
+     * Get Asset Template  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
+     * @param assetTemplateName Asset Template Name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static getAssetTemplate({ assetTemplateName }: IGetAssetTemplateParams, options?: IKvHttpRequestOptions): Observable<AssetTemplate>;
     /**
      * Get Asset Type
      * Get Asset Type  **Permission Required:** &#x60;kelvin.permission.asset_type.read&#x60;
@@ -101,12 +139,11 @@ export declare class AssetService extends BaseService {
     static getAssetTypeMetadata({ assetTypeName, assetTypeMetadataName }: IGetAssetTypeMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetTypeMetadata>;
     /**
      * List Asset
-     * List Asset  **Pagination Sortable Columns:** &#x60;asset.name&#x60;, &#x60;asset.title&#x60;, &#x60;asset.created&#x60;, &#x60;asset.updated&#x60;, &#x60;asset_type.title&#x60;  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
+     * List Asset  **Pagination Sortable Columns:** &#x60;asset.name&#x60;, &#x60;asset.title&#x60;, &#x60;asset.created&#x60;, &#x60;asset.updated&#x60;, &#x60;asset_type.name&#x60;, &#x60;asset_type.title&#x60;, &#x60;status_state&#x60;, &#x60;status_last_seen&#x60;  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
      * @param search Search assets by name or title
      * @param assetTypeName Filter assets by asset type
-     * @param assetGroupName Filter assets by asset group
-     * @param metadata Inject metadata into the response
-     * @param metadataFilter Dot separated string to filter by metadata values Same &lt;metadata_name&gt; will result in OR queries. Different &lt;metadata_name&gt; will result in AND queries. Example: &lt;metadata_name&gt;.&lt;payload_key_to_search&gt;&#x3D;&lt;payload_value_to_search&gt;
+     * @param statusState Filter assets by status state [&#x60;online&#x60;, &#x60;offline&#x60;, &#x60;partially_online&#x60;, &#x60;unknown&#x60;]
+     * @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
@@ -114,51 +151,63 @@ export declare 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, assetGroupName, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListAssetParams, options?: IKvHttpRequestOptions): Observable<AssetListPaginated>;
+    static listAsset({ search, assetTypeName, statusState, deviceTypeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListAssetParams, options?: IKvHttpRequestOptions): Observable<AssetListPaginated>;
     /**
-     * List Asset Metadata
-     * List Asset Metadata  **Pagination Sortable Columns:** &#x60;asset_metadata.name&#x60;  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
-     * @param assetName Asset name
-     * @param search Search Asset Metadata by name
+     * List Asset Class
+     * List Asset Class  **Pagination Sortable Columns:** &#x60;asset_class.name&#x60;, &#x60;asset_class.title&#x60;, &#x60;asset_class.created&#x60;, &#x60;asset_class.updated&#x60;, &#x60;asset_class.owner&#x60;  **Permission Required:** &#x60;kelvin.permission.asset_class.read&#x60;
+     * @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 listAssetMetadata({ assetName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListAssetMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetMetadataListPaginated>;
+    static listAssetClass({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner }?: IListAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClassListPaginated>;
     /**
-     * List Asset Type
-     * List Asset Type  **Pagination Sortable Columns:** &#x60;asset_type.name&#x60;, &#x60;asset_type.title&#x60;, &#x60;asset_type.created&#x60;, &#x60;asset_type.updated&#x60;  **Permission Required:** &#x60;kelvin.permission.asset_type.read&#x60;
-     * @param search Search Asset Type by name
-     * @param metadata Inject metadata into the response
-     * @param metadataFilter Dot separated string to filter by metadata values Same &lt;metadata_name&gt; will result in OR queries. Different &lt;metadata_name&gt; will result in AND queries. Example: &lt;metadata_name&gt;.&lt;payload_key_to_search&gt;&#x3D;&lt;payload_value_to_search&gt;
+     * List Asset Hierarchies
+     * List Asset Hierarchies  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static listAssetHierarchies(options?: IKvHttpRequestOptions): Observable<AssetHierarchyListFull>;
+    /**
+     * List Asset Template
+     * List Asset Template  **Pagination Sortable Columns:** &#x60;asset_template.name&#x60;, &#x60;asset_template.title&#x60;, &#x60;asset_template.created&#x60;, &#x60;asset_template.updated&#x60;, &#x60;asset_template.asset_type_name&#x60;, &#x60;asset_template.device_type_name&#x60;  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
+     * @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 listAssetType({ search, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListAssetTypeParams, options?: IKvHttpRequestOptions): Observable<AssetTypeListPaginated>;
+    static listAssetTemplate({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc, assetTypeNames, deviceTypeNames, assetClassNames, owner }?: IListAssetTemplateParams, options?: IKvHttpRequestOptions): Observable<AssetTemplateListPaginated>;
     /**
-     * List Asset Type Metadata
-     * List Asset Type Metadata  **Pagination Sortable Columns:** &#x60;asset_type_metadata.name&#x60;  **Permission Required:** &#x60;kelvin.permission.asset_type.read&#x60;
-     * @param assetTypeName Asset Type name
-     * @param search Search Asset Type Metadata by name
+     * List Asset Type
+     * List Asset Type  **Pagination Sortable Columns:** &#x60;asset_type.name&#x60;, &#x60;asset_type.title&#x60;, &#x60;asset_type.created&#x60;, &#x60;asset_type.updated&#x60;, &#x60;asset_class.name&#x60;, &#x60;asset_class.title&#x60;, &#x60;asset_type.owner&#x60;  **Permission Required:** &#x60;kelvin.permission.asset_type.read&#x60;
+     * @param search Search asset type by name or title
+     * @param assetClassName Filter asset type by asset class
+     * @param metadata Inject metadata into the response
+     * @param metadataFilter Dot separated string to filter by metadata values Same &lt;metadata_name&gt; will result in OR queries. Different &lt;metadata_name&gt; will result in AND queries. Example: &lt;metadata_name&gt;.&lt;payload_key_to_search&gt;&#x3D;&lt;payload_value_to_search&gt;
      * @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 listAssetTypeMetadata({ assetTypeName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListAssetTypeMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetTypeMetadataListPaginated>;
+    static listAssetType({ search, assetClassName, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc, owner }?: IListAssetTypeParams, options?: IKvHttpRequestOptions): Observable<AssetTypeListPaginated>;
     /**
-     * List Asset Workloads
-     * List Asset Workloads  **Permission Required:** &#x60;kelvin.permission.asset.read&#x60;
-     * @param assetName Asset name
+     * List Asset Type Metadata
+     * List Asset Type Metadata  **Pagination Sortable Columns:** &#x60;asset_type_metadata.name&#x60;  **Permission Required:** &#x60;kelvin.permission.asset_type.read&#x60;
+     * @param assetTypeName Asset Type name
+     * @param search Search Asset Type Metadata by 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
@@ -166,24 +215,32 @@ export declare class AssetService extends BaseService {
      * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: true
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listAssetWorkloads({ assetName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListAssetWorkloadsParams, options?: IKvHttpRequestOptions): Observable<WorkloadListPaginated>;
+    static listAssetTypeMetadata({ assetTypeName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListAssetTypeMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetTypeMetadataListPaginated>;
     /**
      * Update Asset
      * Update Asset  **Permission Required:** &#x60;kelvin.permission.asset.update&#x60;
      * @param asset Asset update schema
      * @param assetName Asset name
+     * @param dryRun Dry Run
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static updateAsset({ asset, assetName }: IUpdateAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
+    static updateAsset({ asset, assetName, dryRun }: IUpdateAssetParams, options?: IKvHttpRequestOptions): Observable<Asset>;
     /**
-     * Update Asset Metadata
-     * Update Asset Metadata  **Permission Required:** &#x60;kelvin.permission.asset.update&#x60;
-     * @param assetmetadata Asset Metadata update schema
-     * @param assetName Asset name
-     * @param assetMetadataName Asset Metadata name
+     * Update Asset Class
+     * Update Asset Class  **Permission Required:** &#x60;kelvin.permission.asset_class.update&#x60;
+     * @param assetClass AssetClass update schema
+     * @param assetClassName Asset Class Name
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static updateAssetMetadata({ assetmetadata, assetName, assetMetadataName }: IUpdateAssetMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetMetadata>;
+    static updateAssetClass({ assetClass, assetClassName }: IUpdateAssetClassParams, options?: IKvHttpRequestOptions): Observable<AssetClass>;
+    /**
+     * Update Asset Template
+     * Update Asset Template  **Permission Required:** &#x60;kelvin.permission.asset.update&#x60;
+     * @param assetTemplate Asset Template update schema
+     * @param assetTemplateName Asset Template Name
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static updateAssetTemplate({ assetTemplate, assetTemplateName }: IUpdateAssetTemplateParams, options?: IKvHttpRequestOptions): Observable<AssetTemplate>;
     /**
      * Update Asset Type
      * Update Asset Type  **Permission Required:** &#x60;kelvin.permission.asset_type.update&#x60;
@@ -201,4 +258,12 @@ export declare class AssetService extends BaseService {
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static updateAssetTypeMetadata({ assettypemetadata, assetTypeName, assetTypeMetadataName }: IUpdateAssetTypeMetadataParams, options?: IKvHttpRequestOptions): Observable<AssetTypeMetadata>;
+    /**
+     * Upload Assets
+     * Upload Assets  **Permission Required:** &#x60;kelvin.permission.asset.create&#x60;
+     * @param file CSV File
+     * @param dryRun If set to true performs only validation
+     * @param {IKvHttpRequestOptions} options Request optional parameters
+     */
+    static uploadAssets({ file, dryRun }: IUploadAssetsParams, options?: IKvHttpRequestOptions): Observable<AssetHierarchyList>;
 }