@openremote/rest 1.7.0-snapshot.20250605141506 → 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 +421 -421
- 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,24 +9,60 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class FlowResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /flow
|
|
17
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP GET /
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /flow/{name}
|
|
22
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
25
25
|
/**
|
|
26
|
-
* HTTP GET /
|
|
27
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /flow/{type}
|
|
27
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
28
28
|
*/
|
|
29
|
-
|
|
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>;
|
|
30
66
|
}
|
|
31
67
|
export declare class RealmResourceClient<O> {
|
|
32
68
|
protected httpClient: HttpClient<O>;
|
|
@@ -62,161 +98,267 @@ export declare class RealmResourceClient<O> {
|
|
|
62
98
|
*/
|
|
63
99
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
64
100
|
}
|
|
65
|
-
export declare class
|
|
101
|
+
export declare class SyslogResourceClient<O> {
|
|
66
102
|
protected httpClient: HttpClient<O>;
|
|
67
103
|
constructor(httpClient: HttpClient<O>);
|
|
68
104
|
/**
|
|
69
|
-
* HTTP GET /
|
|
70
|
-
* Java method: org.openremote.model.
|
|
71
|
-
*/
|
|
72
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
73
|
-
realm?: string;
|
|
74
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
75
|
-
/**
|
|
76
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
77
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
78
|
-
*/
|
|
79
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
80
|
-
realm?: string;
|
|
81
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
82
|
-
/**
|
|
83
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
84
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
105
|
+
* HTTP GET /syslog/config
|
|
106
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
85
107
|
*/
|
|
86
|
-
|
|
87
|
-
parentId?: string;
|
|
88
|
-
realm?: string;
|
|
89
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
90
|
-
}
|
|
91
|
-
export declare class FlowResourceClient<O> {
|
|
92
|
-
protected httpClient: HttpClient<O>;
|
|
93
|
-
constructor(httpClient: HttpClient<O>);
|
|
108
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
94
109
|
/**
|
|
95
|
-
* HTTP
|
|
96
|
-
* Java method: org.openremote.model.
|
|
110
|
+
* HTTP PUT /syslog/config
|
|
111
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
97
112
|
*/
|
|
98
|
-
|
|
113
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
99
114
|
/**
|
|
100
|
-
* HTTP
|
|
101
|
-
* Java method: org.openremote.model.
|
|
115
|
+
* HTTP DELETE /syslog/event
|
|
116
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
102
117
|
*/
|
|
103
|
-
|
|
118
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
104
119
|
/**
|
|
105
|
-
* HTTP GET /
|
|
106
|
-
* Java method: org.openremote.model.
|
|
120
|
+
* HTTP GET /syslog/event
|
|
121
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
107
122
|
*/
|
|
108
|
-
|
|
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>;
|
|
109
132
|
}
|
|
110
|
-
export declare class
|
|
133
|
+
export declare class StatusResourceClient<O> {
|
|
111
134
|
protected httpClient: HttpClient<O>;
|
|
112
135
|
constructor(httpClient: HttpClient<O>);
|
|
113
136
|
/**
|
|
114
|
-
* HTTP GET /
|
|
115
|
-
* Java method: org.openremote.model.
|
|
137
|
+
* HTTP GET /health
|
|
138
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
116
139
|
*/
|
|
117
|
-
|
|
118
|
-
[
|
|
140
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
141
|
+
[index: string]: any;
|
|
119
142
|
}>;
|
|
120
143
|
/**
|
|
121
|
-
* HTTP
|
|
122
|
-
* Java method: org.openremote.model.
|
|
144
|
+
* HTTP GET /info
|
|
145
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
123
146
|
*/
|
|
124
|
-
|
|
125
|
-
[
|
|
147
|
+
getInfo(options?: O): RestResponse<{
|
|
148
|
+
[index: string]: any;
|
|
126
149
|
}>;
|
|
150
|
+
}
|
|
151
|
+
export declare class AssetModelResourceClient<O> {
|
|
152
|
+
protected httpClient: HttpClient<O>;
|
|
153
|
+
constructor(httpClient: HttpClient<O>);
|
|
127
154
|
/**
|
|
128
|
-
* HTTP
|
|
129
|
-
* Java method: org.openremote.model.
|
|
155
|
+
* HTTP GET /model/assetDescriptors
|
|
156
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
130
157
|
*/
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
158
|
+
getAssetDescriptors(queryParams?: {
|
|
159
|
+
parentId?: string;
|
|
160
|
+
parentType?: string;
|
|
161
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
134
162
|
/**
|
|
135
|
-
* HTTP GET /
|
|
136
|
-
* Java method: org.openremote.model.
|
|
163
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
164
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
137
165
|
*/
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
}>;
|
|
166
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
167
|
+
parentId?: string;
|
|
168
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
141
169
|
/**
|
|
142
|
-
* HTTP GET /
|
|
143
|
-
* Java method: org.openremote.model.
|
|
170
|
+
* HTTP GET /model/assetInfos
|
|
171
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
144
172
|
*/
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
173
|
+
getAssetInfos(queryParams?: {
|
|
174
|
+
parentId?: string;
|
|
175
|
+
parentType?: string;
|
|
176
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
148
177
|
/**
|
|
149
|
-
* HTTP GET /
|
|
150
|
-
* Java method: org.openremote.model.
|
|
178
|
+
* HTTP GET /model/metaItemDescriptors
|
|
179
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
151
180
|
*/
|
|
152
|
-
|
|
181
|
+
getMetaItemDescriptors(queryParams?: {
|
|
182
|
+
parentId?: string;
|
|
183
|
+
}, options?: O): RestResponse<{
|
|
184
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
185
|
+
}>;
|
|
153
186
|
/**
|
|
154
|
-
* HTTP
|
|
155
|
-
* Java method: org.openremote.model.
|
|
187
|
+
* HTTP GET /model/valueDescriptors
|
|
188
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
156
189
|
*/
|
|
157
|
-
|
|
158
|
-
|
|
190
|
+
getValueDescriptors(queryParams?: {
|
|
191
|
+
parentId?: string;
|
|
159
192
|
}, options?: O): RestResponse<{
|
|
160
|
-
[
|
|
193
|
+
[index: string]: Model.ValueDescriptor;
|
|
161
194
|
}>;
|
|
162
195
|
}
|
|
163
|
-
export declare class
|
|
196
|
+
export declare class UserResourceClient<O> {
|
|
164
197
|
protected httpClient: HttpClient<O>;
|
|
165
198
|
constructor(httpClient: HttpClient<O>);
|
|
166
199
|
/**
|
|
167
|
-
* HTTP
|
|
168
|
-
* Java method: org.openremote.model.
|
|
200
|
+
* HTTP PUT /user/locale
|
|
201
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
169
202
|
*/
|
|
170
|
-
|
|
203
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
171
204
|
/**
|
|
172
|
-
* HTTP
|
|
173
|
-
* Java method: org.openremote.model.
|
|
205
|
+
* HTTP POST /user/query
|
|
206
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
174
207
|
*/
|
|
175
|
-
|
|
208
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
176
209
|
/**
|
|
177
|
-
* HTTP
|
|
178
|
-
* Java method: org.openremote.model.
|
|
210
|
+
* HTTP GET /user/user
|
|
211
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
179
212
|
*/
|
|
180
|
-
|
|
213
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
181
214
|
/**
|
|
182
|
-
* HTTP
|
|
183
|
-
* Java method: org.openremote.model.
|
|
215
|
+
* HTTP GET /user/userRealmRoles
|
|
216
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
184
217
|
*/
|
|
185
|
-
|
|
218
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
219
|
+
/**
|
|
220
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
221
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
222
|
+
*/
|
|
223
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
224
|
+
/**
|
|
225
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
226
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
227
|
+
*/
|
|
228
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
229
|
+
/**
|
|
230
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
231
|
+
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
232
|
+
*/
|
|
233
|
+
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
234
|
+
/**
|
|
235
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
236
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
237
|
+
*/
|
|
238
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
239
|
+
/**
|
|
240
|
+
* HTTP PUT /user/{realm}/roles
|
|
241
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
242
|
+
*/
|
|
243
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
244
|
+
/**
|
|
245
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
246
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
247
|
+
*/
|
|
248
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
249
|
+
/**
|
|
250
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
251
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
252
|
+
*/
|
|
253
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
254
|
+
/**
|
|
255
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
256
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
257
|
+
*/
|
|
258
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
259
|
+
/**
|
|
260
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
261
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
262
|
+
*/
|
|
263
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
264
|
+
/**
|
|
265
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
266
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
267
|
+
*/
|
|
268
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
269
|
+
/**
|
|
270
|
+
* HTTP POST /user/{realm}/users
|
|
271
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
272
|
+
*/
|
|
273
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
274
|
+
/**
|
|
275
|
+
* HTTP PUT /user/{realm}/users
|
|
276
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
277
|
+
*/
|
|
278
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
279
|
+
/**
|
|
280
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
281
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
282
|
+
*/
|
|
283
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
284
|
+
/**
|
|
285
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
286
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
287
|
+
*/
|
|
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>;
|
|
186
299
|
}
|
|
187
|
-
export declare class
|
|
300
|
+
export declare class NotificationResourceClient<O> {
|
|
188
301
|
protected httpClient: HttpClient<O>;
|
|
189
302
|
constructor(httpClient: HttpClient<O>);
|
|
190
303
|
/**
|
|
191
|
-
* HTTP
|
|
192
|
-
* Java method: org.openremote.model.
|
|
304
|
+
* HTTP GET /notification
|
|
305
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
193
306
|
*/
|
|
194
|
-
|
|
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[]>;
|
|
195
316
|
/**
|
|
196
|
-
* HTTP
|
|
197
|
-
* Java method: org.openremote.model.
|
|
317
|
+
* HTTP DELETE /notification
|
|
318
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
198
319
|
*/
|
|
199
|
-
|
|
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>;
|
|
200
329
|
/**
|
|
201
|
-
* HTTP
|
|
202
|
-
* Java method: org.openremote.model.
|
|
330
|
+
* HTTP POST /notification/alert
|
|
331
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
332
|
+
*/
|
|
333
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
334
|
+
/**
|
|
335
|
+
* HTTP DELETE /notification/{notificationId}
|
|
336
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
203
337
|
*/
|
|
204
|
-
|
|
338
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
205
339
|
/**
|
|
206
|
-
* HTTP
|
|
207
|
-
* Java method: org.openremote.model.
|
|
340
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
341
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
208
342
|
*/
|
|
209
|
-
|
|
343
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
344
|
+
targetId?: string;
|
|
345
|
+
}, options?: O): RestResponse<void>;
|
|
210
346
|
/**
|
|
211
|
-
* HTTP
|
|
212
|
-
* Java method: org.openremote.model.
|
|
347
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
348
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
213
349
|
*/
|
|
214
|
-
|
|
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>);
|
|
215
357
|
/**
|
|
216
|
-
* HTTP
|
|
217
|
-
* Java method: org.openremote.model.
|
|
358
|
+
* HTTP POST /console/register
|
|
359
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
218
360
|
*/
|
|
219
|
-
|
|
361
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
220
362
|
}
|
|
221
363
|
export declare class RulesResourceClient<O> {
|
|
222
364
|
protected httpClient: HttpClient<O>;
|
|
@@ -326,145 +468,31 @@ export declare class RulesResourceClient<O> {
|
|
|
326
468
|
*/
|
|
327
469
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
328
470
|
}
|
|
329
|
-
export declare class
|
|
330
|
-
protected httpClient: HttpClient<O>;
|
|
331
|
-
constructor(httpClient: HttpClient<O>);
|
|
332
|
-
/**
|
|
333
|
-
* HTTP DELETE /gateway/connection
|
|
334
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
335
|
-
*/
|
|
336
|
-
deleteConnections(queryParams?: {
|
|
337
|
-
realm?: string[];
|
|
338
|
-
}, options?: O): RestResponse<void>;
|
|
339
|
-
/**
|
|
340
|
-
* HTTP GET /gateway/connection
|
|
341
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
342
|
-
*/
|
|
343
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
344
|
-
/**
|
|
345
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
346
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
347
|
-
*/
|
|
348
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
349
|
-
/**
|
|
350
|
-
* HTTP GET /gateway/connection/{realm}
|
|
351
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
352
|
-
*/
|
|
353
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
354
|
-
/**
|
|
355
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
356
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
357
|
-
*/
|
|
358
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
359
|
-
/**
|
|
360
|
-
* HTTP GET /gateway/status/{realm}
|
|
361
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
362
|
-
*/
|
|
363
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
364
|
-
}
|
|
365
|
-
export declare class UserResourceClient<O> {
|
|
471
|
+
export declare class AgentResourceClient<O> {
|
|
366
472
|
protected httpClient: HttpClient<O>;
|
|
367
473
|
constructor(httpClient: HttpClient<O>);
|
|
368
474
|
/**
|
|
369
|
-
* HTTP
|
|
370
|
-
* Java method: org.openremote.model.
|
|
371
|
-
*/
|
|
372
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
373
|
-
/**
|
|
374
|
-
* HTTP POST /user/query
|
|
375
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
376
|
-
*/
|
|
377
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
378
|
-
/**
|
|
379
|
-
* HTTP GET /user/user
|
|
380
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
381
|
-
*/
|
|
382
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
383
|
-
/**
|
|
384
|
-
* HTTP GET /user/userRealmRoles
|
|
385
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
386
|
-
*/
|
|
387
|
-
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
388
|
-
/**
|
|
389
|
-
* HTTP GET /user/userRoles/{clientId}
|
|
390
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
391
|
-
*/
|
|
392
|
-
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
393
|
-
/**
|
|
394
|
-
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
395
|
-
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
396
|
-
*/
|
|
397
|
-
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
398
|
-
/**
|
|
399
|
-
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
400
|
-
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
401
|
-
*/
|
|
402
|
-
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
403
|
-
/**
|
|
404
|
-
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
405
|
-
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
406
|
-
*/
|
|
407
|
-
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
408
|
-
/**
|
|
409
|
-
* HTTP PUT /user/{realm}/roles
|
|
410
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
411
|
-
*/
|
|
412
|
-
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
413
|
-
/**
|
|
414
|
-
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
415
|
-
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
416
|
-
*/
|
|
417
|
-
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
418
|
-
/**
|
|
419
|
-
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
420
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
421
|
-
*/
|
|
422
|
-
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
423
|
-
/**
|
|
424
|
-
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
425
|
-
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
426
|
-
*/
|
|
427
|
-
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
428
|
-
/**
|
|
429
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
430
|
-
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
431
|
-
*/
|
|
432
|
-
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
433
|
-
/**
|
|
434
|
-
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
435
|
-
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
436
|
-
*/
|
|
437
|
-
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
438
|
-
/**
|
|
439
|
-
* HTTP POST /user/{realm}/users
|
|
440
|
-
* Java method: org.openremote.model.security.UserResource.create
|
|
441
|
-
*/
|
|
442
|
-
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
443
|
-
/**
|
|
444
|
-
* HTTP PUT /user/{realm}/users
|
|
445
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
446
|
-
*/
|
|
447
|
-
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
448
|
-
/**
|
|
449
|
-
* HTTP DELETE /user/{realm}/users/{userId}
|
|
450
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
451
|
-
*/
|
|
452
|
-
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
453
|
-
/**
|
|
454
|
-
* HTTP GET /user/{realm}/{clientId}/roles
|
|
455
|
-
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
475
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
476
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
456
477
|
*/
|
|
457
|
-
|
|
478
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
479
|
+
realm?: string;
|
|
480
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
458
481
|
/**
|
|
459
|
-
* HTTP
|
|
460
|
-
* Java method: org.openremote.model.
|
|
482
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
483
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
461
484
|
*/
|
|
462
|
-
|
|
485
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
486
|
+
realm?: string;
|
|
487
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
463
488
|
/**
|
|
464
|
-
* HTTP GET /
|
|
465
|
-
* Java method: org.openremote.model.
|
|
489
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
490
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
466
491
|
*/
|
|
467
|
-
|
|
492
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
493
|
+
parentId?: string;
|
|
494
|
+
realm?: string;
|
|
495
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
468
496
|
}
|
|
469
497
|
export declare class AssetResourceClient<O> {
|
|
470
498
|
protected httpClient: HttpClient<O>;
|
|
@@ -570,37 +598,55 @@ export declare class AssetResourceClient<O> {
|
|
|
570
598
|
assetIds?: string[];
|
|
571
599
|
}, options?: O): RestResponse<void>;
|
|
572
600
|
}
|
|
573
|
-
export declare class
|
|
601
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
574
602
|
protected httpClient: HttpClient<O>;
|
|
575
603
|
constructor(httpClient: HttpClient<O>);
|
|
576
604
|
/**
|
|
577
|
-
* HTTP GET /
|
|
578
|
-
* Java method: org.openremote.model.
|
|
605
|
+
* HTTP GET /asset/datapoint/export
|
|
606
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
579
607
|
*/
|
|
580
|
-
|
|
608
|
+
getDatapointExport(queryParams?: {
|
|
609
|
+
attributeRefs?: string;
|
|
610
|
+
fromTimestamp?: number;
|
|
611
|
+
toTimestamp?: number;
|
|
612
|
+
}, options?: O): RestResponse<any>;
|
|
581
613
|
/**
|
|
582
|
-
* HTTP
|
|
583
|
-
* Java method: org.openremote.model.
|
|
614
|
+
* HTTP GET /asset/datapoint/periods
|
|
615
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
584
616
|
*/
|
|
585
|
-
|
|
617
|
+
getDatapointPeriod(queryParams?: {
|
|
618
|
+
assetId?: string;
|
|
619
|
+
attributeName?: string;
|
|
620
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
586
621
|
/**
|
|
587
|
-
* HTTP
|
|
588
|
-
* Java method: org.openremote.model.
|
|
622
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
623
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
589
624
|
*/
|
|
590
|
-
|
|
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>);
|
|
591
630
|
/**
|
|
592
|
-
* HTTP
|
|
593
|
-
* Java method: org.openremote.model.
|
|
631
|
+
* HTTP POST /provisioning
|
|
632
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
594
633
|
*/
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
634
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
635
|
+
/**
|
|
636
|
+
* HTTP GET /provisioning
|
|
637
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
638
|
+
*/
|
|
639
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
640
|
+
/**
|
|
641
|
+
* HTTP DELETE /provisioning/{id}
|
|
642
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
643
|
+
*/
|
|
644
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
645
|
+
/**
|
|
646
|
+
* HTTP PUT /provisioning/{id}
|
|
647
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
648
|
+
*/
|
|
649
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
604
650
|
}
|
|
605
651
|
export declare class AlarmResourceClient<O> {
|
|
606
652
|
protected httpClient: HttpClient<O>;
|
|
@@ -655,144 +701,111 @@ export declare class AlarmResourceClient<O> {
|
|
|
655
701
|
realm?: string;
|
|
656
702
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
657
703
|
}
|
|
658
|
-
export declare class
|
|
704
|
+
export declare class MapResourceClient<O> {
|
|
659
705
|
protected httpClient: HttpClient<O>;
|
|
660
706
|
constructor(httpClient: HttpClient<O>);
|
|
661
707
|
/**
|
|
662
|
-
* HTTP GET /
|
|
663
|
-
* Java method: org.openremote.model.
|
|
708
|
+
* HTTP GET /map
|
|
709
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
664
710
|
*/
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
711
|
+
getSettings(options?: O): RestResponse<{
|
|
712
|
+
[id: string]: unknown;
|
|
713
|
+
}>;
|
|
669
714
|
/**
|
|
670
|
-
* HTTP
|
|
671
|
-
* Java method: org.openremote.model.
|
|
715
|
+
* HTTP PUT /map
|
|
716
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
672
717
|
*/
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
}
|
|
718
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
719
|
+
[id: string]: unknown;
|
|
720
|
+
}>;
|
|
676
721
|
/**
|
|
677
|
-
* HTTP
|
|
678
|
-
* Java method: org.openremote.model.
|
|
722
|
+
* HTTP DELETE /map/deleteMap
|
|
723
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
679
724
|
*/
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
725
|
+
deleteMap(options?: O): RestResponse<{
|
|
726
|
+
[id: string]: unknown;
|
|
727
|
+
}>;
|
|
684
728
|
/**
|
|
685
|
-
* HTTP GET /
|
|
686
|
-
* Java method: org.openremote.model.
|
|
729
|
+
* HTTP GET /map/getCustomMapInfo
|
|
730
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
687
731
|
*/
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
}, options?: O): RestResponse<{
|
|
691
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
732
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
733
|
+
[id: string]: unknown;
|
|
692
734
|
}>;
|
|
693
735
|
/**
|
|
694
|
-
* HTTP GET /
|
|
695
|
-
* Java method: org.openremote.model.
|
|
736
|
+
* HTTP GET /map/js
|
|
737
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
696
738
|
*/
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
}, options?: O): RestResponse<{
|
|
700
|
-
[index: string]: Model.ValueDescriptor;
|
|
739
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
740
|
+
[id: string]: unknown;
|
|
701
741
|
}>;
|
|
702
|
-
}
|
|
703
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
704
|
-
protected httpClient: HttpClient<O>;
|
|
705
|
-
constructor(httpClient: HttpClient<O>);
|
|
706
742
|
/**
|
|
707
|
-
* HTTP
|
|
708
|
-
* Java method: org.openremote.model.
|
|
743
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
744
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
709
745
|
*/
|
|
710
|
-
|
|
746
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
711
747
|
/**
|
|
712
|
-
* HTTP
|
|
713
|
-
* Java method: org.openremote.model.
|
|
748
|
+
* HTTP POST /map/upload
|
|
749
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
714
750
|
*/
|
|
715
|
-
|
|
751
|
+
uploadMap(queryParams?: {
|
|
752
|
+
filename?: string;
|
|
753
|
+
}, options?: O): RestResponse<{
|
|
754
|
+
[id: string]: unknown;
|
|
755
|
+
}>;
|
|
716
756
|
}
|
|
717
|
-
export declare class
|
|
757
|
+
export declare class DashboardResourceClient<O> {
|
|
718
758
|
protected httpClient: HttpClient<O>;
|
|
719
759
|
constructor(httpClient: HttpClient<O>);
|
|
720
760
|
/**
|
|
721
|
-
* HTTP
|
|
722
|
-
* Java method: org.openremote.model.
|
|
761
|
+
* HTTP POST /dashboard
|
|
762
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
723
763
|
*/
|
|
724
|
-
|
|
725
|
-
id?: number;
|
|
726
|
-
type?: string;
|
|
727
|
-
from?: number;
|
|
728
|
-
to?: number;
|
|
729
|
-
realmId?: string;
|
|
730
|
-
userId?: string;
|
|
731
|
-
assetId?: string;
|
|
732
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
764
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
733
765
|
/**
|
|
734
|
-
* HTTP
|
|
735
|
-
* Java method: org.openremote.model.
|
|
766
|
+
* HTTP PUT /dashboard
|
|
767
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
736
768
|
*/
|
|
737
|
-
|
|
738
|
-
id?: number;
|
|
739
|
-
type?: string;
|
|
740
|
-
from?: number;
|
|
741
|
-
to?: number;
|
|
742
|
-
realmId?: string;
|
|
743
|
-
userId?: string;
|
|
744
|
-
assetId?: string;
|
|
745
|
-
}, options?: O): RestResponse<void>;
|
|
769
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
746
770
|
/**
|
|
747
|
-
* HTTP
|
|
748
|
-
* Java method: org.openremote.model.
|
|
771
|
+
* HTTP GET /dashboard/all/{realm}
|
|
772
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
749
773
|
*/
|
|
750
|
-
|
|
774
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
751
775
|
/**
|
|
752
|
-
* HTTP
|
|
753
|
-
* Java method: org.openremote.model.
|
|
776
|
+
* HTTP POST /dashboard/query
|
|
777
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
754
778
|
*/
|
|
755
|
-
|
|
779
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
756
780
|
/**
|
|
757
|
-
* HTTP
|
|
758
|
-
* Java method: org.openremote.model.
|
|
781
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
782
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
759
783
|
*/
|
|
760
|
-
|
|
761
|
-
targetId?: string;
|
|
762
|
-
}, options?: O): RestResponse<void>;
|
|
784
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
763
785
|
/**
|
|
764
|
-
* HTTP
|
|
765
|
-
* Java method: org.openremote.model.
|
|
786
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
787
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
766
788
|
*/
|
|
767
|
-
|
|
768
|
-
targetId?: string;
|
|
769
|
-
}, options?: O): RestResponse<void>;
|
|
789
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
770
790
|
}
|
|
771
|
-
export declare class
|
|
791
|
+
export declare class AppResourceClient<O> {
|
|
772
792
|
protected httpClient: HttpClient<O>;
|
|
773
793
|
constructor(httpClient: HttpClient<O>);
|
|
774
794
|
/**
|
|
775
|
-
* HTTP GET /
|
|
776
|
-
* Java method: org.openremote.model.
|
|
795
|
+
* HTTP GET /apps
|
|
796
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
777
797
|
*/
|
|
778
|
-
|
|
779
|
-
attributeRefs?: string;
|
|
780
|
-
fromTimestamp?: number;
|
|
781
|
-
toTimestamp?: number;
|
|
782
|
-
}, options?: O): RestResponse<any>;
|
|
798
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
783
799
|
/**
|
|
784
|
-
* HTTP GET /
|
|
785
|
-
* Java method: org.openremote.model.
|
|
800
|
+
* HTTP GET /apps/consoleConfig
|
|
801
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
786
802
|
*/
|
|
787
|
-
|
|
788
|
-
assetId?: string;
|
|
789
|
-
attributeName?: string;
|
|
790
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
803
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
791
804
|
/**
|
|
792
|
-
* HTTP
|
|
793
|
-
* Java method: org.openremote.model.
|
|
805
|
+
* HTTP GET /apps/info
|
|
806
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
794
807
|
*/
|
|
795
|
-
|
|
808
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
796
809
|
}
|
|
797
810
|
export declare class ConfigurationResourceClient<O> {
|
|
798
811
|
protected httpClient: HttpClient<O>;
|
|
@@ -849,78 +862,65 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
849
862
|
*/
|
|
850
863
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
851
864
|
}
|
|
852
|
-
export declare class
|
|
853
|
-
protected httpClient: HttpClient<O>;
|
|
854
|
-
constructor(httpClient: HttpClient<O>);
|
|
855
|
-
/**
|
|
856
|
-
* HTTP POST /console/register
|
|
857
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
858
|
-
*/
|
|
859
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
860
|
-
}
|
|
861
|
-
export declare class StatusResourceClient<O> {
|
|
865
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
862
866
|
protected httpClient: HttpClient<O>;
|
|
863
867
|
constructor(httpClient: HttpClient<O>);
|
|
864
868
|
/**
|
|
865
|
-
* HTTP
|
|
866
|
-
* Java method: org.openremote.model.
|
|
869
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
870
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
867
871
|
*/
|
|
868
|
-
|
|
869
|
-
[index: string]: any;
|
|
870
|
-
}>;
|
|
872
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
871
873
|
/**
|
|
872
|
-
* HTTP
|
|
873
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
875
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
874
876
|
*/
|
|
875
|
-
|
|
876
|
-
[index: string]: any;
|
|
877
|
-
}>;
|
|
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 _appResource: AxiosAppResourceClient;
|
|
882
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
883
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
884
881
|
protected _flowResource: AxiosFlowResourceClient;
|
|
885
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
886
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
887
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
888
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
889
882
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
890
|
-
protected
|
|
891
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
883
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
892
884
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
893
|
-
protected
|
|
885
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
894
886
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
895
|
-
protected
|
|
887
|
+
protected _userResource: AxiosUserResourceClient;
|
|
896
888
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
889
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
890
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
891
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
892
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
897
893
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
894
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
895
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
896
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
897
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
898
|
+
protected _appResource: AxiosAppResourceClient;
|
|
898
899
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
899
900
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
900
|
-
protected
|
|
901
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
901
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get AppResource(): AxiosAppResourceClient;
|
|
904
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
905
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
906
903
|
get FlowResource(): AxiosFlowResourceClient;
|
|
907
|
-
get MapResource(): AxiosMapResourceClient;
|
|
908
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
909
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
910
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
911
904
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
912
|
-
get
|
|
913
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
905
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
914
906
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
915
|
-
get
|
|
907
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
916
908
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
917
|
-
get
|
|
909
|
+
get UserResource(): AxiosUserResourceClient;
|
|
918
910
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
911
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
912
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
913
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
914
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
919
915
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
916
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
917
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
918
|
+
get MapResource(): AxiosMapResourceClient;
|
|
919
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
920
|
+
get AppResource(): AxiosAppResourceClient;
|
|
920
921
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
921
922
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
922
|
-
get
|
|
923
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
923
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,55 +928,58 @@ 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
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
|
+
}
|
|
934
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
932
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
936
|
}
|
|
934
937
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
935
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
939
|
}
|
|
937
|
-
export declare class
|
|
940
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
938
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
942
|
}
|
|
940
|
-
export declare class
|
|
943
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
941
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
945
|
}
|
|
943
|
-
export declare class
|
|
946
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
944
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
948
|
}
|
|
946
|
-
export declare class
|
|
949
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
947
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
951
|
}
|
|
949
|
-
export declare class
|
|
952
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
950
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
954
|
}
|
|
952
|
-
export declare class
|
|
955
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
953
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
957
|
}
|
|
955
|
-
export declare class
|
|
958
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
956
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
960
|
}
|
|
958
|
-
export declare class
|
|
961
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
959
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
963
|
}
|
|
961
964
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
962
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
966
|
}
|
|
964
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
965
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
969
|
}
|
|
967
|
-
export declare class
|
|
970
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
968
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
972
|
}
|
|
970
|
-
export declare class
|
|
973
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
971
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
975
|
}
|
|
973
|
-
export declare class
|
|
976
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
974
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
978
|
}
|
|
976
|
-
export declare class
|
|
979
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
977
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
981
|
}
|
|
979
|
-
export declare class
|
|
982
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
980
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
984
|
}
|
|
982
985
|
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -985,9 +988,6 @@ export declare class AxiosConfigurationResourceClient extends ConfigurationResou
|
|
|
985
988
|
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
986
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
990
|
}
|
|
988
|
-
export declare class
|
|
989
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
-
}
|
|
991
|
-
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
991
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|