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