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