@openremote/rest 1.2.0 → 1.3.0-snapshot.20241219112417
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +473 -473
- 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,111 +9,129 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class UserResourceClient<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 PUT /user/locale
|
|
17
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
realm?: any;
|
|
21
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
19
|
+
updateCurrentUserLocale(locale: any, options?: O): RestResponse<void>;
|
|
22
20
|
/**
|
|
23
|
-
* HTTP POST /
|
|
24
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP POST /user/query
|
|
22
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
25
23
|
*/
|
|
26
|
-
|
|
27
|
-
realm?: any;
|
|
28
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
24
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
29
25
|
/**
|
|
30
|
-
* HTTP GET /
|
|
31
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /user/user
|
|
27
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
32
28
|
*/
|
|
33
|
-
|
|
34
|
-
parentId?: any;
|
|
35
|
-
realm?: any;
|
|
36
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
37
|
-
}
|
|
38
|
-
export declare class ConsoleResourceClient<O> {
|
|
39
|
-
protected httpClient: HttpClient<O>;
|
|
40
|
-
constructor(httpClient: HttpClient<O>);
|
|
29
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
41
30
|
/**
|
|
42
|
-
* HTTP
|
|
43
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP GET /user/userRealmRoles
|
|
32
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
44
33
|
*/
|
|
45
|
-
|
|
46
|
-
}
|
|
47
|
-
export declare class StatusResourceClient<O> {
|
|
48
|
-
protected httpClient: HttpClient<O>;
|
|
49
|
-
constructor(httpClient: HttpClient<O>);
|
|
34
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<Model.Role[]>;
|
|
50
35
|
/**
|
|
51
|
-
* HTTP GET /
|
|
52
|
-
* Java method: org.openremote.model.
|
|
36
|
+
* HTTP GET /user/userRoles
|
|
37
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRoles
|
|
53
38
|
*/
|
|
54
|
-
|
|
55
|
-
[index: string]: any;
|
|
56
|
-
}>;
|
|
39
|
+
getCurrentUserRoles(options?: O): RestResponse<Model.Role[]>;
|
|
57
40
|
/**
|
|
58
|
-
* HTTP GET /
|
|
59
|
-
* Java method: org.openremote.model.
|
|
41
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
42
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
60
43
|
*/
|
|
61
|
-
|
|
62
|
-
[index: string]: any;
|
|
63
|
-
}>;
|
|
64
|
-
}
|
|
65
|
-
export declare class ProvisioningResourceClient<O> {
|
|
66
|
-
protected httpClient: HttpClient<O>;
|
|
67
|
-
constructor(httpClient: HttpClient<O>);
|
|
44
|
+
getCurrentUserClientRoles(clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
68
45
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
46
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
47
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
71
48
|
*/
|
|
72
|
-
|
|
49
|
+
disconnectUserSession(realm: any, sessionID: any, options?: O): RestResponse<void>;
|
|
73
50
|
/**
|
|
74
|
-
* HTTP
|
|
75
|
-
* Java method: org.openremote.model.
|
|
51
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
52
|
+
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
76
53
|
*/
|
|
77
|
-
|
|
54
|
+
resetPassword(realm: any, userId: any, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
78
55
|
/**
|
|
79
|
-
* HTTP
|
|
80
|
-
* Java method: org.openremote.model.
|
|
56
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
57
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
81
58
|
*/
|
|
82
|
-
|
|
59
|
+
resetSecret(realm: any, userId: any, options?: O): RestResponse<any>;
|
|
83
60
|
/**
|
|
84
|
-
* HTTP
|
|
85
|
-
* Java method: org.openremote.model.
|
|
61
|
+
* HTTP GET /user/{realm}/roles
|
|
62
|
+
* Java method: org.openremote.model.security.UserResource.getRoles
|
|
86
63
|
*/
|
|
87
|
-
|
|
88
|
-
}
|
|
89
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
90
|
-
protected httpClient: HttpClient<O>;
|
|
91
|
-
constructor(httpClient: HttpClient<O>);
|
|
64
|
+
getRoles(realm: any, options?: O): RestResponse<Model.Role[]>;
|
|
92
65
|
/**
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
66
|
+
* HTTP PUT /user/{realm}/roles
|
|
67
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
95
68
|
*/
|
|
96
|
-
|
|
69
|
+
updateRoles(realm: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
97
70
|
/**
|
|
98
|
-
* HTTP
|
|
99
|
-
* Java method: org.openremote.model.
|
|
71
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
72
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
100
73
|
*/
|
|
101
|
-
|
|
74
|
+
getUserRealmRoles(realm: any, userId: any, options?: O): RestResponse<Model.Role[]>;
|
|
102
75
|
/**
|
|
103
|
-
* HTTP
|
|
104
|
-
* Java method: org.openremote.model.
|
|
76
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
77
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
105
78
|
*/
|
|
106
|
-
|
|
79
|
+
updateUserRealmRoles(realm: any, userId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
107
80
|
/**
|
|
108
|
-
* HTTP GET /
|
|
109
|
-
* Java method: org.openremote.model.
|
|
81
|
+
* HTTP GET /user/{realm}/userRoles/{userId}
|
|
82
|
+
* Java method: org.openremote.model.security.UserResource.getUserRoles
|
|
110
83
|
*/
|
|
111
|
-
|
|
84
|
+
getUserRoles(realm: any, userId: any, options?: O): RestResponse<Model.Role[]>;
|
|
112
85
|
/**
|
|
113
|
-
* HTTP
|
|
114
|
-
* Java method: org.openremote.model.
|
|
86
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}
|
|
87
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRoles
|
|
115
88
|
*/
|
|
116
|
-
|
|
89
|
+
updateUserRoles(realm: any, userId: any, roles: Model.Role[], 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: any, userId: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
95
|
+
/**
|
|
96
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
97
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
98
|
+
*/
|
|
99
|
+
updateUserClientRoles(realm: any, userId: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
100
|
+
/**
|
|
101
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
102
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
103
|
+
*/
|
|
104
|
+
getUserSessions(realm: any, userId: any, options?: O): RestResponse<Model.UserSession[]>;
|
|
105
|
+
/**
|
|
106
|
+
* HTTP POST /user/{realm}/users
|
|
107
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
108
|
+
*/
|
|
109
|
+
create(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
110
|
+
/**
|
|
111
|
+
* HTTP PUT /user/{realm}/users
|
|
112
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
113
|
+
*/
|
|
114
|
+
update(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
115
|
+
/**
|
|
116
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
117
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
118
|
+
*/
|
|
119
|
+
delete(realm: any, userId: any, options?: O): RestResponse<void>;
|
|
120
|
+
/**
|
|
121
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
122
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
123
|
+
*/
|
|
124
|
+
getClientRoles(realm: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
125
|
+
/**
|
|
126
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
127
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
128
|
+
*/
|
|
129
|
+
updateClientRoles(realm: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
130
|
+
/**
|
|
131
|
+
* HTTP GET /user/{realm}/{userId}
|
|
132
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
133
|
+
*/
|
|
134
|
+
get(realm: any, userId: any, options?: O): RestResponse<Model.User>;
|
|
117
135
|
}
|
|
118
136
|
export declare class AlarmResourceClient<O> {
|
|
119
137
|
protected httpClient: HttpClient<O>;
|
|
@@ -168,6 +186,60 @@ export declare class AlarmResourceClient<O> {
|
|
|
168
186
|
realm?: any;
|
|
169
187
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
170
188
|
}
|
|
189
|
+
export declare class NotificationResourceClient<O> {
|
|
190
|
+
protected httpClient: HttpClient<O>;
|
|
191
|
+
constructor(httpClient: HttpClient<O>);
|
|
192
|
+
/**
|
|
193
|
+
* HTTP GET /notification
|
|
194
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
195
|
+
*/
|
|
196
|
+
getNotifications(queryParams?: {
|
|
197
|
+
id?: any;
|
|
198
|
+
type?: any;
|
|
199
|
+
from?: any;
|
|
200
|
+
to?: any;
|
|
201
|
+
realmId?: any;
|
|
202
|
+
userId?: any;
|
|
203
|
+
assetId?: any;
|
|
204
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
205
|
+
/**
|
|
206
|
+
* HTTP DELETE /notification
|
|
207
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
208
|
+
*/
|
|
209
|
+
removeNotifications(queryParams?: {
|
|
210
|
+
id?: any;
|
|
211
|
+
type?: any;
|
|
212
|
+
from?: any;
|
|
213
|
+
to?: any;
|
|
214
|
+
realmId?: any;
|
|
215
|
+
userId?: any;
|
|
216
|
+
assetId?: any;
|
|
217
|
+
}, options?: O): RestResponse<void>;
|
|
218
|
+
/**
|
|
219
|
+
* HTTP POST /notification/alert
|
|
220
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
221
|
+
*/
|
|
222
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
223
|
+
/**
|
|
224
|
+
* HTTP DELETE /notification/{notificationId}
|
|
225
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
226
|
+
*/
|
|
227
|
+
removeNotification(notificationId: any, options?: O): RestResponse<void>;
|
|
228
|
+
/**
|
|
229
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
230
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
231
|
+
*/
|
|
232
|
+
notificationAcknowledged(notificationId: any, acknowledgement: any, queryParams?: {
|
|
233
|
+
targetId?: any;
|
|
234
|
+
}, options?: O): RestResponse<void>;
|
|
235
|
+
/**
|
|
236
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
237
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
238
|
+
*/
|
|
239
|
+
notificationDelivered(notificationId: any, queryParams?: {
|
|
240
|
+
targetId?: any;
|
|
241
|
+
}, options?: O): RestResponse<void>;
|
|
242
|
+
}
|
|
171
243
|
export declare class MapResourceClient<O> {
|
|
172
244
|
protected httpClient: HttpClient<O>;
|
|
173
245
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -198,6 +270,25 @@ export declare class MapResourceClient<O> {
|
|
|
198
270
|
*/
|
|
199
271
|
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
200
272
|
}
|
|
273
|
+
export declare class AppResourceClient<O> {
|
|
274
|
+
protected httpClient: HttpClient<O>;
|
|
275
|
+
constructor(httpClient: HttpClient<O>);
|
|
276
|
+
/**
|
|
277
|
+
* HTTP GET /apps
|
|
278
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
279
|
+
*/
|
|
280
|
+
getApps(options?: O): RestResponse<any[]>;
|
|
281
|
+
/**
|
|
282
|
+
* HTTP GET /apps/consoleConfig
|
|
283
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
284
|
+
*/
|
|
285
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
286
|
+
/**
|
|
287
|
+
* HTTP GET /apps/info
|
|
288
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
289
|
+
*/
|
|
290
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
291
|
+
}
|
|
201
292
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
202
293
|
protected httpClient: HttpClient<O>;
|
|
203
294
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -212,6 +303,171 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
212
303
|
*/
|
|
213
304
|
writePredictedDatapoints(assetId: any, attributeName: any, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
214
305
|
}
|
|
306
|
+
export declare class FlowResourceClient<O> {
|
|
307
|
+
protected httpClient: HttpClient<O>;
|
|
308
|
+
constructor(httpClient: HttpClient<O>);
|
|
309
|
+
/**
|
|
310
|
+
* HTTP GET /flow
|
|
311
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
312
|
+
*/
|
|
313
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
314
|
+
/**
|
|
315
|
+
* HTTP GET /flow/{name}
|
|
316
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
317
|
+
*/
|
|
318
|
+
getNodeDefinition(name: any, options?: O): RestResponse<Model.Node>;
|
|
319
|
+
/**
|
|
320
|
+
* HTTP GET /flow/{type}
|
|
321
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
322
|
+
*/
|
|
323
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
324
|
+
}
|
|
325
|
+
export declare class GatewayClientResourceClient<O> {
|
|
326
|
+
protected httpClient: HttpClient<O>;
|
|
327
|
+
constructor(httpClient: HttpClient<O>);
|
|
328
|
+
/**
|
|
329
|
+
* HTTP DELETE /gateway/connection
|
|
330
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
331
|
+
*/
|
|
332
|
+
deleteConnections(queryParams?: {
|
|
333
|
+
realm?: any[];
|
|
334
|
+
}, options?: O): RestResponse<void>;
|
|
335
|
+
/**
|
|
336
|
+
* HTTP GET /gateway/connection
|
|
337
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
338
|
+
*/
|
|
339
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
340
|
+
/**
|
|
341
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
342
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
343
|
+
*/
|
|
344
|
+
deleteConnection(realm: any, options?: O): RestResponse<void>;
|
|
345
|
+
/**
|
|
346
|
+
* HTTP GET /gateway/connection/{realm}
|
|
347
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
348
|
+
*/
|
|
349
|
+
getConnection(realm: any, options?: O): RestResponse<Model.GatewayConnection>;
|
|
350
|
+
/**
|
|
351
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
352
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
353
|
+
*/
|
|
354
|
+
setConnection(realm: any, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
355
|
+
/**
|
|
356
|
+
* HTTP GET /gateway/status/{realm}
|
|
357
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
358
|
+
*/
|
|
359
|
+
getConnectionStatus(realm: any, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
360
|
+
}
|
|
361
|
+
export declare class RealmResourceClient<O> {
|
|
362
|
+
protected httpClient: HttpClient<O>;
|
|
363
|
+
constructor(httpClient: HttpClient<O>);
|
|
364
|
+
/**
|
|
365
|
+
* HTTP POST /realm
|
|
366
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
367
|
+
*/
|
|
368
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
369
|
+
/**
|
|
370
|
+
* HTTP GET /realm
|
|
371
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
372
|
+
*/
|
|
373
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
374
|
+
/**
|
|
375
|
+
* HTTP GET /realm/accessible
|
|
376
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
377
|
+
*/
|
|
378
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
379
|
+
/**
|
|
380
|
+
* HTTP DELETE /realm/{name}
|
|
381
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
382
|
+
*/
|
|
383
|
+
delete(name: any, options?: O): RestResponse<void>;
|
|
384
|
+
/**
|
|
385
|
+
* HTTP GET /realm/{name}
|
|
386
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
387
|
+
*/
|
|
388
|
+
get(name: any, options?: O): RestResponse<Model.Realm>;
|
|
389
|
+
/**
|
|
390
|
+
* HTTP PUT /realm/{name}
|
|
391
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
392
|
+
*/
|
|
393
|
+
update(name: any, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
394
|
+
}
|
|
395
|
+
export declare class DashboardResourceClient<O> {
|
|
396
|
+
protected httpClient: HttpClient<O>;
|
|
397
|
+
constructor(httpClient: HttpClient<O>);
|
|
398
|
+
/**
|
|
399
|
+
* HTTP POST /dashboard
|
|
400
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
401
|
+
*/
|
|
402
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
403
|
+
/**
|
|
404
|
+
* HTTP PUT /dashboard
|
|
405
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
406
|
+
*/
|
|
407
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
408
|
+
/**
|
|
409
|
+
* HTTP GET /dashboard/all/{realm}
|
|
410
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
411
|
+
*/
|
|
412
|
+
getAllRealmDashboards(realm: any, options?: O): RestResponse<Model.Dashboard[]>;
|
|
413
|
+
/**
|
|
414
|
+
* HTTP POST /dashboard/query
|
|
415
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
416
|
+
*/
|
|
417
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
418
|
+
/**
|
|
419
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
420
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
421
|
+
*/
|
|
422
|
+
delete(realm: any, dashboardId: any, options?: O): RestResponse<void>;
|
|
423
|
+
/**
|
|
424
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
425
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
426
|
+
*/
|
|
427
|
+
get(realm: any, dashboardId: any, options?: O): RestResponse<Model.Dashboard>;
|
|
428
|
+
}
|
|
429
|
+
export declare class StatusResourceClient<O> {
|
|
430
|
+
protected httpClient: HttpClient<O>;
|
|
431
|
+
constructor(httpClient: HttpClient<O>);
|
|
432
|
+
/**
|
|
433
|
+
* HTTP GET /health
|
|
434
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
435
|
+
*/
|
|
436
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
437
|
+
[index: string]: any;
|
|
438
|
+
}>;
|
|
439
|
+
/**
|
|
440
|
+
* HTTP GET /info
|
|
441
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
442
|
+
*/
|
|
443
|
+
getInfo(options?: O): RestResponse<{
|
|
444
|
+
[index: string]: any;
|
|
445
|
+
}>;
|
|
446
|
+
}
|
|
447
|
+
export declare class ProvisioningResourceClient<O> {
|
|
448
|
+
protected httpClient: HttpClient<O>;
|
|
449
|
+
constructor(httpClient: HttpClient<O>);
|
|
450
|
+
/**
|
|
451
|
+
* HTTP POST /provisioning
|
|
452
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
453
|
+
*/
|
|
454
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
455
|
+
/**
|
|
456
|
+
* HTTP GET /provisioning
|
|
457
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
458
|
+
*/
|
|
459
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
460
|
+
/**
|
|
461
|
+
* HTTP DELETE /provisioning/{id}
|
|
462
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
463
|
+
*/
|
|
464
|
+
deleteProvisioningConfig(id: any, options?: O): RestResponse<void>;
|
|
465
|
+
/**
|
|
466
|
+
* HTTP PUT /provisioning/{id}
|
|
467
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
468
|
+
*/
|
|
469
|
+
updateProvisioningConfig(id: any, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
470
|
+
}
|
|
215
471
|
export declare class AssetDatapointResourceClient<O> {
|
|
216
472
|
protected httpClient: HttpClient<O>;
|
|
217
473
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -236,75 +492,61 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
236
492
|
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
237
493
|
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
238
494
|
*/
|
|
239
|
-
getDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
240
|
-
}
|
|
241
|
-
export declare class ConfigurationResourceClient<O> {
|
|
242
|
-
protected httpClient: HttpClient<O>;
|
|
243
|
-
constructor(httpClient: HttpClient<O>);
|
|
244
|
-
/**
|
|
245
|
-
* HTTP GET /configuration/manager
|
|
246
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
247
|
-
*/
|
|
248
|
-
getManagerConfig(options?: O): RestResponse<{
|
|
249
|
-
[id: string]: any;
|
|
250
|
-
}>;
|
|
251
|
-
/**
|
|
252
|
-
* HTTP PUT /configuration/manager
|
|
253
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
254
|
-
*/
|
|
255
|
-
update(managerConfiguration: {
|
|
256
|
-
[id: string]: any;
|
|
257
|
-
}, options?: O): RestResponse<{
|
|
258
|
-
[id: string]: any;
|
|
259
|
-
}>;
|
|
260
|
-
/**
|
|
261
|
-
* HTTP POST /configuration/manager/file
|
|
262
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
263
|
-
*/
|
|
264
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
265
|
-
path?: any;
|
|
266
|
-
}, options?: O): RestResponse<any>;
|
|
267
|
-
/**
|
|
268
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
269
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
270
|
-
*/
|
|
271
|
-
getManagerConfigImage(filename: any, options?: O): RestResponse<any>;
|
|
495
|
+
getDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
272
496
|
}
|
|
273
|
-
export declare class
|
|
497
|
+
export declare class ConsoleResourceClient<O> {
|
|
274
498
|
protected httpClient: HttpClient<O>;
|
|
275
499
|
constructor(httpClient: HttpClient<O>);
|
|
276
500
|
/**
|
|
277
|
-
* HTTP
|
|
278
|
-
* Java method: org.openremote.model.
|
|
501
|
+
* HTTP POST /console/register
|
|
502
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
279
503
|
*/
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
504
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
505
|
+
}
|
|
506
|
+
export declare class AssetModelResourceClient<O> {
|
|
507
|
+
protected httpClient: HttpClient<O>;
|
|
508
|
+
constructor(httpClient: HttpClient<O>);
|
|
283
509
|
/**
|
|
284
|
-
* HTTP GET /
|
|
285
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP GET /model/assetDescriptors
|
|
511
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
286
512
|
*/
|
|
287
|
-
|
|
513
|
+
getAssetDescriptors(queryParams?: {
|
|
514
|
+
parentId?: any;
|
|
515
|
+
parentType?: any;
|
|
516
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
288
517
|
/**
|
|
289
|
-
* HTTP
|
|
290
|
-
* Java method: org.openremote.model.
|
|
518
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
519
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
291
520
|
*/
|
|
292
|
-
|
|
521
|
+
getAssetInfo(assetType: any, queryParams?: {
|
|
522
|
+
parentId?: any;
|
|
523
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
293
524
|
/**
|
|
294
|
-
* HTTP GET /
|
|
295
|
-
* Java method: org.openremote.model.
|
|
525
|
+
* HTTP GET /model/assetInfos
|
|
526
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
296
527
|
*/
|
|
297
|
-
|
|
528
|
+
getAssetInfos(queryParams?: {
|
|
529
|
+
parentId?: any;
|
|
530
|
+
parentType?: any;
|
|
531
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
298
532
|
/**
|
|
299
|
-
* HTTP
|
|
300
|
-
* Java method: org.openremote.model.
|
|
533
|
+
* HTTP GET /model/metaItemDescriptors
|
|
534
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
301
535
|
*/
|
|
302
|
-
|
|
536
|
+
getMetaItemDescriptors(queryParams?: {
|
|
537
|
+
parentId?: any;
|
|
538
|
+
}, options?: O): RestResponse<{
|
|
539
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
540
|
+
}>;
|
|
303
541
|
/**
|
|
304
|
-
* HTTP GET /
|
|
305
|
-
* Java method: org.openremote.model.
|
|
542
|
+
* HTTP GET /model/valueDescriptors
|
|
543
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
306
544
|
*/
|
|
307
|
-
|
|
545
|
+
getValueDescriptors(queryParams?: {
|
|
546
|
+
parentId?: any;
|
|
547
|
+
}, options?: O): RestResponse<{
|
|
548
|
+
[index: string]: Model.ValueDescriptor;
|
|
549
|
+
}>;
|
|
308
550
|
}
|
|
309
551
|
export declare class SyslogResourceClient<O> {
|
|
310
552
|
protected httpClient: HttpClient<O>;
|
|
@@ -338,130 +580,6 @@ export declare class SyslogResourceClient<O> {
|
|
|
338
580
|
subCategory?: any[];
|
|
339
581
|
}, options?: O): RestResponse<any>;
|
|
340
582
|
}
|
|
341
|
-
export declare class UserResourceClient<O> {
|
|
342
|
-
protected httpClient: HttpClient<O>;
|
|
343
|
-
constructor(httpClient: HttpClient<O>);
|
|
344
|
-
/**
|
|
345
|
-
* HTTP PUT /user/locale
|
|
346
|
-
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
347
|
-
*/
|
|
348
|
-
updateCurrentUserLocale(locale: any, options?: O): RestResponse<void>;
|
|
349
|
-
/**
|
|
350
|
-
* HTTP POST /user/query
|
|
351
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
352
|
-
*/
|
|
353
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
354
|
-
/**
|
|
355
|
-
* HTTP GET /user/user
|
|
356
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
357
|
-
*/
|
|
358
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
359
|
-
/**
|
|
360
|
-
* HTTP GET /user/userRealmRoles
|
|
361
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
362
|
-
*/
|
|
363
|
-
getCurrentUserRealmRoles(options?: O): RestResponse<Model.Role[]>;
|
|
364
|
-
/**
|
|
365
|
-
* HTTP GET /user/userRoles
|
|
366
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRoles
|
|
367
|
-
*/
|
|
368
|
-
getCurrentUserRoles(options?: O): RestResponse<Model.Role[]>;
|
|
369
|
-
/**
|
|
370
|
-
* HTTP GET /user/userRoles/{clientId}
|
|
371
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
372
|
-
*/
|
|
373
|
-
getCurrentUserClientRoles(clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
374
|
-
/**
|
|
375
|
-
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
376
|
-
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
377
|
-
*/
|
|
378
|
-
disconnectUserSession(realm: any, sessionID: any, options?: O): RestResponse<void>;
|
|
379
|
-
/**
|
|
380
|
-
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
381
|
-
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
382
|
-
*/
|
|
383
|
-
resetPassword(realm: any, userId: any, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
384
|
-
/**
|
|
385
|
-
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
386
|
-
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
387
|
-
*/
|
|
388
|
-
resetSecret(realm: any, userId: any, options?: O): RestResponse<any>;
|
|
389
|
-
/**
|
|
390
|
-
* HTTP GET /user/{realm}/roles
|
|
391
|
-
* Java method: org.openremote.model.security.UserResource.getRoles
|
|
392
|
-
*/
|
|
393
|
-
getRoles(realm: any, options?: O): RestResponse<Model.Role[]>;
|
|
394
|
-
/**
|
|
395
|
-
* HTTP PUT /user/{realm}/roles
|
|
396
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
397
|
-
*/
|
|
398
|
-
updateRoles(realm: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
399
|
-
/**
|
|
400
|
-
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
401
|
-
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
402
|
-
*/
|
|
403
|
-
getUserRealmRoles(realm: any, userId: any, options?: O): RestResponse<Model.Role[]>;
|
|
404
|
-
/**
|
|
405
|
-
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
406
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
407
|
-
*/
|
|
408
|
-
updateUserRealmRoles(realm: any, userId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
409
|
-
/**
|
|
410
|
-
* HTTP GET /user/{realm}/userRoles/{userId}
|
|
411
|
-
* Java method: org.openremote.model.security.UserResource.getUserRoles
|
|
412
|
-
*/
|
|
413
|
-
getUserRoles(realm: any, userId: any, options?: O): RestResponse<Model.Role[]>;
|
|
414
|
-
/**
|
|
415
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}
|
|
416
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRoles
|
|
417
|
-
*/
|
|
418
|
-
updateUserRoles(realm: any, userId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
419
|
-
/**
|
|
420
|
-
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
421
|
-
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
422
|
-
*/
|
|
423
|
-
getUserClientRoles(realm: any, userId: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
424
|
-
/**
|
|
425
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
426
|
-
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
427
|
-
*/
|
|
428
|
-
updateUserClientRoles(realm: any, userId: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
429
|
-
/**
|
|
430
|
-
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
431
|
-
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
432
|
-
*/
|
|
433
|
-
getUserSessions(realm: any, userId: any, options?: O): RestResponse<Model.UserSession[]>;
|
|
434
|
-
/**
|
|
435
|
-
* HTTP POST /user/{realm}/users
|
|
436
|
-
* Java method: org.openremote.model.security.UserResource.create
|
|
437
|
-
*/
|
|
438
|
-
create(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
439
|
-
/**
|
|
440
|
-
* HTTP PUT /user/{realm}/users
|
|
441
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
442
|
-
*/
|
|
443
|
-
update(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
444
|
-
/**
|
|
445
|
-
* HTTP DELETE /user/{realm}/users/{userId}
|
|
446
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
447
|
-
*/
|
|
448
|
-
delete(realm: any, userId: any, options?: O): RestResponse<void>;
|
|
449
|
-
/**
|
|
450
|
-
* HTTP GET /user/{realm}/{clientId}/roles
|
|
451
|
-
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
452
|
-
*/
|
|
453
|
-
getClientRoles(realm: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
454
|
-
/**
|
|
455
|
-
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
456
|
-
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
457
|
-
*/
|
|
458
|
-
updateClientRoles(realm: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
459
|
-
/**
|
|
460
|
-
* HTTP GET /user/{realm}/{userId}
|
|
461
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
462
|
-
*/
|
|
463
|
-
get(realm: any, userId: any, options?: O): RestResponse<Model.User>;
|
|
464
|
-
}
|
|
465
583
|
export declare class RulesResourceClient<O> {
|
|
466
584
|
protected httpClient: HttpClient<O>;
|
|
467
585
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -570,138 +688,92 @@ export declare class RulesResourceClient<O> {
|
|
|
570
688
|
*/
|
|
571
689
|
updateGlobalRuleset(id: any, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
572
690
|
}
|
|
573
|
-
export declare class
|
|
691
|
+
export declare class AgentResourceClient<O> {
|
|
574
692
|
protected httpClient: HttpClient<O>;
|
|
575
693
|
constructor(httpClient: HttpClient<O>);
|
|
576
694
|
/**
|
|
577
|
-
* HTTP
|
|
578
|
-
* Java method: org.openremote.model.
|
|
579
|
-
*/
|
|
580
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
581
|
-
/**
|
|
582
|
-
* HTTP PUT /dashboard
|
|
583
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
584
|
-
*/
|
|
585
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
586
|
-
/**
|
|
587
|
-
* HTTP GET /dashboard/all/{realm}
|
|
588
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
589
|
-
*/
|
|
590
|
-
getAllRealmDashboards(realm: any, options?: O): RestResponse<Model.Dashboard[]>;
|
|
591
|
-
/**
|
|
592
|
-
* HTTP POST /dashboard/query
|
|
593
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
695
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
696
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
594
697
|
*/
|
|
595
|
-
|
|
698
|
+
doProtocolAssetDiscovery(agentId: any, queryParams?: {
|
|
699
|
+
realm?: any;
|
|
700
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
596
701
|
/**
|
|
597
|
-
* HTTP
|
|
598
|
-
* Java method: org.openremote.model.
|
|
702
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
703
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
599
704
|
*/
|
|
600
|
-
|
|
705
|
+
doProtocolAssetImport(agentId: any, fileInfo: Model.FileInfo, queryParams?: {
|
|
706
|
+
realm?: any;
|
|
707
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
601
708
|
/**
|
|
602
|
-
* HTTP GET /
|
|
603
|
-
* Java method: org.openremote.model.
|
|
709
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
710
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
604
711
|
*/
|
|
605
|
-
|
|
712
|
+
doProtocolInstanceDiscovery(agentType: any, queryParams?: {
|
|
713
|
+
parentId?: any;
|
|
714
|
+
realm?: any;
|
|
715
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
606
716
|
}
|
|
607
|
-
export declare class
|
|
717
|
+
export declare class ConfigurationResourceClient<O> {
|
|
608
718
|
protected httpClient: HttpClient<O>;
|
|
609
719
|
constructor(httpClient: HttpClient<O>);
|
|
610
720
|
/**
|
|
611
|
-
* HTTP GET /
|
|
612
|
-
* Java method: org.openremote.model.
|
|
613
|
-
*/
|
|
614
|
-
getAssetDescriptors(queryParams?: {
|
|
615
|
-
parentId?: any;
|
|
616
|
-
parentType?: any;
|
|
617
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
618
|
-
/**
|
|
619
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
620
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
621
|
-
*/
|
|
622
|
-
getAssetInfo(assetType: any, queryParams?: {
|
|
623
|
-
parentId?: any;
|
|
624
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
625
|
-
/**
|
|
626
|
-
* HTTP GET /model/assetInfos
|
|
627
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
628
|
-
*/
|
|
629
|
-
getAssetInfos(queryParams?: {
|
|
630
|
-
parentId?: any;
|
|
631
|
-
parentType?: any;
|
|
632
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
633
|
-
/**
|
|
634
|
-
* HTTP GET /model/metaItemDescriptors
|
|
635
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
721
|
+
* HTTP GET /configuration/manager
|
|
722
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
636
723
|
*/
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
}, options?: O): RestResponse<{
|
|
640
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
724
|
+
getManagerConfig(options?: O): RestResponse<{
|
|
725
|
+
[id: string]: any;
|
|
641
726
|
}>;
|
|
642
727
|
/**
|
|
643
|
-
* HTTP
|
|
644
|
-
* Java method: org.openremote.model.
|
|
728
|
+
* HTTP PUT /configuration/manager
|
|
729
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
645
730
|
*/
|
|
646
|
-
|
|
647
|
-
|
|
731
|
+
update(managerConfiguration: {
|
|
732
|
+
[id: string]: any;
|
|
648
733
|
}, options?: O): RestResponse<{
|
|
649
|
-
[
|
|
734
|
+
[id: string]: any;
|
|
650
735
|
}>;
|
|
736
|
+
/**
|
|
737
|
+
* HTTP POST /configuration/manager/file
|
|
738
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
739
|
+
*/
|
|
740
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
741
|
+
path?: any;
|
|
742
|
+
}, options?: O): RestResponse<any>;
|
|
743
|
+
/**
|
|
744
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
745
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
746
|
+
*/
|
|
747
|
+
getManagerConfigImage(filename: any, options?: O): RestResponse<any>;
|
|
651
748
|
}
|
|
652
|
-
export declare class
|
|
749
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
653
750
|
protected httpClient: HttpClient<O>;
|
|
654
751
|
constructor(httpClient: HttpClient<O>);
|
|
655
752
|
/**
|
|
656
|
-
* HTTP
|
|
657
|
-
* Java method: org.openremote.model.
|
|
658
|
-
*/
|
|
659
|
-
getNotifications(queryParams?: {
|
|
660
|
-
id?: any;
|
|
661
|
-
type?: any;
|
|
662
|
-
from?: any;
|
|
663
|
-
to?: any;
|
|
664
|
-
realmId?: any;
|
|
665
|
-
userId?: any;
|
|
666
|
-
assetId?: any;
|
|
667
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
668
|
-
/**
|
|
669
|
-
* HTTP DELETE /notification
|
|
670
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
753
|
+
* HTTP POST /gateway/tunnel
|
|
754
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
671
755
|
*/
|
|
672
|
-
|
|
673
|
-
id?: any;
|
|
674
|
-
type?: any;
|
|
675
|
-
from?: any;
|
|
676
|
-
to?: any;
|
|
677
|
-
realmId?: any;
|
|
678
|
-
userId?: any;
|
|
679
|
-
assetId?: any;
|
|
680
|
-
}, options?: O): RestResponse<void>;
|
|
756
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
681
757
|
/**
|
|
682
|
-
* HTTP
|
|
683
|
-
* Java method: org.openremote.model.
|
|
758
|
+
* HTTP DELETE /gateway/tunnel
|
|
759
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
684
760
|
*/
|
|
685
|
-
|
|
761
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
686
762
|
/**
|
|
687
|
-
* HTTP
|
|
688
|
-
* Java method: org.openremote.model.
|
|
763
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
764
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
689
765
|
*/
|
|
690
|
-
|
|
766
|
+
getAllActiveTunnelInfos(realm: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
691
767
|
/**
|
|
692
|
-
* HTTP
|
|
693
|
-
* Java method: org.openremote.model.
|
|
768
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
769
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
694
770
|
*/
|
|
695
|
-
|
|
696
|
-
targetId?: any;
|
|
697
|
-
}, options?: O): RestResponse<void>;
|
|
771
|
+
getGatewayActiveTunnelInfos(realm: any, id: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
698
772
|
/**
|
|
699
|
-
* HTTP
|
|
700
|
-
* Java method: org.openremote.model.
|
|
773
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
774
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
701
775
|
*/
|
|
702
|
-
|
|
703
|
-
targetId?: any;
|
|
704
|
-
}, options?: O): RestResponse<void>;
|
|
776
|
+
getActiveTunnelInfo(realm: any, id: any, target: any, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
705
777
|
}
|
|
706
778
|
export declare class AssetResourceClient<O> {
|
|
707
779
|
protected httpClient: HttpClient<O>;
|
|
@@ -807,123 +879,51 @@ export declare class AssetResourceClient<O> {
|
|
|
807
879
|
assetIds?: any[];
|
|
808
880
|
}, options?: O): RestResponse<void>;
|
|
809
881
|
}
|
|
810
|
-
export declare class RealmResourceClient<O> {
|
|
811
|
-
protected httpClient: HttpClient<O>;
|
|
812
|
-
constructor(httpClient: HttpClient<O>);
|
|
813
|
-
/**
|
|
814
|
-
* HTTP POST /realm
|
|
815
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
816
|
-
*/
|
|
817
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
818
|
-
/**
|
|
819
|
-
* HTTP GET /realm
|
|
820
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
821
|
-
*/
|
|
822
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
823
|
-
/**
|
|
824
|
-
* HTTP GET /realm/accessible
|
|
825
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
826
|
-
*/
|
|
827
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
828
|
-
/**
|
|
829
|
-
* HTTP DELETE /realm/{name}
|
|
830
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
831
|
-
*/
|
|
832
|
-
delete(name: any, options?: O): RestResponse<void>;
|
|
833
|
-
/**
|
|
834
|
-
* HTTP GET /realm/{name}
|
|
835
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
836
|
-
*/
|
|
837
|
-
get(name: any, options?: O): RestResponse<Model.Realm>;
|
|
838
|
-
/**
|
|
839
|
-
* HTTP PUT /realm/{name}
|
|
840
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
841
|
-
*/
|
|
842
|
-
update(name: any, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
843
|
-
}
|
|
844
|
-
export declare class FlowResourceClient<O> {
|
|
845
|
-
protected httpClient: HttpClient<O>;
|
|
846
|
-
constructor(httpClient: HttpClient<O>);
|
|
847
|
-
/**
|
|
848
|
-
* HTTP GET /flow
|
|
849
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
850
|
-
*/
|
|
851
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
852
|
-
/**
|
|
853
|
-
* HTTP GET /flow/{name}
|
|
854
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
855
|
-
*/
|
|
856
|
-
getNodeDefinition(name: any, options?: O): RestResponse<Model.Node>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP GET /flow/{type}
|
|
859
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
860
|
-
*/
|
|
861
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
862
|
-
}
|
|
863
|
-
export declare class AppResourceClient<O> {
|
|
864
|
-
protected httpClient: HttpClient<O>;
|
|
865
|
-
constructor(httpClient: HttpClient<O>);
|
|
866
|
-
/**
|
|
867
|
-
* HTTP GET /apps
|
|
868
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
869
|
-
*/
|
|
870
|
-
getApps(options?: O): RestResponse<any[]>;
|
|
871
|
-
/**
|
|
872
|
-
* HTTP GET /apps/consoleConfig
|
|
873
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
874
|
-
*/
|
|
875
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
876
|
-
/**
|
|
877
|
-
* HTTP GET /apps/info
|
|
878
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
879
|
-
*/
|
|
880
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
881
|
-
}
|
|
882
882
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
883
883
|
export declare class ApiClient {
|
|
884
|
-
protected
|
|
885
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
886
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
887
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
888
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
884
|
+
protected _userResource: AxiosUserResourceClient;
|
|
889
885
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
886
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
890
887
|
protected _mapResource: AxiosMapResourceClient;
|
|
888
|
+
protected _appResource: AxiosAppResourceClient;
|
|
891
889
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
892
|
-
protected
|
|
893
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
890
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
894
891
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
895
|
-
protected
|
|
896
|
-
protected _userResource: AxiosUserResourceClient;
|
|
897
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
892
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
898
893
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
894
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
895
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
896
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
897
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
899
898
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
900
|
-
protected
|
|
899
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
900
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
901
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
902
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
903
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
901
904
|
protected _assetResource: AxiosAssetResourceClient;
|
|
902
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
903
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
904
|
-
protected _appResource: AxiosAppResourceClient;
|
|
905
905
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
906
|
-
get
|
|
907
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
908
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
909
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
910
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
906
|
+
get UserResource(): AxiosUserResourceClient;
|
|
911
907
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
908
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
912
909
|
get MapResource(): AxiosMapResourceClient;
|
|
910
|
+
get AppResource(): AxiosAppResourceClient;
|
|
913
911
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
914
|
-
get
|
|
915
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
912
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
916
913
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
917
|
-
get
|
|
918
|
-
get UserResource(): AxiosUserResourceClient;
|
|
919
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
914
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
920
915
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
916
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
917
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
918
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
919
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
921
920
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
922
|
-
get
|
|
921
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
922
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
923
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
924
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
925
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
923
926
|
get AssetResource(): AxiosAssetResourceClient;
|
|
924
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
925
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
926
|
-
get AppResource(): AxiosAppResourceClient;
|
|
927
927
|
}
|
|
928
928
|
import * as Axios from "axios";
|
|
929
929
|
declare module "axios" {
|
|
@@ -931,66 +931,66 @@ declare module "axios" {
|
|
|
931
931
|
data: R;
|
|
932
932
|
}
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|
|
991
|
-
export declare class
|
|
991
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|
|
994
|
-
export declare class
|
|
994
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
995
995
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
996
996
|
}
|