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