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