@openremote/rest 1.5.0-snapshot.20250422083638 → 1.5.0-snapshot.20250422151242
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.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +458 -456
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,59 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class AlarmResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP POST /alarm
|
|
17
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
18
|
-
*/
|
|
19
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
20
|
-
assetIds?: string[];
|
|
21
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
22
|
-
/**
|
|
23
|
-
* HTTP GET /alarm
|
|
24
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
25
|
-
*/
|
|
26
|
-
getAlarms(queryParams?: {
|
|
27
|
-
realm?: string;
|
|
28
|
-
status?: Model.AlarmStatus;
|
|
29
|
-
assetId?: string;
|
|
30
|
-
assigneeId?: string;
|
|
31
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
32
|
-
/**
|
|
33
|
-
* HTTP DELETE /alarm
|
|
34
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
35
|
-
*/
|
|
36
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
37
|
-
/**
|
|
38
|
-
* HTTP PUT /alarm/assets
|
|
39
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
40
|
-
*/
|
|
41
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
42
|
-
/**
|
|
43
|
-
* HTTP GET /alarm/{alarmId}
|
|
44
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
45
|
-
*/
|
|
46
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
47
|
-
/**
|
|
48
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
49
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
50
|
-
*/
|
|
51
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
52
|
-
/**
|
|
53
|
-
* HTTP PUT /alarm/{alarmId}
|
|
54
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
55
|
-
*/
|
|
56
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
57
|
-
/**
|
|
58
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
59
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
60
|
-
*/
|
|
61
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
62
|
-
realm?: string;
|
|
63
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
64
|
-
}
|
|
65
12
|
export declare class RealmResourceClient<O> {
|
|
66
13
|
protected httpClient: HttpClient<O>;
|
|
67
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -96,6 +43,72 @@ export declare class RealmResourceClient<O> {
|
|
|
96
43
|
*/
|
|
97
44
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
98
45
|
}
|
|
46
|
+
export declare class SyslogResourceClient<O> {
|
|
47
|
+
protected httpClient: HttpClient<O>;
|
|
48
|
+
constructor(httpClient: HttpClient<O>);
|
|
49
|
+
/**
|
|
50
|
+
* HTTP GET /syslog/config
|
|
51
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
52
|
+
*/
|
|
53
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
54
|
+
/**
|
|
55
|
+
* HTTP PUT /syslog/config
|
|
56
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
57
|
+
*/
|
|
58
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
59
|
+
/**
|
|
60
|
+
* HTTP DELETE /syslog/event
|
|
61
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
62
|
+
*/
|
|
63
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
64
|
+
/**
|
|
65
|
+
* HTTP GET /syslog/event
|
|
66
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
67
|
+
*/
|
|
68
|
+
getEvents(queryParams?: {
|
|
69
|
+
level?: Model.SyslogLevel;
|
|
70
|
+
per_page?: number;
|
|
71
|
+
page?: number;
|
|
72
|
+
from?: number;
|
|
73
|
+
to?: number;
|
|
74
|
+
category?: Model.SyslogCategory[];
|
|
75
|
+
subCategory?: string[];
|
|
76
|
+
}, options?: O): RestResponse<any>;
|
|
77
|
+
}
|
|
78
|
+
export declare class DashboardResourceClient<O> {
|
|
79
|
+
protected httpClient: HttpClient<O>;
|
|
80
|
+
constructor(httpClient: HttpClient<O>);
|
|
81
|
+
/**
|
|
82
|
+
* HTTP POST /dashboard
|
|
83
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
84
|
+
*/
|
|
85
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
86
|
+
/**
|
|
87
|
+
* HTTP PUT /dashboard
|
|
88
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
89
|
+
*/
|
|
90
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
91
|
+
/**
|
|
92
|
+
* HTTP GET /dashboard/all/{realm}
|
|
93
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
94
|
+
*/
|
|
95
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
96
|
+
/**
|
|
97
|
+
* HTTP POST /dashboard/query
|
|
98
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
99
|
+
*/
|
|
100
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
101
|
+
/**
|
|
102
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
103
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
104
|
+
*/
|
|
105
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
106
|
+
/**
|
|
107
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
108
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
109
|
+
*/
|
|
110
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
111
|
+
}
|
|
99
112
|
export declare class RulesResourceClient<O> {
|
|
100
113
|
protected httpClient: HttpClient<O>;
|
|
101
114
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -204,128 +217,224 @@ export declare class RulesResourceClient<O> {
|
|
|
204
217
|
*/
|
|
205
218
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
206
219
|
}
|
|
207
|
-
export declare class
|
|
220
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
208
221
|
protected httpClient: HttpClient<O>;
|
|
209
222
|
constructor(httpClient: HttpClient<O>);
|
|
210
223
|
/**
|
|
211
|
-
* HTTP
|
|
212
|
-
* Java method: org.openremote.model.
|
|
224
|
+
* HTTP GET /asset/datapoint/export
|
|
225
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
213
226
|
*/
|
|
214
|
-
|
|
227
|
+
getDatapointExport(queryParams?: {
|
|
228
|
+
attributeRefs?: string;
|
|
229
|
+
fromTimestamp?: number;
|
|
230
|
+
toTimestamp?: number;
|
|
231
|
+
}, options?: O): RestResponse<any>;
|
|
215
232
|
/**
|
|
216
|
-
* HTTP
|
|
217
|
-
* Java method: org.openremote.model.
|
|
233
|
+
* HTTP GET /asset/datapoint/periods
|
|
234
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
218
235
|
*/
|
|
219
|
-
|
|
236
|
+
getDatapointPeriod(queryParams?: {
|
|
237
|
+
assetId?: string;
|
|
238
|
+
attributeName?: string;
|
|
239
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
220
240
|
/**
|
|
221
|
-
* HTTP
|
|
222
|
-
* Java method: org.openremote.model.
|
|
241
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
242
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
223
243
|
*/
|
|
224
|
-
|
|
244
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
245
|
+
}
|
|
246
|
+
export declare class FlowResourceClient<O> {
|
|
247
|
+
protected httpClient: HttpClient<O>;
|
|
248
|
+
constructor(httpClient: HttpClient<O>);
|
|
225
249
|
/**
|
|
226
|
-
* HTTP
|
|
227
|
-
* Java method: org.openremote.model.
|
|
250
|
+
* HTTP GET /flow
|
|
251
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
228
252
|
*/
|
|
229
|
-
|
|
253
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
230
254
|
/**
|
|
231
|
-
* HTTP
|
|
232
|
-
* Java method: org.openremote.model.
|
|
255
|
+
* HTTP GET /flow/{name}
|
|
256
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
233
257
|
*/
|
|
234
|
-
|
|
258
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
235
259
|
/**
|
|
236
|
-
* HTTP GET /
|
|
237
|
-
* Java method: org.openremote.model.
|
|
260
|
+
* HTTP GET /flow/{type}
|
|
261
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
238
262
|
*/
|
|
239
|
-
|
|
263
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
240
264
|
}
|
|
241
|
-
export declare class
|
|
265
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
242
266
|
protected httpClient: HttpClient<O>;
|
|
243
267
|
constructor(httpClient: HttpClient<O>);
|
|
244
268
|
/**
|
|
245
|
-
* HTTP
|
|
246
|
-
* Java method: org.openremote.model.
|
|
247
|
-
*/
|
|
248
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
249
|
-
/**
|
|
250
|
-
* HTTP GET /apps/consoleConfig
|
|
251
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
269
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
270
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
252
271
|
*/
|
|
253
|
-
|
|
272
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
254
273
|
/**
|
|
255
|
-
* HTTP
|
|
256
|
-
* Java method: org.openremote.model.
|
|
274
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
275
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
257
276
|
*/
|
|
258
|
-
|
|
277
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
259
278
|
}
|
|
260
|
-
export declare class
|
|
279
|
+
export declare class AssetModelResourceClient<O> {
|
|
261
280
|
protected httpClient: HttpClient<O>;
|
|
262
281
|
constructor(httpClient: HttpClient<O>);
|
|
263
282
|
/**
|
|
264
|
-
* HTTP GET /
|
|
265
|
-
* Java method: org.openremote.model.
|
|
283
|
+
* HTTP GET /model/assetDescriptors
|
|
284
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
266
285
|
*/
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
286
|
+
getAssetDescriptors(queryParams?: {
|
|
287
|
+
parentId?: string;
|
|
288
|
+
parentType?: string;
|
|
289
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
270
290
|
/**
|
|
271
|
-
* HTTP GET /
|
|
272
|
-
* Java method: org.openremote.model.
|
|
291
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
292
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
273
293
|
*/
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
}>;
|
|
277
|
-
}
|
|
278
|
-
export declare class AgentResourceClient<O> {
|
|
279
|
-
protected httpClient: HttpClient<O>;
|
|
280
|
-
constructor(httpClient: HttpClient<O>);
|
|
294
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
295
|
+
parentId?: string;
|
|
296
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
281
297
|
/**
|
|
282
|
-
* HTTP GET /
|
|
283
|
-
* Java method: org.openremote.model.asset.
|
|
298
|
+
* HTTP GET /model/assetInfos
|
|
299
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
284
300
|
*/
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
301
|
+
getAssetInfos(queryParams?: {
|
|
302
|
+
parentId?: string;
|
|
303
|
+
parentType?: string;
|
|
304
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
288
305
|
/**
|
|
289
|
-
* HTTP
|
|
290
|
-
* Java method: org.openremote.model.asset.
|
|
306
|
+
* HTTP GET /model/metaItemDescriptors
|
|
307
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
291
308
|
*/
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
}, options?: O): RestResponse<
|
|
309
|
+
getMetaItemDescriptors(queryParams?: {
|
|
310
|
+
parentId?: string;
|
|
311
|
+
}, options?: O): RestResponse<{
|
|
312
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
313
|
+
}>;
|
|
295
314
|
/**
|
|
296
|
-
* HTTP GET /
|
|
297
|
-
* Java method: org.openremote.model.asset.
|
|
315
|
+
* HTTP GET /model/valueDescriptors
|
|
316
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
298
317
|
*/
|
|
299
|
-
|
|
318
|
+
getValueDescriptors(queryParams?: {
|
|
300
319
|
parentId?: string;
|
|
301
|
-
|
|
302
|
-
|
|
320
|
+
}, options?: O): RestResponse<{
|
|
321
|
+
[index: string]: Model.ValueDescriptor;
|
|
322
|
+
}>;
|
|
303
323
|
}
|
|
304
|
-
export declare class
|
|
324
|
+
export declare class MapResourceClient<O> {
|
|
305
325
|
protected httpClient: HttpClient<O>;
|
|
306
326
|
constructor(httpClient: HttpClient<O>);
|
|
307
327
|
/**
|
|
308
|
-
* HTTP GET /
|
|
309
|
-
* Java method: org.openremote.model.
|
|
328
|
+
* HTTP GET /map
|
|
329
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
310
330
|
*/
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
331
|
+
getSettings(options?: O): RestResponse<{
|
|
332
|
+
[id: string]: unknown;
|
|
333
|
+
}>;
|
|
334
|
+
/**
|
|
335
|
+
* HTTP PUT /map
|
|
336
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
315
337
|
*/
|
|
316
|
-
|
|
338
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
339
|
+
[id: string]: unknown;
|
|
340
|
+
}>;
|
|
317
341
|
/**
|
|
318
|
-
* HTTP
|
|
319
|
-
* Java method: org.openremote.model.
|
|
342
|
+
* HTTP DELETE /map/deleteMap
|
|
343
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
320
344
|
*/
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
}
|
|
345
|
+
deleteMap(options?: O): RestResponse<{
|
|
346
|
+
[id: string]: unknown;
|
|
347
|
+
}>;
|
|
324
348
|
/**
|
|
325
|
-
* HTTP GET /
|
|
326
|
-
* Java method: org.openremote.model.
|
|
349
|
+
* HTTP GET /map/getCustomMapInfo
|
|
350
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
327
351
|
*/
|
|
328
|
-
|
|
352
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
353
|
+
[id: string]: unknown;
|
|
354
|
+
}>;
|
|
355
|
+
/**
|
|
356
|
+
* HTTP GET /map/js
|
|
357
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
358
|
+
*/
|
|
359
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
360
|
+
[id: string]: unknown;
|
|
361
|
+
}>;
|
|
362
|
+
/**
|
|
363
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
364
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
365
|
+
*/
|
|
366
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
367
|
+
/**
|
|
368
|
+
* HTTP POST /map/upload
|
|
369
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
370
|
+
*/
|
|
371
|
+
uploadMap(queryParams?: {
|
|
372
|
+
filename?: string;
|
|
373
|
+
}, options?: O): RestResponse<{
|
|
374
|
+
[id: string]: unknown;
|
|
375
|
+
}>;
|
|
376
|
+
}
|
|
377
|
+
export declare class GatewayClientResourceClient<O> {
|
|
378
|
+
protected httpClient: HttpClient<O>;
|
|
379
|
+
constructor(httpClient: HttpClient<O>);
|
|
380
|
+
/**
|
|
381
|
+
* HTTP DELETE /gateway/connection
|
|
382
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
383
|
+
*/
|
|
384
|
+
deleteConnections(queryParams?: {
|
|
385
|
+
realm?: string[];
|
|
386
|
+
}, options?: O): RestResponse<void>;
|
|
387
|
+
/**
|
|
388
|
+
* HTTP GET /gateway/connection
|
|
389
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
390
|
+
*/
|
|
391
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
392
|
+
/**
|
|
393
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
394
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
395
|
+
*/
|
|
396
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
397
|
+
/**
|
|
398
|
+
* HTTP GET /gateway/connection/{realm}
|
|
399
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
400
|
+
*/
|
|
401
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
402
|
+
/**
|
|
403
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
404
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
405
|
+
*/
|
|
406
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
407
|
+
/**
|
|
408
|
+
* HTTP GET /gateway/status/{realm}
|
|
409
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
410
|
+
*/
|
|
411
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
412
|
+
}
|
|
413
|
+
export declare class AgentResourceClient<O> {
|
|
414
|
+
protected httpClient: HttpClient<O>;
|
|
415
|
+
constructor(httpClient: HttpClient<O>);
|
|
416
|
+
/**
|
|
417
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
418
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
419
|
+
*/
|
|
420
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
421
|
+
realm?: string;
|
|
422
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
423
|
+
/**
|
|
424
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
425
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
426
|
+
*/
|
|
427
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
428
|
+
realm?: string;
|
|
429
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
430
|
+
/**
|
|
431
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
432
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
433
|
+
*/
|
|
434
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
435
|
+
parentId?: string;
|
|
436
|
+
realm?: string;
|
|
437
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
329
438
|
}
|
|
330
439
|
export declare class ConsoleResourceClient<O> {
|
|
331
440
|
protected httpClient: HttpClient<O>;
|
|
@@ -336,77 +445,101 @@ export declare class ConsoleResourceClient<O> {
|
|
|
336
445
|
*/
|
|
337
446
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
338
447
|
}
|
|
339
|
-
export declare class
|
|
448
|
+
export declare class StatusResourceClient<O> {
|
|
340
449
|
protected httpClient: HttpClient<O>;
|
|
341
450
|
constructor(httpClient: HttpClient<O>);
|
|
342
451
|
/**
|
|
343
|
-
* HTTP
|
|
344
|
-
* Java method: org.openremote.model.
|
|
452
|
+
* HTTP GET /health
|
|
453
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
345
454
|
*/
|
|
346
|
-
|
|
455
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
456
|
+
[index: string]: any;
|
|
457
|
+
}>;
|
|
347
458
|
/**
|
|
348
|
-
* HTTP
|
|
349
|
-
* Java method: org.openremote.model.
|
|
459
|
+
* HTTP GET /info
|
|
460
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
350
461
|
*/
|
|
351
|
-
|
|
462
|
+
getInfo(options?: O): RestResponse<{
|
|
463
|
+
[index: string]: any;
|
|
464
|
+
}>;
|
|
352
465
|
}
|
|
353
|
-
export declare class
|
|
466
|
+
export declare class NotificationResourceClient<O> {
|
|
354
467
|
protected httpClient: HttpClient<O>;
|
|
355
468
|
constructor(httpClient: HttpClient<O>);
|
|
356
469
|
/**
|
|
357
|
-
* HTTP GET /
|
|
358
|
-
* Java method: org.openremote.model.
|
|
470
|
+
* HTTP GET /notification
|
|
471
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
359
472
|
*/
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
473
|
+
getNotifications(queryParams?: {
|
|
474
|
+
id?: number;
|
|
475
|
+
type?: string;
|
|
476
|
+
from?: number;
|
|
477
|
+
to?: number;
|
|
478
|
+
realmId?: string;
|
|
479
|
+
userId?: string;
|
|
480
|
+
assetId?: string;
|
|
481
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
365
482
|
/**
|
|
366
|
-
* HTTP
|
|
367
|
-
* Java method: org.openremote.model.
|
|
483
|
+
* HTTP DELETE /notification
|
|
484
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
368
485
|
*/
|
|
369
|
-
|
|
486
|
+
removeNotifications(queryParams?: {
|
|
487
|
+
id?: number;
|
|
488
|
+
type?: string;
|
|
489
|
+
from?: number;
|
|
490
|
+
to?: number;
|
|
491
|
+
realmId?: string;
|
|
492
|
+
userId?: string;
|
|
370
493
|
assetId?: string;
|
|
371
|
-
|
|
372
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
494
|
+
}, options?: O): RestResponse<void>;
|
|
373
495
|
/**
|
|
374
|
-
* HTTP POST /
|
|
375
|
-
* Java method: org.openremote.model.
|
|
496
|
+
* HTTP POST /notification/alert
|
|
497
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
376
498
|
*/
|
|
377
|
-
|
|
499
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
500
|
+
/**
|
|
501
|
+
* HTTP DELETE /notification/{notificationId}
|
|
502
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
503
|
+
*/
|
|
504
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
505
|
+
/**
|
|
506
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
507
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
508
|
+
*/
|
|
509
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
510
|
+
targetId?: string;
|
|
511
|
+
}, options?: O): RestResponse<void>;
|
|
512
|
+
/**
|
|
513
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
514
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
515
|
+
*/
|
|
516
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
517
|
+
targetId?: string;
|
|
518
|
+
}, options?: O): RestResponse<void>;
|
|
378
519
|
}
|
|
379
|
-
export declare class
|
|
520
|
+
export declare class ProvisioningResourceClient<O> {
|
|
380
521
|
protected httpClient: HttpClient<O>;
|
|
381
522
|
constructor(httpClient: HttpClient<O>);
|
|
382
523
|
/**
|
|
383
|
-
* HTTP
|
|
384
|
-
* Java method: org.openremote.model.
|
|
524
|
+
* HTTP POST /provisioning
|
|
525
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
385
526
|
*/
|
|
386
|
-
|
|
527
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
387
528
|
/**
|
|
388
|
-
* HTTP
|
|
389
|
-
* Java method: org.openremote.model.
|
|
529
|
+
* HTTP GET /provisioning
|
|
530
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
390
531
|
*/
|
|
391
|
-
|
|
532
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
392
533
|
/**
|
|
393
|
-
* HTTP DELETE /
|
|
394
|
-
* Java method: org.openremote.model.
|
|
534
|
+
* HTTP DELETE /provisioning/{id}
|
|
535
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
395
536
|
*/
|
|
396
|
-
|
|
537
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
397
538
|
/**
|
|
398
|
-
* HTTP
|
|
399
|
-
* Java method: org.openremote.model.
|
|
539
|
+
* HTTP PUT /provisioning/{id}
|
|
540
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
400
541
|
*/
|
|
401
|
-
|
|
402
|
-
level?: Model.SyslogLevel;
|
|
403
|
-
per_page?: number;
|
|
404
|
-
page?: number;
|
|
405
|
-
from?: number;
|
|
406
|
-
to?: number;
|
|
407
|
-
category?: Model.SyslogCategory[];
|
|
408
|
-
subCategory?: string[];
|
|
409
|
-
}, options?: O): RestResponse<any>;
|
|
542
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
410
543
|
}
|
|
411
544
|
export declare class UserResourceClient<O> {
|
|
412
545
|
protected httpClient: HttpClient<O>;
|
|
@@ -507,232 +640,39 @@ export declare class UserResourceClient<O> {
|
|
|
507
640
|
*/
|
|
508
641
|
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
509
642
|
/**
|
|
510
|
-
* HTTP GET /user/{realm}/{userId}
|
|
511
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
512
|
-
*/
|
|
513
|
-
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
514
|
-
}
|
|
515
|
-
export declare class ProvisioningResourceClient<O> {
|
|
516
|
-
protected httpClient: HttpClient<O>;
|
|
517
|
-
constructor(httpClient: HttpClient<O>);
|
|
518
|
-
/**
|
|
519
|
-
* HTTP POST /provisioning
|
|
520
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
521
|
-
*/
|
|
522
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
523
|
-
/**
|
|
524
|
-
* HTTP GET /provisioning
|
|
525
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
526
|
-
*/
|
|
527
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
528
|
-
/**
|
|
529
|
-
* HTTP DELETE /provisioning/{id}
|
|
530
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
531
|
-
*/
|
|
532
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
533
|
-
/**
|
|
534
|
-
* HTTP PUT /provisioning/{id}
|
|
535
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
536
|
-
*/
|
|
537
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
538
|
-
}
|
|
539
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
540
|
-
protected httpClient: HttpClient<O>;
|
|
541
|
-
constructor(httpClient: HttpClient<O>);
|
|
542
|
-
/**
|
|
543
|
-
* HTTP POST /gateway/tunnel
|
|
544
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
545
|
-
*/
|
|
546
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
547
|
-
/**
|
|
548
|
-
* HTTP DELETE /gateway/tunnel
|
|
549
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
550
|
-
*/
|
|
551
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
552
|
-
/**
|
|
553
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
554
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
555
|
-
*/
|
|
556
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
557
|
-
/**
|
|
558
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
559
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
560
|
-
*/
|
|
561
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
562
|
-
/**
|
|
563
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
564
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
565
|
-
*/
|
|
566
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
567
|
-
}
|
|
568
|
-
export declare class NotificationResourceClient<O> {
|
|
569
|
-
protected httpClient: HttpClient<O>;
|
|
570
|
-
constructor(httpClient: HttpClient<O>);
|
|
571
|
-
/**
|
|
572
|
-
* HTTP GET /notification
|
|
573
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
574
|
-
*/
|
|
575
|
-
getNotifications(queryParams?: {
|
|
576
|
-
id?: number;
|
|
577
|
-
type?: string;
|
|
578
|
-
from?: number;
|
|
579
|
-
to?: number;
|
|
580
|
-
realmId?: string;
|
|
581
|
-
userId?: string;
|
|
582
|
-
assetId?: string;
|
|
583
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
584
|
-
/**
|
|
585
|
-
* HTTP DELETE /notification
|
|
586
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
587
|
-
*/
|
|
588
|
-
removeNotifications(queryParams?: {
|
|
589
|
-
id?: number;
|
|
590
|
-
type?: string;
|
|
591
|
-
from?: number;
|
|
592
|
-
to?: number;
|
|
593
|
-
realmId?: string;
|
|
594
|
-
userId?: string;
|
|
595
|
-
assetId?: string;
|
|
596
|
-
}, options?: O): RestResponse<void>;
|
|
597
|
-
/**
|
|
598
|
-
* HTTP POST /notification/alert
|
|
599
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
600
|
-
*/
|
|
601
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
602
|
-
/**
|
|
603
|
-
* HTTP DELETE /notification/{notificationId}
|
|
604
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
605
|
-
*/
|
|
606
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
607
|
-
/**
|
|
608
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
609
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
610
|
-
*/
|
|
611
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
612
|
-
targetId?: string;
|
|
613
|
-
}, options?: O): RestResponse<void>;
|
|
614
|
-
/**
|
|
615
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
616
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
617
|
-
*/
|
|
618
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
619
|
-
targetId?: string;
|
|
620
|
-
}, options?: O): RestResponse<void>;
|
|
621
|
-
}
|
|
622
|
-
export declare class MapResourceClient<O> {
|
|
623
|
-
protected httpClient: HttpClient<O>;
|
|
624
|
-
constructor(httpClient: HttpClient<O>);
|
|
625
|
-
/**
|
|
626
|
-
* HTTP GET /map
|
|
627
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
628
|
-
*/
|
|
629
|
-
getSettings(options?: O): RestResponse<{
|
|
630
|
-
[id: string]: unknown;
|
|
631
|
-
}>;
|
|
632
|
-
/**
|
|
633
|
-
* HTTP PUT /map
|
|
634
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
635
|
-
*/
|
|
636
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<any>;
|
|
637
|
-
/**
|
|
638
|
-
* HTTP DELETE /map/deleteMap
|
|
639
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
640
|
-
*/
|
|
641
|
-
deleteMap(options?: O): RestResponse<{
|
|
642
|
-
[id: string]: unknown;
|
|
643
|
-
}>;
|
|
644
|
-
/**
|
|
645
|
-
* HTTP GET /map/getCustomMapInfo
|
|
646
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
647
|
-
*/
|
|
648
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
649
|
-
[id: string]: unknown;
|
|
650
|
-
}>;
|
|
651
|
-
/**
|
|
652
|
-
* HTTP GET /map/js
|
|
653
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
654
|
-
*/
|
|
655
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
656
|
-
[id: string]: unknown;
|
|
657
|
-
}>;
|
|
658
|
-
/**
|
|
659
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
660
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
661
|
-
*/
|
|
662
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
663
|
-
/**
|
|
664
|
-
* HTTP POST /map/upload
|
|
665
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
666
|
-
*/
|
|
667
|
-
uploadMap(queryParams?: {
|
|
668
|
-
filename?: string;
|
|
669
|
-
}, options?: O): RestResponse<{
|
|
670
|
-
[id: string]: unknown;
|
|
671
|
-
}>;
|
|
672
|
-
}
|
|
673
|
-
export declare class FlowResourceClient<O> {
|
|
674
|
-
protected httpClient: HttpClient<O>;
|
|
675
|
-
constructor(httpClient: HttpClient<O>);
|
|
676
|
-
/**
|
|
677
|
-
* HTTP GET /flow
|
|
678
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
679
|
-
*/
|
|
680
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
681
|
-
/**
|
|
682
|
-
* HTTP GET /flow/{name}
|
|
683
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
684
|
-
*/
|
|
685
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
686
|
-
/**
|
|
687
|
-
* HTTP GET /flow/{type}
|
|
688
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
643
|
+
* HTTP GET /user/{realm}/{userId}
|
|
644
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
689
645
|
*/
|
|
690
|
-
|
|
646
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
691
647
|
}
|
|
692
|
-
export declare class
|
|
648
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
693
649
|
protected httpClient: HttpClient<O>;
|
|
694
650
|
constructor(httpClient: HttpClient<O>);
|
|
695
651
|
/**
|
|
696
|
-
* HTTP
|
|
697
|
-
* Java method: org.openremote.model.
|
|
652
|
+
* HTTP POST /gateway/tunnel
|
|
653
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
698
654
|
*/
|
|
699
|
-
|
|
700
|
-
parentId?: string;
|
|
701
|
-
parentType?: string;
|
|
702
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
655
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
703
656
|
/**
|
|
704
|
-
* HTTP
|
|
705
|
-
* Java method: org.openremote.model.
|
|
657
|
+
* HTTP DELETE /gateway/tunnel
|
|
658
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
706
659
|
*/
|
|
707
|
-
|
|
708
|
-
parentId?: string;
|
|
709
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
660
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
710
661
|
/**
|
|
711
|
-
* HTTP GET /
|
|
712
|
-
* Java method: org.openremote.model.
|
|
662
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
663
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
713
664
|
*/
|
|
714
|
-
|
|
715
|
-
parentId?: string;
|
|
716
|
-
parentType?: string;
|
|
717
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
665
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
718
666
|
/**
|
|
719
|
-
* HTTP GET /
|
|
720
|
-
* Java method: org.openremote.model.
|
|
667
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
668
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
721
669
|
*/
|
|
722
|
-
|
|
723
|
-
parentId?: string;
|
|
724
|
-
}, options?: O): RestResponse<{
|
|
725
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
726
|
-
}>;
|
|
670
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
727
671
|
/**
|
|
728
|
-
* HTTP GET /
|
|
729
|
-
* Java method: org.openremote.model.
|
|
672
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
673
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
730
674
|
*/
|
|
731
|
-
|
|
732
|
-
parentId?: string;
|
|
733
|
-
}, options?: O): RestResponse<{
|
|
734
|
-
[index: string]: Model.ValueDescriptor;
|
|
735
|
-
}>;
|
|
675
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
736
676
|
}
|
|
737
677
|
export declare class AssetResourceClient<O> {
|
|
738
678
|
protected httpClient: HttpClient<O>;
|
|
@@ -838,87 +778,149 @@ export declare class AssetResourceClient<O> {
|
|
|
838
778
|
assetIds?: string[];
|
|
839
779
|
}, options?: O): RestResponse<void>;
|
|
840
780
|
}
|
|
841
|
-
export declare class
|
|
781
|
+
export declare class AlarmResourceClient<O> {
|
|
842
782
|
protected httpClient: HttpClient<O>;
|
|
843
783
|
constructor(httpClient: HttpClient<O>);
|
|
844
784
|
/**
|
|
845
|
-
* HTTP
|
|
846
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* HTTP POST /alarm
|
|
786
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
847
787
|
*/
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
}, options?: O): RestResponse<
|
|
788
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
789
|
+
assetIds?: string[];
|
|
790
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
851
791
|
/**
|
|
852
|
-
* HTTP GET /
|
|
853
|
-
* Java method: org.openremote.model.
|
|
792
|
+
* HTTP GET /alarm
|
|
793
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
854
794
|
*/
|
|
855
|
-
|
|
795
|
+
getAlarms(queryParams?: {
|
|
796
|
+
realm?: string;
|
|
797
|
+
status?: Model.AlarmStatus;
|
|
798
|
+
assetId?: string;
|
|
799
|
+
assigneeId?: string;
|
|
800
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
856
801
|
/**
|
|
857
|
-
* HTTP DELETE /
|
|
858
|
-
* Java method: org.openremote.model.
|
|
802
|
+
* HTTP DELETE /alarm
|
|
803
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
859
804
|
*/
|
|
860
|
-
|
|
805
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
861
806
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
807
|
+
* HTTP PUT /alarm/assets
|
|
808
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
864
809
|
*/
|
|
865
|
-
|
|
810
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
866
811
|
/**
|
|
867
|
-
* HTTP
|
|
868
|
-
* Java method: org.openremote.model.
|
|
812
|
+
* HTTP GET /alarm/{alarmId}
|
|
813
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
869
814
|
*/
|
|
870
|
-
|
|
815
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
871
816
|
/**
|
|
872
|
-
* HTTP
|
|
873
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
818
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
874
819
|
*/
|
|
875
|
-
|
|
820
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
821
|
+
/**
|
|
822
|
+
* HTTP PUT /alarm/{alarmId}
|
|
823
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
824
|
+
*/
|
|
825
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
826
|
+
/**
|
|
827
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
828
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
829
|
+
*/
|
|
830
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
831
|
+
realm?: string;
|
|
832
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
833
|
+
}
|
|
834
|
+
export declare class ConfigurationResourceClient<O> {
|
|
835
|
+
protected httpClient: HttpClient<O>;
|
|
836
|
+
constructor(httpClient: HttpClient<O>);
|
|
837
|
+
/**
|
|
838
|
+
* HTTP GET /configuration/manager
|
|
839
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
840
|
+
*/
|
|
841
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
842
|
+
/**
|
|
843
|
+
* HTTP PUT /configuration/manager
|
|
844
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
845
|
+
*/
|
|
846
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
847
|
+
/**
|
|
848
|
+
* HTTP POST /configuration/manager/file
|
|
849
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
850
|
+
*/
|
|
851
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
852
|
+
path?: string;
|
|
853
|
+
}, options?: O): RestResponse<string>;
|
|
854
|
+
/**
|
|
855
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
856
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
857
|
+
*/
|
|
858
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
859
|
+
}
|
|
860
|
+
export declare class AppResourceClient<O> {
|
|
861
|
+
protected httpClient: HttpClient<O>;
|
|
862
|
+
constructor(httpClient: HttpClient<O>);
|
|
863
|
+
/**
|
|
864
|
+
* HTTP GET /apps
|
|
865
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
866
|
+
*/
|
|
867
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
868
|
+
/**
|
|
869
|
+
* HTTP GET /apps/consoleConfig
|
|
870
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
871
|
+
*/
|
|
872
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
873
|
+
/**
|
|
874
|
+
* HTTP GET /apps/info
|
|
875
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
876
|
+
*/
|
|
877
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
876
878
|
}
|
|
877
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
878
880
|
export declare class ApiClient {
|
|
879
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
880
881
|
protected _realmResource: AxiosRealmResourceClient;
|
|
881
|
-
protected
|
|
882
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
882
883
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
883
|
-
protected
|
|
884
|
-
protected
|
|
884
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
885
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
886
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
887
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
888
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
889
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
890
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
885
891
|
protected _agentResource: AxiosAgentResourceClient;
|
|
886
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
887
892
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
888
|
-
protected
|
|
889
|
-
protected
|
|
890
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
891
|
-
protected _userResource: AxiosUserResourceClient;
|
|
893
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
894
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
892
895
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
896
|
+
protected _userResource: AxiosUserResourceClient;
|
|
893
897
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
894
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
895
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
896
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
897
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
898
898
|
protected _assetResource: AxiosAssetResourceClient;
|
|
899
|
-
protected
|
|
899
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
900
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
901
|
+
protected _appResource: AxiosAppResourceClient;
|
|
900
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
901
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
902
903
|
get RealmResource(): AxiosRealmResourceClient;
|
|
903
|
-
get
|
|
904
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
904
905
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
905
|
-
get
|
|
906
|
-
get
|
|
906
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
907
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
908
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
909
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
910
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
911
|
+
get MapResource(): AxiosMapResourceClient;
|
|
912
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
907
913
|
get AgentResource(): AxiosAgentResourceClient;
|
|
908
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
909
914
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
910
|
-
get
|
|
911
|
-
get
|
|
912
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
913
|
-
get UserResource(): AxiosUserResourceClient;
|
|
915
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
916
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
914
917
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
918
|
+
get UserResource(): AxiosUserResourceClient;
|
|
915
919
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
916
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
917
|
-
get MapResource(): AxiosMapResourceClient;
|
|
918
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
919
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
920
920
|
get AssetResource(): AxiosAssetResourceClient;
|
|
921
|
-
get
|
|
921
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
922
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
923
|
+
get AppResource(): AxiosAppResourceClient;
|
|
922
924
|
}
|
|
923
925
|
import * as Axios from "axios";
|
|
924
926
|
declare module "axios" {
|
|
@@ -926,66 +928,66 @@ declare module "axios" {
|
|
|
926
928
|
data: R;
|
|
927
929
|
}
|
|
928
930
|
}
|
|
929
|
-
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
930
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
931
|
-
}
|
|
932
931
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
933
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
934
933
|
}
|
|
935
|
-
export declare class
|
|
934
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
936
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
937
936
|
}
|
|
938
937
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
939
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
940
939
|
}
|
|
941
|
-
export declare class
|
|
942
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
943
|
-
}
|
|
944
|
-
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
940
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
945
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
946
942
|
}
|
|
947
|
-
export declare class
|
|
943
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
948
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
949
945
|
}
|
|
950
|
-
export declare class
|
|
946
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
951
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
952
948
|
}
|
|
953
|
-
export declare class
|
|
949
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
954
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
955
951
|
}
|
|
956
|
-
export declare class
|
|
952
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
957
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
958
954
|
}
|
|
959
|
-
export declare class
|
|
955
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
960
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
961
957
|
}
|
|
962
|
-
export declare class
|
|
958
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
963
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
964
960
|
}
|
|
965
|
-
export declare class
|
|
961
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
966
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
967
963
|
}
|
|
968
|
-
export declare class
|
|
964
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
969
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
970
966
|
}
|
|
971
|
-
export declare class
|
|
967
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
972
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
973
969
|
}
|
|
974
970
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
975
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
976
972
|
}
|
|
977
|
-
export declare class
|
|
973
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
978
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
979
975
|
}
|
|
980
|
-
export declare class
|
|
976
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
981
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
982
978
|
}
|
|
983
|
-
export declare class
|
|
979
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
984
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
985
981
|
}
|
|
986
982
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
987
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
988
984
|
}
|
|
989
|
-
export declare class
|
|
985
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
986
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
|
+
}
|
|
988
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
989
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
+
}
|
|
991
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
990
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
991
993
|
}
|