@openremote/rest 1.12.0-snapshot.20251126084901 → 1.12.0-snapshot.20251126163417
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 +609 -609
- 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,129 +9,57 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class StatusResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP POST /user/query
|
|
22
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
23
|
-
*/
|
|
24
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP PUT /user/request-password-reset
|
|
27
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
28
|
-
*/
|
|
29
|
-
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
30
|
-
/**
|
|
31
|
-
* HTTP PUT /user/reset-password
|
|
32
|
-
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
33
|
-
*/
|
|
34
|
-
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
35
|
-
/**
|
|
36
|
-
* HTTP PUT /user/update
|
|
37
|
-
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
38
|
-
*/
|
|
39
|
-
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
40
|
-
/**
|
|
41
|
-
* HTTP GET /user/user
|
|
42
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
43
|
-
*/
|
|
44
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
45
|
-
/**
|
|
46
|
-
* HTTP GET /user/userRealmRoles
|
|
47
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
48
|
-
*/
|
|
49
|
-
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
50
|
-
/**
|
|
51
|
-
* HTTP GET /user/userRoles/{clientId}
|
|
52
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
53
|
-
*/
|
|
54
|
-
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
55
|
-
/**
|
|
56
|
-
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
57
|
-
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
58
|
-
*/
|
|
59
|
-
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
60
|
-
/**
|
|
61
|
-
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
62
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
63
|
-
*/
|
|
64
|
-
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
65
|
-
/**
|
|
66
|
-
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
67
|
-
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
68
|
-
*/
|
|
69
|
-
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
70
|
-
/**
|
|
71
|
-
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
72
|
-
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
73
|
-
*/
|
|
74
|
-
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
75
|
-
/**
|
|
76
|
-
* HTTP PUT /user/{realm}/roles
|
|
77
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
78
|
-
*/
|
|
79
|
-
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
80
|
-
/**
|
|
81
|
-
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
82
|
-
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
83
|
-
*/
|
|
84
|
-
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
85
|
-
/**
|
|
86
|
-
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
87
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
88
|
-
*/
|
|
89
|
-
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
90
|
-
/**
|
|
91
|
-
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
92
|
-
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
93
|
-
*/
|
|
94
|
-
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
95
|
-
/**
|
|
96
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
97
|
-
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
16
|
+
* HTTP GET /health
|
|
17
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
98
18
|
*/
|
|
99
|
-
|
|
19
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
20
|
+
[index: string]: any;
|
|
21
|
+
}>;
|
|
100
22
|
/**
|
|
101
|
-
* HTTP GET /
|
|
102
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /info
|
|
24
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
103
25
|
*/
|
|
104
|
-
|
|
26
|
+
getInfo(options?: O): RestResponse<{
|
|
27
|
+
[index: string]: any;
|
|
28
|
+
}>;
|
|
29
|
+
}
|
|
30
|
+
export declare class DashboardResourceClient<O> {
|
|
31
|
+
protected httpClient: HttpClient<O>;
|
|
32
|
+
constructor(httpClient: HttpClient<O>);
|
|
105
33
|
/**
|
|
106
|
-
* HTTP POST /
|
|
107
|
-
* Java method: org.openremote.model.
|
|
34
|
+
* HTTP POST /dashboard
|
|
35
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
108
36
|
*/
|
|
109
|
-
create(
|
|
37
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
110
38
|
/**
|
|
111
|
-
* HTTP PUT /
|
|
112
|
-
* Java method: org.openremote.model.
|
|
39
|
+
* HTTP PUT /dashboard
|
|
40
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
113
41
|
*/
|
|
114
|
-
update(
|
|
42
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
115
43
|
/**
|
|
116
|
-
* HTTP
|
|
117
|
-
* Java method: org.openremote.model.
|
|
44
|
+
* HTTP GET /dashboard/all/{realm}
|
|
45
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
118
46
|
*/
|
|
119
|
-
|
|
47
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
120
48
|
/**
|
|
121
|
-
* HTTP
|
|
122
|
-
* Java method: org.openremote.model.
|
|
49
|
+
* HTTP POST /dashboard/query
|
|
50
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
123
51
|
*/
|
|
124
|
-
|
|
52
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
125
53
|
/**
|
|
126
|
-
* HTTP
|
|
127
|
-
* Java method: org.openremote.model.
|
|
54
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
55
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
128
56
|
*/
|
|
129
|
-
|
|
57
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
130
58
|
/**
|
|
131
|
-
* HTTP GET /
|
|
132
|
-
* Java method: org.openremote.model.
|
|
59
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
60
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
133
61
|
*/
|
|
134
|
-
get(realm: string,
|
|
62
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
135
63
|
}
|
|
136
64
|
export declare class AssetResourceClient<O> {
|
|
137
65
|
protected httpClient: HttpClient<O>;
|
|
@@ -242,326 +170,409 @@ export declare class AssetResourceClient<O> {
|
|
|
242
170
|
assetIds?: string[];
|
|
243
171
|
}, options?: O): RestResponse<void>;
|
|
244
172
|
}
|
|
245
|
-
export declare class
|
|
173
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
246
174
|
protected httpClient: HttpClient<O>;
|
|
247
175
|
constructor(httpClient: HttpClient<O>);
|
|
248
176
|
/**
|
|
249
|
-
*
|
|
250
|
-
*
|
|
177
|
+
* Response code 200 - List of registered external services
|
|
178
|
+
* HTTP GET /service
|
|
179
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
251
180
|
*/
|
|
252
|
-
|
|
181
|
+
getServices(queryParams?: {
|
|
182
|
+
realm?: string;
|
|
183
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
253
184
|
/**
|
|
254
|
-
*
|
|
255
|
-
*
|
|
185
|
+
* Response code 200 - Service registered successfully
|
|
186
|
+
* Response code 400 - Invalid external service object
|
|
187
|
+
* Response code 409 - ExternalService instance already registered
|
|
188
|
+
* HTTP POST /service
|
|
189
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
256
190
|
*/
|
|
257
|
-
|
|
258
|
-
language?: Model.RulesetLang[];
|
|
259
|
-
fullyPopulate?: boolean;
|
|
260
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
191
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
261
192
|
/**
|
|
262
|
-
*
|
|
263
|
-
*
|
|
193
|
+
* Response code 200 - List of registered external services
|
|
194
|
+
* HTTP GET /service/global
|
|
195
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
264
196
|
*/
|
|
265
|
-
|
|
197
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
266
198
|
/**
|
|
267
|
-
*
|
|
268
|
-
*
|
|
199
|
+
* Response code 200 - Service registered successfully
|
|
200
|
+
* Response code 400 - Invalid external service object
|
|
201
|
+
* Response code 409 - ExternalService instance already registered
|
|
202
|
+
* HTTP POST /service/global
|
|
203
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
269
204
|
*/
|
|
270
|
-
|
|
271
|
-
language?: Model.RulesetLang[];
|
|
272
|
-
fullyPopulate?: boolean;
|
|
273
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
205
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
274
206
|
/**
|
|
275
|
-
*
|
|
276
|
-
*
|
|
207
|
+
* Response code 204 - Service deregistered successfully
|
|
208
|
+
* Response code 404 - Service instance not found
|
|
209
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
210
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
277
211
|
*/
|
|
278
|
-
|
|
212
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
279
213
|
/**
|
|
280
|
-
*
|
|
281
|
-
*
|
|
214
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
215
|
+
* Response code 404 - ExternalService not found
|
|
216
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
217
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
282
218
|
*/
|
|
283
|
-
|
|
219
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
284
220
|
/**
|
|
285
|
-
*
|
|
286
|
-
*
|
|
221
|
+
* Response code 204 - Heartbeat sent successfully
|
|
222
|
+
* Response code 404 - Service instance not found
|
|
223
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
224
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
287
225
|
*/
|
|
288
|
-
|
|
226
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
227
|
+
}
|
|
228
|
+
export declare class RealmResourceClient<O> {
|
|
229
|
+
protected httpClient: HttpClient<O>;
|
|
230
|
+
constructor(httpClient: HttpClient<O>);
|
|
289
231
|
/**
|
|
290
|
-
* HTTP
|
|
291
|
-
* Java method: org.openremote.model.
|
|
232
|
+
* HTTP POST /realm
|
|
233
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
292
234
|
*/
|
|
293
|
-
|
|
235
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
294
236
|
/**
|
|
295
|
-
* HTTP GET /
|
|
296
|
-
* Java method: org.openremote.model.
|
|
237
|
+
* HTTP GET /realm
|
|
238
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
297
239
|
*/
|
|
298
|
-
|
|
240
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
299
241
|
/**
|
|
300
|
-
* HTTP GET /
|
|
301
|
-
* Java method: org.openremote.model.
|
|
242
|
+
* HTTP GET /realm/accessible
|
|
243
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
302
244
|
*/
|
|
303
|
-
|
|
245
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
304
246
|
/**
|
|
305
|
-
* HTTP
|
|
306
|
-
* Java method: org.openremote.model.
|
|
247
|
+
* HTTP DELETE /realm/{name}
|
|
248
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
307
249
|
*/
|
|
308
|
-
|
|
250
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
309
251
|
/**
|
|
310
|
-
* HTTP
|
|
311
|
-
* Java method: org.openremote.model.
|
|
252
|
+
* HTTP GET /realm/{name}
|
|
253
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
312
254
|
*/
|
|
313
|
-
|
|
255
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
314
256
|
/**
|
|
315
|
-
* HTTP
|
|
316
|
-
* Java method: org.openremote.model.
|
|
257
|
+
* HTTP PUT /realm/{name}
|
|
258
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
317
259
|
*/
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
260
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
261
|
+
}
|
|
262
|
+
export declare class AgentResourceClient<O> {
|
|
263
|
+
protected httpClient: HttpClient<O>;
|
|
264
|
+
constructor(httpClient: HttpClient<O>);
|
|
322
265
|
/**
|
|
323
|
-
* HTTP
|
|
324
|
-
* Java method: org.openremote.model.
|
|
266
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
267
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
325
268
|
*/
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
330
|
-
*/
|
|
331
|
-
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
332
|
-
/**
|
|
333
|
-
* HTTP PUT /rules/realm/{id}
|
|
334
|
-
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
335
|
-
*/
|
|
336
|
-
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
337
|
-
/**
|
|
338
|
-
* HTTP DELETE /rules/{id}
|
|
339
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
340
|
-
*/
|
|
341
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
269
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
270
|
+
realm?: string;
|
|
271
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
342
272
|
/**
|
|
343
|
-
* HTTP
|
|
344
|
-
* Java method: org.openremote.model.
|
|
273
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
274
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
345
275
|
*/
|
|
346
|
-
|
|
276
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
277
|
+
realm?: string;
|
|
278
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
347
279
|
/**
|
|
348
|
-
* HTTP
|
|
349
|
-
* Java method: org.openremote.model.
|
|
280
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
281
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
350
282
|
*/
|
|
351
|
-
|
|
283
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
284
|
+
parentId?: string;
|
|
285
|
+
realm?: string;
|
|
286
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
352
287
|
}
|
|
353
|
-
export declare class
|
|
288
|
+
export declare class MapResourceClient<O> {
|
|
354
289
|
protected httpClient: HttpClient<O>;
|
|
355
290
|
constructor(httpClient: HttpClient<O>);
|
|
356
291
|
/**
|
|
357
|
-
* HTTP GET /
|
|
358
|
-
* Java method: org.openremote.model.
|
|
292
|
+
* HTTP GET /map
|
|
293
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
359
294
|
*/
|
|
360
|
-
|
|
361
|
-
[
|
|
295
|
+
getSettings(options?: O): RestResponse<{
|
|
296
|
+
[id: string]: unknown;
|
|
362
297
|
}>;
|
|
363
298
|
/**
|
|
364
|
-
* HTTP
|
|
365
|
-
* Java method: org.openremote.model.
|
|
299
|
+
* HTTP PUT /map
|
|
300
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
366
301
|
*/
|
|
367
|
-
|
|
368
|
-
[
|
|
302
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
303
|
+
[id: string]: unknown;
|
|
369
304
|
}>;
|
|
370
|
-
}
|
|
371
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
372
|
-
protected httpClient: HttpClient<O>;
|
|
373
|
-
constructor(httpClient: HttpClient<O>);
|
|
374
|
-
/**
|
|
375
|
-
* Response code 200 - List of registered external services
|
|
376
|
-
* HTTP GET /service
|
|
377
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
378
|
-
*/
|
|
379
|
-
getServices(queryParams?: {
|
|
380
|
-
realm?: string;
|
|
381
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
382
|
-
/**
|
|
383
|
-
* Response code 200 - Service registered successfully
|
|
384
|
-
* Response code 400 - Invalid external service object
|
|
385
|
-
* Response code 409 - ExternalService instance already registered
|
|
386
|
-
* HTTP POST /service
|
|
387
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
388
|
-
*/
|
|
389
|
-
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
390
305
|
/**
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
306
|
+
* HTTP DELETE /map/deleteMap
|
|
307
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
394
308
|
*/
|
|
395
|
-
|
|
309
|
+
deleteMap(options?: O): RestResponse<{
|
|
310
|
+
[id: string]: unknown;
|
|
311
|
+
}>;
|
|
396
312
|
/**
|
|
397
|
-
*
|
|
398
|
-
*
|
|
399
|
-
* Response code 409 - ExternalService instance already registered
|
|
400
|
-
* HTTP POST /service/global
|
|
401
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
313
|
+
* HTTP GET /map/getCustomMapInfo
|
|
314
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
402
315
|
*/
|
|
403
|
-
|
|
316
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
317
|
+
[id: string]: unknown;
|
|
318
|
+
}>;
|
|
404
319
|
/**
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
408
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
320
|
+
* HTTP GET /map/js
|
|
321
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
409
322
|
*/
|
|
410
|
-
|
|
323
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
324
|
+
[id: string]: unknown;
|
|
325
|
+
}>;
|
|
411
326
|
/**
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
415
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
327
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
328
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
416
329
|
*/
|
|
417
|
-
|
|
330
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
418
331
|
/**
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
422
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
332
|
+
* HTTP POST /map/upload
|
|
333
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
423
334
|
*/
|
|
424
|
-
|
|
335
|
+
uploadMap(queryParams?: {
|
|
336
|
+
filename?: string;
|
|
337
|
+
}, options?: O): RestResponse<{
|
|
338
|
+
[id: string]: unknown;
|
|
339
|
+
}>;
|
|
425
340
|
}
|
|
426
|
-
export declare class
|
|
341
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
427
342
|
protected httpClient: HttpClient<O>;
|
|
428
343
|
constructor(httpClient: HttpClient<O>);
|
|
429
344
|
/**
|
|
430
|
-
* HTTP GET /
|
|
431
|
-
* Java method: org.openremote.model.
|
|
345
|
+
* HTTP GET /asset/datapoint/export
|
|
346
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
432
347
|
*/
|
|
433
|
-
|
|
348
|
+
getDatapointExport(queryParams?: {
|
|
349
|
+
attributeRefs?: string;
|
|
350
|
+
fromTimestamp?: number;
|
|
351
|
+
toTimestamp?: number;
|
|
352
|
+
}, options?: O): RestResponse<any>;
|
|
434
353
|
/**
|
|
435
|
-
* HTTP GET /
|
|
436
|
-
* Java method: org.openremote.model.
|
|
354
|
+
* HTTP GET /asset/datapoint/periods
|
|
355
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
437
356
|
*/
|
|
438
|
-
|
|
357
|
+
getDatapointPeriod(queryParams?: {
|
|
358
|
+
assetId?: string;
|
|
359
|
+
attributeName?: string;
|
|
360
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
439
361
|
/**
|
|
440
|
-
* HTTP
|
|
441
|
-
* Java method: org.openremote.model.
|
|
362
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
363
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
442
364
|
*/
|
|
443
|
-
|
|
365
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
444
366
|
}
|
|
445
|
-
export declare class
|
|
367
|
+
export declare class UserResourceClient<O> {
|
|
446
368
|
protected httpClient: HttpClient<O>;
|
|
447
369
|
constructor(httpClient: HttpClient<O>);
|
|
448
370
|
/**
|
|
449
|
-
* HTTP
|
|
450
|
-
* Java method: org.openremote.model.
|
|
371
|
+
* HTTP PUT /user/locale
|
|
372
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
451
373
|
*/
|
|
452
|
-
|
|
374
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
453
375
|
/**
|
|
454
|
-
* HTTP
|
|
455
|
-
* Java method: org.openremote.model.
|
|
376
|
+
* HTTP POST /user/query
|
|
377
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
456
378
|
*/
|
|
457
|
-
|
|
379
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
458
380
|
/**
|
|
459
|
-
* HTTP
|
|
460
|
-
* Java method: org.openremote.model.
|
|
381
|
+
* HTTP PUT /user/request-password-reset
|
|
382
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
461
383
|
*/
|
|
462
|
-
|
|
384
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
463
385
|
/**
|
|
464
|
-
* HTTP
|
|
465
|
-
* Java method: org.openremote.model.
|
|
386
|
+
* HTTP PUT /user/reset-password
|
|
387
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
466
388
|
*/
|
|
467
|
-
|
|
389
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
468
390
|
/**
|
|
469
|
-
* HTTP
|
|
470
|
-
* Java method: org.openremote.model.
|
|
391
|
+
* HTTP PUT /user/update
|
|
392
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
471
393
|
*/
|
|
472
|
-
|
|
394
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
473
395
|
/**
|
|
474
|
-
* HTTP GET /
|
|
475
|
-
* Java method: org.openremote.model.
|
|
396
|
+
* HTTP GET /user/user
|
|
397
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
476
398
|
*/
|
|
477
|
-
|
|
478
|
-
}
|
|
479
|
-
export declare class AlarmResourceClient<O> {
|
|
480
|
-
protected httpClient: HttpClient<O>;
|
|
481
|
-
constructor(httpClient: HttpClient<O>);
|
|
399
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
482
400
|
/**
|
|
483
|
-
* HTTP
|
|
484
|
-
* Java method: org.openremote.model.
|
|
401
|
+
* HTTP GET /user/userRealmRoles
|
|
402
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
485
403
|
*/
|
|
486
|
-
|
|
487
|
-
assetIds?: string[];
|
|
488
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
404
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
489
405
|
/**
|
|
490
|
-
* HTTP GET /
|
|
491
|
-
* Java method: org.openremote.model.
|
|
406
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
407
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
492
408
|
*/
|
|
493
|
-
|
|
494
|
-
realm?: string;
|
|
495
|
-
status?: Model.AlarmStatus;
|
|
496
|
-
assetId?: string;
|
|
497
|
-
assigneeId?: string;
|
|
498
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
409
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
499
410
|
/**
|
|
500
|
-
* HTTP
|
|
501
|
-
* Java method: org.openremote.model.
|
|
411
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
412
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
502
413
|
*/
|
|
503
|
-
|
|
414
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
504
415
|
/**
|
|
505
|
-
* HTTP PUT /
|
|
506
|
-
* Java method: org.openremote.model.
|
|
416
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
417
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
507
418
|
*/
|
|
508
|
-
|
|
419
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
509
420
|
/**
|
|
510
|
-
* HTTP
|
|
511
|
-
* Java method: org.openremote.model.
|
|
421
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
422
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
512
423
|
*/
|
|
513
|
-
|
|
424
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
514
425
|
/**
|
|
515
|
-
* HTTP
|
|
516
|
-
* Java method: org.openremote.model.
|
|
426
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
427
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
517
428
|
*/
|
|
518
|
-
|
|
429
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
519
430
|
/**
|
|
520
|
-
* HTTP PUT /
|
|
521
|
-
* Java method: org.openremote.model.
|
|
431
|
+
* HTTP PUT /user/{realm}/roles
|
|
432
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
522
433
|
*/
|
|
523
|
-
|
|
434
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
524
435
|
/**
|
|
525
|
-
* HTTP GET /
|
|
526
|
-
* Java method: org.openremote.model.
|
|
436
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
437
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
527
438
|
*/
|
|
528
|
-
|
|
529
|
-
realm?: string;
|
|
530
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
531
|
-
}
|
|
532
|
-
export declare class RealmResourceClient<O> {
|
|
533
|
-
protected httpClient: HttpClient<O>;
|
|
534
|
-
constructor(httpClient: HttpClient<O>);
|
|
439
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
535
440
|
/**
|
|
536
|
-
* HTTP
|
|
537
|
-
* Java method: org.openremote.model.security.
|
|
538
|
-
*/
|
|
539
|
-
|
|
441
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
442
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
443
|
+
*/
|
|
444
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
540
445
|
/**
|
|
541
|
-
* HTTP GET /realm
|
|
542
|
-
* Java method: org.openremote.model.security.
|
|
446
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
447
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
543
448
|
*/
|
|
544
|
-
|
|
449
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
545
450
|
/**
|
|
546
|
-
* HTTP
|
|
547
|
-
* Java method: org.openremote.model.security.
|
|
451
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
452
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
548
453
|
*/
|
|
549
|
-
|
|
454
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
550
455
|
/**
|
|
551
|
-
* HTTP
|
|
552
|
-
* Java method: org.openremote.model.security.
|
|
456
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
457
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
553
458
|
*/
|
|
554
|
-
|
|
459
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
555
460
|
/**
|
|
556
|
-
* HTTP
|
|
557
|
-
* Java method: org.openremote.model.security.
|
|
461
|
+
* HTTP POST /user/{realm}/users
|
|
462
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
558
463
|
*/
|
|
559
|
-
|
|
464
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
560
465
|
/**
|
|
561
|
-
* HTTP PUT /
|
|
562
|
-
* Java method: org.openremote.model.security.
|
|
466
|
+
* HTTP PUT /user/{realm}/users
|
|
467
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
563
468
|
*/
|
|
564
|
-
update(
|
|
469
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
470
|
+
/**
|
|
471
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
472
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
473
|
+
*/
|
|
474
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
475
|
+
/**
|
|
476
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
477
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
478
|
+
*/
|
|
479
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
480
|
+
/**
|
|
481
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
482
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
483
|
+
*/
|
|
484
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
485
|
+
/**
|
|
486
|
+
* HTTP GET /user/{realm}/{userId}
|
|
487
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
488
|
+
*/
|
|
489
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
490
|
+
}
|
|
491
|
+
export declare class NotificationResourceClient<O> {
|
|
492
|
+
protected httpClient: HttpClient<O>;
|
|
493
|
+
constructor(httpClient: HttpClient<O>);
|
|
494
|
+
/**
|
|
495
|
+
* HTTP GET /notification
|
|
496
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
497
|
+
*/
|
|
498
|
+
getNotifications(queryParams?: {
|
|
499
|
+
id?: number;
|
|
500
|
+
type?: string;
|
|
501
|
+
from?: number;
|
|
502
|
+
to?: number;
|
|
503
|
+
realmId?: string;
|
|
504
|
+
userId?: string;
|
|
505
|
+
assetId?: string;
|
|
506
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
507
|
+
/**
|
|
508
|
+
* HTTP DELETE /notification
|
|
509
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
510
|
+
*/
|
|
511
|
+
removeNotifications(queryParams?: {
|
|
512
|
+
id?: number;
|
|
513
|
+
type?: string;
|
|
514
|
+
from?: number;
|
|
515
|
+
to?: number;
|
|
516
|
+
realmId?: string;
|
|
517
|
+
userId?: string;
|
|
518
|
+
assetId?: string;
|
|
519
|
+
}, options?: O): RestResponse<void>;
|
|
520
|
+
/**
|
|
521
|
+
* HTTP POST /notification/alert
|
|
522
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
523
|
+
*/
|
|
524
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
525
|
+
/**
|
|
526
|
+
* HTTP DELETE /notification/{notificationId}
|
|
527
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
528
|
+
*/
|
|
529
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
530
|
+
/**
|
|
531
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
532
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
533
|
+
*/
|
|
534
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
535
|
+
targetId?: string;
|
|
536
|
+
}, options?: O): RestResponse<void>;
|
|
537
|
+
/**
|
|
538
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
539
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
540
|
+
*/
|
|
541
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
542
|
+
targetId?: string;
|
|
543
|
+
}, options?: O): RestResponse<void>;
|
|
544
|
+
}
|
|
545
|
+
export declare class SyslogResourceClient<O> {
|
|
546
|
+
protected httpClient: HttpClient<O>;
|
|
547
|
+
constructor(httpClient: HttpClient<O>);
|
|
548
|
+
/**
|
|
549
|
+
* HTTP GET /syslog/config
|
|
550
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
551
|
+
*/
|
|
552
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
553
|
+
/**
|
|
554
|
+
* HTTP PUT /syslog/config
|
|
555
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
556
|
+
*/
|
|
557
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
558
|
+
/**
|
|
559
|
+
* HTTP DELETE /syslog/event
|
|
560
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
561
|
+
*/
|
|
562
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
563
|
+
/**
|
|
564
|
+
* HTTP GET /syslog/event
|
|
565
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
566
|
+
*/
|
|
567
|
+
getEvents(queryParams?: {
|
|
568
|
+
level?: Model.SyslogLevel;
|
|
569
|
+
per_page?: number;
|
|
570
|
+
page?: number;
|
|
571
|
+
from?: number;
|
|
572
|
+
to?: number;
|
|
573
|
+
category?: Model.SyslogCategory[];
|
|
574
|
+
subCategory?: string[];
|
|
575
|
+
}, options?: O): RestResponse<any>;
|
|
565
576
|
}
|
|
566
577
|
export declare class GatewayClientResourceClient<O> {
|
|
567
578
|
protected httpClient: HttpClient<O>;
|
|
@@ -599,14 +610,58 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
599
610
|
*/
|
|
600
611
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
601
612
|
}
|
|
602
|
-
export declare class
|
|
613
|
+
export declare class AlarmResourceClient<O> {
|
|
603
614
|
protected httpClient: HttpClient<O>;
|
|
604
615
|
constructor(httpClient: HttpClient<O>);
|
|
605
616
|
/**
|
|
606
|
-
* HTTP POST /
|
|
607
|
-
* Java method: org.openremote.model.
|
|
617
|
+
* HTTP POST /alarm
|
|
618
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
608
619
|
*/
|
|
609
|
-
|
|
620
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
621
|
+
assetIds?: string[];
|
|
622
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
623
|
+
/**
|
|
624
|
+
* HTTP GET /alarm
|
|
625
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
626
|
+
*/
|
|
627
|
+
getAlarms(queryParams?: {
|
|
628
|
+
realm?: string;
|
|
629
|
+
status?: Model.AlarmStatus;
|
|
630
|
+
assetId?: string;
|
|
631
|
+
assigneeId?: string;
|
|
632
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
633
|
+
/**
|
|
634
|
+
* HTTP DELETE /alarm
|
|
635
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
636
|
+
*/
|
|
637
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
638
|
+
/**
|
|
639
|
+
* HTTP PUT /alarm/assets
|
|
640
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
641
|
+
*/
|
|
642
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
643
|
+
/**
|
|
644
|
+
* HTTP GET /alarm/{alarmId}
|
|
645
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
646
|
+
*/
|
|
647
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
648
|
+
/**
|
|
649
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
650
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
651
|
+
*/
|
|
652
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
653
|
+
/**
|
|
654
|
+
* HTTP PUT /alarm/{alarmId}
|
|
655
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
656
|
+
*/
|
|
657
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
658
|
+
/**
|
|
659
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
660
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
661
|
+
*/
|
|
662
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
663
|
+
realm?: string;
|
|
664
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
610
665
|
}
|
|
611
666
|
export declare class ProvisioningResourceClient<O> {
|
|
612
667
|
protected httpClient: HttpClient<O>;
|
|
@@ -632,385 +687,330 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
632
687
|
*/
|
|
633
688
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
634
689
|
}
|
|
635
|
-
export declare class
|
|
690
|
+
export declare class FlowResourceClient<O> {
|
|
636
691
|
protected httpClient: HttpClient<O>;
|
|
637
692
|
constructor(httpClient: HttpClient<O>);
|
|
638
693
|
/**
|
|
639
|
-
* HTTP GET /
|
|
640
|
-
* Java method: org.openremote.model.
|
|
694
|
+
* HTTP GET /flow
|
|
695
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
641
696
|
*/
|
|
642
|
-
|
|
697
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
643
698
|
/**
|
|
644
|
-
* HTTP GET /
|
|
645
|
-
* Java method: org.openremote.model.
|
|
699
|
+
* HTTP GET /flow/{name}
|
|
700
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
646
701
|
*/
|
|
647
|
-
|
|
702
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
648
703
|
/**
|
|
649
|
-
* HTTP GET /
|
|
650
|
-
* Java method: org.openremote.model.
|
|
704
|
+
* HTTP GET /flow/{type}
|
|
705
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
651
706
|
*/
|
|
652
|
-
|
|
707
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
653
708
|
}
|
|
654
|
-
export declare class
|
|
709
|
+
export declare class AssetModelResourceClient<O> {
|
|
655
710
|
protected httpClient: HttpClient<O>;
|
|
656
711
|
constructor(httpClient: HttpClient<O>);
|
|
657
712
|
/**
|
|
658
|
-
* HTTP GET /
|
|
659
|
-
* Java method: org.openremote.model.
|
|
713
|
+
* HTTP GET /model/assetDescriptors
|
|
714
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
660
715
|
*/
|
|
661
|
-
|
|
716
|
+
getAssetDescriptors(queryParams?: {
|
|
717
|
+
parentId?: string;
|
|
718
|
+
parentType?: string;
|
|
719
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
662
720
|
/**
|
|
663
|
-
* HTTP
|
|
664
|
-
* Java method: org.openremote.model.
|
|
721
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
722
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
665
723
|
*/
|
|
666
|
-
|
|
724
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
725
|
+
parentId?: string;
|
|
726
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
667
727
|
/**
|
|
668
|
-
* HTTP
|
|
669
|
-
* Java method: org.openremote.model.
|
|
728
|
+
* HTTP GET /model/assetInfos
|
|
729
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
670
730
|
*/
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
731
|
+
getAssetInfos(queryParams?: {
|
|
732
|
+
parentId?: string;
|
|
733
|
+
parentType?: string;
|
|
734
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
674
735
|
/**
|
|
675
|
-
* HTTP GET /
|
|
676
|
-
* Java method: org.openremote.model.
|
|
736
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
737
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
677
738
|
*/
|
|
678
|
-
|
|
739
|
+
getValueDescriptorSchema(queryParams?: {
|
|
740
|
+
name?: string;
|
|
741
|
+
hash?: string;
|
|
742
|
+
}, options?: O): RestResponse<any>;
|
|
743
|
+
/**
|
|
744
|
+
* HTTP GET /model/metaItemDescriptors
|
|
745
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
746
|
+
*/
|
|
747
|
+
getMetaItemDescriptors(queryParams?: {
|
|
748
|
+
parentId?: string;
|
|
749
|
+
}, options?: O): RestResponse<{
|
|
750
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
751
|
+
}>;
|
|
752
|
+
/**
|
|
753
|
+
* HTTP GET /model/valueDescriptors
|
|
754
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
755
|
+
*/
|
|
756
|
+
getValueDescriptors(queryParams?: {
|
|
757
|
+
parentId?: string;
|
|
758
|
+
}, options?: O): RestResponse<{
|
|
759
|
+
[index: string]: Model.ValueDescriptor;
|
|
760
|
+
}>;
|
|
679
761
|
}
|
|
680
|
-
export declare class
|
|
762
|
+
export declare class RulesResourceClient<O> {
|
|
681
763
|
protected httpClient: HttpClient<O>;
|
|
682
764
|
constructor(httpClient: HttpClient<O>);
|
|
683
765
|
/**
|
|
684
|
-
* HTTP POST /
|
|
685
|
-
* Java method: org.openremote.model.
|
|
686
|
-
*/
|
|
687
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
688
|
-
/**
|
|
689
|
-
* HTTP DELETE /gateway/tunnel
|
|
690
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
766
|
+
* HTTP POST /rules
|
|
767
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
691
768
|
*/
|
|
692
|
-
|
|
769
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
693
770
|
/**
|
|
694
|
-
* HTTP GET /
|
|
695
|
-
* Java method: org.openremote.model.
|
|
771
|
+
* HTTP GET /rules
|
|
772
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
696
773
|
*/
|
|
697
|
-
|
|
774
|
+
getGlobalRulesets(queryParams?: {
|
|
775
|
+
language?: Model.RulesetLang[];
|
|
776
|
+
fullyPopulate?: boolean;
|
|
777
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
698
778
|
/**
|
|
699
|
-
* HTTP
|
|
700
|
-
* Java method: org.openremote.model.
|
|
779
|
+
* HTTP POST /rules/asset
|
|
780
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
701
781
|
*/
|
|
702
|
-
|
|
782
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
703
783
|
/**
|
|
704
|
-
* HTTP GET /
|
|
705
|
-
* Java method: org.openremote.model.
|
|
784
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
785
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
706
786
|
*/
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
constructor(httpClient: HttpClient<O>);
|
|
787
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
788
|
+
language?: Model.RulesetLang[];
|
|
789
|
+
fullyPopulate?: boolean;
|
|
790
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
712
791
|
/**
|
|
713
|
-
* HTTP
|
|
714
|
-
* Java method: org.openremote.model.
|
|
792
|
+
* HTTP DELETE /rules/asset/{id}
|
|
793
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
715
794
|
*/
|
|
716
|
-
|
|
795
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
717
796
|
/**
|
|
718
|
-
* HTTP
|
|
719
|
-
* Java method: org.openremote.model.
|
|
797
|
+
* HTTP GET /rules/asset/{id}
|
|
798
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
720
799
|
*/
|
|
721
|
-
|
|
722
|
-
}
|
|
723
|
-
export declare class SyslogResourceClient<O> {
|
|
724
|
-
protected httpClient: HttpClient<O>;
|
|
725
|
-
constructor(httpClient: HttpClient<O>);
|
|
800
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
726
801
|
/**
|
|
727
|
-
* HTTP
|
|
728
|
-
* Java method: org.openremote.model.
|
|
802
|
+
* HTTP PUT /rules/asset/{id}
|
|
803
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
729
804
|
*/
|
|
730
|
-
|
|
805
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
731
806
|
/**
|
|
732
|
-
* HTTP
|
|
733
|
-
* Java method: org.openremote.model.
|
|
807
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
808
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
734
809
|
*/
|
|
735
|
-
|
|
810
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
736
811
|
/**
|
|
737
|
-
* HTTP
|
|
738
|
-
* Java method: org.openremote.model.
|
|
812
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
813
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
739
814
|
*/
|
|
740
|
-
|
|
815
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
741
816
|
/**
|
|
742
|
-
* HTTP GET /
|
|
743
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP GET /rules/info/global
|
|
818
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
744
819
|
*/
|
|
745
|
-
|
|
746
|
-
level?: Model.SyslogLevel;
|
|
747
|
-
per_page?: number;
|
|
748
|
-
page?: number;
|
|
749
|
-
from?: number;
|
|
750
|
-
to?: number;
|
|
751
|
-
category?: Model.SyslogCategory[];
|
|
752
|
-
subCategory?: string[];
|
|
753
|
-
}, options?: O): RestResponse<any>;
|
|
754
|
-
}
|
|
755
|
-
export declare class NotificationResourceClient<O> {
|
|
756
|
-
protected httpClient: HttpClient<O>;
|
|
757
|
-
constructor(httpClient: HttpClient<O>);
|
|
820
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
758
821
|
/**
|
|
759
|
-
* HTTP GET /
|
|
760
|
-
* Java method: org.openremote.model.
|
|
822
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
823
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
761
824
|
*/
|
|
762
|
-
|
|
763
|
-
id?: number;
|
|
764
|
-
type?: string;
|
|
765
|
-
from?: number;
|
|
766
|
-
to?: number;
|
|
767
|
-
realmId?: string;
|
|
768
|
-
userId?: string;
|
|
769
|
-
assetId?: string;
|
|
770
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
825
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
771
826
|
/**
|
|
772
|
-
* HTTP
|
|
773
|
-
* Java method: org.openremote.model.
|
|
827
|
+
* HTTP POST /rules/realm
|
|
828
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
774
829
|
*/
|
|
775
|
-
|
|
776
|
-
id?: number;
|
|
777
|
-
type?: string;
|
|
778
|
-
from?: number;
|
|
779
|
-
to?: number;
|
|
780
|
-
realmId?: string;
|
|
781
|
-
userId?: string;
|
|
782
|
-
assetId?: string;
|
|
783
|
-
}, options?: O): RestResponse<void>;
|
|
830
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
784
831
|
/**
|
|
785
|
-
* HTTP
|
|
786
|
-
* Java method: org.openremote.model.
|
|
832
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
833
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
787
834
|
*/
|
|
788
|
-
|
|
835
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
836
|
+
language?: Model.RulesetLang[];
|
|
837
|
+
fullyPopulate?: boolean;
|
|
838
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
789
839
|
/**
|
|
790
|
-
* HTTP DELETE /
|
|
791
|
-
* Java method: org.openremote.model.
|
|
840
|
+
* HTTP DELETE /rules/realm/{id}
|
|
841
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
792
842
|
*/
|
|
793
|
-
|
|
843
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
794
844
|
/**
|
|
795
|
-
* HTTP
|
|
796
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* HTTP GET /rules/realm/{id}
|
|
846
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
797
847
|
*/
|
|
798
|
-
|
|
799
|
-
targetId?: string;
|
|
800
|
-
}, options?: O): RestResponse<void>;
|
|
848
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
801
849
|
/**
|
|
802
|
-
* HTTP PUT /
|
|
803
|
-
* Java method: org.openremote.model.
|
|
850
|
+
* HTTP PUT /rules/realm/{id}
|
|
851
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
804
852
|
*/
|
|
805
|
-
|
|
806
|
-
targetId?: string;
|
|
807
|
-
}, options?: O): RestResponse<void>;
|
|
808
|
-
}
|
|
809
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
810
|
-
protected httpClient: HttpClient<O>;
|
|
811
|
-
constructor(httpClient: HttpClient<O>);
|
|
853
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
812
854
|
/**
|
|
813
|
-
* HTTP
|
|
814
|
-
* Java method: org.openremote.model.
|
|
855
|
+
* HTTP DELETE /rules/{id}
|
|
856
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
815
857
|
*/
|
|
816
|
-
|
|
817
|
-
attributeRefs?: string;
|
|
818
|
-
fromTimestamp?: number;
|
|
819
|
-
toTimestamp?: number;
|
|
820
|
-
}, options?: O): RestResponse<any>;
|
|
858
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
821
859
|
/**
|
|
822
|
-
* HTTP GET /
|
|
823
|
-
* Java method: org.openremote.model.
|
|
860
|
+
* HTTP GET /rules/{id}
|
|
861
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
824
862
|
*/
|
|
825
|
-
|
|
826
|
-
assetId?: string;
|
|
827
|
-
attributeName?: string;
|
|
828
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
863
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
829
864
|
/**
|
|
830
|
-
* HTTP
|
|
831
|
-
* Java method: org.openremote.model.
|
|
865
|
+
* HTTP PUT /rules/{id}
|
|
866
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
832
867
|
*/
|
|
833
|
-
|
|
868
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
834
869
|
}
|
|
835
|
-
export declare class
|
|
870
|
+
export declare class ConfigurationResourceClient<O> {
|
|
836
871
|
protected httpClient: HttpClient<O>;
|
|
837
872
|
constructor(httpClient: HttpClient<O>);
|
|
838
873
|
/**
|
|
839
|
-
* HTTP GET /
|
|
840
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP GET /configuration/manager
|
|
875
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
841
876
|
*/
|
|
842
|
-
|
|
843
|
-
realm?: string;
|
|
844
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
877
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
845
878
|
/**
|
|
846
|
-
* HTTP
|
|
847
|
-
* Java method: org.openremote.model.
|
|
879
|
+
* HTTP PUT /configuration/manager
|
|
880
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
848
881
|
*/
|
|
849
|
-
|
|
850
|
-
realm?: string;
|
|
851
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
882
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
852
883
|
/**
|
|
853
|
-
* HTTP
|
|
854
|
-
* Java method: org.openremote.model.
|
|
884
|
+
* HTTP POST /configuration/manager/file
|
|
885
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
855
886
|
*/
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
887
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
888
|
+
path?: string;
|
|
889
|
+
}, options?: O): RestResponse<string>;
|
|
890
|
+
/**
|
|
891
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
892
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
893
|
+
*/
|
|
894
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
860
895
|
}
|
|
861
|
-
export declare class
|
|
896
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
862
897
|
protected httpClient: HttpClient<O>;
|
|
863
898
|
constructor(httpClient: HttpClient<O>);
|
|
864
899
|
/**
|
|
865
|
-
* HTTP
|
|
866
|
-
* Java method: org.openremote.model.
|
|
867
|
-
*/
|
|
868
|
-
getSettings(options?: O): RestResponse<{
|
|
869
|
-
[id: string]: unknown;
|
|
870
|
-
}>;
|
|
871
|
-
/**
|
|
872
|
-
* HTTP PUT /map
|
|
873
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
874
|
-
*/
|
|
875
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
876
|
-
[id: string]: unknown;
|
|
877
|
-
}>;
|
|
878
|
-
/**
|
|
879
|
-
* HTTP DELETE /map/deleteMap
|
|
880
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
900
|
+
* HTTP POST /gateway/tunnel
|
|
901
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
881
902
|
*/
|
|
882
|
-
|
|
883
|
-
[id: string]: unknown;
|
|
884
|
-
}>;
|
|
903
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
885
904
|
/**
|
|
886
|
-
* HTTP
|
|
887
|
-
* Java method: org.openremote.model.
|
|
905
|
+
* HTTP DELETE /gateway/tunnel
|
|
906
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
888
907
|
*/
|
|
889
|
-
|
|
890
|
-
[id: string]: unknown;
|
|
891
|
-
}>;
|
|
908
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
892
909
|
/**
|
|
893
|
-
* HTTP GET /
|
|
894
|
-
* Java method: org.openremote.model.
|
|
910
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
911
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
895
912
|
*/
|
|
896
|
-
|
|
897
|
-
[id: string]: unknown;
|
|
898
|
-
}>;
|
|
913
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
899
914
|
/**
|
|
900
|
-
* HTTP GET /
|
|
901
|
-
* Java method: org.openremote.model.
|
|
915
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
916
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
902
917
|
*/
|
|
903
|
-
|
|
918
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
904
919
|
/**
|
|
905
|
-
* HTTP
|
|
906
|
-
* Java method: org.openremote.model.
|
|
920
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
921
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
907
922
|
*/
|
|
908
|
-
|
|
909
|
-
filename?: string;
|
|
910
|
-
}, options?: O): RestResponse<{
|
|
911
|
-
[id: string]: unknown;
|
|
912
|
-
}>;
|
|
923
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
913
924
|
}
|
|
914
|
-
export declare class
|
|
925
|
+
export declare class ConsoleResourceClient<O> {
|
|
915
926
|
protected httpClient: HttpClient<O>;
|
|
916
927
|
constructor(httpClient: HttpClient<O>);
|
|
917
928
|
/**
|
|
918
|
-
* HTTP
|
|
919
|
-
* Java method: org.openremote.model.
|
|
929
|
+
* HTTP POST /console/register
|
|
930
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
920
931
|
*/
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
932
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
933
|
+
}
|
|
934
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
935
|
+
protected httpClient: HttpClient<O>;
|
|
936
|
+
constructor(httpClient: HttpClient<O>);
|
|
925
937
|
/**
|
|
926
|
-
* HTTP
|
|
927
|
-
* Java method: org.openremote.model.
|
|
938
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
939
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
928
940
|
*/
|
|
929
|
-
|
|
930
|
-
parentId?: string;
|
|
931
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
941
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
932
942
|
/**
|
|
933
|
-
* HTTP
|
|
934
|
-
* Java method: org.openremote.model.
|
|
943
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
944
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
935
945
|
*/
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
946
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
947
|
+
}
|
|
948
|
+
export declare class AppResourceClient<O> {
|
|
949
|
+
protected httpClient: HttpClient<O>;
|
|
950
|
+
constructor(httpClient: HttpClient<O>);
|
|
940
951
|
/**
|
|
941
|
-
* HTTP GET /
|
|
942
|
-
* Java method: org.openremote.model.
|
|
952
|
+
* HTTP GET /apps
|
|
953
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
943
954
|
*/
|
|
944
|
-
|
|
945
|
-
name?: string;
|
|
946
|
-
hash?: string;
|
|
947
|
-
}, options?: O): RestResponse<any>;
|
|
955
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
948
956
|
/**
|
|
949
|
-
* HTTP GET /
|
|
950
|
-
* Java method: org.openremote.model.
|
|
957
|
+
* HTTP GET /apps/consoleConfig
|
|
958
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
951
959
|
*/
|
|
952
|
-
|
|
953
|
-
parentId?: string;
|
|
954
|
-
}, options?: O): RestResponse<{
|
|
955
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
956
|
-
}>;
|
|
960
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
957
961
|
/**
|
|
958
|
-
* HTTP GET /
|
|
959
|
-
* Java method: org.openremote.model.
|
|
962
|
+
* HTTP GET /apps/info
|
|
963
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
960
964
|
*/
|
|
961
|
-
|
|
962
|
-
parentId?: string;
|
|
963
|
-
}, options?: O): RestResponse<{
|
|
964
|
-
[index: string]: Model.ValueDescriptor;
|
|
965
|
-
}>;
|
|
965
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
-
protected _userResource: AxiosUserResourceClient;
|
|
970
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
971
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
972
969
|
protected _statusResource: AxiosStatusResourceClient;
|
|
973
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
974
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
975
970
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
976
|
-
protected
|
|
971
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
972
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
977
973
|
protected _realmResource: AxiosRealmResourceClient;
|
|
974
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
975
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
976
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
977
|
+
protected _userResource: AxiosUserResourceClient;
|
|
978
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
979
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
978
980
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
979
|
-
protected
|
|
981
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
980
982
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
981
|
-
protected
|
|
983
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
984
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
985
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
982
986
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
983
987
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
988
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
984
989
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
985
|
-
protected
|
|
986
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
987
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
988
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
989
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
990
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
990
|
+
protected _appResource: AxiosAppResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
get UserResource(): AxiosUserResourceClient;
|
|
993
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
994
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
995
992
|
get StatusResource(): AxiosStatusResourceClient;
|
|
996
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
997
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
998
993
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
999
|
-
get
|
|
994
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
995
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1000
996
|
get RealmResource(): AxiosRealmResourceClient;
|
|
997
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
998
|
+
get MapResource(): AxiosMapResourceClient;
|
|
999
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1000
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1001
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1002
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1001
1003
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1002
|
-
get
|
|
1004
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1003
1005
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1004
|
-
get
|
|
1006
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1007
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1008
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1005
1009
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1006
1010
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1011
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1007
1012
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1008
|
-
get
|
|
1009
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1010
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1011
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1012
|
-
get MapResource(): AxiosMapResourceClient;
|
|
1013
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1013
|
+
get AppResource(): AxiosAppResourceClient;
|
|
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
|
|
1021
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
|
-
export declare class
|
|
1027
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
|
-
export declare class
|
|
1030
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1033
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1035
|
}
|
|
1036
|
-
export declare class
|
|
1036
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1038
|
}
|
|
1039
|
-
export declare class
|
|
1039
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1041
|
}
|
|
1042
|
-
export declare class
|
|
1042
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1044
|
}
|
|
1045
|
-
export declare class
|
|
1045
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1047
|
}
|
|
1048
|
-
export declare class
|
|
1048
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1050
|
}
|
|
1051
|
-
export declare class
|
|
1051
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1053
|
}
|
|
1054
|
-
export declare class
|
|
1054
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1056
|
}
|
|
1057
|
-
export declare class
|
|
1057
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1059
|
}
|
|
1060
|
-
export declare class
|
|
1060
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1062
|
}
|
|
1063
|
-
export declare class
|
|
1063
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1065
|
}
|
|
1066
|
-
export declare class
|
|
1066
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1068
|
}
|
|
1069
|
-
export declare class
|
|
1069
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1071
|
}
|
|
1072
|
-
export declare class
|
|
1072
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1074
|
}
|
|
1075
|
-
export declare class
|
|
1075
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1077
|
}
|
|
1078
|
-
export declare class
|
|
1078
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1080
|
}
|
|
1081
|
-
export declare class
|
|
1081
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1083
|
}
|
|
1084
|
-
export declare class
|
|
1084
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|