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