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