@kelvininc/js-client-sdk 7.12.0 → 7.13.2

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

@@ -1,5 +1,6 @@
 import { Asset, AssetClass, AssetClassListPaginated, AssetDataStreamsListPaginated, AssetHierarchies, AssetHierarchyList, AssetListPaginated, AssetOEE, AssetStatisticsPaginated, AssetStatus, AssetStatusCount, AssetTemplate, AssetTemplateListPaginated, AssetType, AssetTypeListPaginated, AssetTypeMetadata, AssetTypeMetadataListPaginated, FailureOverviewPaginated } from '../../../models';
 import { BaseService } from '../../base.service';
+import { EPaginatorType } from '../../pagination/paginator.types';
 /**
  * @category Service
  */
@@ -21,8 +22,8 @@ export class AssetService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = asset;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/create`, requestConfig, Asset);
     }
     /**
@@ -36,8 +37,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assetClass;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/class/create`, requestConfig, AssetClass);
     }
     /**
@@ -51,8 +52,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assetTemplate;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/templates/create`, requestConfig, AssetTemplate);
     }
     /**
@@ -66,8 +67,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assettype;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/create`, requestConfig, AssetType);
     }
     /**
@@ -82,8 +83,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assettypemetadata;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/create`, requestConfig, AssetTypeMetadata);
     }
     /**
@@ -96,8 +97,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/${encodeURIComponent(String(assetName))}/delete`, requestConfig);
     }
     /**
@@ -110,8 +111,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/class/${encodeURIComponent(String(assetClassName))}/delete`, requestConfig);
     }
     /**
@@ -124,8 +125,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/templates/${encodeURIComponent(String(assetTemplateName))}/delete`, requestConfig);
     }
     /**
@@ -138,8 +139,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/delete`, requestConfig);
     }
     /**
@@ -153,8 +154,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/${encodeURIComponent(String(assetTypeMetadataName))}/delete`, requestConfig);
     }
     /**
@@ -173,8 +174,8 @@ export class AssetService extends BaseService {
             queryParameters['metadata'] = metadata;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/${encodeURIComponent(String(assetName))}/get`, requestConfig, Asset);
     }
     /**
@@ -187,8 +188,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/class/${encodeURIComponent(String(assetClassName))}/get`, requestConfig, AssetClass);
     }
     /**
@@ -200,8 +201,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/hierarchy/get`, requestConfig, AssetHierarchies);
     }
     /**
@@ -224,8 +225,8 @@ export class AssetService extends BaseService {
             queryParameters['asset_type_depth'] = assetTypeDepth;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/${encodeURIComponent(String(assetName))}/hierarchy/get`, requestConfig, Asset);
     }
     /**
@@ -245,8 +246,8 @@ export class AssetService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = assetNames;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/oee/get`, requestConfig, AssetOEE);
     }
     /**
@@ -282,8 +283,8 @@ export class AssetService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = asset;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/statistics/get`, requestConfig, AssetStatisticsPaginated);
     }
     /**
@@ -295,8 +296,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/status/count/get`, requestConfig, AssetStatusCount);
     }
     /**
@@ -308,8 +309,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/status/current/get`, requestConfig, AssetStatus);
     }
     /**
@@ -322,8 +323,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/templates/${encodeURIComponent(String(assetTemplateName))}/get`, requestConfig, AssetTemplate);
     }
     /**
@@ -342,8 +343,8 @@ export class AssetService extends BaseService {
             queryParameters['metadata'] = metadata;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/get`, requestConfig, AssetType);
     }
     /**
@@ -357,8 +358,8 @@ export class AssetService extends BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/${encodeURIComponent(String(assetTypeMetadataName))}/get`, requestConfig, AssetTypeMetadata);
     }
     /**
@@ -424,8 +425,8 @@ export class AssetService extends BaseService {
             queryParameters['sort_asc'] = sortAsc;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/list`, requestConfig, AssetListPaginated);
     }
     /**
@@ -471,8 +472,8 @@ export class AssetService extends BaseService {
             queryParameters['entity_type_name'] = entityTypeName;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/class/list`, requestConfig, AssetClassListPaginated);
     }
     /**
@@ -509,8 +510,8 @@ export class AssetService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = assetDatastreams;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/${encodeURIComponent(String(assetName))}/datastreams/list`, requestConfig, AssetDataStreamsListPaginated);
     }
     /**
@@ -564,8 +565,8 @@ export class AssetService extends BaseService {
             queryParameters['owner'] = owner;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/templates/list`, requestConfig, AssetTemplateListPaginated);
     }
     /**
@@ -623,8 +624,8 @@ export class AssetService extends BaseService {
             queryParameters['entity_type_name'] = entityTypeName;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/list`, requestConfig, AssetTypeListPaginated);
     }
     /**
@@ -663,45 +664,58 @@ export class AssetService extends BaseService {
             queryParameters['sort_asc'] = sortAsc;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/list`, requestConfig, AssetTypeMetadataListPaginated);
     }
     /**
      * List Failure Overview
-     * List Failure Overview  Returns a dictionary with a data property containing an array of failure overview summaries for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> objects that have failures recorded on the Kelvin Platform based on the filter requirements in the body parameters.  This will summarize all failures on <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> and give the failure quotient per <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>.  **Pagination Sortable Columns:** `asset.name`, `asset.title`, `asset.failure_quotient`, `asset_type.title`  **Permission Required:** `kelvin.permission.asset.read`
+     * List Failure Overview  Returns a dictionary with a data property containing an array of failure overview summaries for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> objects that have failures recorded on the Kelvin Platform based on the filter requirements in the body parameters.  This will summarize all failures on <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-hierarchy' target='_blank'>hierarchy</a> of each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> and give the failure quotient per <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a>.  **Pagination Sortable Columns:** `name`, `title`, `asset_type_name`, `asset_type_title`, `device_type_name`, `device_type_title`, `failure_quotient`, `severity`, `total_sev1`, `total_sev2`, `total_sev3`, `total_sev4`, `total_sev5`  **Permission Required:** `kelvin.permission.asset.read`
      * @param asset Failure Overview schema
-     * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Asset</a> failure overview objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Kelvin Asset Statistic 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 Asset</a> failure overviews 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 Asset</a> failure overviews 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 Asset</a> failure overview parameters. Only one parameter can be selected.</p> There are three parameter options; `asset.name`, `asset.title`, `asset.failure_quotient` and `asset_type.title`.</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 paginationType Desired pagination type
+     * @param pageSize Desired page size
+     * @param page Desired page. Only valid for type=limits pagination
+     * @param next Retrieve next page. Only valid for type=cursor pagination
+     * @param previous Retrieve previous page. Only valid for type=cursor pagination
+     * @param direction Direction in which to sort the data
+     * @param sortBy Columns by which to sort the data
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static listFailureOverview({ asset, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
+    static listFailureOverview({ asset, paginationType, pageSize, page, next, previous, direction, sortBy }, options) {
         const requestConfig = {
             method: 'post'
         };
         const queryParameters = {};
+        if (paginationType != null) {
+            queryParameters['pagination_type'] = paginationType;
+        }
         if (pageSize != null) {
             queryParameters['page_size'] = pageSize;
         }
-        if (startingAfter != null) {
-            queryParameters['starting_after'] = startingAfter;
+        if (page != null) {
+            queryParameters['page'] = page;
         }
-        if (endingBefore != null) {
-            queryParameters['ending_before'] = endingBefore;
+        if (next != null) {
+            queryParameters['next'] = next;
+        }
+        if (previous != null) {
+            queryParameters['previous'] = previous;
+        }
+        if (direction != null) {
+            queryParameters['direction'] = direction;
         }
         if (sortBy != null) {
             queryParameters['sort_by'] = sortBy;
         }
-        if (sortAsc != null) {
-            queryParameters['sort_asc'] = sortAsc;
-        }
         requestConfig.params = queryParameters;
         requestConfig.data = asset;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        if (paginationType === EPaginatorType.Stream) {
+            requestConfig.mediaType = 'application/x-json-stream';
+        }
+        else {
+            requestConfig.mediaType = 'application/json';
+        }
         return this.request(`/assets/failure-overview/list`, requestConfig, FailureOverviewPaginated);
     }
     /**
@@ -722,8 +736,8 @@ export class AssetService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = asset;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/${encodeURIComponent(String(assetName))}/update`, requestConfig, Asset);
     }
     /**
@@ -738,8 +752,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assetClass;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/class/${encodeURIComponent(String(assetClassName))}/update`, requestConfig, AssetClass);
     }
     /**
@@ -759,8 +773,8 @@ export class AssetService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = hierarchy;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/hierarchy/update`, requestConfig);
     }
     /**
@@ -775,8 +789,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assetTemplate;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/templates/${encodeURIComponent(String(assetTemplateName))}/update`, requestConfig, AssetTemplate);
     }
     /**
@@ -791,8 +805,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assettype;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/update`, requestConfig, AssetType);
     }
     /**
@@ -808,8 +822,8 @@ export class AssetService extends BaseService {
             method: 'post'
         };
         requestConfig.data = assettypemetadata;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/${encodeURIComponent(String(assetTypeName))}/metadata/${encodeURIComponent(String(assetTypeMetadataName))}/update`, requestConfig, AssetTypeMetadata);
     }
     /**
@@ -833,8 +847,8 @@ export class AssetService extends BaseService {
             formParams.append('file', file);
         }
         requestConfig.data = formParams;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/create/upload`, requestConfig, AssetHierarchyList);
     }
 }