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