@kelvininc/js-client-sdk 7.12.0 → 7.18.0

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

@@ -9,7 +9,7 @@ const base_service_1 = require("../../base.service");
 class DataLabelService extends base_service_1.BaseService {
     /**
      * Create Data Label
-     * Create Data Label  **Note:** * If `label_name` is provided and does not exist, it will create a new label * The `source.type` can be `workload` or `user`  **Permission Required:** `kelvin.permission.data_label.create`
+     * Create Data Label  <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> are a way to annotate specific events for one or more <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs.  This is particularly useful if you need to freeze a set of data points and decision making notes from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> and/or from third party applications (such as an MES or a specialized machine learning model) in one data package that can be visualized on a dashboard or retrieved at a later date for analysis.  **Permission Required:** `kelvin.permission.data_label.create`
      * @param datalabel DataLabel create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -18,13 +18,13 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = datalabel;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/create`, requestConfig, models_1.DataLabel);
     }
     /**
      * Create Label
-     * Create Label  **Permission Required:** `kelvin.permission.data_label.create`
+     * Create Label  Creates a label that can be used as a reference and filter in <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a>.  Tip: When a create/update <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> API request is performed and the Label does not exist, this `Create Label` API request will be automatically performed.  **Permission Required:** `kelvin.permission.data_label.create`
      * @param label Label create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -33,14 +33,14 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = label;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/create`, requestConfig, models_1.Label);
     }
     /**
      * Create Label Metadata
-     * Create Label Metadata  **Permission Required:** `kelvin.permission.data_label.create`
-     * @param labelName Label name
+     * Create Label Metadata  Creates a custom JSON payload that can be attached to a Label. You can create multiple different types of metadata payloads for each Label.  When performing a `get` or `list` API request on Label or <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> then you can also add this metadata name. This Label Metadata payload will then be embedded in the response.  For listing Labels you can also perform filters on the Label Metadata payload to only return labels with Metadata Label payload parameters matching the filters.  This Label Metadata does not affect the operations of Labels or <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> on the Kelvin Platform. Label Metadata is not available in the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-manager-ui\" target=\"_blank\">Kelvin Manager UI</a>.  **Permission Required:** `kelvin.permission.data_label.create`
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param labelmetadata Label Metadata create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -49,13 +49,13 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = labelmetadata;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/${encodeURIComponent(String(labelName))}/metadata/create`, requestConfig, models_1.LabelMetadata);
     }
     /**
      * Create Label Metadata Bulk
-     * Create Label Metadata Bulk  **Permission Required:** `kelvin.permission.data_label.create`
+     * Create Label Metadata Bulk  Bulk create option for create Label Metadata API which creates a custom JSON payload that can be attached to a Label. You can create multiple different types of metadata payloads for each Label.  When performing a `get` or `list` API request on Label or <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> then you can also add a metadata parameter. The Label Metadata payload will then be embedded in the response.  For listing Labels you can also perform filters on the Label Metadata payload to only return labels with Metadata Label payload parameters matching the filters.  This Label Metadata does not affect the operations of Labels or <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> on the Kelvin Platform. Label Metadata is not available in the <a href=\"https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-manager-ui\" target=\"_blank\">Kelvin Manager UI</a>.  **Permission Required:** `kelvin.permission.data_label.create`
      * @param labelmetadatabulk Label Bulk Metadata create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -64,56 +64,56 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = labelmetadatabulk;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/metadata/create`, requestConfig);
     }
     /**
      * Delete Data Label
-     * Delete Data Label  **Permission Required:** `kelvin.permission.data_label.delete`
-     * @param datalabelId Data Label id
+     * Delete Data Label  Permanently delete an existing <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a>. This cannot be undone once the API request has been submitted.  **Permission Required:** `kelvin.permission.data_label.delete`
+     * @param datalabelId Unique integer number for the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Label</a> to update.</p> This is similar to a primary key in a database which is a unique integer number representing one row of data.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static deleteDataLabel({ datalabelId }, options) {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/${encodeURIComponent(String(datalabelId))}/delete`, requestConfig);
     }
     /**
      * Delete Label
-     * Delete Label  **Permission Required:** `kelvin.permission.data_label.delete`
-     * @param labelName Label name
+     * Delete Label  Permanently delete an existing Label. This cannot be undone once the API request has been submitted.  <span style=\"color: #ff0000;font-weight: bold;\">WARNING</span> : If you delete a Label, all related <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> will also be permanently deleted !  **Permission Required:** `kelvin.permission.data_label.delete`
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static deleteLabel({ labelName }, options) {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/${encodeURIComponent(String(labelName))}/delete`, requestConfig);
     }
     /**
      * Delete Label Metadata
-     * Delete Label Metadata  **Permission Required:** `kelvin.permission.data_label.delete`
-     * @param labelName Label name
-     * @param labelMetadataName Label Metadata name
+     * Delete Label Metadata  Permanently delete an existing Label Metadata object associated with a specific Label. This cannot be undone once the API request has been submitted.  This will only delete the specific Label Metadata object linked to the Label. If there is a Label Metadata object with the same name and payload BUT associated with a different Label, this will not be deleted.  **Permission Required:** `kelvin.permission.data_label.delete`
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param labelMetadataName Label Metadata unique identifier name to retrieve.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static deleteLabelMetadata({ labelName, labelMetadataName }, options) {
         const requestConfig = {
             method: 'post'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/${encodeURIComponent(String(labelName))}/metadata/${encodeURIComponent(String(labelMetadataName))}/delete`, requestConfig);
     }
     /**
      * Delete Label Metadata Bulk
-     * Delete Label Metadata Bulk  **Permission Required:** `kelvin.permission.data_label.delete`
+     * Delete Label Metadata Bulk  Bulk delete option for delete Label Metadata API which permanently deletes an existing Label Metadata object associated with a specific Label. This cannot be undone once the API request has been submitted.  This will only delete the specific Label Metadata object linked to the Label. If there is a Label Metadata object with the same name and payload BUT associated with a different Label, this will not be deleted.  **Permission Required:** `kelvin.permission.data_label.delete`
      * @param labelmetadatabulk Label Bulk Metadata delete schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -122,19 +122,19 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = labelmetadatabulk;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/metadata/delete`, requestConfig);
     }
     /**
      * Filter Data Label
-     * Filter Data Label  **Pagination Sortable Columns:** `data_label.id`  **Permission Required:** `kelvin.permission.data_label.read`
+     * Filter Data Label  An advanced version of List Data Label which allows you to also filter on <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs.  All other options in List Data Label API are also available in this API request.  **Pagination Sortable Columns:** `data_label.id`  **Permission Required:** `kelvin.permission.data_label.read`
      * @param datalabelfilter Data Label filter schema
-     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
-     * @param startingAfter Lower bound cursor for use in pagination
-     * @param endingBefore Upper bound cursor for use in pagination
-     * @param sortBy Parameter to sort by. Must be one of the sortable columns
-     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: false
+     * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> objects.
+     * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response 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/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response 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/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> parameters. Only one parameter can be selected.</p> There in only one parameter option; `data_label.id`.</p> The default is `data_label.id`
+     * @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 {IKvHttpRequestOptions} options Request optional parameters
      */
     static filterDataLabel({ datalabelfilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
@@ -159,27 +159,27 @@ class DataLabelService extends base_service_1.BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = datalabelfilter;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/filter`, requestConfig, models_1.DataLabelListPaginated);
     }
     /**
      * Get Data Label
-     * Get Data Label  **Permission Required:** `kelvin.permission.data_label.read`
-     * @param datalabelId Data Label id
+     * Get Data Label  Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Label</a>.  **Permission Required:** `kelvin.permission.data_label.read`
+     * @param datalabelId Unique integer number for the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Label</a> to update.</p> This is similar to a primary key in a database which is a unique integer number representing one row of data.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getDataLabel({ datalabelId }, options) {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/${encodeURIComponent(String(datalabelId))}/get`, requestConfig, models_1.DataLabel);
     }
     /**
      * Get Data Label Last
-     * Get Data Label Last  **Note**: * Between filters a **AND*+ operator is implicit * `label_names`: lists data labels using **OR** operator; * `metrics`: lists data labels using **OR** operator; * `start_date`: lists data labels with start_date >= query date (RFC3339 format with microseconds); * `end_date`: lists data labels with end_date <= query date (RFC3339 format with microseconds)  **Permission Required:** `kelvin.permission.data_label.read`
+     * Get Data Label Last  Retrieve the properties of only the last <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Label</a> entry.</p> Some options are available to limit the search criteria or range. </p> Finding the last entry can be limited to either after `start_date` or before `end_date` or between the two dates. Also an array of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs or Label names can be filtered.  **Permission Required:** `kelvin.permission.data_label.read`
      * @param datalabelrangeget Data Label range get schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -188,13 +188,13 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = datalabelrangeget;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/last/get`, requestConfig, models_1.DataLabel);
     }
     /**
      * Get Data Label Range
-     * Get Data Label Range  **Note**: * Between filters a **AND*+ operator is implicit * `label_names`: lists data labels using **OR** operator; * `metrics`: lists data labels using **OR** operator; * `start_date`: lists data labels with start_date >= query date (RFC3339 format with microseconds); * `end_date`: lists data labels with end_date <= query date (RFC3339 format with microseconds)  **Permission Required:** `kelvin.permission.data_label.read`
+     * Get Data Label Range  Retrieve the properties of a list of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> where the `start_date` or `end_date` of the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> is within the range of this GET API `start_date` and `end_date`.  **Permission Required:** `kelvin.permission.data_label.read`
      * @param datalabelrangeget Data Label range get schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -203,13 +203,13 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = datalabelrangeget;
-        requestConfig.mediaType = 'application/x-json-stream';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/x-json-stream';
         return this.request(`/datalabels/range/get`, requestConfig, models_1.DataLabel);
     }
     /**
      * Get Data Labels Clustering
-     * Get Data Labels Clustering  **Note**: * `time_bucket`: needed to aggregate a cluster. Use Go parsing for duration: https://golang.org/pkg/time/#ParseDuration * `label_names`: lists data labels using **OR** operator; * `metrics`: lists data labels using **OR** operator; * `start_date`: lists data labels with start_date >= query date (RFC3339 format with microseconds); * `end_date`: lists data labels with end_date <= query date (RFC3339 format with microseconds)  **Permission Required:** `kelvin.permission.data_label.read`
+     * Get Data Labels Clustering  Groups and counts the occurrence of Label Names within a defined time bucket for recorded <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a>.  The grouping can also be filtered to only include certain parameters of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a>.  For example you can filter on Label names, <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs, and time range.  **Permission Required:** `kelvin.permission.data_label.read`
      * @param datalabelclustering Data Label range cluster schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -218,15 +218,15 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = datalabelclustering;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/clustering/get`, requestConfig, models_1.DataLabelCluster);
     }
     /**
      * Get Label
-     * Get Label  **Permission Required:** `kelvin.permission.data_label.read`
-     * @param labelName Label name
-     * @param metadata Inject metadata into the response
+     * Get Label  Retrieve the properties of a Label.  **Permission Required:** `kelvin.permission.data_label.read`
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param metadata Inject Label Metadata into the response
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getLabel({ labelName, metadata }, options) {
@@ -238,34 +238,34 @@ class DataLabelService 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(`/datalabels/labels/${encodeURIComponent(String(labelName))}/get`, requestConfig, models_1.Label);
     }
     /**
      * Get Label Metadata
-     * Get Label Metadata  **Permission Required:** `kelvin.permission.data_label.read`
-     * @param labelName Label name
-     * @param labelMetadataName Label Metadata name
+     * Get Label Metadata  Retrieves the Label Metadata object associated with a Label.  This will only retrieve the specific Label Metadata object linked to the Label. If there is a Label Metadata object with the same name and payload BUT associated with a different Label, this will not be retrieved.  **Permission Required:** `kelvin.permission.data_label.read`
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param labelMetadataName Label Metadata unique identifier name to retrieve.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getLabelMetadata({ labelName, labelMetadataName }, options) {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/${encodeURIComponent(String(labelName))}/metadata/${encodeURIComponent(String(labelMetadataName))}/get`, requestConfig, models_1.LabelMetadata);
     }
     /**
      * List Data Label
-     * List Data Label  **Pagination Sortable Columns:** `data_label.id`  **Permission Required:** `kelvin.permission.data_label.read`
-     * @param search Search datalabels by description and label name
-     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
-     * @param startingAfter Lower bound cursor for use in pagination
-     * @param endingBefore Upper bound cursor for use in pagination
-     * @param sortBy Parameter to sort by. Must be one of the sortable columns
-     * @param sortAsc Order of sorting is Ascending. Possible Values: true/false. Default: false
+     * List Data Label  Returns an array of dictionary objects with all the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> based on any of the parameters given. If no parameters are given, all <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> will be returned.  **Pagination Sortable Columns:** `data_label.id`  **Permission Required:** `kelvin.permission.data_label.read`
+     * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> list. Both the Display Name (title) and the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> name or display name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
+     * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> objects.
+     * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response 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/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response 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/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> parameters. Only one parameter can be selected.</p> There in only one parameter option; `data_label.id`.</p> The default is `data_label.id`
+     * @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 {IKvHttpRequestOptions} options Request optional parameters
      */
     static listDataLabel({ search, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
@@ -292,22 +292,22 @@ class DataLabelService 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(`/datalabels/list`, requestConfig, models_1.DataLabelListPaginated);
     }
     /**
      * List Label
-     * List Label  **Pagination Sortable Columns:** `label.name`  **Permission Required:** `kelvin.permission.data_label.read`
-     * @param names Filter labels by name
-     * @param search Search Labels by name or title
-     * @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 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 Label  Returns a dictionary with a data property containing a list of all Labels on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.  **Pagination Sortable Columns:** `label.name`  **Permission Required:** `kelvin.permission.data_label.read`
+     * @param names Filter Label on the parameter by its name. This is given as an array, for example `[extruder,tank]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `[extruder,tank]` will return Labels with the name `extruder` but not with the names `demo-ch-extruder-gear-setpoint` or `demo-og-gas-tank-level`.
+     * @param search Search and filter the Label list. Both the Display Name (title) and the Name will be included in the filter field criteria. This is given as an array, for example `[extruder,tank]`.</p> The search is case insensitive and will find partial matches as well. For example if a Label name or display name is `demo-og-centrifugal-pump-speed`, then a match will be made if the filter string is `demo` or `FUGaL`.
+     * @param metadata Inject Label Metadata into the response
+     * @param metadataFilter Array of metadata keys/value filter conditions. For <metadata_name> with the same name, the filter conditions will result in OR queries. For <metadata_name> with different names will result in AND queries. Example: [ <metadata_name>.<payload_key_to_search>=<payload_value_to_search>, <metadata_name2>.<payload_key2_to_search>=<payload_value2_to_search> ]
+     * @param pageSize Number of Label objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 Label objects.
+     * @param startingAfter An alphanumeric string to move to the next page of Labels 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 Labels 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 Label parameters. Only one parameter can be selected.</p> There is only parameter option available which is also the default; `label.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 {IKvHttpRequestOptions} options Request optional parameters
      */
     static listLabel({ names, search, metadata, metadataFilter, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
@@ -343,20 +343,20 @@ class DataLabelService 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(`/datalabels/labels/list`, requestConfig, models_1.LabelListPaginated);
     }
     /**
      * List Label Metadata
-     * List Label Metadata  **Pagination Sortable Columns:** `label_metadata.name`, `label_metadata.label_name`  **Permission Required:** `kelvin.permission.data_label.read`
-     * @param labelName Label name
-     * @param search Search Label 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
-     * @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 Label Metadata  Returns a filtered list of Label Metadata objects linked with a Label.  The path parameter is required but the query parameters are optional. If no query parameters are given with the API request, then the defaults will be used to return the Label Metadata list. The defaults are the first 20 Label Metadata linked to the Label returned in alphabetical order by the unique identifier name.  **Pagination Sortable Columns:** `label_metadata.name`, `label_metadata.label_name`  **Permission Required:** `kelvin.permission.data_label.read`
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param search Search and filter the Label Metadata objects list. Only the Name will be included in the search field criteria. This is given as an array, for example `[pump,fan]`.</p> The search is case insensitive and will find partial matches as well. For example if a Label Metadata name is centrifugal_pump, then a match will be made if the search string is `pum` or `FUGaL`.
+     * @param pageSize Number of Label Metadata objects to be returned. Page size can be between 1 and 1000 objects. The default is 20 Label Metadata objects.
+     * @param startingAfter An alphanumeric string to move to the next page of Label Metadata objects 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 Label Metadata objects 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 Label Metadata parameters. Only one parameter can be selected.</p> There are two parameter options; `label_metadata.name`, `label_metadata.label_name`. The default is `label_metadata.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). The default is `true` (ascending).
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listLabelMetadata({ labelName, search, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
@@ -383,15 +383,15 @@ class DataLabelService 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(`/datalabels/labels/${encodeURIComponent(String(labelName))}/metadata/list`, requestConfig, models_1.LabelMetadataListPaginated);
     }
     /**
      * Update Data Label
-     * Update Data Label  **Note:** * If `metrics` are provided, it will replace the full list * If `label_name` is provided and does not exist, it will create a new label  **Permission Required:** `kelvin.permission.data_label.update`
+     * Update Data Label  <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> are a way to annotate specific events for one or more <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> / <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs.  This is particularly useful if you need to freeze a set of data points and decision making notes from the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> and/or from third party applications (such as an MES or a specialized machine learning model) in one package that can be visualized on a dashboard or retrieved at a later date for analysis.  If `metrics` are provided in the update, it will replace the full existing list.  **Permission Required:** `kelvin.permission.data_label.update`
      * @param datalabel DataLabel update schema
-     * @param datalabelId DataLabel id
+     * @param datalabelId Unique integer number for the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-platform/kelvin-api/kelvin-api-categories/data-labels/' target='_blank'>Kelvin Data Labels</a> to update.</p> This is similar to a primary key in a database which is a unique integer number representing one row of data.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static updateDataLabel({ datalabel, datalabelId }, options) {
@@ -399,15 +399,15 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = datalabel;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/${encodeURIComponent(String(datalabelId))}/update`, requestConfig, models_1.DataLabel);
     }
     /**
      * Update Label
-     * Update Label  **Permission Required:** `kelvin.permission.data_label.update`
+     * Update Label  Update an existing Label with any new values passed through the body parameters.  **Permission Required:** `kelvin.permission.data_label.update`
      * @param label Label update schema
-     * @param labelName Label name
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static updateLabel({ label, labelName }, options) {
@@ -415,16 +415,16 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = label;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/${encodeURIComponent(String(labelName))}/update`, requestConfig, models_1.Label);
     }
     /**
      * Update Label Metadata
-     * Update Label Metadata  **Permission Required:** `kelvin.permission.data_label.update`
+     * Update Label Metadata  Updates the payload of an existing Label Metadata object associated with a Label.  The payload will be completely replaced by the new payload. Any existing key/value pairs that you want to keep must be included in your new payload that is sent with the API request.  This will only update the payload of the specific Label Metadata object linked to the Label. If there is a Label Metadata object with the same name and payload BUT associated with a different Label, this will not be updated.  **Permission Required:** `kelvin.permission.data_label.update`
      * @param labelmetadata Label Metadata update schema
-     * @param labelName Label name
-     * @param labelMetadataName Label Metadata name
+     * @param labelName Unique identifier name for the Label.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param labelMetadataName Label Metadata unique identifier name to retrieve.</p> This must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static updateLabelMetadata({ labelmetadata, labelName, labelMetadataName }, options) {
@@ -432,8 +432,8 @@ class DataLabelService extends base_service_1.BaseService {
             method: 'post'
         };
         requestConfig.data = labelmetadata;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/datalabels/labels/${encodeURIComponent(String(labelName))}/metadata/${encodeURIComponent(String(labelMetadataName))}/update`, requestConfig, models_1.LabelMetadata);
     }
 }