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