@openremote/rest 1.9.0-snapshot.20250922103504 → 1.9.0-snapshot.20250922141329
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.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +470 -470
- 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,183 +9,73 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /apps
|
|
17
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
18
|
-
*/
|
|
19
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP GET /apps/consoleConfig
|
|
22
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
23
|
-
*/
|
|
24
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP GET /apps/info
|
|
27
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
28
|
-
*/
|
|
29
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
30
|
-
}
|
|
31
|
-
export declare class MapResourceClient<O> {
|
|
32
|
-
protected httpClient: HttpClient<O>;
|
|
33
|
-
constructor(httpClient: HttpClient<O>);
|
|
34
|
-
/**
|
|
35
|
-
* HTTP GET /map
|
|
36
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
37
|
-
*/
|
|
38
|
-
getSettings(options?: O): RestResponse<{
|
|
39
|
-
[id: string]: unknown;
|
|
40
|
-
}>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP PUT /map
|
|
43
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
44
|
-
*/
|
|
45
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
46
|
-
[id: string]: unknown;
|
|
47
|
-
}>;
|
|
48
|
-
/**
|
|
49
|
-
* HTTP DELETE /map/deleteMap
|
|
50
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
51
|
-
*/
|
|
52
|
-
deleteMap(options?: O): RestResponse<{
|
|
53
|
-
[id: string]: unknown;
|
|
54
|
-
}>;
|
|
55
|
-
/**
|
|
56
|
-
* HTTP GET /map/getCustomMapInfo
|
|
57
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
58
|
-
*/
|
|
59
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
60
|
-
[id: string]: unknown;
|
|
61
|
-
}>;
|
|
62
|
-
/**
|
|
63
|
-
* HTTP GET /map/js
|
|
64
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
65
|
-
*/
|
|
66
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
67
|
-
[id: string]: unknown;
|
|
68
|
-
}>;
|
|
69
|
-
/**
|
|
70
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
71
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
72
|
-
*/
|
|
73
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
74
|
-
/**
|
|
75
|
-
* HTTP POST /map/upload
|
|
76
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
77
|
-
*/
|
|
78
|
-
uploadMap(queryParams?: {
|
|
79
|
-
filename?: string;
|
|
80
|
-
}, options?: O): RestResponse<{
|
|
81
|
-
[id: string]: unknown;
|
|
82
|
-
}>;
|
|
83
|
-
}
|
|
84
|
-
export declare class SyslogResourceClient<O> {
|
|
12
|
+
export declare class NotificationResourceClient<O> {
|
|
85
13
|
protected httpClient: HttpClient<O>;
|
|
86
14
|
constructor(httpClient: HttpClient<O>);
|
|
87
15
|
/**
|
|
88
|
-
* HTTP GET /
|
|
89
|
-
* Java method: org.openremote.model.
|
|
90
|
-
*/
|
|
91
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
92
|
-
/**
|
|
93
|
-
* HTTP PUT /syslog/config
|
|
94
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
95
|
-
*/
|
|
96
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
97
|
-
/**
|
|
98
|
-
* HTTP DELETE /syslog/event
|
|
99
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
100
|
-
*/
|
|
101
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
102
|
-
/**
|
|
103
|
-
* HTTP GET /syslog/event
|
|
104
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
16
|
+
* HTTP GET /notification
|
|
17
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
105
18
|
*/
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
page?: number;
|
|
19
|
+
getNotifications(queryParams?: {
|
|
20
|
+
id?: number;
|
|
21
|
+
type?: string;
|
|
110
22
|
from?: number;
|
|
111
23
|
to?: number;
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
}
|
|
116
|
-
export declare class AgentResourceClient<O> {
|
|
117
|
-
protected httpClient: HttpClient<O>;
|
|
118
|
-
constructor(httpClient: HttpClient<O>);
|
|
119
|
-
/**
|
|
120
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
121
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
122
|
-
*/
|
|
123
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
124
|
-
realm?: string;
|
|
125
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
126
|
-
/**
|
|
127
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
128
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
129
|
-
*/
|
|
130
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
131
|
-
realm?: string;
|
|
132
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
133
|
-
/**
|
|
134
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
135
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
136
|
-
*/
|
|
137
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
138
|
-
parentId?: string;
|
|
139
|
-
realm?: string;
|
|
140
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
141
|
-
}
|
|
142
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
143
|
-
protected httpClient: HttpClient<O>;
|
|
144
|
-
constructor(httpClient: HttpClient<O>);
|
|
24
|
+
realmId?: string;
|
|
25
|
+
userId?: string;
|
|
26
|
+
assetId?: string;
|
|
27
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
145
28
|
/**
|
|
146
|
-
* HTTP
|
|
147
|
-
* Java method: org.openremote.model.
|
|
29
|
+
* HTTP DELETE /notification
|
|
30
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
148
31
|
*/
|
|
149
|
-
|
|
32
|
+
removeNotifications(queryParams?: {
|
|
33
|
+
id?: number;
|
|
34
|
+
type?: string;
|
|
35
|
+
from?: number;
|
|
36
|
+
to?: number;
|
|
37
|
+
realmId?: string;
|
|
38
|
+
userId?: string;
|
|
39
|
+
assetId?: string;
|
|
40
|
+
}, options?: O): RestResponse<void>;
|
|
150
41
|
/**
|
|
151
|
-
* HTTP
|
|
152
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP POST /notification/alert
|
|
43
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
153
44
|
*/
|
|
154
|
-
|
|
45
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
155
46
|
/**
|
|
156
|
-
* HTTP
|
|
157
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP DELETE /notification/{notificationId}
|
|
48
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
158
49
|
*/
|
|
159
|
-
|
|
50
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
160
51
|
/**
|
|
161
|
-
* HTTP
|
|
162
|
-
* Java method: org.openremote.model.
|
|
52
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
53
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
163
54
|
*/
|
|
164
|
-
|
|
55
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
56
|
+
targetId?: string;
|
|
57
|
+
}, options?: O): RestResponse<void>;
|
|
165
58
|
/**
|
|
166
|
-
* HTTP
|
|
167
|
-
* Java method: org.openremote.model.
|
|
59
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
60
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
168
61
|
*/
|
|
169
|
-
|
|
62
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
63
|
+
targetId?: string;
|
|
64
|
+
}, options?: O): RestResponse<void>;
|
|
170
65
|
}
|
|
171
|
-
export declare class
|
|
66
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
172
67
|
protected httpClient: HttpClient<O>;
|
|
173
68
|
constructor(httpClient: HttpClient<O>);
|
|
174
69
|
/**
|
|
175
|
-
* HTTP
|
|
176
|
-
* Java method: org.openremote.model.
|
|
177
|
-
*/
|
|
178
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
179
|
-
/**
|
|
180
|
-
* HTTP GET /flow/{name}
|
|
181
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
70
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
71
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
182
72
|
*/
|
|
183
|
-
|
|
73
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
184
74
|
/**
|
|
185
|
-
* HTTP
|
|
186
|
-
* Java method: org.openremote.model.
|
|
75
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
76
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
187
77
|
*/
|
|
188
|
-
|
|
78
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
189
79
|
}
|
|
190
80
|
export declare class AssetResourceClient<O> {
|
|
191
81
|
protected httpClient: HttpClient<O>;
|
|
@@ -327,61 +217,174 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
327
217
|
*/
|
|
328
218
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
329
219
|
}
|
|
330
|
-
export declare class
|
|
220
|
+
export declare class ConfigurationResourceClient<O> {
|
|
331
221
|
protected httpClient: HttpClient<O>;
|
|
332
222
|
constructor(httpClient: HttpClient<O>);
|
|
333
223
|
/**
|
|
334
|
-
* HTTP GET /
|
|
335
|
-
* Java method: org.openremote.model.
|
|
336
|
-
*/
|
|
337
|
-
getAssetDescriptors(queryParams?: {
|
|
338
|
-
parentId?: string;
|
|
339
|
-
parentType?: string;
|
|
340
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
341
|
-
/**
|
|
342
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
343
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
224
|
+
* HTTP GET /configuration/manager
|
|
225
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
344
226
|
*/
|
|
345
|
-
|
|
346
|
-
parentId?: string;
|
|
347
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
227
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
348
228
|
/**
|
|
349
|
-
* HTTP
|
|
350
|
-
* Java method: org.openremote.model.
|
|
229
|
+
* HTTP PUT /configuration/manager
|
|
230
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
351
231
|
*/
|
|
352
|
-
|
|
353
|
-
parentId?: string;
|
|
354
|
-
parentType?: string;
|
|
355
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
232
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
356
233
|
/**
|
|
357
|
-
* HTTP
|
|
358
|
-
* Java method: org.openremote.model.
|
|
234
|
+
* HTTP POST /configuration/manager/file
|
|
235
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
359
236
|
*/
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
}, options?: O): RestResponse<
|
|
363
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
364
|
-
}>;
|
|
237
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
238
|
+
path?: string;
|
|
239
|
+
}, options?: O): RestResponse<string>;
|
|
365
240
|
/**
|
|
366
|
-
* HTTP GET /
|
|
367
|
-
* Java method: org.openremote.model.
|
|
241
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
242
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
368
243
|
*/
|
|
369
|
-
|
|
370
|
-
parentId?: string;
|
|
371
|
-
}, options?: O): RestResponse<{
|
|
372
|
-
[index: string]: Model.ValueDescriptor;
|
|
373
|
-
}>;
|
|
244
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
374
245
|
}
|
|
375
|
-
export declare class
|
|
246
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
376
247
|
protected httpClient: HttpClient<O>;
|
|
377
248
|
constructor(httpClient: HttpClient<O>);
|
|
378
249
|
/**
|
|
379
|
-
* HTTP
|
|
380
|
-
* Java method: org.openremote.model.
|
|
250
|
+
* HTTP POST /gateway/tunnel
|
|
251
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
381
252
|
*/
|
|
382
|
-
|
|
253
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
383
254
|
/**
|
|
384
|
-
* HTTP
|
|
255
|
+
* HTTP DELETE /gateway/tunnel
|
|
256
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
257
|
+
*/
|
|
258
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
259
|
+
/**
|
|
260
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
261
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
262
|
+
*/
|
|
263
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
264
|
+
/**
|
|
265
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
266
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
267
|
+
*/
|
|
268
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
269
|
+
/**
|
|
270
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
271
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
272
|
+
*/
|
|
273
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
274
|
+
}
|
|
275
|
+
export declare class StatusResourceClient<O> {
|
|
276
|
+
protected httpClient: HttpClient<O>;
|
|
277
|
+
constructor(httpClient: HttpClient<O>);
|
|
278
|
+
/**
|
|
279
|
+
* HTTP GET /health
|
|
280
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
281
|
+
*/
|
|
282
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
283
|
+
[index: string]: any;
|
|
284
|
+
}>;
|
|
285
|
+
/**
|
|
286
|
+
* HTTP GET /info
|
|
287
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
288
|
+
*/
|
|
289
|
+
getInfo(options?: O): RestResponse<{
|
|
290
|
+
[index: string]: any;
|
|
291
|
+
}>;
|
|
292
|
+
}
|
|
293
|
+
export declare class SyslogResourceClient<O> {
|
|
294
|
+
protected httpClient: HttpClient<O>;
|
|
295
|
+
constructor(httpClient: HttpClient<O>);
|
|
296
|
+
/**
|
|
297
|
+
* HTTP GET /syslog/config
|
|
298
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
299
|
+
*/
|
|
300
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
301
|
+
/**
|
|
302
|
+
* HTTP PUT /syslog/config
|
|
303
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
304
|
+
*/
|
|
305
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
306
|
+
/**
|
|
307
|
+
* HTTP DELETE /syslog/event
|
|
308
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
309
|
+
*/
|
|
310
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
311
|
+
/**
|
|
312
|
+
* HTTP GET /syslog/event
|
|
313
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
314
|
+
*/
|
|
315
|
+
getEvents(queryParams?: {
|
|
316
|
+
level?: Model.SyslogLevel;
|
|
317
|
+
per_page?: number;
|
|
318
|
+
page?: number;
|
|
319
|
+
from?: number;
|
|
320
|
+
to?: number;
|
|
321
|
+
category?: Model.SyslogCategory[];
|
|
322
|
+
subCategory?: string[];
|
|
323
|
+
}, options?: O): RestResponse<any>;
|
|
324
|
+
}
|
|
325
|
+
export declare class AlarmResourceClient<O> {
|
|
326
|
+
protected httpClient: HttpClient<O>;
|
|
327
|
+
constructor(httpClient: HttpClient<O>);
|
|
328
|
+
/**
|
|
329
|
+
* HTTP POST /alarm
|
|
330
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
331
|
+
*/
|
|
332
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
333
|
+
assetIds?: string[];
|
|
334
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
335
|
+
/**
|
|
336
|
+
* HTTP GET /alarm
|
|
337
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
338
|
+
*/
|
|
339
|
+
getAlarms(queryParams?: {
|
|
340
|
+
realm?: string;
|
|
341
|
+
status?: Model.AlarmStatus;
|
|
342
|
+
assetId?: string;
|
|
343
|
+
assigneeId?: string;
|
|
344
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
345
|
+
/**
|
|
346
|
+
* HTTP DELETE /alarm
|
|
347
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
348
|
+
*/
|
|
349
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
350
|
+
/**
|
|
351
|
+
* HTTP PUT /alarm/assets
|
|
352
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
353
|
+
*/
|
|
354
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
355
|
+
/**
|
|
356
|
+
* HTTP GET /alarm/{alarmId}
|
|
357
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
358
|
+
*/
|
|
359
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
360
|
+
/**
|
|
361
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
362
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
363
|
+
*/
|
|
364
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
365
|
+
/**
|
|
366
|
+
* HTTP PUT /alarm/{alarmId}
|
|
367
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
368
|
+
*/
|
|
369
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
370
|
+
/**
|
|
371
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
372
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
373
|
+
*/
|
|
374
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
375
|
+
realm?: string;
|
|
376
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
377
|
+
}
|
|
378
|
+
export declare class UserResourceClient<O> {
|
|
379
|
+
protected httpClient: HttpClient<O>;
|
|
380
|
+
constructor(httpClient: HttpClient<O>);
|
|
381
|
+
/**
|
|
382
|
+
* HTTP PUT /user/locale
|
|
383
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
384
|
+
*/
|
|
385
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
386
|
+
/**
|
|
387
|
+
* HTTP POST /user/query
|
|
385
388
|
* Java method: org.openremote.model.security.UserResource.query
|
|
386
389
|
*/
|
|
387
390
|
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
@@ -520,155 +523,88 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
520
523
|
*/
|
|
521
524
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
522
525
|
}
|
|
523
|
-
export declare class
|
|
526
|
+
export declare class AssetModelResourceClient<O> {
|
|
524
527
|
protected httpClient: HttpClient<O>;
|
|
525
528
|
constructor(httpClient: HttpClient<O>);
|
|
526
529
|
/**
|
|
527
|
-
* HTTP GET /
|
|
528
|
-
* Java method: org.openremote.model.
|
|
529
|
-
*/
|
|
530
|
-
getNotifications(queryParams?: {
|
|
531
|
-
id?: number;
|
|
532
|
-
type?: string;
|
|
533
|
-
from?: number;
|
|
534
|
-
to?: number;
|
|
535
|
-
realmId?: string;
|
|
536
|
-
userId?: string;
|
|
537
|
-
assetId?: string;
|
|
538
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
539
|
-
/**
|
|
540
|
-
* HTTP DELETE /notification
|
|
541
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
530
|
+
* HTTP GET /model/assetDescriptors
|
|
531
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
542
532
|
*/
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
to?: number;
|
|
548
|
-
realmId?: string;
|
|
549
|
-
userId?: string;
|
|
550
|
-
assetId?: string;
|
|
551
|
-
}, options?: O): RestResponse<void>;
|
|
533
|
+
getAssetDescriptors(queryParams?: {
|
|
534
|
+
parentId?: string;
|
|
535
|
+
parentType?: string;
|
|
536
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
552
537
|
/**
|
|
553
|
-
* HTTP
|
|
554
|
-
* Java method: org.openremote.model.
|
|
538
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
539
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
555
540
|
*/
|
|
556
|
-
|
|
541
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
542
|
+
parentId?: string;
|
|
543
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
557
544
|
/**
|
|
558
|
-
* HTTP
|
|
559
|
-
* Java method: org.openremote.model.
|
|
545
|
+
* HTTP GET /model/assetInfos
|
|
546
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
560
547
|
*/
|
|
561
|
-
|
|
548
|
+
getAssetInfos(queryParams?: {
|
|
549
|
+
parentId?: string;
|
|
550
|
+
parentType?: string;
|
|
551
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
562
552
|
/**
|
|
563
|
-
* HTTP
|
|
564
|
-
* Java method: org.openremote.model.
|
|
553
|
+
* HTTP GET /model/metaItemDescriptors
|
|
554
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
565
555
|
*/
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
}, options?: O): RestResponse<
|
|
556
|
+
getMetaItemDescriptors(queryParams?: {
|
|
557
|
+
parentId?: string;
|
|
558
|
+
}, options?: O): RestResponse<{
|
|
559
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
560
|
+
}>;
|
|
569
561
|
/**
|
|
570
|
-
* HTTP
|
|
571
|
-
* Java method: org.openremote.model.
|
|
562
|
+
* HTTP GET /model/valueDescriptors
|
|
563
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
572
564
|
*/
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
}, options?: O): RestResponse<
|
|
565
|
+
getValueDescriptors(queryParams?: {
|
|
566
|
+
parentId?: string;
|
|
567
|
+
}, options?: O): RestResponse<{
|
|
568
|
+
[index: string]: Model.ValueDescriptor;
|
|
569
|
+
}>;
|
|
576
570
|
}
|
|
577
|
-
export declare class
|
|
571
|
+
export declare class AgentResourceClient<O> {
|
|
578
572
|
protected httpClient: HttpClient<O>;
|
|
579
573
|
constructor(httpClient: HttpClient<O>);
|
|
580
574
|
/**
|
|
581
|
-
* HTTP GET /
|
|
582
|
-
* Java method: org.openremote.model.
|
|
575
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
576
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
583
577
|
*/
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
toTimestamp?: number;
|
|
588
|
-
}, options?: O): RestResponse<any>;
|
|
578
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
579
|
+
realm?: string;
|
|
580
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
589
581
|
/**
|
|
590
|
-
* HTTP
|
|
591
|
-
* Java method: org.openremote.model.
|
|
582
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
583
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
592
584
|
*/
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
585
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
586
|
+
realm?: string;
|
|
587
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
597
588
|
/**
|
|
598
|
-
* HTTP
|
|
599
|
-
* Java method: org.openremote.model.
|
|
589
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
590
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
600
591
|
*/
|
|
601
|
-
|
|
592
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
593
|
+
parentId?: string;
|
|
594
|
+
realm?: string;
|
|
595
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
602
596
|
}
|
|
603
|
-
export declare class
|
|
597
|
+
export declare class RulesResourceClient<O> {
|
|
604
598
|
protected httpClient: HttpClient<O>;
|
|
605
599
|
constructor(httpClient: HttpClient<O>);
|
|
606
600
|
/**
|
|
607
|
-
* HTTP
|
|
608
|
-
* Java method: org.openremote.model.
|
|
601
|
+
* HTTP POST /rules
|
|
602
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
609
603
|
*/
|
|
610
|
-
|
|
611
|
-
[index: string]: any;
|
|
612
|
-
}>;
|
|
604
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
613
605
|
/**
|
|
614
|
-
* HTTP GET /
|
|
615
|
-
* Java method: org.openremote.model.
|
|
616
|
-
*/
|
|
617
|
-
getInfo(options?: O): RestResponse<{
|
|
618
|
-
[index: string]: any;
|
|
619
|
-
}>;
|
|
620
|
-
}
|
|
621
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
622
|
-
protected httpClient: HttpClient<O>;
|
|
623
|
-
constructor(httpClient: HttpClient<O>);
|
|
624
|
-
/**
|
|
625
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
626
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
627
|
-
*/
|
|
628
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
629
|
-
/**
|
|
630
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
631
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
632
|
-
*/
|
|
633
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
634
|
-
}
|
|
635
|
-
export declare class ConfigurationResourceClient<O> {
|
|
636
|
-
protected httpClient: HttpClient<O>;
|
|
637
|
-
constructor(httpClient: HttpClient<O>);
|
|
638
|
-
/**
|
|
639
|
-
* HTTP GET /configuration/manager
|
|
640
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
641
|
-
*/
|
|
642
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
643
|
-
/**
|
|
644
|
-
* HTTP PUT /configuration/manager
|
|
645
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
646
|
-
*/
|
|
647
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
648
|
-
/**
|
|
649
|
-
* HTTP POST /configuration/manager/file
|
|
650
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
651
|
-
*/
|
|
652
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
653
|
-
path?: string;
|
|
654
|
-
}, options?: O): RestResponse<string>;
|
|
655
|
-
/**
|
|
656
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
657
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
658
|
-
*/
|
|
659
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
660
|
-
}
|
|
661
|
-
export declare class RulesResourceClient<O> {
|
|
662
|
-
protected httpClient: HttpClient<O>;
|
|
663
|
-
constructor(httpClient: HttpClient<O>);
|
|
664
|
-
/**
|
|
665
|
-
* HTTP POST /rules
|
|
666
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
667
|
-
*/
|
|
668
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
669
|
-
/**
|
|
670
|
-
* HTTP GET /rules
|
|
671
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
606
|
+
* HTTP GET /rules
|
|
607
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
672
608
|
*/
|
|
673
609
|
getGlobalRulesets(queryParams?: {
|
|
674
610
|
language?: Model.RulesetLang[];
|
|
@@ -766,6 +702,133 @@ export declare class RulesResourceClient<O> {
|
|
|
766
702
|
*/
|
|
767
703
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
768
704
|
}
|
|
705
|
+
export declare class MapResourceClient<O> {
|
|
706
|
+
protected httpClient: HttpClient<O>;
|
|
707
|
+
constructor(httpClient: HttpClient<O>);
|
|
708
|
+
/**
|
|
709
|
+
* HTTP GET /map
|
|
710
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
711
|
+
*/
|
|
712
|
+
getSettings(options?: O): RestResponse<{
|
|
713
|
+
[id: string]: unknown;
|
|
714
|
+
}>;
|
|
715
|
+
/**
|
|
716
|
+
* HTTP PUT /map
|
|
717
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
718
|
+
*/
|
|
719
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
720
|
+
[id: string]: unknown;
|
|
721
|
+
}>;
|
|
722
|
+
/**
|
|
723
|
+
* HTTP DELETE /map/deleteMap
|
|
724
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
725
|
+
*/
|
|
726
|
+
deleteMap(options?: O): RestResponse<{
|
|
727
|
+
[id: string]: unknown;
|
|
728
|
+
}>;
|
|
729
|
+
/**
|
|
730
|
+
* HTTP GET /map/getCustomMapInfo
|
|
731
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
732
|
+
*/
|
|
733
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
734
|
+
[id: string]: unknown;
|
|
735
|
+
}>;
|
|
736
|
+
/**
|
|
737
|
+
* HTTP GET /map/js
|
|
738
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
739
|
+
*/
|
|
740
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
741
|
+
[id: string]: unknown;
|
|
742
|
+
}>;
|
|
743
|
+
/**
|
|
744
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
745
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
746
|
+
*/
|
|
747
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
748
|
+
/**
|
|
749
|
+
* HTTP POST /map/upload
|
|
750
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
751
|
+
*/
|
|
752
|
+
uploadMap(queryParams?: {
|
|
753
|
+
filename?: string;
|
|
754
|
+
}, options?: O): RestResponse<{
|
|
755
|
+
[id: string]: unknown;
|
|
756
|
+
}>;
|
|
757
|
+
}
|
|
758
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
759
|
+
protected httpClient: HttpClient<O>;
|
|
760
|
+
constructor(httpClient: HttpClient<O>);
|
|
761
|
+
/**
|
|
762
|
+
* Response code 200 - List of registered external services
|
|
763
|
+
* HTTP GET /service
|
|
764
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
765
|
+
*/
|
|
766
|
+
getServices(queryParams?: {
|
|
767
|
+
realm?: string;
|
|
768
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
769
|
+
/**
|
|
770
|
+
* Response code 200 - Service registered successfully
|
|
771
|
+
* Response code 400 - Invalid external service object
|
|
772
|
+
* Response code 409 - ExternalService instance already registered
|
|
773
|
+
* HTTP POST /service
|
|
774
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
775
|
+
*/
|
|
776
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
777
|
+
/**
|
|
778
|
+
* Response code 200 - List of registered external services
|
|
779
|
+
* HTTP GET /service/global
|
|
780
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
781
|
+
*/
|
|
782
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
783
|
+
/**
|
|
784
|
+
* Response code 200 - Service registered successfully
|
|
785
|
+
* Response code 400 - Invalid external service object
|
|
786
|
+
* Response code 409 - ExternalService instance already registered
|
|
787
|
+
* HTTP POST /service/global
|
|
788
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
789
|
+
*/
|
|
790
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
791
|
+
/**
|
|
792
|
+
* Response code 204 - Service deregistered successfully
|
|
793
|
+
* Response code 404 - Service instance not found
|
|
794
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
795
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
796
|
+
*/
|
|
797
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
798
|
+
/**
|
|
799
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
800
|
+
* Response code 404 - ExternalService not found
|
|
801
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
802
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
803
|
+
*/
|
|
804
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
805
|
+
/**
|
|
806
|
+
* Response code 204 - Heartbeat sent successfully
|
|
807
|
+
* Response code 404 - Service instance not found
|
|
808
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
809
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
810
|
+
*/
|
|
811
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
812
|
+
}
|
|
813
|
+
export declare class FlowResourceClient<O> {
|
|
814
|
+
protected httpClient: HttpClient<O>;
|
|
815
|
+
constructor(httpClient: HttpClient<O>);
|
|
816
|
+
/**
|
|
817
|
+
* HTTP GET /flow
|
|
818
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
819
|
+
*/
|
|
820
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
821
|
+
/**
|
|
822
|
+
* HTTP GET /flow/{name}
|
|
823
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
824
|
+
*/
|
|
825
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
826
|
+
/**
|
|
827
|
+
* HTTP GET /flow/{type}
|
|
828
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
829
|
+
*/
|
|
830
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
831
|
+
}
|
|
769
832
|
export declare class ConsoleResourceClient<O> {
|
|
770
833
|
protected httpClient: HttpClient<O>;
|
|
771
834
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -775,6 +838,51 @@ export declare class ConsoleResourceClient<O> {
|
|
|
775
838
|
*/
|
|
776
839
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
777
840
|
}
|
|
841
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
842
|
+
protected httpClient: HttpClient<O>;
|
|
843
|
+
constructor(httpClient: HttpClient<O>);
|
|
844
|
+
/**
|
|
845
|
+
* HTTP GET /asset/datapoint/export
|
|
846
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
847
|
+
*/
|
|
848
|
+
getDatapointExport(queryParams?: {
|
|
849
|
+
attributeRefs?: string;
|
|
850
|
+
fromTimestamp?: number;
|
|
851
|
+
toTimestamp?: number;
|
|
852
|
+
}, options?: O): RestResponse<any>;
|
|
853
|
+
/**
|
|
854
|
+
* HTTP GET /asset/datapoint/periods
|
|
855
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
856
|
+
*/
|
|
857
|
+
getDatapointPeriod(queryParams?: {
|
|
858
|
+
assetId?: string;
|
|
859
|
+
attributeName?: string;
|
|
860
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
861
|
+
/**
|
|
862
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
863
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
864
|
+
*/
|
|
865
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
866
|
+
}
|
|
867
|
+
export declare class AppResourceClient<O> {
|
|
868
|
+
protected httpClient: HttpClient<O>;
|
|
869
|
+
constructor(httpClient: HttpClient<O>);
|
|
870
|
+
/**
|
|
871
|
+
* HTTP GET /apps
|
|
872
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
873
|
+
*/
|
|
874
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
875
|
+
/**
|
|
876
|
+
* HTTP GET /apps/consoleConfig
|
|
877
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
878
|
+
*/
|
|
879
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
880
|
+
/**
|
|
881
|
+
* HTTP GET /apps/info
|
|
882
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
883
|
+
*/
|
|
884
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
885
|
+
}
|
|
778
886
|
export declare class RealmResourceClient<O> {
|
|
779
887
|
protected httpClient: HttpClient<O>;
|
|
780
888
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -809,59 +917,6 @@ export declare class RealmResourceClient<O> {
|
|
|
809
917
|
*/
|
|
810
918
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
811
919
|
}
|
|
812
|
-
export declare class AlarmResourceClient<O> {
|
|
813
|
-
protected httpClient: HttpClient<O>;
|
|
814
|
-
constructor(httpClient: HttpClient<O>);
|
|
815
|
-
/**
|
|
816
|
-
* HTTP POST /alarm
|
|
817
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
818
|
-
*/
|
|
819
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
820
|
-
assetIds?: string[];
|
|
821
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
822
|
-
/**
|
|
823
|
-
* HTTP GET /alarm
|
|
824
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
825
|
-
*/
|
|
826
|
-
getAlarms(queryParams?: {
|
|
827
|
-
realm?: string;
|
|
828
|
-
status?: Model.AlarmStatus;
|
|
829
|
-
assetId?: string;
|
|
830
|
-
assigneeId?: string;
|
|
831
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
832
|
-
/**
|
|
833
|
-
* HTTP DELETE /alarm
|
|
834
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
835
|
-
*/
|
|
836
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
837
|
-
/**
|
|
838
|
-
* HTTP PUT /alarm/assets
|
|
839
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
840
|
-
*/
|
|
841
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
842
|
-
/**
|
|
843
|
-
* HTTP GET /alarm/{alarmId}
|
|
844
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
845
|
-
*/
|
|
846
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
847
|
-
/**
|
|
848
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
849
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
850
|
-
*/
|
|
851
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
852
|
-
/**
|
|
853
|
-
* HTTP PUT /alarm/{alarmId}
|
|
854
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
855
|
-
*/
|
|
856
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
859
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
860
|
-
*/
|
|
861
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
862
|
-
realm?: string;
|
|
863
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
864
|
-
}
|
|
865
920
|
export declare class DashboardResourceClient<O> {
|
|
866
921
|
protected httpClient: HttpClient<O>;
|
|
867
922
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -896,108 +951,53 @@ export declare class DashboardResourceClient<O> {
|
|
|
896
951
|
*/
|
|
897
952
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
898
953
|
}
|
|
899
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
900
|
-
protected httpClient: HttpClient<O>;
|
|
901
|
-
constructor(httpClient: HttpClient<O>);
|
|
902
|
-
/**
|
|
903
|
-
* Response code 200 - List of registered external services
|
|
904
|
-
* HTTP GET /service
|
|
905
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
906
|
-
*/
|
|
907
|
-
getServices(queryParams?: {
|
|
908
|
-
realm?: string;
|
|
909
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
910
|
-
/**
|
|
911
|
-
* Response code 200 - Service registered successfully
|
|
912
|
-
* Response code 400 - Invalid external service object
|
|
913
|
-
* Response code 409 - ExternalService instance already registered
|
|
914
|
-
* HTTP POST /service
|
|
915
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
916
|
-
*/
|
|
917
|
-
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
918
|
-
/**
|
|
919
|
-
* Response code 200 - List of registered external services
|
|
920
|
-
* HTTP GET /service/global
|
|
921
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
922
|
-
*/
|
|
923
|
-
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
924
|
-
/**
|
|
925
|
-
* Response code 200 - Service registered successfully
|
|
926
|
-
* Response code 400 - Invalid external service object
|
|
927
|
-
* Response code 409 - ExternalService instance already registered
|
|
928
|
-
* HTTP POST /service/global
|
|
929
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
930
|
-
*/
|
|
931
|
-
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
932
|
-
/**
|
|
933
|
-
* Response code 204 - Service deregistered successfully
|
|
934
|
-
* Response code 404 - Service instance not found
|
|
935
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
936
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
937
|
-
*/
|
|
938
|
-
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
939
|
-
/**
|
|
940
|
-
* Response code 200 - ExternalService retrieved successfully
|
|
941
|
-
* Response code 404 - ExternalService not found
|
|
942
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
943
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
944
|
-
*/
|
|
945
|
-
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
946
|
-
/**
|
|
947
|
-
* Response code 204 - Heartbeat sent successfully
|
|
948
|
-
* Response code 404 - Service instance not found
|
|
949
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
950
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
951
|
-
*/
|
|
952
|
-
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
953
|
-
}
|
|
954
954
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
955
955
|
export declare class ApiClient {
|
|
956
|
-
protected
|
|
957
|
-
protected
|
|
958
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
959
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
960
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
961
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
956
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
957
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
962
958
|
protected _assetResource: AxiosAssetResourceClient;
|
|
963
959
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
964
|
-
protected
|
|
960
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
961
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
962
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
963
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
964
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
965
965
|
protected _userResource: AxiosUserResourceClient;
|
|
966
966
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
967
|
-
protected
|
|
968
|
-
protected
|
|
969
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
970
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
971
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
967
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
968
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
972
969
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
970
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
971
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
972
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
973
973
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
974
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
975
|
+
protected _appResource: AxiosAppResourceClient;
|
|
974
976
|
protected _realmResource: AxiosRealmResourceClient;
|
|
975
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
976
977
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
977
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
978
978
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
979
|
-
get
|
|
980
|
-
get
|
|
981
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
982
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
983
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
984
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
979
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
980
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
985
981
|
get AssetResource(): AxiosAssetResourceClient;
|
|
986
982
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
987
|
-
get
|
|
983
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
984
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
985
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
986
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
987
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
988
988
|
get UserResource(): AxiosUserResourceClient;
|
|
989
989
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
990
|
-
get
|
|
991
|
-
get
|
|
992
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
993
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
994
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
990
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
991
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
995
992
|
get RulesResource(): AxiosRulesResourceClient;
|
|
993
|
+
get MapResource(): AxiosMapResourceClient;
|
|
994
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
995
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
996
996
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
997
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
998
|
+
get AppResource(): AxiosAppResourceClient;
|
|
997
999
|
get RealmResource(): AxiosRealmResourceClient;
|
|
998
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
999
1000
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1000
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1001
1001
|
}
|
|
1002
1002
|
import * as Axios from "axios";
|
|
1003
1003
|
declare module "axios" {
|
|
@@ -1005,31 +1005,31 @@ declare module "axios" {
|
|
|
1005
1005
|
data: R;
|
|
1006
1006
|
}
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|
|
1014
|
-
export declare class
|
|
1014
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1015
1015
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1016
1016
|
}
|
|
1017
|
-
export declare class
|
|
1017
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1018
1018
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1019
1019
|
}
|
|
1020
|
-
export declare class
|
|
1020
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1021
1021
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1022
1022
|
}
|
|
1023
|
-
export declare class
|
|
1023
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1024
1024
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1025
1025
|
}
|
|
1026
|
-
export declare class
|
|
1026
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1027
1027
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1028
1028
|
}
|
|
1029
|
-
export declare class
|
|
1029
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1030
1030
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1031
1031
|
}
|
|
1032
|
-
export declare class
|
|
1032
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1033
1033
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1034
1034
|
}
|
|
1035
1035
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1038,36 +1038,36 @@ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.Ax
|
|
|
1038
1038
|
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1039
1039
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1040
1040
|
}
|
|
1041
|
-
export declare class
|
|
1041
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1042
1042
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1043
1043
|
}
|
|
1044
|
-
export declare class
|
|
1044
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1045
1045
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1046
1046
|
}
|
|
1047
|
-
export declare class
|
|
1047
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1048
1048
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1049
1049
|
}
|
|
1050
|
-
export declare class
|
|
1050
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1051
1051
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1052
1052
|
}
|
|
1053
|
-
export declare class
|
|
1053
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1054
1054
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1055
1055
|
}
|
|
1056
|
-
export declare class
|
|
1056
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1057
1057
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1058
1058
|
}
|
|
1059
1059
|
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1060
1060
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1061
1061
|
}
|
|
1062
|
-
export declare class
|
|
1062
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1063
1063
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1064
1064
|
}
|
|
1065
|
-
export declare class
|
|
1065
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1066
1066
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1067
1067
|
}
|
|
1068
|
-
export declare class
|
|
1068
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1069
1069
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1070
1070
|
}
|
|
1071
|
-
export declare class
|
|
1071
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1072
1072
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1073
1073
|
}
|