@openremote/rest 1.12.0-snapshot.20251113155855 → 1.12.0-snapshot.20251118161313
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 +471 -471
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +1 -1
package/lib/restclient.d.ts
CHANGED
|
@@ -9,31 +9,152 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class SyslogResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /syslog/config
|
|
17
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
19
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
20
|
+
/**
|
|
21
|
+
* HTTP PUT /syslog/config
|
|
22
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
23
|
+
*/
|
|
24
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
25
|
+
/**
|
|
26
|
+
* HTTP DELETE /syslog/event
|
|
27
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
28
|
+
*/
|
|
29
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
30
|
+
/**
|
|
31
|
+
* HTTP GET /syslog/event
|
|
32
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
33
|
+
*/
|
|
34
|
+
getEvents(queryParams?: {
|
|
35
|
+
level?: Model.SyslogLevel;
|
|
36
|
+
per_page?: number;
|
|
37
|
+
page?: number;
|
|
38
|
+
from?: number;
|
|
39
|
+
to?: number;
|
|
40
|
+
category?: Model.SyslogCategory[];
|
|
41
|
+
subCategory?: string[];
|
|
23
42
|
}, options?: O): RestResponse<any>;
|
|
43
|
+
}
|
|
44
|
+
export declare class RealmResourceClient<O> {
|
|
45
|
+
protected httpClient: HttpClient<O>;
|
|
46
|
+
constructor(httpClient: HttpClient<O>);
|
|
24
47
|
/**
|
|
25
|
-
* HTTP
|
|
26
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP POST /realm
|
|
49
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
27
50
|
*/
|
|
28
|
-
|
|
29
|
-
assetId?: string;
|
|
30
|
-
attributeName?: string;
|
|
31
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
51
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
32
52
|
/**
|
|
33
|
-
* HTTP
|
|
34
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* HTTP GET /realm
|
|
54
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
35
55
|
*/
|
|
36
|
-
|
|
56
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
57
|
+
/**
|
|
58
|
+
* HTTP GET /realm/accessible
|
|
59
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
60
|
+
*/
|
|
61
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
62
|
+
/**
|
|
63
|
+
* HTTP DELETE /realm/{name}
|
|
64
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
65
|
+
*/
|
|
66
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
67
|
+
/**
|
|
68
|
+
* HTTP GET /realm/{name}
|
|
69
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
70
|
+
*/
|
|
71
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
72
|
+
/**
|
|
73
|
+
* HTTP PUT /realm/{name}
|
|
74
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
75
|
+
*/
|
|
76
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
77
|
+
}
|
|
78
|
+
export declare class GatewayClientResourceClient<O> {
|
|
79
|
+
protected httpClient: HttpClient<O>;
|
|
80
|
+
constructor(httpClient: HttpClient<O>);
|
|
81
|
+
/**
|
|
82
|
+
* HTTP DELETE /gateway/connection
|
|
83
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
84
|
+
*/
|
|
85
|
+
deleteConnections(queryParams?: {
|
|
86
|
+
realm?: string[];
|
|
87
|
+
}, options?: O): RestResponse<void>;
|
|
88
|
+
/**
|
|
89
|
+
* HTTP GET /gateway/connection
|
|
90
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
91
|
+
*/
|
|
92
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
93
|
+
/**
|
|
94
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
95
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
96
|
+
*/
|
|
97
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
98
|
+
/**
|
|
99
|
+
* HTTP GET /gateway/connection/{realm}
|
|
100
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
101
|
+
*/
|
|
102
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
103
|
+
/**
|
|
104
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
105
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
106
|
+
*/
|
|
107
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
108
|
+
/**
|
|
109
|
+
* HTTP GET /gateway/status/{realm}
|
|
110
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
111
|
+
*/
|
|
112
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
113
|
+
}
|
|
114
|
+
export declare class AppResourceClient<O> {
|
|
115
|
+
protected httpClient: HttpClient<O>;
|
|
116
|
+
constructor(httpClient: HttpClient<O>);
|
|
117
|
+
/**
|
|
118
|
+
* HTTP GET /apps
|
|
119
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
120
|
+
*/
|
|
121
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
122
|
+
/**
|
|
123
|
+
* HTTP GET /apps/consoleConfig
|
|
124
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
125
|
+
*/
|
|
126
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
127
|
+
/**
|
|
128
|
+
* HTTP GET /apps/info
|
|
129
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
130
|
+
*/
|
|
131
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
132
|
+
}
|
|
133
|
+
export declare class AgentResourceClient<O> {
|
|
134
|
+
protected httpClient: HttpClient<O>;
|
|
135
|
+
constructor(httpClient: HttpClient<O>);
|
|
136
|
+
/**
|
|
137
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
138
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
139
|
+
*/
|
|
140
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
141
|
+
realm?: string;
|
|
142
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
143
|
+
/**
|
|
144
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
145
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
146
|
+
*/
|
|
147
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
148
|
+
realm?: string;
|
|
149
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
150
|
+
/**
|
|
151
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
152
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
153
|
+
*/
|
|
154
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
155
|
+
parentId?: string;
|
|
156
|
+
realm?: string;
|
|
157
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
37
158
|
}
|
|
38
159
|
export declare class RulesResourceClient<O> {
|
|
39
160
|
protected httpClient: HttpClient<O>;
|
|
@@ -143,6 +264,35 @@ export declare class RulesResourceClient<O> {
|
|
|
143
264
|
*/
|
|
144
265
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
145
266
|
}
|
|
267
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
268
|
+
protected httpClient: HttpClient<O>;
|
|
269
|
+
constructor(httpClient: HttpClient<O>);
|
|
270
|
+
/**
|
|
271
|
+
* HTTP POST /gateway/tunnel
|
|
272
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
273
|
+
*/
|
|
274
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
275
|
+
/**
|
|
276
|
+
* HTTP DELETE /gateway/tunnel
|
|
277
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
278
|
+
*/
|
|
279
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
280
|
+
/**
|
|
281
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
282
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
283
|
+
*/
|
|
284
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
285
|
+
/**
|
|
286
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
287
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
288
|
+
*/
|
|
289
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
290
|
+
/**
|
|
291
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
292
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
293
|
+
*/
|
|
294
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
295
|
+
}
|
|
146
296
|
export declare class AssetModelResourceClient<O> {
|
|
147
297
|
protected httpClient: HttpClient<O>;
|
|
148
298
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -196,219 +346,59 @@ export declare class AssetModelResourceClient<O> {
|
|
|
196
346
|
[index: string]: Model.ValueDescriptor;
|
|
197
347
|
}>;
|
|
198
348
|
}
|
|
199
|
-
export declare class
|
|
349
|
+
export declare class NotificationResourceClient<O> {
|
|
200
350
|
protected httpClient: HttpClient<O>;
|
|
201
351
|
constructor(httpClient: HttpClient<O>);
|
|
202
352
|
/**
|
|
203
|
-
* HTTP GET /
|
|
204
|
-
* Java method: org.openremote.model.
|
|
205
|
-
*/
|
|
206
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
207
|
-
/**
|
|
208
|
-
* HTTP PUT /syslog/config
|
|
209
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
210
|
-
*/
|
|
211
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
212
|
-
/**
|
|
213
|
-
* HTTP DELETE /syslog/event
|
|
214
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
353
|
+
* HTTP GET /notification
|
|
354
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
215
355
|
*/
|
|
216
|
-
|
|
356
|
+
getNotifications(queryParams?: {
|
|
357
|
+
id?: number;
|
|
358
|
+
type?: string;
|
|
359
|
+
from?: number;
|
|
360
|
+
to?: number;
|
|
361
|
+
realmId?: string;
|
|
362
|
+
userId?: string;
|
|
363
|
+
assetId?: string;
|
|
364
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
217
365
|
/**
|
|
218
|
-
* HTTP
|
|
219
|
-
* Java method: org.openremote.model.
|
|
366
|
+
* HTTP DELETE /notification
|
|
367
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
220
368
|
*/
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
page?: number;
|
|
369
|
+
removeNotifications(queryParams?: {
|
|
370
|
+
id?: number;
|
|
371
|
+
type?: string;
|
|
225
372
|
from?: number;
|
|
226
373
|
to?: number;
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
}
|
|
231
|
-
export declare class MapResourceClient<O> {
|
|
232
|
-
protected httpClient: HttpClient<O>;
|
|
233
|
-
constructor(httpClient: HttpClient<O>);
|
|
374
|
+
realmId?: string;
|
|
375
|
+
userId?: string;
|
|
376
|
+
assetId?: string;
|
|
377
|
+
}, options?: O): RestResponse<void>;
|
|
234
378
|
/**
|
|
235
|
-
* HTTP
|
|
236
|
-
* Java method: org.openremote.model.
|
|
379
|
+
* HTTP POST /notification/alert
|
|
380
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
237
381
|
*/
|
|
238
|
-
|
|
239
|
-
[id: string]: unknown;
|
|
240
|
-
}>;
|
|
382
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
241
383
|
/**
|
|
242
|
-
* HTTP
|
|
243
|
-
* Java method: org.openremote.model.
|
|
384
|
+
* HTTP DELETE /notification/{notificationId}
|
|
385
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
244
386
|
*/
|
|
245
|
-
|
|
246
|
-
[id: string]: unknown;
|
|
247
|
-
}>;
|
|
387
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
248
388
|
/**
|
|
249
|
-
* HTTP
|
|
250
|
-
* Java method: org.openremote.model.
|
|
389
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
390
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
251
391
|
*/
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
}>;
|
|
392
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
393
|
+
targetId?: string;
|
|
394
|
+
}, options?: O): RestResponse<void>;
|
|
255
395
|
/**
|
|
256
|
-
* HTTP
|
|
257
|
-
* Java method: org.openremote.model.
|
|
258
|
-
*/
|
|
259
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
260
|
-
[id: string]: unknown;
|
|
261
|
-
}>;
|
|
262
|
-
/**
|
|
263
|
-
* HTTP GET /map/js
|
|
264
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
265
|
-
*/
|
|
266
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
267
|
-
[id: string]: unknown;
|
|
268
|
-
}>;
|
|
269
|
-
/**
|
|
270
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
271
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
272
|
-
*/
|
|
273
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
274
|
-
/**
|
|
275
|
-
* HTTP POST /map/upload
|
|
276
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
277
|
-
*/
|
|
278
|
-
uploadMap(queryParams?: {
|
|
279
|
-
filename?: string;
|
|
280
|
-
}, options?: O): RestResponse<{
|
|
281
|
-
[id: string]: unknown;
|
|
282
|
-
}>;
|
|
283
|
-
}
|
|
284
|
-
export declare class RealmResourceClient<O> {
|
|
285
|
-
protected httpClient: HttpClient<O>;
|
|
286
|
-
constructor(httpClient: HttpClient<O>);
|
|
287
|
-
/**
|
|
288
|
-
* HTTP POST /realm
|
|
289
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
290
|
-
*/
|
|
291
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP GET /realm
|
|
294
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
295
|
-
*/
|
|
296
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
297
|
-
/**
|
|
298
|
-
* HTTP GET /realm/accessible
|
|
299
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
300
|
-
*/
|
|
301
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
302
|
-
/**
|
|
303
|
-
* HTTP DELETE /realm/{name}
|
|
304
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
305
|
-
*/
|
|
306
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
307
|
-
/**
|
|
308
|
-
* HTTP GET /realm/{name}
|
|
309
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
310
|
-
*/
|
|
311
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
312
|
-
/**
|
|
313
|
-
* HTTP PUT /realm/{name}
|
|
314
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
315
|
-
*/
|
|
316
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
317
|
-
}
|
|
318
|
-
export declare class ProvisioningResourceClient<O> {
|
|
319
|
-
protected httpClient: HttpClient<O>;
|
|
320
|
-
constructor(httpClient: HttpClient<O>);
|
|
321
|
-
/**
|
|
322
|
-
* HTTP POST /provisioning
|
|
323
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
324
|
-
*/
|
|
325
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
326
|
-
/**
|
|
327
|
-
* HTTP GET /provisioning
|
|
328
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
329
|
-
*/
|
|
330
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
331
|
-
/**
|
|
332
|
-
* HTTP DELETE /provisioning/{id}
|
|
333
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
334
|
-
*/
|
|
335
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP PUT /provisioning/{id}
|
|
338
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
339
|
-
*/
|
|
340
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
341
|
-
}
|
|
342
|
-
export declare class AppResourceClient<O> {
|
|
343
|
-
protected httpClient: HttpClient<O>;
|
|
344
|
-
constructor(httpClient: HttpClient<O>);
|
|
345
|
-
/**
|
|
346
|
-
* HTTP GET /apps
|
|
347
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
348
|
-
*/
|
|
349
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
350
|
-
/**
|
|
351
|
-
* HTTP GET /apps/consoleConfig
|
|
352
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
353
|
-
*/
|
|
354
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
355
|
-
/**
|
|
356
|
-
* HTTP GET /apps/info
|
|
357
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
358
|
-
*/
|
|
359
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
360
|
-
}
|
|
361
|
-
export declare class StatusResourceClient<O> {
|
|
362
|
-
protected httpClient: HttpClient<O>;
|
|
363
|
-
constructor(httpClient: HttpClient<O>);
|
|
364
|
-
/**
|
|
365
|
-
* HTTP GET /health
|
|
366
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
367
|
-
*/
|
|
368
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
369
|
-
[index: string]: any;
|
|
370
|
-
}>;
|
|
371
|
-
/**
|
|
372
|
-
* HTTP GET /info
|
|
373
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
374
|
-
*/
|
|
375
|
-
getInfo(options?: O): RestResponse<{
|
|
376
|
-
[index: string]: any;
|
|
377
|
-
}>;
|
|
378
|
-
}
|
|
379
|
-
export declare class DashboardResourceClient<O> {
|
|
380
|
-
protected httpClient: HttpClient<O>;
|
|
381
|
-
constructor(httpClient: HttpClient<O>);
|
|
382
|
-
/**
|
|
383
|
-
* HTTP POST /dashboard
|
|
384
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
385
|
-
*/
|
|
386
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
387
|
-
/**
|
|
388
|
-
* HTTP PUT /dashboard
|
|
389
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
390
|
-
*/
|
|
391
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
392
|
-
/**
|
|
393
|
-
* HTTP GET /dashboard/all/{realm}
|
|
394
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
395
|
-
*/
|
|
396
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
397
|
-
/**
|
|
398
|
-
* HTTP POST /dashboard/query
|
|
399
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
400
|
-
*/
|
|
401
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
402
|
-
/**
|
|
403
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
404
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
405
|
-
*/
|
|
406
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
407
|
-
/**
|
|
408
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
409
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
396
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
397
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
410
398
|
*/
|
|
411
|
-
|
|
399
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
400
|
+
targetId?: string;
|
|
401
|
+
}, options?: O): RestResponse<void>;
|
|
412
402
|
}
|
|
413
403
|
export declare class ExternalServiceResourceClient<O> {
|
|
414
404
|
protected httpClient: HttpClient<O>;
|
|
@@ -465,132 +455,113 @@ export declare class ExternalServiceResourceClient<O> {
|
|
|
465
455
|
*/
|
|
466
456
|
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
467
457
|
}
|
|
468
|
-
export declare class
|
|
458
|
+
export declare class AssetResourceClient<O> {
|
|
469
459
|
protected httpClient: HttpClient<O>;
|
|
470
460
|
constructor(httpClient: HttpClient<O>);
|
|
471
461
|
/**
|
|
472
|
-
* HTTP POST /
|
|
473
|
-
* Java method: org.openremote.model.
|
|
462
|
+
* HTTP POST /asset
|
|
463
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
474
464
|
*/
|
|
475
|
-
|
|
465
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
476
466
|
/**
|
|
477
|
-
* HTTP DELETE /
|
|
478
|
-
* Java method: org.openremote.model.
|
|
467
|
+
* HTTP DELETE /asset
|
|
468
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
479
469
|
*/
|
|
480
|
-
|
|
470
|
+
delete(queryParams?: {
|
|
471
|
+
assetId?: string[];
|
|
472
|
+
}, options?: O): RestResponse<void>;
|
|
481
473
|
/**
|
|
482
|
-
* HTTP
|
|
483
|
-
* Java method: org.openremote.model.
|
|
474
|
+
* HTTP PUT /asset/attributes
|
|
475
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
484
476
|
*/
|
|
485
|
-
|
|
477
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
486
478
|
/**
|
|
487
|
-
* HTTP
|
|
488
|
-
* Java method: org.openremote.model.
|
|
479
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
480
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
489
481
|
*/
|
|
490
|
-
|
|
482
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
491
483
|
/**
|
|
492
|
-
* HTTP
|
|
493
|
-
* Java method: org.openremote.model.
|
|
484
|
+
* HTTP DELETE /asset/parent
|
|
485
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
494
486
|
*/
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
protected httpClient: HttpClient<O>;
|
|
499
|
-
constructor(httpClient: HttpClient<O>);
|
|
487
|
+
updateNoneParent(queryParams?: {
|
|
488
|
+
assetIds?: string[];
|
|
489
|
+
}, options?: O): RestResponse<void>;
|
|
500
490
|
/**
|
|
501
|
-
* HTTP GET /
|
|
502
|
-
* Java method: org.openremote.model.
|
|
491
|
+
* HTTP GET /asset/partial/{assetId}
|
|
492
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
503
493
|
*/
|
|
504
|
-
|
|
494
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
505
495
|
/**
|
|
506
|
-
* HTTP
|
|
507
|
-
* Java method: org.openremote.model.
|
|
496
|
+
* HTTP POST /asset/query
|
|
497
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
508
498
|
*/
|
|
509
|
-
|
|
499
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
510
500
|
/**
|
|
511
|
-
* HTTP POST /
|
|
512
|
-
* Java method: org.openremote.model.
|
|
501
|
+
* HTTP POST /asset/tree
|
|
502
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
513
503
|
*/
|
|
514
|
-
|
|
515
|
-
path?: string;
|
|
516
|
-
}, options?: O): RestResponse<string>;
|
|
504
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
517
505
|
/**
|
|
518
|
-
* HTTP GET /
|
|
519
|
-
* Java method: org.openremote.model.
|
|
506
|
+
* HTTP GET /asset/user/current
|
|
507
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
520
508
|
*/
|
|
521
|
-
|
|
522
|
-
}
|
|
523
|
-
export declare class FlowResourceClient<O> {
|
|
524
|
-
protected httpClient: HttpClient<O>;
|
|
525
|
-
constructor(httpClient: HttpClient<O>);
|
|
509
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
526
510
|
/**
|
|
527
|
-
* HTTP
|
|
528
|
-
* Java method: org.openremote.model.
|
|
511
|
+
* HTTP POST /asset/user/link
|
|
512
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
529
513
|
*/
|
|
530
|
-
|
|
514
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
531
515
|
/**
|
|
532
|
-
* HTTP GET /
|
|
533
|
-
* Java method: org.openremote.model.
|
|
516
|
+
* HTTP GET /asset/user/link
|
|
517
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
534
518
|
*/
|
|
535
|
-
|
|
519
|
+
getUserAssetLinks(queryParams?: {
|
|
520
|
+
realm?: string;
|
|
521
|
+
userId?: string;
|
|
522
|
+
assetId?: string;
|
|
523
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
536
524
|
/**
|
|
537
|
-
* HTTP
|
|
538
|
-
* Java method: org.openremote.model.
|
|
525
|
+
* HTTP POST /asset/user/link/delete
|
|
526
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
539
527
|
*/
|
|
540
|
-
|
|
541
|
-
}
|
|
542
|
-
export declare class NotificationResourceClient<O> {
|
|
543
|
-
protected httpClient: HttpClient<O>;
|
|
544
|
-
constructor(httpClient: HttpClient<O>);
|
|
528
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
545
529
|
/**
|
|
546
|
-
* HTTP
|
|
547
|
-
* Java method: org.openremote.model.
|
|
530
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
531
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
548
532
|
*/
|
|
549
|
-
|
|
550
|
-
id?: number;
|
|
551
|
-
type?: string;
|
|
552
|
-
from?: number;
|
|
553
|
-
to?: number;
|
|
554
|
-
realmId?: string;
|
|
555
|
-
userId?: string;
|
|
556
|
-
assetId?: string;
|
|
557
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
533
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
558
534
|
/**
|
|
559
|
-
* HTTP DELETE /
|
|
560
|
-
* Java method: org.openremote.model.
|
|
535
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
536
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
561
537
|
*/
|
|
562
|
-
|
|
563
|
-
id?: number;
|
|
564
|
-
type?: string;
|
|
565
|
-
from?: number;
|
|
566
|
-
to?: number;
|
|
567
|
-
realmId?: string;
|
|
568
|
-
userId?: string;
|
|
569
|
-
assetId?: string;
|
|
570
|
-
}, options?: O): RestResponse<void>;
|
|
538
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
571
539
|
/**
|
|
572
|
-
* HTTP
|
|
573
|
-
* Java method: org.openremote.model.
|
|
540
|
+
* HTTP GET /asset/{assetId}
|
|
541
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
574
542
|
*/
|
|
575
|
-
|
|
543
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
576
544
|
/**
|
|
577
|
-
* HTTP
|
|
578
|
-
* Java method: org.openremote.model.
|
|
545
|
+
* HTTP PUT /asset/{assetId}
|
|
546
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
579
547
|
*/
|
|
580
|
-
|
|
548
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
581
549
|
/**
|
|
582
|
-
* HTTP PUT /
|
|
583
|
-
* Java method: org.openremote.model.
|
|
550
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
551
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
584
552
|
*/
|
|
585
|
-
|
|
586
|
-
targetId?: string;
|
|
587
|
-
}, options?: O): RestResponse<void>;
|
|
553
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
588
554
|
/**
|
|
589
|
-
* HTTP PUT /
|
|
590
|
-
* Java method: org.openremote.model.
|
|
555
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
556
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
591
557
|
*/
|
|
592
|
-
|
|
593
|
-
|
|
558
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
559
|
+
/**
|
|
560
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
561
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
562
|
+
*/
|
|
563
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
564
|
+
assetIds?: string[];
|
|
594
565
|
}, options?: O): RestResponse<void>;
|
|
595
566
|
}
|
|
596
567
|
export declare class ConsoleResourceClient<O> {
|
|
@@ -655,31 +626,58 @@ export declare class AlarmResourceClient<O> {
|
|
|
655
626
|
realm?: string;
|
|
656
627
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
657
628
|
}
|
|
658
|
-
export declare class
|
|
629
|
+
export declare class MapResourceClient<O> {
|
|
659
630
|
protected httpClient: HttpClient<O>;
|
|
660
631
|
constructor(httpClient: HttpClient<O>);
|
|
661
632
|
/**
|
|
662
|
-
* HTTP GET /
|
|
663
|
-
* Java method: org.openremote.model.
|
|
633
|
+
* HTTP GET /map
|
|
634
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
664
635
|
*/
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
}
|
|
636
|
+
getSettings(options?: O): RestResponse<{
|
|
637
|
+
[id: string]: unknown;
|
|
638
|
+
}>;
|
|
668
639
|
/**
|
|
669
|
-
* HTTP
|
|
670
|
-
* Java method: org.openremote.model.
|
|
640
|
+
* HTTP PUT /map
|
|
641
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
671
642
|
*/
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
}
|
|
643
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
644
|
+
[id: string]: unknown;
|
|
645
|
+
}>;
|
|
675
646
|
/**
|
|
676
|
-
* HTTP
|
|
677
|
-
* Java method: org.openremote.model.
|
|
647
|
+
* HTTP DELETE /map/deleteMap
|
|
648
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
678
649
|
*/
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
650
|
+
deleteMap(options?: O): RestResponse<{
|
|
651
|
+
[id: string]: unknown;
|
|
652
|
+
}>;
|
|
653
|
+
/**
|
|
654
|
+
* HTTP GET /map/getCustomMapInfo
|
|
655
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
656
|
+
*/
|
|
657
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
658
|
+
[id: string]: unknown;
|
|
659
|
+
}>;
|
|
660
|
+
/**
|
|
661
|
+
* HTTP GET /map/js
|
|
662
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
663
|
+
*/
|
|
664
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
665
|
+
[id: string]: unknown;
|
|
666
|
+
}>;
|
|
667
|
+
/**
|
|
668
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
669
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
670
|
+
*/
|
|
671
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
672
|
+
/**
|
|
673
|
+
* HTTP POST /map/upload
|
|
674
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
675
|
+
*/
|
|
676
|
+
uploadMap(queryParams?: {
|
|
677
|
+
filename?: string;
|
|
678
|
+
}, options?: O): RestResponse<{
|
|
679
|
+
[id: string]: unknown;
|
|
680
|
+
}>;
|
|
683
681
|
}
|
|
684
682
|
export declare class UserResourceClient<O> {
|
|
685
683
|
protected httpClient: HttpClient<O>;
|
|
@@ -805,150 +803,126 @@ export declare class UserResourceClient<O> {
|
|
|
805
803
|
*/
|
|
806
804
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
807
805
|
}
|
|
808
|
-
export declare class
|
|
806
|
+
export declare class FlowResourceClient<O> {
|
|
809
807
|
protected httpClient: HttpClient<O>;
|
|
810
808
|
constructor(httpClient: HttpClient<O>);
|
|
811
809
|
/**
|
|
812
|
-
* HTTP
|
|
813
|
-
* Java method: org.openremote.model.
|
|
814
|
-
*/
|
|
815
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
816
|
-
/**
|
|
817
|
-
* HTTP DELETE /asset
|
|
818
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
819
|
-
*/
|
|
820
|
-
delete(queryParams?: {
|
|
821
|
-
assetId?: string[];
|
|
822
|
-
}, options?: O): RestResponse<void>;
|
|
823
|
-
/**
|
|
824
|
-
* HTTP PUT /asset/attributes
|
|
825
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
826
|
-
*/
|
|
827
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
828
|
-
/**
|
|
829
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
830
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
831
|
-
*/
|
|
832
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
833
|
-
/**
|
|
834
|
-
* HTTP DELETE /asset/parent
|
|
835
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
836
|
-
*/
|
|
837
|
-
updateNoneParent(queryParams?: {
|
|
838
|
-
assetIds?: string[];
|
|
839
|
-
}, options?: O): RestResponse<void>;
|
|
840
|
-
/**
|
|
841
|
-
* HTTP GET /asset/partial/{assetId}
|
|
842
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
843
|
-
*/
|
|
844
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
845
|
-
/**
|
|
846
|
-
* HTTP POST /asset/query
|
|
847
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
848
|
-
*/
|
|
849
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
850
|
-
/**
|
|
851
|
-
* HTTP POST /asset/tree
|
|
852
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
853
|
-
*/
|
|
854
|
-
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
855
|
-
/**
|
|
856
|
-
* HTTP GET /asset/user/current
|
|
857
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
810
|
+
* HTTP GET /flow
|
|
811
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
858
812
|
*/
|
|
859
|
-
|
|
813
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
860
814
|
/**
|
|
861
|
-
* HTTP
|
|
862
|
-
* Java method: org.openremote.model.
|
|
815
|
+
* HTTP GET /flow/{name}
|
|
816
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
863
817
|
*/
|
|
864
|
-
|
|
818
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
865
819
|
/**
|
|
866
|
-
* HTTP GET /
|
|
867
|
-
* Java method: org.openremote.model.
|
|
820
|
+
* HTTP GET /flow/{type}
|
|
821
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
868
822
|
*/
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
823
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
824
|
+
}
|
|
825
|
+
export declare class ConfigurationResourceClient<O> {
|
|
826
|
+
protected httpClient: HttpClient<O>;
|
|
827
|
+
constructor(httpClient: HttpClient<O>);
|
|
874
828
|
/**
|
|
875
|
-
* HTTP
|
|
876
|
-
* Java method: org.openremote.model.
|
|
829
|
+
* HTTP GET /configuration/manager
|
|
830
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
877
831
|
*/
|
|
878
|
-
|
|
832
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
879
833
|
/**
|
|
880
|
-
* HTTP
|
|
881
|
-
* Java method: org.openremote.model.
|
|
834
|
+
* HTTP PUT /configuration/manager
|
|
835
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
882
836
|
*/
|
|
883
|
-
|
|
837
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
884
838
|
/**
|
|
885
|
-
* HTTP
|
|
886
|
-
* Java method: org.openremote.model.
|
|
839
|
+
* HTTP POST /configuration/manager/file
|
|
840
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
887
841
|
*/
|
|
888
|
-
|
|
842
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
843
|
+
path?: string;
|
|
844
|
+
}, options?: O): RestResponse<string>;
|
|
889
845
|
/**
|
|
890
|
-
* HTTP GET /
|
|
891
|
-
* Java method: org.openremote.model.
|
|
846
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
847
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
892
848
|
*/
|
|
893
|
-
|
|
849
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
850
|
+
}
|
|
851
|
+
export declare class ProvisioningResourceClient<O> {
|
|
852
|
+
protected httpClient: HttpClient<O>;
|
|
853
|
+
constructor(httpClient: HttpClient<O>);
|
|
894
854
|
/**
|
|
895
|
-
* HTTP
|
|
896
|
-
* Java method: org.openremote.model.
|
|
855
|
+
* HTTP POST /provisioning
|
|
856
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
897
857
|
*/
|
|
898
|
-
|
|
858
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
899
859
|
/**
|
|
900
|
-
* HTTP
|
|
901
|
-
* Java method: org.openremote.model.
|
|
860
|
+
* HTTP GET /provisioning
|
|
861
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
902
862
|
*/
|
|
903
|
-
|
|
863
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
904
864
|
/**
|
|
905
|
-
* HTTP
|
|
906
|
-
* Java method: org.openremote.model.
|
|
865
|
+
* HTTP DELETE /provisioning/{id}
|
|
866
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
907
867
|
*/
|
|
908
|
-
|
|
868
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
909
869
|
/**
|
|
910
|
-
* HTTP PUT /
|
|
911
|
-
* Java method: org.openremote.model.
|
|
870
|
+
* HTTP PUT /provisioning/{id}
|
|
871
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
912
872
|
*/
|
|
913
|
-
|
|
914
|
-
assetIds?: string[];
|
|
915
|
-
}, options?: O): RestResponse<void>;
|
|
873
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
916
874
|
}
|
|
917
|
-
export declare class
|
|
875
|
+
export declare class DashboardResourceClient<O> {
|
|
918
876
|
protected httpClient: HttpClient<O>;
|
|
919
877
|
constructor(httpClient: HttpClient<O>);
|
|
920
878
|
/**
|
|
921
|
-
* HTTP
|
|
922
|
-
* Java method: org.openremote.model.
|
|
879
|
+
* HTTP POST /dashboard
|
|
880
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
923
881
|
*/
|
|
924
|
-
|
|
925
|
-
realm?: string[];
|
|
926
|
-
}, options?: O): RestResponse<void>;
|
|
882
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
927
883
|
/**
|
|
928
|
-
* HTTP
|
|
929
|
-
* Java method: org.openremote.model.
|
|
884
|
+
* HTTP PUT /dashboard
|
|
885
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
930
886
|
*/
|
|
931
|
-
|
|
887
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
932
888
|
/**
|
|
933
|
-
* HTTP
|
|
934
|
-
* Java method: org.openremote.model.
|
|
889
|
+
* HTTP GET /dashboard/all/{realm}
|
|
890
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
935
891
|
*/
|
|
936
|
-
|
|
892
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
937
893
|
/**
|
|
938
|
-
* HTTP
|
|
939
|
-
* Java method: org.openremote.model.
|
|
894
|
+
* HTTP POST /dashboard/query
|
|
895
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
940
896
|
*/
|
|
941
|
-
|
|
897
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
942
898
|
/**
|
|
943
|
-
* HTTP
|
|
944
|
-
* Java method: org.openremote.model.
|
|
899
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
900
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
945
901
|
*/
|
|
946
|
-
|
|
902
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
947
903
|
/**
|
|
948
|
-
* HTTP GET /
|
|
949
|
-
* Java method: org.openremote.model.
|
|
904
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
905
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
950
906
|
*/
|
|
951
|
-
|
|
907
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
908
|
+
}
|
|
909
|
+
export declare class StatusResourceClient<O> {
|
|
910
|
+
protected httpClient: HttpClient<O>;
|
|
911
|
+
constructor(httpClient: HttpClient<O>);
|
|
912
|
+
/**
|
|
913
|
+
* HTTP GET /health
|
|
914
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
915
|
+
*/
|
|
916
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
917
|
+
[index: string]: any;
|
|
918
|
+
}>;
|
|
919
|
+
/**
|
|
920
|
+
* HTTP GET /info
|
|
921
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
922
|
+
*/
|
|
923
|
+
getInfo(options?: O): RestResponse<{
|
|
924
|
+
[index: string]: any;
|
|
925
|
+
}>;
|
|
952
926
|
}
|
|
953
927
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
954
928
|
protected httpClient: HttpClient<O>;
|
|
@@ -964,53 +938,79 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
964
938
|
*/
|
|
965
939
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
966
940
|
}
|
|
941
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
942
|
+
protected httpClient: HttpClient<O>;
|
|
943
|
+
constructor(httpClient: HttpClient<O>);
|
|
944
|
+
/**
|
|
945
|
+
* HTTP GET /asset/datapoint/export
|
|
946
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
947
|
+
*/
|
|
948
|
+
getDatapointExport(queryParams?: {
|
|
949
|
+
attributeRefs?: string;
|
|
950
|
+
fromTimestamp?: number;
|
|
951
|
+
toTimestamp?: number;
|
|
952
|
+
}, options?: O): RestResponse<any>;
|
|
953
|
+
/**
|
|
954
|
+
* HTTP GET /asset/datapoint/periods
|
|
955
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
956
|
+
*/
|
|
957
|
+
getDatapointPeriod(queryParams?: {
|
|
958
|
+
assetId?: string;
|
|
959
|
+
attributeName?: string;
|
|
960
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
961
|
+
/**
|
|
962
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
963
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
964
|
+
*/
|
|
965
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
966
|
+
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
970
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
971
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
972
969
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
973
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
974
970
|
protected _realmResource: AxiosRealmResourceClient;
|
|
975
|
-
protected
|
|
971
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
976
972
|
protected _appResource: AxiosAppResourceClient;
|
|
977
|
-
protected
|
|
978
|
-
protected
|
|
979
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
973
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
974
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
980
975
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
981
|
-
protected
|
|
982
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
976
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
983
977
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
978
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
979
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
984
980
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
985
981
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
986
|
-
protected
|
|
982
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
987
983
|
protected _userResource: AxiosUserResourceClient;
|
|
988
|
-
protected
|
|
989
|
-
protected
|
|
984
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
985
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
986
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
987
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
988
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
990
989
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
990
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
993
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
994
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
995
992
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
996
|
-
get MapResource(): AxiosMapResourceClient;
|
|
997
993
|
get RealmResource(): AxiosRealmResourceClient;
|
|
998
|
-
get
|
|
994
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
999
995
|
get AppResource(): AxiosAppResourceClient;
|
|
1000
|
-
get
|
|
1001
|
-
get
|
|
1002
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
996
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
997
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1003
998
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1004
|
-
get
|
|
1005
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
999
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1006
1000
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1001
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1002
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1007
1003
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1008
1004
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1009
|
-
get
|
|
1005
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1010
1006
|
get UserResource(): AxiosUserResourceClient;
|
|
1011
|
-
get
|
|
1012
|
-
get
|
|
1007
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1008
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1009
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1010
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1011
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1013
1012
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1013
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1018,69 +1018,69 @@ declare module "axios" {
|
|
|
1018
1018
|
data: R;
|
|
1019
1019
|
}
|
|
1020
1020
|
}
|
|
1021
|
-
export declare class
|
|
1022
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
|
-
}
|
|
1024
|
-
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1021
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1023
|
}
|
|
1027
|
-
export declare class
|
|
1024
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1026
|
}
|
|
1030
|
-
export declare class
|
|
1027
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1029
|
}
|
|
1033
|
-
export declare class
|
|
1030
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1032
|
}
|
|
1036
|
-
export declare class
|
|
1033
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1035
|
}
|
|
1039
|
-
export declare class
|
|
1036
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1038
|
}
|
|
1042
|
-
export declare class
|
|
1039
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1041
|
}
|
|
1045
|
-
export declare class
|
|
1042
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1044
|
}
|
|
1048
|
-
export declare class
|
|
1045
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1047
|
}
|
|
1051
1048
|
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1050
|
}
|
|
1054
|
-
export declare class
|
|
1051
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1053
|
}
|
|
1057
|
-
export declare class
|
|
1054
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1056
|
}
|
|
1060
|
-
export declare class
|
|
1057
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1059
|
}
|
|
1063
|
-
export declare class
|
|
1060
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1062
|
}
|
|
1066
|
-
export declare class
|
|
1063
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1065
|
}
|
|
1069
|
-
export declare class
|
|
1066
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1068
|
}
|
|
1072
|
-
export declare class
|
|
1069
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1071
|
}
|
|
1075
|
-
export declare class
|
|
1072
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1074
|
}
|
|
1078
|
-
export declare class
|
|
1075
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1077
|
}
|
|
1081
|
-
export declare class
|
|
1078
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1080
|
}
|
|
1084
1081
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1083
|
}
|
|
1084
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
|
+
}
|