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