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