@kelvininc/js-client-sdk 7.13.2 → 7.18.0

package/dist/esm/services/generated/api/map.service.d.ts

@@ -9,115 +9,115 @@ import { ICreateMapOEEParams, ICreateMapParams, ICreateMapShiftParams, ICreateSy
 export declare class MapService extends BaseService {
     /**
      * Create Map
-     * Create Map  **Permission Required:** `kelvin.permission.maps.create`
+     * Create a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview' target='_blank'>Kelvin Maps</a>.  **Permission Required:** `kelvin.permission.maps.create`
      * @param map Map create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static createMap({ map }: ICreateMapParams, options?: IKvHttpRequestOptions): Observable<MapModel>;
     /**
      * Create Map OEE
-     * Create Map OEE  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
+     * Create new OEE data for the selected &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.  When new OEE data is created, the current OEE data will be timestamped with an end_date which is the same as the start_date for the new OEE data. This timestamp is automatically generated from the current time when the API request is submitted.  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
      * @param mapOee Map OEE create schema
-     * @param mapName Map name
+     * @param mapName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; to save the data to.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; 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 createMapOEE({ mapOee, mapName }: ICreateMapOEEParams, options?: IKvHttpRequestOptions): Observable<MapOEE>;
     /**
      * Create Map Shift
-     * Create Map Shift  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
+     * Create a new Shift for the selected &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.  When a new Shift is created, the current Shift will be timestamped with an end_date which is the same as the start_date for the new shift. This timestamp is automatically generated from the current time when the API request is submitted.  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
      * @param mapShift Map Shift create schema
-     * @param mapName Map name
+     * @param mapName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; to save the data to.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; 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 createMapShift({ mapShift, mapName }: ICreateMapShiftParams, options?: IKvHttpRequestOptions): Observable<MapShift>;
     /**
      * Create Symbol
-     * Create Symbol  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
+     * Create a new Symbol for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; library.&lt;/p&gt; This will be available for use in all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt;.  **Permission Required:** &#x60;kelvin.permission.maps.create&#x60;
      * @param symbol Symbol create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static createSymbol({ symbol }: ICreateSymbolParams, options?: IKvHttpRequestOptions): Observable<Symbol>;
     /**
      * Delete Map
-     * Delete Map  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;
-     * @param mapName Map name
+     * Permanently delete an existing &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;. This cannot be undone once the API request has been submitted. &lt;/p&gt;This will also delete all version of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;
+     * @param mapName Unique identifier name of the wanted &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; 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 deleteMap({ mapName }: IDeleteMapParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
     /**
      * Delete Symbol
-     * Delete Symbol  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;
-     * @param symbolName Symbol name
+     * Permanently delete an existing &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt;. This cannot be undone once the API request has been submitted. &lt;/p&gt; Be careful as there will be no warnings if the image is in use in any entity. Any deleted &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbols&lt;/a&gt; in use will not cause any errors to &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; overviews and the affected entities will have a blank space where the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; should be displayed.  **Permission Required:** &#x60;kelvin.permission.maps.delete&#x60;
+     * @param symbolName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt;. This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; 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 deleteSymbol({ symbolName }: IDeleteSymbolParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse>;
     /**
      * Get Map
-     * Get Map  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
-     * @param mapName Map name
-     * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * Retrieve the properties of a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; and all related entities and relationships associated with the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * @param mapName Unique identifier name of the wanted &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param timestamp Timestamp to search for a specific &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; version (supports RFC3339 and Unix timestamps with nanosecond precision).&lt;/p&gt; If no timestamp is given in the query or body parameters, then the current time will be selected which will look at the most recent version of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMap({ mapName, timestamp }: IGetMapParams, options?: IKvHttpRequestOptions): Observable<MapModel>;
     /**
      * Get Map OEE
-     * Get Map OEE  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * Get OEE data for the selected &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;. The shift information returned will be the data that was active for the requested timestamp.  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
      * @param mapNames Map OEE get schema
-     * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param timestamp Timestamp to search for specific OEE data values (supports RFC3339 and Unix timestamps with nanosecond precision).&lt;/p&gt; Example; &#39;2022-07-08T08:41:01.657916Z&#39;.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMapOEE({ mapNames, timestamp }: IGetMapOEEParams, options?: IKvHttpRequestOptions): Observable<MapOEE[]>;
     /**
      * Get Map Shift
-     * Get Map Shift  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * Get Shift data for the selected &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;. The shift information returned will be the data that was active for the requested timestamp.  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
      * @param mapNames Map Shift get schema
-     * @param timestamp Timestamp to search for specific Shift values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param timestamp Timestamp to search for a specific shift (supports RFC3339 and Unix timestamps with nanosecond precision).&lt;/p&gt; Example; &#39;2022-07-08T08:41:01.657916Z&#39;.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMapShift({ mapNames, timestamp }: IGetMapShiftParams, options?: IKvHttpRequestOptions): Observable<MapShift[]>;
     /**
      * List Maps
-     * List Maps  **Pagination Sortable Columns:** &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;start_date&#x60;, &#x60;mode&#x60;, &#x60;map.asset_name&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
-     * @param entity Filter for maps that contain the entity
-     * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
-     * @param mode Filter maps by mode. Possible Values: production/simulation
-     * @param assetName Filter for maps that exist in the context of an asset 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
+     * Returns a dictionary with a data property containing a filtered array of all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; objects on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.  **Pagination Sortable Columns:** &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;start_date&#x60;, &#x60;mode&#x60;, &#x60;map.asset_name&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * @param entity Filter on the entity name in the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt;.
+     * @param timestamp Timestamp to search for a specific &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; version (supports RFC3339 and Unix timestamps with nanosecond precision).&lt;/p&gt; If no timestamp is given in the query or body parameters, then the current time will be selected which will look at the most recent version of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.
+     * @param mode Filter &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; based on the mode key.&lt;/p&gt; There are two parameter options; &#x60;production&#x60; and &#x60;simulation&#x60;.
+     * @param assetName Filter on the name of the parent &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt;.&lt;/p&gt; This &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; must be a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset Group&lt;/a&gt; with a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset Type&lt;/a&gt; &#x60;site&#x60;.&lt;/p&gt; This filter will not search for &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt; that are located in the entities in &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt;.
+     * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; objects.
+     * @param startingAfter An alphanumeric string to move to the next page of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; in the list.&lt;/p&gt; 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 -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; 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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; in the list.&lt;/p&gt; 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 -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; 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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; parameters. Only one parameter can be selected.&lt;/p&gt; There are five parameter options; &#x60;map.name&#x60;, &#x60;map.title&#x60;, &#x60;map.asset_name&#x60;, &#x60;start_date&#x60; and &#x60;mode&#x60;
+     * @param sortAsc Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;true&#x60; (ascending order) and &#x60;false&#x60; (descending order).&lt;/p&gt; The default is &#x60;true&#x60; (ascending).
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listMaps({ entity, timestamp, mode, assetName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListMapsParams, options?: IKvHttpRequestOptions): Observable<MapListPaginated>;
     /**
      * List Symbols
-     * List Symbols  **Pagination Sortable Columns:** &#x60;symbol.name&#x60;, &#x60;symbol.title&#x60;, &#x60;symbol.symbol_type&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
-     * @param search Search symbols by name or title
-     * @param symbolTypes Search symbols by symbol type
-     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
-     * @param startingAfter Lower bound cursor for use in pagination
-     * @param endingBefore Upper bound cursor for use in pagination
-     * @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
+     * Returns a dictionary with a data property containing a filtered array of all Symbol objects on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Platform&lt;/a&gt;.  **Pagination Sortable Columns:** &#x60;symbol.name&#x60;, &#x60;symbol.title&#x60;, &#x60;symbol.symbol_type&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * @param search Search and filter the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; 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 &#x60;[pump,fan]&#x60;.&lt;/p&gt; The search is case insensitive and will find partial matches as well. For example if a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; name or display name is &#x60;centrifugal_pump&#x60;, then a match will be made if the search string is &#x60;pum&#x60; or &#x60;FUGaL&#x60;.
+     * @param symbolTypes Filter on the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; parameter &#x60;symbol_type&#x60;. This is given as an array, for example &#x60;[pump,fan]&#x60;.&lt;/p&gt; The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space but not at the beginning or end).&lt;/p&gt; For example a search with &#x60;[pump,fan]&#x60; will return Symbols with the name &#x60;pump&#x60; but not with the names &#x60;pumps&#x60; or &#x60;centrifugal-fan&#x60;.
+     * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; objects.
+     * @param startingAfter An alphanumeric string to move to the next page of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbols&lt;/a&gt; in the list.&lt;/p&gt; 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 -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; 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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbols&lt;/a&gt; in the list.&lt;/p&gt; 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 -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; 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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; parameters. Only one parameter can be selected.&lt;/p&gt; There are three parameter options; &#x60;symbol.name&#x60;, &#x60;symbol.title&#x60; and &#x60;symbol.symbol_type&#x60;
+     * @param sortAsc Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;true&#x60; (ascending order) and &#x60;false&#x60; (descending order).&lt;/p&gt; The default is &#x60;true&#x60; (ascending).
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listSymbols({ search, symbolTypes, pageSize, startingAfter, endingBefore, sortBy, sortAsc }?: IListSymbolsParams, options?: IKvHttpRequestOptions): Observable<SymbolsListPaginated>;
     /**
      * List Versions
-     * List Versions for a single map  **Pagination Sortable Columns:** &#x60;start_date&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
-     * @param mapName Map 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 all the versions that have been saved for a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.  This will include some limited data such as the mode and time when the version was active as the latest version.  The current (latest) &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; version will not have an &#x60;end_date&#x60; key.  **Pagination Sortable Columns:** &#x60;start_date&#x60;  **Permission Required:** &#x60;kelvin.permission.maps.read&#x60;
+     * @param mapName Unique identifier name of the wanted &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
+     * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; objects.
+     * @param startingAfter An alphanumeric string to move to the next page of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; in the list.&lt;/p&gt; 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 -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; 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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; in the list.&lt;/p&gt; 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 -&gt; previous_page and pagination -&gt; next_page respectively.&lt;/p&gt; The pagination -&gt; 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 &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt; parameters. Only one parameter can be selected.&lt;/p&gt; There is only one option; &#x60;start_date&#x60;
+     * @param sortAsc Sorting order for the results according to the &#x60;sort_by&#x60; parameter.&lt;/p&gt; There are two options; &#x60;true&#x60; (ascending order) and &#x60;false&#x60; (descending order).&lt;/p&gt; The default is &#x60;true&#x60; (ascending).
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static listVersions({ mapName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListVersionsParams, options?: IKvHttpRequestOptions): Observable<MapVersionListPaginated>;
     /**
      * Update Map
-     * Update Map  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;
+     * Update the information and process flows in a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Map&lt;/a&gt; in &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Maps&lt;/a&gt;.  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;
      * @param map Map update schema
      * @param mapName Map name
      * @param {IKvHttpRequestOptions} options Request optional parameters
@@ -125,9 +125,9 @@ export declare class MapService extends BaseService {
     static updateMap({ map, mapName }: IUpdateMapParams, options?: IKvHttpRequestOptions): Observable<MapModel>;
     /**
      * Update Symbol
-     * Update Symbol  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;
+     * Update the information or image of an existing Symbol for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt; library.&lt;/p&gt; This will be available for use in all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Process Maps&lt;/a&gt;.  **Permission Required:** &#x60;kelvin.permission.maps.update&#x60;
      * @param symbol Symbol update schema
-     * @param symbolName Symbol name
+     * @param symbolName Unique identifier name for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h&#x3D;symbol#symbol-library&#39; target&#x3D;&#39;_blank&#39;&gt;Symbol&lt;/a&gt;. This must contain only lowercase alphanumeric characters. The &#x60;.&#x60;, &#x60;_&#x60; and &#x60;-&#x60; 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 updateSymbol({ symbol, symbolName }: IUpdateSymbolParams, options?: IKvHttpRequestOptions): Observable<Symbol>;

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

@@ -6,7 +6,7 @@ import { BaseService } from '../../base.service';
 export class MapService extends BaseService {
     /**
      * Create Map
-     * Create Map  **Permission Required:** `kelvin.permission.maps.create`
+     * Create a new <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview' target='_blank'>Kelvin Maps</a>.  **Permission Required:** `kelvin.permission.maps.create`
      * @param map Map create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -21,9 +21,9 @@ export class MapService extends BaseService {
     }
     /**
      * Create Map OEE
-     * Create Map OEE  **Permission Required:** `kelvin.permission.maps.create`
+     * Create new OEE data for the selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.  When new OEE data is created, the current OEE data will be timestamped with an end_date which is the same as the start_date for the new OEE data. This timestamp is automatically generated from the current time when the API request is submitted.  **Permission Required:** `kelvin.permission.maps.create`
      * @param mapOee Map OEE create schema
-     * @param mapName Map name
+     * @param mapName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> to save the data to.</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 createMapOEE({ mapOee, mapName }, options) {
@@ -37,9 +37,9 @@ export class MapService extends BaseService {
     }
     /**
      * Create Map Shift
-     * Create Map Shift  **Permission Required:** `kelvin.permission.maps.create`
+     * Create a new Shift for the selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.  When a new Shift is created, the current Shift will be timestamped with an end_date which is the same as the start_date for the new shift. This timestamp is automatically generated from the current time when the API request is submitted.  **Permission Required:** `kelvin.permission.maps.create`
      * @param mapShift Map Shift create schema
-     * @param mapName Map name
+     * @param mapName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> to save the data to.</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 createMapShift({ mapShift, mapName }, options) {
@@ -53,7 +53,7 @@ export class MapService extends BaseService {
     }
     /**
      * Create Symbol
-     * Create Symbol  **Permission Required:** `kelvin.permission.maps.create`
+     * Create a new Symbol for the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a> library.</p> This will be available for use in all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a>.  **Permission Required:** `kelvin.permission.maps.create`
      * @param symbol Symbol create schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -68,8 +68,8 @@ export class MapService extends BaseService {
     }
     /**
      * Delete Map
-     * Delete Map  **Permission Required:** `kelvin.permission.maps.delete`
-     * @param mapName Map name
+     * Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>. This cannot be undone once the API request has been submitted. </p>This will also delete all version of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.  **Permission Required:** `kelvin.permission.maps.delete`
+     * @param mapName Unique identifier name of the wanted <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.</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 deleteMap({ mapName }, options) {
@@ -82,8 +82,8 @@ export class MapService extends BaseService {
     }
     /**
      * Delete Symbol
-     * Delete Symbol  **Permission Required:** `kelvin.permission.maps.delete`
-     * @param symbolName Symbol name
+     * Permanently delete an existing <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a>. This cannot be undone once the API request has been submitted. </p> Be careful as there will be no warnings if the image is in use in any entity. Any deleted <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbols</a> in use will not cause any errors to <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> overviews and the affected entities will have a blank space where the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a> should be displayed.  **Permission Required:** `kelvin.permission.maps.delete`
+     * @param symbolName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a>. 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 deleteSymbol({ symbolName }, options) {
@@ -96,9 +96,9 @@ export class MapService extends BaseService {
     }
     /**
      * Get Map
-     * Get Map  **Permission Required:** `kelvin.permission.maps.read`
-     * @param mapName Map name
-     * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> and all related entities and relationships associated with the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.  **Permission Required:** `kelvin.permission.maps.read`
+     * @param mapName Unique identifier name of the wanted <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.</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 timestamp Timestamp to search for a specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a> version (supports RFC3339 and Unix timestamps with nanosecond precision).</p> If no timestamp is given in the query or body parameters, then the current time will be selected which will look at the most recent version of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMap({ mapName, timestamp }, options) {
@@ -116,9 +116,9 @@ export class MapService extends BaseService {
     }
     /**
      * Get Map OEE
-     * Get Map OEE  **Permission Required:** `kelvin.permission.maps.read`
+     * Get OEE data for the selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>. The shift information returned will be the data that was active for the requested timestamp.  **Permission Required:** `kelvin.permission.maps.read`
      * @param mapNames Map OEE get schema
-     * @param timestamp Timestamp to search for specific OEE values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param timestamp Timestamp to search for specific OEE data values (supports RFC3339 and Unix timestamps with nanosecond precision).</p> Example; '2022-07-08T08:41:01.657916Z'.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMapOEE({ mapNames, timestamp }, options) {
@@ -137,9 +137,9 @@ export class MapService extends BaseService {
     }
     /**
      * Get Map Shift
-     * Get Map Shift  **Permission Required:** `kelvin.permission.maps.read`
+     * Get Shift data for the selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>. The shift information returned will be the data that was active for the requested timestamp.  **Permission Required:** `kelvin.permission.maps.read`
      * @param mapNames Map Shift get schema
-     * @param timestamp Timestamp to search for specific Shift values for a given point in time (supports RFC3339 and Unix timestamps with nanosecond precision)
+     * @param timestamp Timestamp to search for a specific shift (supports RFC3339 and Unix timestamps with nanosecond precision).</p> Example; '2022-07-08T08:41:01.657916Z'.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
     static getMapShift({ mapNames, timestamp }, options) {
@@ -158,16 +158,16 @@ export class MapService extends BaseService {
     }
     /**
      * List Maps
-     * List Maps  **Pagination Sortable Columns:** `map.name`, `map.title`, `start_date`, `mode`, `map.asset_name`  **Permission Required:** `kelvin.permission.maps.read`
-     * @param entity Filter for maps that contain the entity
-     * @param timestamp Timestamp to search for a specific version (supports RFC3339 and Unix timestamps with nanosecond precision)
-     * @param mode Filter maps by mode. Possible Values: production/simulation
-     * @param assetName Filter for maps that exist in the context of an asset 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
+     * Returns a dictionary with a data property containing a filtered array of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a> objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.  **Pagination Sortable Columns:** `map.name`, `map.title`, `start_date`, `mode`, `map.asset_name`  **Permission Required:** `kelvin.permission.maps.read`
+     * @param entity Filter on the entity name in the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a>.
+     * @param timestamp Timestamp to search for a specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a> version (supports RFC3339 and Unix timestamps with nanosecond precision).</p> If no timestamp is given in the query or body parameters, then the current time will be selected which will look at the most recent version of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.
+     * @param mode Filter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a> based on the mode key.</p> There are two parameter options; `production` and `simulation`.
+     * @param assetName Filter on the name of the parent <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a>.</p> This <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Asset</a> must be a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-groups' target='_blank'>Kelvin Asset Group</a> with a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type' target='_blank'>Kelvin Asset Type</a> `site`.</p> This filter will not search for <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset' target='_blank'>Kelvin Assets</a> that are located in the entities in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a>.
+     * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</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/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> objects.
+     * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</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/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</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/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a> parameters. Only one parameter can be selected.</p> There are five parameter options; `map.name`, `map.title`, `map.asset_name`, `start_date` and `mode`
+     * @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 listMaps({ entity, timestamp, mode, assetName, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
@@ -209,14 +209,14 @@ export class MapService extends BaseService {
     }
     /**
      * List Symbols
-     * List Symbols  **Pagination Sortable Columns:** `symbol.name`, `symbol.title`, `symbol.symbol_type`  **Permission Required:** `kelvin.permission.maps.read`
-     * @param search Search symbols by name or title
-     * @param symbolTypes Search symbols by symbol type
-     * @param pageSize Number of objects to be returned, between 1 and 1000. Default: 20
-     * @param startingAfter Lower bound cursor for use in pagination
-     * @param endingBefore Upper bound cursor for use in pagination
-     * @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
+     * Returns a dictionary with a data property containing a filtered array of all Symbol objects on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>.  **Pagination Sortable Columns:** `symbol.name`, `symbol.title`, `symbol.symbol_type`  **Permission Required:** `kelvin.permission.maps.read`
+     * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</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-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a> name or display name is `centrifugal_pump`, then a match will be made if the search string is `pum` or `FUGaL`.
+     * @param symbolTypes Filter on the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a> parameter `symbol_type`. This is given as an array, for example `[pump,fan]`.</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 search with `[pump,fan]` will return Symbols with the name `pump` but not with the names `pumps` or `centrifugal-fan`.
+     * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</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-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a> objects.
+     * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbols</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-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbols</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-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a> parameters. Only one parameter can be selected.</p> There are three parameter options; `symbol.name`, `symbol.title` and `symbol.symbol_type`
+     * @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 listSymbols({ search, symbolTypes, pageSize, startingAfter, endingBefore, sortBy, sortAsc } = {}, options) {
@@ -252,13 +252,13 @@ export class MapService extends BaseService {
     }
     /**
      * List Versions
-     * List Versions for a single map  **Pagination Sortable Columns:** `start_date`  **Permission Required:** `kelvin.permission.maps.read`
-     * @param mapName Map 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 all the versions that have been saved for a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.  This will include some limited data such as the mode and time when the version was active as the latest version.  The current (latest) <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> version will not have an `end_date` key.  **Pagination Sortable Columns:** `start_date`  **Permission Required:** `kelvin.permission.maps.read`
+     * @param mapName Unique identifier name of the wanted <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a>.</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 pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</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/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> objects.
+     * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</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/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</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/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a> parameters. Only one parameter can be selected.</p> There is only one option; `start_date`
+     * @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 listVersions({ mapName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
@@ -288,7 +288,7 @@ export class MapService extends BaseService {
     }
     /**
      * Update Map
-     * Update Map  **Permission Required:** `kelvin.permission.maps.update`
+     * Update the information and process flows in a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Map</a> in <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview' target='_blank'>Kelvin Maps</a>.  **Permission Required:** `kelvin.permission.maps.update`
      * @param map Map update schema
      * @param mapName Map name
      * @param {IKvHttpRequestOptions} options Request optional parameters
@@ -304,9 +304,9 @@ export class MapService extends BaseService {
     }
     /**
      * Update Symbol
-     * Update Symbol  **Permission Required:** `kelvin.permission.maps.update`
+     * Update the information or image of an existing Symbol for the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a> library.</p> This will be available for use in all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/kelvin-maps-overview/#processes' target='_blank'>Kelvin Process Maps</a>.  **Permission Required:** `kelvin.permission.maps.update`
      * @param symbol Symbol update schema
-     * @param symbolName Symbol name
+     * @param symbolName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-editors/kelvin-maps-process-map-editor/?h=symbol#symbol-library' target='_blank'>Symbol</a>. 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 updateSymbol({ symbol, symbolName }, options) {