npm - @kelvininc/js-client-sdk - Versions diffs - 7.12.0 → 7.18.0 - Mend

@kelvininc/js-client-sdk 7.12.0 → 7.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2693) hide show

package/dist/esm/services/generated/api/bridge.service.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"bridge.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/bridge.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,6BAA6B,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrJ,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAWjD;;GAEG;AAEH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAE7C;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,UAAU,EAAuB,EAAE,OAA+B;QAEvF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAClH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAuB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC;QAE5B,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAS,iBAAiB,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,UAAU,EAAoB,EAAE,OAA+B;QAEjF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAS,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IAC9G,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IAEH,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,KAAwB,EAAE,EAAE,OAA+B;QAEjM,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,eAAe,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;SACjC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;SACvC;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,WAAW,IAAI,IAAI,EAAE;YACxB,eAAe,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;SAC9C;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAsB,eAAe,EAAE,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAA2B,EAAE,OAA+B;QAEvJ,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAqB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC9I,CAAC;IAED;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAgC,EAAE,OAA+B;QAExL,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,UAAU,IAAI,IAAI,EAAE;YACvB,eAAe,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;SAC5C;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgC,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,mBAAmB,EAAE,aAAa,EAAE,6BAA6B,CAAC,CAAC;IACzK,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,iBAAiB,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAA4B,EAAE,OAA+B;QAEzJ,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAsB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,eAAe,EAAE,aAAa,EAAE,mBAAmB,CAAC,CAAC;IACjJ,CAAC;IAED;;;;;;;;OAQG;IAEH,MAAM,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,KAA4B,EAAE,EAAE,OAA+B;QAEpH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,eAAe,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;SACjC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QAEvC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAgB,4CAA4C,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;IAChH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,WAAW,CAAC,EAAE,UAAU,EAAsB,EAAE,OAA+B;QAErF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IACjH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,UAAU,CAAC,EAAE,UAAU,EAAqB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAC7C,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAkB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAChH,CAAC;CACD","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';\nimport { AssetListPaginated, Bridge, BridgeDataStreamListPaginated, BridgeListPaginated, MetricListPaginated, MQTTTopicList } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tIDeleteBridgeParams,\n\tIDeployBridgeParams,\n\tIGetBridgeParams, IListBridgeAssetsParams,\n\tIListBridgeDataStreamsParams,\n\tIListBridgeMetricsParams, IListBridgeParams, IListMQTTTopicsParams,\n\tIStartBridgeParams,\n\tIStopBridgeParams\n} from '../types';\n\n/*\n @category Service\n /\n\nexport class BridgeService extends BaseService {\n\n\t/\n\t Delete Bridge\n\t * Delete Bridge application Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. This cannot be undone once the API request has been submitted. <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> can be deleted even if the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a> is offline. In this case, the information will be immediately deleted on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> and the commands to delete on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a> will be sent when it next comes online. Permission Required: `kelvin.permission.bridge.delete`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic deleteBridge({ bridgeName }: IDeleteBridgeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/bridges/${encodeURIComponent(String(bridgeName))}/delete`, requestConfig);\n\t}\n\n\t/\n\t Deploy Bridge\n\t * Deploy Bridge App Deploy a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> to a selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. The Kelvin Bridge will handle all the communications and data transfer between external equipment and the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> using one of four communication protocols; OPC UA, MQTT, Modbus TCP / RTU or Emerson ROC. Each protocol will require a different type of payload structure that defines the exact address specifications for each <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. Permission Required: `kelvin.permission.bridge.create`\n\t * @param bridge Bridge create schema. Supported protocols [`opc-ua`, `mqtt`, `modbus`, `roc`]\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic deployBridge({ bridge }: IDeployBridgeParams, options?: IKvHttpRequestOptions): Observable<Bridge> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = bridge;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<Bridge>(`/bridges/deploy`, requestConfig, Bridge);\n\t}\n\n\t/\n\t Get Bridge\n\t * Get Bridge Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getBridge({ bridgeName }: IGetBridgeParams, options?: IKvHttpRequestOptions): Observable<Bridge> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<Bridge>(`/bridges/${encodeURIComponent(String(bridgeName))}/get`, requestConfig, Bridge);\n\t}\n\n\t/\n\t List Bridge\n\t * List Bridge Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Pagination Sortable Columns: `bridge.name`, `bridge.title`, `bridge.protocol`, `bridge.acp_name`, `bridge.workload_name`, `bridge.created`, `bridge.updated`, `status_state`, `status_last_seen` Permission Required: `kelvin.permission.bridge.read`\n\t * @param names Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> by its name. This is given as an array, for example `[extruder-bridge,tank-bridge]`.</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-bridge,tank-bridge]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the name `extruder-bridge` but not with the names `demo-extruder-bridge` or `tank-bridge-one`.\n\t * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[demo,bridge]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> name or display name is `extruder-bridge`, then a match will be made if the search string is `ext` or `rIDge`.\n\t * @param acpName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>'s acp_name (This is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>). This is given as an array, for example `[demo-node-1,extruder-node]`.</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 `[demo-node-1,extruder-node]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the parameter acp_name `extruder-node` but not with the names `demo-extruder-node` or `extruder-node-one`.\n\t * @param protocol Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `protocol`. This is the communication protocol used by the bridge. This is given as an array, for example `[modbus,mqtt]`.</p> There are four options available; `modbus`, `opc-ua`, `mqtt`, `roc`.\n\t * @param workloadName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `workload_name`. This is given as an array, for example `[extruder,tank]`.</p> The filter is done on the full workload_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 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the parameter workload_name `extruder` but not with the workload_name `demo-extruder-bridge` or `bridge-tank`.\n\t * @param statusState Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `status_state`. This is the communication protocol used by the bridge. This is given as an array, for example `[failed,stopped]`.</p> There are five options available; `running`, `stopped`, `failed`, `deploying`, `offline`.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `bridge.name`, `bridge.title`, `bridge.protocol`, `bridge.acp_name`, `bridge.workload_name`, `bridge.created`, `bridge.updated`, `status_state` and `status_last_seen`.</p> The default is `bridge.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridge({ names, search, acpName, protocol, workloadName, statusState, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeParams = {}, options?: IKvHttpRequestOptions): Observable<BridgeListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (names != null) {\n\t\t\tqueryParameters['names'] = names;\n\t\t}\n\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\n\t\t}\n\n\t\tif (acpName != null) {\n\t\t\tqueryParameters['acp_name'] = acpName;\n\t\t}\n\n\t\tif (protocol != null) {\n\t\t\tqueryParameters['protocol'] = protocol;\n\t\t}\n\n\t\tif (workloadName != null) {\n\t\t\tqueryParameters['workload_name'] = workloadName;\n\t\t}\n\n\t\tif (statusState != null) {\n\t\t\tqueryParameters['status_state'] = statusState;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<BridgeListPaginated>(`/bridges/list`, requestConfig, BridgeListPaginated);\n\t}\n\n\t/\n\t List Bridge Assets\n\t * List Bridge Assets Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Pagination Sortable Columns: `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.title` Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> by its name.</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 `demo-bridge-one` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the name `demo-bridge-one` but not with the names `demo-bridge` or `bridge-one`.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `asset.name`, `asset.title`, `asset.created`, `asset.updated` and `asset_type.title`.</p> The default is `asset.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridgeAssets({ bridgeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeAssetsParams, options?: IKvHttpRequestOptions): Observable<AssetListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<AssetListPaginated>(`/bridges/${encodeURIComponent(String(bridgeName))}/assets/list`, requestConfig, AssetListPaginated);\n\t}\n\n\t/\n\t List Bridge Data Streams\n\t * List Bridge Data Streams Returns a list of all the <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 that have been deployed with the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The specific connection details for each Kelvin Asset / Kelvin Metric pair are also returned in a payload. The payload structure will depend on the type of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. There are four types; OPC UA, MQTT, Modbus and ROC. You can apply a number of filters to the return list. Pagination Sortable Columns: `bridge_metric_asset.asset_name`, `bridge_metric_asset.metric_name` Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> name to retrieve the data stream objects.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param assetName Filter the data stream objects of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which contain specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> names.\n\t * @param metricName Filter the data stream objects of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which contain specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> names.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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 parameter under 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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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 parameter under 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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are two parameter options; `bridge_metric_asset.asset_name`, `bridge_metric_asset.metric_name`.</p> The default is `bridge_metric_asset.asset_name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridgeDataStreams({ bridgeName, assetName, metricName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeDataStreamsParams, options?: IKvHttpRequestOptions): Observable<BridgeDataStreamListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (metricName != null) {\n\t\t\tqueryParameters['metric_name'] = metricName;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<BridgeDataStreamListPaginated>(`/bridges/${encodeURIComponent(String(bridgeName))}/datastreams/list`, requestConfig, BridgeDataStreamListPaginated);\n\t}\n\n\t/\n\t List Bridge Metrics\n\t * List Bridge Metrics Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Pagination Sortable Columns: `metric.name`, `metric.title`, `metric.created`, `metric.updated`, `metric.data_type_name` Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</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-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `metric.name`, `metric.title`, `metric.created`, `metric.updated` and `metric.data_type_name`.</p> The default is `metric.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridgeMetrics({ bridgeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeMetricsParams, options?: IKvHttpRequestOptions): Observable<MetricListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MetricListPaginated>(`/bridges/${encodeURIComponent(String(bridgeName))}/metrics/list`, requestConfig, MetricListPaginated);\n\t}\n\n\t/\n\t List MQTT Topics\n\t * List MQTT Topics Returns a dictionary with a data property containing a list of the MQTT topic payload options available on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. The MQTT topic payload definitions defines how <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which are using the `mqtt` protocol will interpret incoming messages on a topic. Sortable Columns: `bridge_mqtt_topic.name`, `bridge_mqtt_topic.title`, `bridge_mqtt_topic.topic`, `bridge_mqtt_topic.created`, `bridge_mqtt_topic.updated` Permission Required: `kelvin.permission.bridge.read`\n\t * @param names Filter on the MQTT Topics by its name.</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 `topic-one` will return MQTT topics with the name `topic-one` but not with the names `topic-one-extended` or `topic`.\n\t * @param search Search and filter the MQTT Topic list. The Display Name, the Name and the Topic will be included in the search field criteria. This is given as an array, for example `[one,two]`.</p> The search is case insensitive and will find partial matches as well. For example if a MQTT TOpic name, display name or topic is `topic-one`, then a match will be made if the search string is `one` or `oPic`.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are five parameter options; `bridge_mqtt_topic.name`, `bridge_mqtt_topic.title`, `bridge_mqtt_topic.topic`, `bridge_mqtt_topic.created`, `bridge_mqtt_topic.updated`.</p> The default is `bridge_mqtt_topic.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listMQTTTopics({ names, search, sortBy, sortAsc }: IListMQTTTopicsParams = {}, options?: IKvHttpRequestOptions): Observable<MQTTTopicList> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (names != null) {\n\t\t\tqueryParameters['names'] = names;\n\t\t}\n\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<MQTTTopicList>(`/bridges/protocols/mqtt/configuration/list`, requestConfig, MQTTTopicList);\n\t}\n\n\t/\n\t Start Bridge\n\t * Start Bridge application Start a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> must already be deployed to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. Permission Required: `kelvin.permission.bridge.update`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic startBridge({ bridgeName }: IStartBridgeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/bridges/${encodeURIComponent(String(bridgeName))}/start`, requestConfig);\n\t}\n\n\t/\n\t Stop Bridge\n\t * Stop Bridge application Stop a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> must already be deployed to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. Permission Required: `kelvin.permission.bridge.update`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic stopBridge({ bridgeName }: IStopBridgeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\trequestConfig.mediaType = 'application/json';\n\t\trequestConfig.options = options;\n\n\t\treturn this.request<IKvHttpResponse>(`/bridges/${encodeURIComponent(String(bridgeName))}/stop`, requestConfig);\n\t}\n}\n"]}
1	+ {"version":3,"file":"bridge.service.js","sourceRoot":"","sources":["../../../../../src/services/generated/api/bridge.service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,EAAE,6BAA6B,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrJ,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAWjD;;GAEG;AAEH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAE7C;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,UAAU,EAAuB,EAAE,OAA+B;QAEvF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAClH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM,EAAuB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,MAAuB;SAC/B,CAAC;QACF,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC;QAC5B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAS,iBAAiB,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,SAAS,CAAC,EAAE,UAAU,EAAoB,EAAE,OAA+B;QAEjF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QACF,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAS,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IAC9G,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IAEH,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,KAAwB,EAAE,EAAE,OAA+B;QAE9M,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,eAAe,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;SACjC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,IAAI,WAAW,IAAI,IAAI,EAAE;YACxB,eAAe,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;SAC9C;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC;SACvC;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,WAAW,IAAI,IAAI,EAAE;YACxB,eAAe,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC;SAC9C;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAsB,eAAe,EAAE,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAA2B,EAAE,OAA+B;QAEvJ,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAqB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;IAC9I,CAAC;IAED;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAC,qBAAqB,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAgC,EAAE,OAA+B;QAExL,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,SAAS,IAAI,IAAI,EAAE;YACtB,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;SAC1C;QAED,IAAI,UAAU,IAAI,IAAI,EAAE;YACvB,eAAe,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC;SAC5C;QAED,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAgC,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,mBAAmB,EAAE,aAAa,EAAE,6BAA6B,CAAC,CAAC;IACzK,CAAC;IAED;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,iBAAiB,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAA4B,EAAE,OAA+B;QAEzJ,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACrB,eAAe,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;SACxC;QAED,IAAI,aAAa,IAAI,IAAI,EAAE;YAC1B,eAAe,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;SAClD;QAED,IAAI,YAAY,IAAI,IAAI,EAAE;YACzB,eAAe,CAAC,eAAe,CAAC,GAAG,YAAY,CAAC;SAChD;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAsB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,eAAe,EAAE,aAAa,EAAE,mBAAmB,CAAC,CAAC;IACjJ,CAAC;IAED;;;;;;;;OAQG;IAEH,MAAM,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,KAA4B,EAAE,EAAE,OAA+B;QAEpH,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QAEF,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,eAAe,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;SACjC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;SACnC;QAED,IAAI,MAAM,IAAI,IAAI,EAAE;YACnB,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;SACpC;QAED,IAAI,OAAO,IAAI,IAAI,EAAE;YACpB,eAAe,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;SACtC;QAED,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC;QACvC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAgB,4CAA4C,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;IAChH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,WAAW,CAAC,EAAE,UAAU,EAAsB,EAAE,OAA+B;QAErF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QACF,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IACjH,CAAC;IAED;;;;;OAKG;IAEH,MAAM,CAAC,UAAU,CAAC,EAAE,UAAU,EAAqB,EAAE,OAA+B;QAEnF,MAAM,aAAa,GAAmB;YACrC,MAAM,EAAE,KAAsB;SAC9B,CAAC;QACF,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAChC,aAAa,CAAC,SAAS,GAAG,kBAAkB,CAAC;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAkB,YAAY,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAChH,CAAC;CACD","sourcesContent":["import { Observable } from 'rxjs';\nimport { EKvHttpMethod, IKvHttpRequest, IKvHttpRequestOptions, IKvHttpResponse } from '../../../core/http';\nimport { AssetListPaginated, Bridge, BridgeDataStreamListPaginated, BridgeListPaginated, MetricListPaginated, MQTTTopicList } from '../../../models';\nimport { BaseService } from '../../base.service';\nimport {\n\tIDeleteBridgeParams,\n\tIDeployBridgeParams,\n\tIGetBridgeParams, IListBridgeAssetsParams,\n\tIListBridgeDataStreamsParams,\n\tIListBridgeMetricsParams, IListBridgeParams, IListMQTTTopicsParams,\n\tIStartBridgeParams,\n\tIStopBridgeParams\n} from '../types';\n\n/*\n @category Service\n /\n\nexport class BridgeService extends BaseService {\n\n\t/\n\t Delete Bridge\n\t * Delete Bridge application Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. This cannot be undone once the API request has been submitted. <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> can be deleted even if the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a> is unreachable. In this case, the information will be immediately deleted on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> and the commands to delete on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a> will be sent when it next comes online. Permission Required: `kelvin.permission.bridge.delete`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic deleteBridge({ bridgeName }: IDeleteBridgeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/bridges/${encodeURIComponent(String(bridgeName))}/delete`, requestConfig);\n\t}\n\n\t/\n\t Deploy Bridge\n\t * Deploy Bridge App Deploy a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> to a selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. The Kelvin Bridge will handle all the communications and data transfer between external equipment and the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> using one of four communication protocols; OPC UA, MQTT, Modbus TCP / RTU or Emerson ROC. Each protocol will require a different type of payload structure that defines the exact address specifications for each <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. Permission Required: `kelvin.permission.bridge.create` Note: `acp_name` is deprecated. If `cluster_name` is set, it will override `acp_name`\n\t * @param bridge Bridge create schema. Supported protocols [`opc-ua`, `mqtt`, `modbus`, `roc`]\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic deployBridge({ bridge }: IDeployBridgeParams, options?: IKvHttpRequestOptions): Observable<Bridge> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'post' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.data = bridge;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<Bridge>(`/bridges/deploy`, requestConfig, Bridge);\n\t}\n\n\t/\n\t Get Bridge\n\t * Get Bridge Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic getBridge({ bridgeName }: IGetBridgeParams, options?: IKvHttpRequestOptions): Observable<Bridge> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<Bridge>(`/bridges/${encodeURIComponent(String(bridgeName))}/get`, requestConfig, Bridge);\n\t}\n\n\t/\n\t List Bridge\n\t * List Bridge Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Pagination Sortable Columns: `bridge.name`, `bridge.title`, `bridge.protocol`, `bridge.cluster_name`, `bridge.workload_name`, `bridge.created`, `bridge.updated`, `status_state`, `status_last_seen` Permission Required: `kelvin.permission.bridge.read`\n\t * @param names Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> by its name. This is given as an array, for example `[extruder-bridge,tank-bridge]`.</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-bridge,tank-bridge]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the name `extruder-bridge` but not with the names `demo-extruder-bridge` or `tank-bridge-one`.\n\t * @param search Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[demo,bridge]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> name or display name is `extruder-bridge`, then a match will be made if the search string is `ext` or `rIDge`.\n\t * @param acpName `[Deprecated]` Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>'s cluster_name (This is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>). This is given as an array, for example `[demo-node-1,extruder-node]`.</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 `[demo-node-1,extruder-node]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the parameter cluster_name `extruder-node` but not with the names `demo-extruder-node` or `extruder-node-one`.\n\t * @param clusterName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>'s cluster_name (This is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>). This is given as an array, for example `[demo-node-1,extruder-node]`.</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 `[demo-node-1,extruder-node]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the parameter cluster_name `extruder-node` but not with the names `demo-extruder-node` or `extruder-node-one`.\n\t * @param protocol Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `protocol`. This is the communication protocol used by the bridge. This is given as an array, for example `[modbus,mqtt]`.</p> There are four options available; `modbus`, `opc-ua`, `mqtt`, `roc`.\n\t * @param workloadName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `workload_name`. This is given as an array, for example `[extruder,tank]`.</p> The filter is done on the full workload_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 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the parameter workload_name `extruder` but not with the workload_name `demo-extruder-bridge` or `bridge-tank`.\n\t * @param statusState Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `status_state`. This is the communication protocol used by the bridge. This is given as an array, for example `[failed,stopped]`.</p> There are five options available; `running`, `stopped`, `failed`, `deploying`, `unreachable`.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `bridge.name`, `bridge.title`, `bridge.protocol`, `bridge.cluster_name`, `bridge.workload_name`, `bridge.created`, `bridge.updated`, `status_state` and `status_last_seen`.</p> The default is `bridge.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridge({ names, search, acpName, clusterName, protocol, workloadName, statusState, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeParams = {}, options?: IKvHttpRequestOptions): Observable<BridgeListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (names != null) {\n\t\t\tqueryParameters['names'] = names;\n\t\t}\n\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\n\t\t}\n\n\t\tif (acpName != null) {\n\t\t\tqueryParameters['acp_name'] = acpName;\n\t\t}\n\n\t\tif (clusterName != null) {\n\t\t\tqueryParameters['cluster_name'] = clusterName;\n\t\t}\n\n\t\tif (protocol != null) {\n\t\t\tqueryParameters['protocol'] = protocol;\n\t\t}\n\n\t\tif (workloadName != null) {\n\t\t\tqueryParameters['workload_name'] = workloadName;\n\t\t}\n\n\t\tif (statusState != null) {\n\t\t\tqueryParameters['status_state'] = statusState;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<BridgeListPaginated>(`/bridges/list`, requestConfig, BridgeListPaginated);\n\t}\n\n\t/\n\t List Bridge Assets\n\t * List Bridge Assets Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Pagination Sortable Columns: `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.title` Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> by its name.</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 `demo-bridge-one` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the name `demo-bridge-one` but not with the names `demo-bridge` or `bridge-one`.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `asset.name`, `asset.title`, `asset.created`, `asset.updated` and `asset_type.title`.</p> The default is `asset.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridgeAssets({ bridgeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeAssetsParams, options?: IKvHttpRequestOptions): Observable<AssetListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<AssetListPaginated>(`/bridges/${encodeURIComponent(String(bridgeName))}/assets/list`, requestConfig, AssetListPaginated);\n\t}\n\n\t/\n\t List Bridge Data Streams\n\t * List Bridge Data Streams Returns a list of all the <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 that have been deployed with the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The specific connection details for each Kelvin Asset / Kelvin Metric pair are also returned in a payload. The payload structure will depend on the type of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. There are four types; OPC UA, MQTT, Modbus and ROC. You can apply a number of filters to the return list. Pagination Sortable Columns: `bridge_metric_asset.asset_name`, `bridge_metric_asset.metric_name` Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> name to retrieve the data stream objects.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param assetName Filter the data stream objects of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which contain specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> names.\n\t * @param metricName Filter the data stream objects of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which contain specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> names.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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 parameter under 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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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 parameter under 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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are two parameter options; `bridge_metric_asset.asset_name`, `bridge_metric_asset.metric_name`.</p> The default is `bridge_metric_asset.asset_name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridgeDataStreams({ bridgeName, assetName, metricName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeDataStreamsParams, options?: IKvHttpRequestOptions): Observable<BridgeDataStreamListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (assetName != null) {\n\t\t\tqueryParameters['asset_name'] = assetName;\n\t\t}\n\n\t\tif (metricName != null) {\n\t\t\tqueryParameters['metric_name'] = metricName;\n\t\t}\n\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<BridgeDataStreamListPaginated>(`/bridges/${encodeURIComponent(String(bridgeName))}/datastreams/list`, requestConfig, BridgeDataStreamListPaginated);\n\t}\n\n\t/\n\t List Bridge Metrics\n\t * List Bridge Metrics Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Pagination Sortable Columns: `metric.name`, `metric.title`, `metric.created`, `metric.updated`, `metric.data_type_name` Permission Required: `kelvin.permission.bridge.read`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param pageSize Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</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-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> objects.\n\t * @param startingAfter An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</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.\n\t * @param endingBefore An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</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.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `metric.name`, `metric.title`, `metric.created`, `metric.updated` and `metric.data_type_name`.</p> The default is `metric.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listBridgeMetrics({ bridgeName, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListBridgeMetricsParams, options?: IKvHttpRequestOptions): Observable<MetricListPaginated> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (pageSize != null) {\n\t\t\tqueryParameters['page_size'] = pageSize;\n\t\t}\n\n\t\tif (startingAfter != null) {\n\t\t\tqueryParameters['starting_after'] = startingAfter;\n\t\t}\n\n\t\tif (endingBefore != null) {\n\t\t\tqueryParameters['ending_before'] = endingBefore;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<MetricListPaginated>(`/bridges/${encodeURIComponent(String(bridgeName))}/metrics/list`, requestConfig, MetricListPaginated);\n\t}\n\n\t/\n\t List MQTT Topics\n\t * List MQTT Topics Returns a dictionary with a data property containing a list of the MQTT topic payload options available on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. The MQTT topic payload definitions defines how <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which are using the `mqtt` protocol will interpret incoming messages on a topic. Sortable Columns: `bridge_mqtt_topic.name`, `bridge_mqtt_topic.title`, `bridge_mqtt_topic.topic`, `bridge_mqtt_topic.created`, `bridge_mqtt_topic.updated` Permission Required: `kelvin.permission.bridge.read`\n\t * @param names Filter on the MQTT Topics by its name.</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 `topic-one` will return MQTT topics with the name `topic-one` but not with the names `topic-one-extended` or `topic`.\n\t * @param search Search and filter the MQTT Topic list. The Display Name, the Name and the Topic will be included in the search field criteria. This is given as an array, for example `[one,two]`.</p> The search is case insensitive and will find partial matches as well. For example if a MQTT TOpic name, display name or topic is `topic-one`, then a match will be made if the search string is `one` or `oPic`.\n\t * @param sortBy Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are five parameter options; `bridge_mqtt_topic.name`, `bridge_mqtt_topic.title`, `bridge_mqtt_topic.topic`, `bridge_mqtt_topic.created`, `bridge_mqtt_topic.updated`.</p> The default is `bridge_mqtt_topic.name`\n\t * @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).\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic listMQTTTopics({ names, search, sortBy, sortAsc }: IListMQTTTopicsParams = {}, options?: IKvHttpRequestOptions): Observable<MQTTTopicList> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\n\t\tconst queryParameters = {};\n\t\tif (names != null) {\n\t\t\tqueryParameters['names'] = names;\n\t\t}\n\n\t\tif (search != null) {\n\t\t\tqueryParameters['search'] = search;\n\t\t}\n\n\t\tif (sortBy != null) {\n\t\t\tqueryParameters['sort_by'] = sortBy;\n\t\t}\n\n\t\tif (sortAsc != null) {\n\t\t\tqueryParameters['sort_asc'] = sortAsc;\n\t\t}\n\n\t\trequestConfig.params = queryParameters;\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<MQTTTopicList>(`/bridges/protocols/mqtt/configuration/list`, requestConfig, MQTTTopicList);\n\t}\n\n\t/\n\t Start Bridge\n\t * Start Bridge application Start a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> must already be deployed to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. Permission Required: `kelvin.permission.bridge.update`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t /\n\n\tstatic startBridge({ bridgeName }: IStartBridgeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/bridges/${encodeURIComponent(String(bridgeName))}/start`, requestConfig);\n\t}\n\n\t/\n\t Stop Bridge\n\t * Stop Bridge application Stop a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> must already be deployed to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. Permission Required: `kelvin.permission.bridge.update`\n\t * @param bridgeName Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</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.\n\t * @param {IKvHttpRequestOptions} options Request optional parameters\n\t */\n\n\tstatic stopBridge({ bridgeName }: IStopBridgeParams, options?: IKvHttpRequestOptions): Observable<IKvHttpResponse> {\n\n\t\tconst requestConfig: IKvHttpRequest = {\n\t\t\tmethod: 'get' as EKvHttpMethod\n\t\t};\n\t\trequestConfig.options = options;\n\t\trequestConfig.mediaType = 'application/json';\n\n\t\treturn this.request<IKvHttpResponse>(`/bridges/${encodeURIComponent(String(bridgeName))}/stop`, requestConfig);\n\t}\n}\n"]}

package/dist/esm/services/generated/api/controlChange.service.d.ts CHANGED Viewed

@@ -30,12 +30,13 @@ export declare class ControlChangeService extends BaseService {
      * Get Control Change
      * Get Control Change  Returns the properties of a single &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; request via its unique ID.  Returned object will not only give the &#x60;status&#x60; and &#x60;payload&#x60; of the last &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; but also the &#x60;status_log&#x60; containing the information of when the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; was created, sent to bridge and confirmed with a read.  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeId Unique identifier id for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters and the &#x60;-&#x60; character only. For example &#x60;764168a8-0e1e-33aa-adc7-14dfbb78dfad&#x60;
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getControlChange({ controlChangeId }: IGetControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGet>;
+    static getControlChange({ controlChangeId, statusLimit }: IGetControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGet>;
     /**
      * Get Control Change Clustering
-     * Get Control Change Clustering  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
+     * Get Control Change Clustering  Groups and counts the occurrence of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Changes&lt;/a&gt; within a defined time bucket.  The grouping can also be filtered to only include &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Changes&lt;/a&gt; for certain &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt;, &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; or current &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; statuses.  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeClustering Control Change Clustering schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -44,6 +45,7 @@ export declare class ControlChangeService extends BaseService {
      * Get Last Control Change
      * Get Last Control Change  Returns a list of the last &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; for each &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs for each of the body parameters in the array &#x60;asset_names&#x60;.  The list will include &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Changes&lt;/a&gt; that succeeded, failed or are pending.  Each object will not only give the &#x60;status&#x60; and &#x60;payload&#x60; of the last &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; but also the &#x60;status_log&#x60; containing the information of when the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; was created, sent to bridge and confirmed with a read.  **Pagination Sortable Columns:** &#x60;control_change.id&#x60;, &#x60;control_change.asset_name&#x60;, &#x60;control_change.metric_name&#x60;, &#x60;control_change.last_state&#x60;, &#x60;control_change.created&#x60;, &#x60;control_change.updated&#x60;, &#x60;control_change.timestamp&#x60;  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeLast Last control change schema
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 Kelvin Asset Statistic objects.
      * @param startingAfter An alphanumeric string to move to the next page of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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 the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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.
@@ -51,11 +53,12 @@ export declare class ControlChangeService extends BaseService {
      * @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 getLastControlChange({ controlChangeLast, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IGetLastControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGetPaginated>;
+    static getLastControlChange({ controlChangeLast, statusLimit, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IGetLastControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGetPaginated>;
     /**
      * Get Range Control Change
      * Get Range Control Change.  Returns a list of the history of all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; status changes that have happened within a date range for each &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs for each of the body parameters in the array &#x60;asset_names&#x60;.  **Pagination Sortable Columns:** &#x60;control_change.id&#x60;, &#x60;control_change.asset_name&#x60;, &#x60;control_change.metric_name&#x60;, &#x60;control_change.last_state&#x60;, &#x60;control_change.created&#x60;, &#x60;control_change.updated&#x60;, &#x60;control_change.timestamp&#x60;  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeRange Control change range schema
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 Kelvin Asset Statistic objects.
      * @param startingAfter An alphanumeric string to move to the next page of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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 the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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.
@@ -63,11 +66,12 @@ export declare class ControlChangeService extends BaseService {
      * @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 getRangeControlChange({ controlChangeRange, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IGetRangeControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGetPaginated>;
+    static getRangeControlChange({ controlChangeRange, statusLimit, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IGetRangeControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGetPaginated>;
     /**
      * List Control Change
      * List Control Change lists the Control Changes for each asset metric.  Returns a list of the history of all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; requests for each &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs for each of the body parameters in the array &#x60;asset_names&#x60;.  **Pagination Sortable Columns:** &#x60;control_change.id&#x60;, &#x60;control_change.asset_name&#x60;, &#x60;control_change.metric_name&#x60;, &#x60;control_change.last_state&#x60;, &#x60;control_change.created&#x60;, &#x60;control_change.updated&#x60;, &#x60;control_change.timestamp&#x60;  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeList Control change list schema
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 Kelvin Asset Statistic objects.
      * @param startingAfter An alphanumeric string to move to the next page of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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 the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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.
@@ -75,7 +79,7 @@ export declare class ControlChangeService extends BaseService {
      * @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 listControlChange({ controlChangeList, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGetPaginated>;
+    static listControlChange({ controlChangeList, statusLimit, pageSize, startingAfter, endingBefore, sortBy, sortAsc }: IListControlChangeParams, options?: IKvHttpRequestOptions): Observable<ControlChangeGetPaginated>;
     /**
      * Upload Control Change
      * Upload Control Change  This is required only for internal &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; management. It will update 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; with the current status of all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; requests on a &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Node&lt;/a&gt;.  **Permission Required:** &#x60;kelvin.permission.control_change.create&#x60;

package/dist/esm/services/generated/api/controlChange.service.js CHANGED Viewed

@@ -15,8 +15,8 @@ export class ControlChangeService extends BaseService {
             method: 'post'
         };
         requestConfig.data = controlChange;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/create`, requestConfig, ControlChange);
     }
     /**
@@ -51,27 +51,33 @@ export class ControlChangeService extends BaseService {
             queryParameters['sort_asc'] = sortAsc;
         }
         requestConfig.params = queryParameters;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/sync/${encodeURIComponent(String(node))}/download`, requestConfig, ControlChangePaginated);
     }
     /**
      * Get Control Change
      * Get Control Change  Returns the properties of a single &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; request via its unique ID.  Returned object will not only give the &#x60;status&#x60; and &#x60;payload&#x60; of the last &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; but also the &#x60;status_log&#x60; containing the information of when the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; was created, sent to bridge and confirmed with a read.  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeId Unique identifier id for the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt;.&lt;/p&gt; This must contain only lowercase alphanumeric characters and the &#x60;-&#x60; character only. For example &#x60;764168a8-0e1e-33aa-adc7-14dfbb78dfad&#x60;
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
-    static getControlChange({ controlChangeId }, options) {
+    static getControlChange({ controlChangeId, statusLimit }, options) {
         const requestConfig = {
             method: 'get'
         };
-        requestConfig.mediaType = 'application/json';
+        const queryParameters = {};
+        if (statusLimit != null) {
+            queryParameters['status_limit'] = statusLimit;
+        }
+        requestConfig.params = queryParameters;
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/${encodeURIComponent(String(controlChangeId))}/get`, requestConfig, ControlChangeGet);
     }
     /**
      * Get Control Change Clustering
-     * Get Control Change Clustering  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
+     * Get Control Change Clustering  Groups and counts the occurrence of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Changes&lt;/a&gt; within a defined time bucket.  The grouping can also be filtered to only include &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Changes&lt;/a&gt; for certain &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Assets&lt;/a&gt;, &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metrics&lt;/a&gt; or current &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; statuses.  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeClustering Control Change Clustering schema
      * @param {IKvHttpRequestOptions} options Request optional parameters
      */
@@ -80,14 +86,15 @@ export class ControlChangeService extends BaseService {
             method: 'post'
         };
         requestConfig.data = controlChangeClustering;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/clustering/get`, requestConfig, ControlChangeClustering);
     }
     /**
      * Get Last Control Change
      * Get Last Control Change  Returns a list of the last &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; for each &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs for each of the body parameters in the array &#x60;asset_names&#x60;.  The list will include &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Changes&lt;/a&gt; that succeeded, failed or are pending.  Each object will not only give the &#x60;status&#x60; and &#x60;payload&#x60; of the last &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; but also the &#x60;status_log&#x60; containing the information of when the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; was created, sent to bridge and confirmed with a read.  **Pagination Sortable Columns:** &#x60;control_change.id&#x60;, &#x60;control_change.asset_name&#x60;, &#x60;control_change.metric_name&#x60;, &#x60;control_change.last_state&#x60;, &#x60;control_change.created&#x60;, &#x60;control_change.updated&#x60;, &#x60;control_change.timestamp&#x60;  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeLast Last control change schema
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 Kelvin Asset Statistic objects.
      * @param startingAfter An alphanumeric string to move to the next page of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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 the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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.
@@ -95,11 +102,14 @@ export class ControlChangeService extends BaseService {
      * @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 getLastControlChange({ controlChangeLast, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
+    static getLastControlChange({ controlChangeLast, statusLimit, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
         const requestConfig = {
             method: 'post'
         };
         const queryParameters = {};
+        if (statusLimit != null) {
+            queryParameters['status_limit'] = statusLimit;
+        }
         if (pageSize != null) {
             queryParameters['page_size'] = pageSize;
         }
@@ -117,14 +127,15 @@ export class ControlChangeService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = controlChangeLast;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/last/get`, requestConfig, ControlChangeGetPaginated);
     }
     /**
      * Get Range Control Change
      * Get Range Control Change.  Returns a list of the history of all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; status changes that have happened within a date range for each &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs for each of the body parameters in the array &#x60;asset_names&#x60;.  **Pagination Sortable Columns:** &#x60;control_change.id&#x60;, &#x60;control_change.asset_name&#x60;, &#x60;control_change.metric_name&#x60;, &#x60;control_change.last_state&#x60;, &#x60;control_change.created&#x60;, &#x60;control_change.updated&#x60;, &#x60;control_change.timestamp&#x60;  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeRange Control change range schema
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 Kelvin Asset Statistic objects.
      * @param startingAfter An alphanumeric string to move to the next page of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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 the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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.
@@ -132,11 +143,14 @@ export class ControlChangeService extends BaseService {
      * @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 getRangeControlChange({ controlChangeRange, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
+    static getRangeControlChange({ controlChangeRange, statusLimit, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
         const requestConfig = {
             method: 'post'
         };
         const queryParameters = {};
+        if (statusLimit != null) {
+            queryParameters['status_limit'] = statusLimit;
+        }
         if (pageSize != null) {
             queryParameters['page_size'] = pageSize;
         }
@@ -154,14 +168,15 @@ export class ControlChangeService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = controlChangeRange;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/range/get`, requestConfig, ControlChangeGetPaginated);
     }
     /**
      * List Control Change
      * List Control Change lists the Control Changes for each asset metric.  Returns a list of the history of all &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; requests for each &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Asset&lt;/a&gt; / &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Metric&lt;/a&gt; pairs for each of the body parameters in the array &#x60;asset_names&#x60;.  **Pagination Sortable Columns:** &#x60;control_change.id&#x60;, &#x60;control_change.asset_name&#x60;, &#x60;control_change.metric_name&#x60;, &#x60;control_change.last_state&#x60;, &#x60;control_change.created&#x60;, &#x60;control_change.updated&#x60;, &#x60;control_change.timestamp&#x60;  **Permission Required:** &#x60;kelvin.permission.control_change.read&#x60;
      * @param controlChangeList Control change list schema
+     * @param statusLimit Number of statuses per &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 300 objects.&lt;/p&gt; Default value is 20.
      * @param pageSize Number of &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; objects to be returned. Page size can be between 1 and 1000 objects.&lt;/p&gt; The default is 20 Kelvin Asset Statistic objects.
      * @param startingAfter An alphanumeric string to move to the next page of the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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 the &lt;a href&#x3D;&#39;https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-control-change/&#39; target&#x3D;&#39;_blank&#39;&gt;Kelvin Control Change&lt;/a&gt; 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.
@@ -169,11 +184,14 @@ export class ControlChangeService extends BaseService {
      * @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 listControlChange({ controlChangeList, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
+    static listControlChange({ controlChangeList, statusLimit, pageSize, startingAfter, endingBefore, sortBy, sortAsc }, options) {
         const requestConfig = {
             method: 'post'
         };
         const queryParameters = {};
+        if (statusLimit != null) {
+            queryParameters['status_limit'] = statusLimit;
+        }
         if (pageSize != null) {
             queryParameters['page_size'] = pageSize;
         }
@@ -191,8 +209,8 @@ export class ControlChangeService extends BaseService {
         }
         requestConfig.params = queryParameters;
         requestConfig.data = controlChangeList;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/list`, requestConfig, ControlChangeGetPaginated);
     }
     /**
@@ -207,8 +225,8 @@ export class ControlChangeService extends BaseService {
             method: 'post'
         };
         requestConfig.data = controlChange;
-        requestConfig.mediaType = 'application/json';
         requestConfig.options = options;
+        requestConfig.mediaType = 'application/json';
         return this.request(`/control-changes/sync/${encodeURIComponent(String(node))}/upload`, requestConfig);
     }
 }