@kelvininc/js-client-sdk 7.12.0 → 7.13.2

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetService = void 0;
 const models_1 = require("../../../models");
 const base_service_1 = require("../../base.service");
+const paginator_types_1 = require("../../pagination/paginator.types");
 /**
  * @category Service
  */
@@ -24,8 +25,8 @@ class AssetService extends base_service_1.BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = asset;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/create`, requestConfig, models_1.Asset);
     }
     /**
@@ -39,8 +40,8 @@ class AssetService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = assetClass;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/class/create`, requestConfig, models_1.AssetClass);
     }
     /**
@@ -54,8 +55,8 @@ class AssetService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = assetTemplate;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/templates/create`, requestConfig, models_1.AssetTemplate);
     }
     /**
@@ -69,8 +70,8 @@ class AssetService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = assettype;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/types/create`, requestConfig, models_1.AssetType);
     }
     /**
@@ -85,8 +86,8 @@ class AssetService extends base_service_1.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, models_1.AssetTypeMetadata);
     }
     /**
@@ -99,8 +100,8 @@ class AssetService extends base_service_1.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);
     }
     /**
@@ -113,8 +114,8 @@ class AssetService extends base_service_1.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);
     }
     /**
@@ -127,8 +128,8 @@ class AssetService extends base_service_1.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);
     }
     /**
@@ -141,8 +142,8 @@ class AssetService extends base_service_1.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);
     }
     /**
@@ -156,8 +157,8 @@ class AssetService extends base_service_1.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);
     }
     /**
@@ -176,8 +177,8 @@ class AssetService extends base_service_1.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, models_1.Asset);
     }
     /**
@@ -190,8 +191,8 @@ class AssetService extends base_service_1.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, models_1.AssetClass);
     }
     /**
@@ -203,8 +204,8 @@ class AssetService extends base_service_1.BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/hierarchy/get`, requestConfig, models_1.AssetHierarchies);
     }
     /**
@@ -227,8 +228,8 @@ class AssetService extends base_service_1.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, models_1.Asset);
     }
     /**
@@ -248,8 +249,8 @@ class AssetService extends base_service_1.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, models_1.AssetOEE);
     }
     /**
@@ -285,8 +286,8 @@ class AssetService extends base_service_1.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, models_1.AssetStatisticsPaginated);
     }
     /**
@@ -298,8 +299,8 @@ class AssetService extends base_service_1.BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/status/count/get`, requestConfig, models_1.AssetStatusCount);
     }
     /**
@@ -311,8 +312,8 @@ class AssetService extends base_service_1.BaseService {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/assets/status/current/get`, requestConfig, models_1.AssetStatus);
     }
     /**
@@ -325,8 +326,8 @@ class AssetService extends base_service_1.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, models_1.AssetTemplate);
     }
     /**
@@ -345,8 +346,8 @@ class AssetService extends base_service_1.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, models_1.AssetType);
     }
     /**
@@ -360,8 +361,8 @@ class AssetService extends base_service_1.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, models_1.AssetTypeMetadata);
     }
     /**
@@ -427,8 +428,8 @@ class AssetService extends base_service_1.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, models_1.AssetListPaginated);
     }
     /**
@@ -474,8 +475,8 @@ class AssetService extends base_service_1.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, models_1.AssetClassListPaginated);
     }
     /**
@@ -512,8 +513,8 @@ class AssetService extends base_service_1.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, models_1.AssetDataStreamsListPaginated);
     }
     /**
@@ -567,8 +568,8 @@ class AssetService extends base_service_1.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, models_1.AssetTemplateListPaginated);
     }
     /**
@@ -626,8 +627,8 @@ class AssetService extends base_service_1.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, models_1.AssetTypeListPaginated);
     }
     /**
@@ -666,45 +667,58 @@ class AssetService extends base_service_1.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, models_1.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 === paginator_types_1.EPaginatorType.Stream) {
+            requestConfig.mediaType = 'application/x-json-stream';
+        }
+        else {
+            requestConfig.mediaType = 'application/json';
+        }
         return this.request(`/assets/failure-overview/list`, requestConfig, models_1.FailureOverviewPaginated);
     }
     /**
@@ -725,8 +739,8 @@ class AssetService extends base_service_1.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, models_1.Asset);
     }
     /**
@@ -741,8 +755,8 @@ class AssetService extends base_service_1.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, models_1.AssetClass);
     }
     /**
@@ -762,8 +776,8 @@ class AssetService extends base_service_1.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);
     }
     /**
@@ -778,8 +792,8 @@ class AssetService extends base_service_1.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, models_1.AssetTemplate);
     }
     /**
@@ -794,8 +808,8 @@ class AssetService extends base_service_1.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, models_1.AssetType);
     }
     /**
@@ -811,8 +825,8 @@ class AssetService extends base_service_1.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, models_1.AssetTypeMetadata);
     }
     /**
@@ -836,8 +850,8 @@ class AssetService extends base_service_1.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, models_1.AssetHierarchyList);
     }
 }