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