@openremote/rest 1.4.0-snapshot.20250326102055 → 1.4.0-snapshot.20250326163317
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +454 -454
- 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,60 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /asset/datapoint/export
|
|
17
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
18
|
-
*/
|
|
19
|
-
getDatapointExport(queryParams?: {
|
|
20
|
-
attributeRefs?: string;
|
|
21
|
-
fromTimestamp?: number;
|
|
22
|
-
toTimestamp?: number;
|
|
23
|
-
}, options?: O): RestResponse<any>;
|
|
24
|
-
/**
|
|
25
|
-
* HTTP GET /asset/datapoint/periods
|
|
26
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
27
|
-
*/
|
|
28
|
-
getDatapointPeriod(queryParams?: {
|
|
29
|
-
assetId?: string;
|
|
30
|
-
attributeName?: string;
|
|
31
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
32
|
-
/**
|
|
33
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
34
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
35
|
-
*/
|
|
36
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
37
|
-
}
|
|
38
|
-
export declare class ConsoleResourceClient<O> {
|
|
39
|
-
protected httpClient: HttpClient<O>;
|
|
40
|
-
constructor(httpClient: HttpClient<O>);
|
|
41
|
-
/**
|
|
42
|
-
* HTTP POST /console/register
|
|
43
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
44
|
-
*/
|
|
45
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
46
|
-
}
|
|
47
|
-
export declare class FlowResourceClient<O> {
|
|
48
|
-
protected httpClient: HttpClient<O>;
|
|
49
|
-
constructor(httpClient: HttpClient<O>);
|
|
50
|
-
/**
|
|
51
|
-
* HTTP GET /flow
|
|
52
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
53
|
-
*/
|
|
54
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
55
|
-
/**
|
|
56
|
-
* HTTP GET /flow/{name}
|
|
57
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
58
|
-
*/
|
|
59
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
60
|
-
/**
|
|
61
|
-
* HTTP GET /flow/{type}
|
|
62
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
63
|
-
*/
|
|
64
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
65
|
-
}
|
|
66
12
|
export declare class GatewayServiceResourceClient<O> {
|
|
67
13
|
protected httpClient: HttpClient<O>;
|
|
68
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -92,110 +38,6 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
92
38
|
*/
|
|
93
39
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
94
40
|
}
|
|
95
|
-
export declare class AssetResourceClient<O> {
|
|
96
|
-
protected httpClient: HttpClient<O>;
|
|
97
|
-
constructor(httpClient: HttpClient<O>);
|
|
98
|
-
/**
|
|
99
|
-
* HTTP POST /asset
|
|
100
|
-
* Java method: org.openremote.model.asset.AssetResource.create
|
|
101
|
-
*/
|
|
102
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
103
|
-
/**
|
|
104
|
-
* HTTP DELETE /asset
|
|
105
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
106
|
-
*/
|
|
107
|
-
delete(queryParams?: {
|
|
108
|
-
assetId?: string[];
|
|
109
|
-
}, options?: O): RestResponse<void>;
|
|
110
|
-
/**
|
|
111
|
-
* HTTP PUT /asset/attributes
|
|
112
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
113
|
-
*/
|
|
114
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
115
|
-
/**
|
|
116
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
117
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
118
|
-
*/
|
|
119
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
120
|
-
/**
|
|
121
|
-
* HTTP DELETE /asset/parent
|
|
122
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
123
|
-
*/
|
|
124
|
-
updateNoneParent(queryParams?: {
|
|
125
|
-
assetIds?: string[];
|
|
126
|
-
}, options?: O): RestResponse<void>;
|
|
127
|
-
/**
|
|
128
|
-
* HTTP GET /asset/partial/{assetId}
|
|
129
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
130
|
-
*/
|
|
131
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
132
|
-
/**
|
|
133
|
-
* HTTP POST /asset/query
|
|
134
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
135
|
-
*/
|
|
136
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
137
|
-
/**
|
|
138
|
-
* HTTP GET /asset/user/current
|
|
139
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
140
|
-
*/
|
|
141
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
142
|
-
/**
|
|
143
|
-
* HTTP POST /asset/user/link
|
|
144
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
145
|
-
*/
|
|
146
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
147
|
-
/**
|
|
148
|
-
* HTTP GET /asset/user/link
|
|
149
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
150
|
-
*/
|
|
151
|
-
getUserAssetLinks(queryParams?: {
|
|
152
|
-
realm?: string;
|
|
153
|
-
userId?: string;
|
|
154
|
-
assetId?: string;
|
|
155
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
156
|
-
/**
|
|
157
|
-
* HTTP POST /asset/user/link/delete
|
|
158
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
159
|
-
*/
|
|
160
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
161
|
-
/**
|
|
162
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
163
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
164
|
-
*/
|
|
165
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
166
|
-
/**
|
|
167
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
168
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
169
|
-
*/
|
|
170
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
171
|
-
/**
|
|
172
|
-
* HTTP GET /asset/{assetId}
|
|
173
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
174
|
-
*/
|
|
175
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
176
|
-
/**
|
|
177
|
-
* HTTP PUT /asset/{assetId}
|
|
178
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
179
|
-
*/
|
|
180
|
-
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
181
|
-
/**
|
|
182
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
183
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
184
|
-
*/
|
|
185
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
186
|
-
/**
|
|
187
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
188
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
189
|
-
*/
|
|
190
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
191
|
-
/**
|
|
192
|
-
* HTTP PUT /asset/{parentAssetId}/child
|
|
193
|
-
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
194
|
-
*/
|
|
195
|
-
updateParent(parentAssetId: string, queryParams?: {
|
|
196
|
-
assetIds?: string[];
|
|
197
|
-
}, options?: O): RestResponse<void>;
|
|
198
|
-
}
|
|
199
41
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
200
42
|
protected httpClient: HttpClient<O>;
|
|
201
43
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -210,40 +52,6 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
210
52
|
*/
|
|
211
53
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
212
54
|
}
|
|
213
|
-
export declare class RealmResourceClient<O> {
|
|
214
|
-
protected httpClient: HttpClient<O>;
|
|
215
|
-
constructor(httpClient: HttpClient<O>);
|
|
216
|
-
/**
|
|
217
|
-
* HTTP POST /realm
|
|
218
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
219
|
-
*/
|
|
220
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
221
|
-
/**
|
|
222
|
-
* HTTP GET /realm
|
|
223
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
224
|
-
*/
|
|
225
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
226
|
-
/**
|
|
227
|
-
* HTTP GET /realm/accessible
|
|
228
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
229
|
-
*/
|
|
230
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
231
|
-
/**
|
|
232
|
-
* HTTP DELETE /realm/{name}
|
|
233
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
234
|
-
*/
|
|
235
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
236
|
-
/**
|
|
237
|
-
* HTTP GET /realm/{name}
|
|
238
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
239
|
-
*/
|
|
240
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
241
|
-
/**
|
|
242
|
-
* HTTP PUT /realm/{name}
|
|
243
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
244
|
-
*/
|
|
245
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
246
|
-
}
|
|
247
55
|
export declare class AgentResourceClient<O> {
|
|
248
56
|
protected httpClient: HttpClient<O>;
|
|
249
57
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -270,67 +78,23 @@ export declare class AgentResourceClient<O> {
|
|
|
270
78
|
realm?: string;
|
|
271
79
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
272
80
|
}
|
|
273
|
-
export declare class
|
|
81
|
+
export declare class StatusResourceClient<O> {
|
|
274
82
|
protected httpClient: HttpClient<O>;
|
|
275
83
|
constructor(httpClient: HttpClient<O>);
|
|
276
84
|
/**
|
|
277
|
-
* HTTP GET /
|
|
278
|
-
* Java method: org.openremote.model.
|
|
85
|
+
* HTTP GET /health
|
|
86
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
279
87
|
*/
|
|
280
|
-
|
|
281
|
-
[
|
|
88
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
89
|
+
[index: string]: any;
|
|
282
90
|
}>;
|
|
283
91
|
/**
|
|
284
|
-
* HTTP
|
|
285
|
-
* Java method: org.openremote.model.
|
|
286
|
-
*/
|
|
287
|
-
saveSettings(mapConfig: {
|
|
288
|
-
[index: string]: Model.MapRealmConfig;
|
|
289
|
-
}, options?: O): RestResponse<any>;
|
|
290
|
-
/**
|
|
291
|
-
* HTTP GET /map/js
|
|
292
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
92
|
+
* HTTP GET /info
|
|
93
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
293
94
|
*/
|
|
294
|
-
|
|
295
|
-
[
|
|
95
|
+
getInfo(options?: O): RestResponse<{
|
|
96
|
+
[index: string]: any;
|
|
296
97
|
}>;
|
|
297
|
-
/**
|
|
298
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
299
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
300
|
-
*/
|
|
301
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
302
|
-
}
|
|
303
|
-
export declare class SyslogResourceClient<O> {
|
|
304
|
-
protected httpClient: HttpClient<O>;
|
|
305
|
-
constructor(httpClient: HttpClient<O>);
|
|
306
|
-
/**
|
|
307
|
-
* HTTP GET /syslog/config
|
|
308
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
309
|
-
*/
|
|
310
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
311
|
-
/**
|
|
312
|
-
* HTTP PUT /syslog/config
|
|
313
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
314
|
-
*/
|
|
315
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
316
|
-
/**
|
|
317
|
-
* HTTP DELETE /syslog/event
|
|
318
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
319
|
-
*/
|
|
320
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
321
|
-
/**
|
|
322
|
-
* HTTP GET /syslog/event
|
|
323
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
324
|
-
*/
|
|
325
|
-
getEvents(queryParams?: {
|
|
326
|
-
level?: Model.SyslogLevel;
|
|
327
|
-
per_page?: number;
|
|
328
|
-
page?: number;
|
|
329
|
-
from?: number;
|
|
330
|
-
to?: number;
|
|
331
|
-
category?: Model.SyslogCategory[];
|
|
332
|
-
subCategory?: string[];
|
|
333
|
-
}, options?: O): RestResponse<any>;
|
|
334
98
|
}
|
|
335
99
|
export declare class DashboardResourceClient<O> {
|
|
336
100
|
protected httpClient: HttpClient<O>;
|
|
@@ -366,60 +130,7 @@ export declare class DashboardResourceClient<O> {
|
|
|
366
130
|
*/
|
|
367
131
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
368
132
|
}
|
|
369
|
-
export declare class
|
|
370
|
-
protected httpClient: HttpClient<O>;
|
|
371
|
-
constructor(httpClient: HttpClient<O>);
|
|
372
|
-
/**
|
|
373
|
-
* HTTP POST /alarm
|
|
374
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
375
|
-
*/
|
|
376
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
377
|
-
assetIds?: string[];
|
|
378
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
379
|
-
/**
|
|
380
|
-
* HTTP GET /alarm
|
|
381
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
382
|
-
*/
|
|
383
|
-
getAlarms(queryParams?: {
|
|
384
|
-
realm?: string;
|
|
385
|
-
status?: Model.AlarmStatus;
|
|
386
|
-
assetId?: string;
|
|
387
|
-
assigneeId?: string;
|
|
388
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
389
|
-
/**
|
|
390
|
-
* HTTP DELETE /alarm
|
|
391
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
392
|
-
*/
|
|
393
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
394
|
-
/**
|
|
395
|
-
* HTTP PUT /alarm/assets
|
|
396
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
397
|
-
*/
|
|
398
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
399
|
-
/**
|
|
400
|
-
* HTTP GET /alarm/{alarmId}
|
|
401
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
402
|
-
*/
|
|
403
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
404
|
-
/**
|
|
405
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
406
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
407
|
-
*/
|
|
408
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
409
|
-
/**
|
|
410
|
-
* HTTP PUT /alarm/{alarmId}
|
|
411
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
412
|
-
*/
|
|
413
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
414
|
-
/**
|
|
415
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
416
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
417
|
-
*/
|
|
418
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
419
|
-
realm?: string;
|
|
420
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
421
|
-
}
|
|
422
|
-
export declare class UserResourceClient<O> {
|
|
133
|
+
export declare class UserResourceClient<O> {
|
|
423
134
|
protected httpClient: HttpClient<O>;
|
|
424
135
|
constructor(httpClient: HttpClient<O>);
|
|
425
136
|
/**
|
|
@@ -543,6 +254,201 @@ export declare class UserResourceClient<O> {
|
|
|
543
254
|
*/
|
|
544
255
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
545
256
|
}
|
|
257
|
+
export declare class RealmResourceClient<O> {
|
|
258
|
+
protected httpClient: HttpClient<O>;
|
|
259
|
+
constructor(httpClient: HttpClient<O>);
|
|
260
|
+
/**
|
|
261
|
+
* HTTP POST /realm
|
|
262
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
263
|
+
*/
|
|
264
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
265
|
+
/**
|
|
266
|
+
* HTTP GET /realm
|
|
267
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
268
|
+
*/
|
|
269
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
270
|
+
/**
|
|
271
|
+
* HTTP GET /realm/accessible
|
|
272
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
273
|
+
*/
|
|
274
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
275
|
+
/**
|
|
276
|
+
* HTTP DELETE /realm/{name}
|
|
277
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
278
|
+
*/
|
|
279
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
280
|
+
/**
|
|
281
|
+
* HTTP GET /realm/{name}
|
|
282
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
283
|
+
*/
|
|
284
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
285
|
+
/**
|
|
286
|
+
* HTTP PUT /realm/{name}
|
|
287
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
288
|
+
*/
|
|
289
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
290
|
+
}
|
|
291
|
+
export declare class GatewayClientResourceClient<O> {
|
|
292
|
+
protected httpClient: HttpClient<O>;
|
|
293
|
+
constructor(httpClient: HttpClient<O>);
|
|
294
|
+
/**
|
|
295
|
+
* HTTP DELETE /gateway/connection
|
|
296
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
297
|
+
*/
|
|
298
|
+
deleteConnections(queryParams?: {
|
|
299
|
+
realm?: string[];
|
|
300
|
+
}, options?: O): RestResponse<void>;
|
|
301
|
+
/**
|
|
302
|
+
* HTTP GET /gateway/connection
|
|
303
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
304
|
+
*/
|
|
305
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
306
|
+
/**
|
|
307
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
308
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
309
|
+
*/
|
|
310
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
311
|
+
/**
|
|
312
|
+
* HTTP GET /gateway/connection/{realm}
|
|
313
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
314
|
+
*/
|
|
315
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
316
|
+
/**
|
|
317
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
318
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
319
|
+
*/
|
|
320
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
321
|
+
/**
|
|
322
|
+
* HTTP GET /gateway/status/{realm}
|
|
323
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
324
|
+
*/
|
|
325
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
326
|
+
}
|
|
327
|
+
export declare class AssetModelResourceClient<O> {
|
|
328
|
+
protected httpClient: HttpClient<O>;
|
|
329
|
+
constructor(httpClient: HttpClient<O>);
|
|
330
|
+
/**
|
|
331
|
+
* HTTP GET /model/assetDescriptors
|
|
332
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
333
|
+
*/
|
|
334
|
+
getAssetDescriptors(queryParams?: {
|
|
335
|
+
parentId?: string;
|
|
336
|
+
parentType?: string;
|
|
337
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
338
|
+
/**
|
|
339
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
340
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
341
|
+
*/
|
|
342
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
343
|
+
parentId?: string;
|
|
344
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
345
|
+
/**
|
|
346
|
+
* HTTP GET /model/assetInfos
|
|
347
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
348
|
+
*/
|
|
349
|
+
getAssetInfos(queryParams?: {
|
|
350
|
+
parentId?: string;
|
|
351
|
+
parentType?: string;
|
|
352
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
353
|
+
/**
|
|
354
|
+
* HTTP GET /model/metaItemDescriptors
|
|
355
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
356
|
+
*/
|
|
357
|
+
getMetaItemDescriptors(queryParams?: {
|
|
358
|
+
parentId?: string;
|
|
359
|
+
}, options?: O): RestResponse<{
|
|
360
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
361
|
+
}>;
|
|
362
|
+
/**
|
|
363
|
+
* HTTP GET /model/valueDescriptors
|
|
364
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
365
|
+
*/
|
|
366
|
+
getValueDescriptors(queryParams?: {
|
|
367
|
+
parentId?: string;
|
|
368
|
+
}, options?: O): RestResponse<{
|
|
369
|
+
[index: string]: Model.ValueDescriptor;
|
|
370
|
+
}>;
|
|
371
|
+
}
|
|
372
|
+
export declare class ConfigurationResourceClient<O> {
|
|
373
|
+
protected httpClient: HttpClient<O>;
|
|
374
|
+
constructor(httpClient: HttpClient<O>);
|
|
375
|
+
/**
|
|
376
|
+
* HTTP GET /configuration/manager
|
|
377
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
378
|
+
*/
|
|
379
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
380
|
+
/**
|
|
381
|
+
* HTTP PUT /configuration/manager
|
|
382
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
383
|
+
*/
|
|
384
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
385
|
+
/**
|
|
386
|
+
* HTTP POST /configuration/manager/file
|
|
387
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
388
|
+
*/
|
|
389
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
390
|
+
path?: string;
|
|
391
|
+
}, options?: O): RestResponse<string>;
|
|
392
|
+
/**
|
|
393
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
394
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
395
|
+
*/
|
|
396
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
397
|
+
}
|
|
398
|
+
export declare class FlowResourceClient<O> {
|
|
399
|
+
protected httpClient: HttpClient<O>;
|
|
400
|
+
constructor(httpClient: HttpClient<O>);
|
|
401
|
+
/**
|
|
402
|
+
* HTTP GET /flow
|
|
403
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
404
|
+
*/
|
|
405
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
406
|
+
/**
|
|
407
|
+
* HTTP GET /flow/{name}
|
|
408
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
409
|
+
*/
|
|
410
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
411
|
+
/**
|
|
412
|
+
* HTTP GET /flow/{type}
|
|
413
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
414
|
+
*/
|
|
415
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
416
|
+
}
|
|
417
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
418
|
+
protected httpClient: HttpClient<O>;
|
|
419
|
+
constructor(httpClient: HttpClient<O>);
|
|
420
|
+
/**
|
|
421
|
+
* HTTP GET /asset/datapoint/export
|
|
422
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
423
|
+
*/
|
|
424
|
+
getDatapointExport(queryParams?: {
|
|
425
|
+
attributeRefs?: string;
|
|
426
|
+
fromTimestamp?: number;
|
|
427
|
+
toTimestamp?: number;
|
|
428
|
+
}, options?: O): RestResponse<any>;
|
|
429
|
+
/**
|
|
430
|
+
* HTTP GET /asset/datapoint/periods
|
|
431
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
432
|
+
*/
|
|
433
|
+
getDatapointPeriod(queryParams?: {
|
|
434
|
+
assetId?: string;
|
|
435
|
+
attributeName?: string;
|
|
436
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
437
|
+
/**
|
|
438
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
439
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
440
|
+
*/
|
|
441
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
442
|
+
}
|
|
443
|
+
export declare class ConsoleResourceClient<O> {
|
|
444
|
+
protected httpClient: HttpClient<O>;
|
|
445
|
+
constructor(httpClient: HttpClient<O>);
|
|
446
|
+
/**
|
|
447
|
+
* HTTP POST /console/register
|
|
448
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
449
|
+
*/
|
|
450
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
451
|
+
}
|
|
546
452
|
export declare class NotificationResourceClient<O> {
|
|
547
453
|
protected httpClient: HttpClient<O>;
|
|
548
454
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -597,49 +503,195 @@ export declare class NotificationResourceClient<O> {
|
|
|
597
503
|
targetId?: string;
|
|
598
504
|
}, options?: O): RestResponse<void>;
|
|
599
505
|
}
|
|
600
|
-
export declare class
|
|
506
|
+
export declare class AssetResourceClient<O> {
|
|
601
507
|
protected httpClient: HttpClient<O>;
|
|
602
508
|
constructor(httpClient: HttpClient<O>);
|
|
603
509
|
/**
|
|
604
|
-
* HTTP
|
|
605
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP POST /asset
|
|
511
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
606
512
|
*/
|
|
607
|
-
|
|
513
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
608
514
|
/**
|
|
609
|
-
* HTTP
|
|
610
|
-
* Java method: org.openremote.model.
|
|
515
|
+
* HTTP DELETE /asset
|
|
516
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
517
|
+
*/
|
|
518
|
+
delete(queryParams?: {
|
|
519
|
+
assetId?: string[];
|
|
520
|
+
}, options?: O): RestResponse<void>;
|
|
521
|
+
/**
|
|
522
|
+
* HTTP PUT /asset/attributes
|
|
523
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
524
|
+
*/
|
|
525
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
526
|
+
/**
|
|
527
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
528
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
529
|
+
*/
|
|
530
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
531
|
+
/**
|
|
532
|
+
* HTTP DELETE /asset/parent
|
|
533
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
534
|
+
*/
|
|
535
|
+
updateNoneParent(queryParams?: {
|
|
536
|
+
assetIds?: string[];
|
|
537
|
+
}, options?: O): RestResponse<void>;
|
|
538
|
+
/**
|
|
539
|
+
* HTTP GET /asset/partial/{assetId}
|
|
540
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
541
|
+
*/
|
|
542
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
543
|
+
/**
|
|
544
|
+
* HTTP POST /asset/query
|
|
545
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
546
|
+
*/
|
|
547
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
548
|
+
/**
|
|
549
|
+
* HTTP GET /asset/user/current
|
|
550
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
551
|
+
*/
|
|
552
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
553
|
+
/**
|
|
554
|
+
* HTTP POST /asset/user/link
|
|
555
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
556
|
+
*/
|
|
557
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
558
|
+
/**
|
|
559
|
+
* HTTP GET /asset/user/link
|
|
560
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
561
|
+
*/
|
|
562
|
+
getUserAssetLinks(queryParams?: {
|
|
563
|
+
realm?: string;
|
|
564
|
+
userId?: string;
|
|
565
|
+
assetId?: string;
|
|
566
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
567
|
+
/**
|
|
568
|
+
* HTTP POST /asset/user/link/delete
|
|
569
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
570
|
+
*/
|
|
571
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
572
|
+
/**
|
|
573
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
574
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
575
|
+
*/
|
|
576
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
577
|
+
/**
|
|
578
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
579
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
580
|
+
*/
|
|
581
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
582
|
+
/**
|
|
583
|
+
* HTTP GET /asset/{assetId}
|
|
584
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
585
|
+
*/
|
|
586
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
587
|
+
/**
|
|
588
|
+
* HTTP PUT /asset/{assetId}
|
|
589
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
590
|
+
*/
|
|
591
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
592
|
+
/**
|
|
593
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
594
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
595
|
+
*/
|
|
596
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
597
|
+
/**
|
|
598
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
599
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
600
|
+
*/
|
|
601
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
602
|
+
/**
|
|
603
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
604
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
605
|
+
*/
|
|
606
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
607
|
+
assetIds?: string[];
|
|
608
|
+
}, options?: O): RestResponse<void>;
|
|
609
|
+
}
|
|
610
|
+
export declare class SyslogResourceClient<O> {
|
|
611
|
+
protected httpClient: HttpClient<O>;
|
|
612
|
+
constructor(httpClient: HttpClient<O>);
|
|
613
|
+
/**
|
|
614
|
+
* HTTP GET /syslog/config
|
|
615
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
616
|
+
*/
|
|
617
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
618
|
+
/**
|
|
619
|
+
* HTTP PUT /syslog/config
|
|
620
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
621
|
+
*/
|
|
622
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
623
|
+
/**
|
|
624
|
+
* HTTP DELETE /syslog/event
|
|
625
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
626
|
+
*/
|
|
627
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
628
|
+
/**
|
|
629
|
+
* HTTP GET /syslog/event
|
|
630
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
631
|
+
*/
|
|
632
|
+
getEvents(queryParams?: {
|
|
633
|
+
level?: Model.SyslogLevel;
|
|
634
|
+
per_page?: number;
|
|
635
|
+
page?: number;
|
|
636
|
+
from?: number;
|
|
637
|
+
to?: number;
|
|
638
|
+
category?: Model.SyslogCategory[];
|
|
639
|
+
subCategory?: string[];
|
|
640
|
+
}, options?: O): RestResponse<any>;
|
|
641
|
+
}
|
|
642
|
+
export declare class ProvisioningResourceClient<O> {
|
|
643
|
+
protected httpClient: HttpClient<O>;
|
|
644
|
+
constructor(httpClient: HttpClient<O>);
|
|
645
|
+
/**
|
|
646
|
+
* HTTP POST /provisioning
|
|
647
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
648
|
+
*/
|
|
649
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
650
|
+
/**
|
|
651
|
+
* HTTP GET /provisioning
|
|
652
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
611
653
|
*/
|
|
612
|
-
|
|
654
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
613
655
|
/**
|
|
614
|
-
* HTTP
|
|
615
|
-
* Java method: org.openremote.model.
|
|
656
|
+
* HTTP DELETE /provisioning/{id}
|
|
657
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
616
658
|
*/
|
|
617
|
-
|
|
618
|
-
path?: string;
|
|
619
|
-
}, options?: O): RestResponse<string>;
|
|
659
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
620
660
|
/**
|
|
621
|
-
* HTTP
|
|
622
|
-
* Java method: org.openremote.model.
|
|
661
|
+
* HTTP PUT /provisioning/{id}
|
|
662
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
623
663
|
*/
|
|
624
|
-
|
|
664
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
625
665
|
}
|
|
626
|
-
export declare class
|
|
666
|
+
export declare class MapResourceClient<O> {
|
|
627
667
|
protected httpClient: HttpClient<O>;
|
|
628
668
|
constructor(httpClient: HttpClient<O>);
|
|
629
669
|
/**
|
|
630
|
-
* HTTP GET /
|
|
631
|
-
* Java method: org.openremote.model.
|
|
670
|
+
* HTTP GET /map
|
|
671
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
632
672
|
*/
|
|
633
|
-
|
|
634
|
-
[
|
|
673
|
+
getSettings(options?: O): RestResponse<{
|
|
674
|
+
[id: string]: unknown;
|
|
635
675
|
}>;
|
|
636
676
|
/**
|
|
637
|
-
* HTTP
|
|
638
|
-
* Java method: org.openremote.model.
|
|
677
|
+
* HTTP PUT /map
|
|
678
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
639
679
|
*/
|
|
640
|
-
|
|
641
|
-
[index: string]:
|
|
680
|
+
saveSettings(mapConfig: {
|
|
681
|
+
[index: string]: Model.MapRealmConfig;
|
|
682
|
+
}, options?: O): RestResponse<any>;
|
|
683
|
+
/**
|
|
684
|
+
* HTTP GET /map/js
|
|
685
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
686
|
+
*/
|
|
687
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
688
|
+
[id: string]: unknown;
|
|
642
689
|
}>;
|
|
690
|
+
/**
|
|
691
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
692
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
693
|
+
*/
|
|
694
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
643
695
|
}
|
|
644
696
|
export declare class AppResourceClient<O> {
|
|
645
697
|
protected httpClient: HttpClient<O>;
|
|
@@ -660,30 +712,6 @@ export declare class AppResourceClient<O> {
|
|
|
660
712
|
*/
|
|
661
713
|
getAppInfos(options?: O): RestResponse<any>;
|
|
662
714
|
}
|
|
663
|
-
export declare class ProvisioningResourceClient<O> {
|
|
664
|
-
protected httpClient: HttpClient<O>;
|
|
665
|
-
constructor(httpClient: HttpClient<O>);
|
|
666
|
-
/**
|
|
667
|
-
* HTTP POST /provisioning
|
|
668
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
669
|
-
*/
|
|
670
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
671
|
-
/**
|
|
672
|
-
* HTTP GET /provisioning
|
|
673
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
674
|
-
*/
|
|
675
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
676
|
-
/**
|
|
677
|
-
* HTTP DELETE /provisioning/{id}
|
|
678
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
679
|
-
*/
|
|
680
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
681
|
-
/**
|
|
682
|
-
* HTTP PUT /provisioning/{id}
|
|
683
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
684
|
-
*/
|
|
685
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
686
|
-
}
|
|
687
715
|
export declare class RulesResourceClient<O> {
|
|
688
716
|
protected httpClient: HttpClient<O>;
|
|
689
717
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -792,132 +820,104 @@ export declare class RulesResourceClient<O> {
|
|
|
792
820
|
*/
|
|
793
821
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
794
822
|
}
|
|
795
|
-
export declare class
|
|
823
|
+
export declare class AlarmResourceClient<O> {
|
|
796
824
|
protected httpClient: HttpClient<O>;
|
|
797
825
|
constructor(httpClient: HttpClient<O>);
|
|
798
826
|
/**
|
|
799
|
-
* HTTP
|
|
800
|
-
* Java method: org.openremote.model.
|
|
801
|
-
*/
|
|
802
|
-
deleteConnections(queryParams?: {
|
|
803
|
-
realm?: string[];
|
|
804
|
-
}, options?: O): RestResponse<void>;
|
|
805
|
-
/**
|
|
806
|
-
* HTTP GET /gateway/connection
|
|
807
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
808
|
-
*/
|
|
809
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
810
|
-
/**
|
|
811
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
812
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
813
|
-
*/
|
|
814
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
815
|
-
/**
|
|
816
|
-
* HTTP GET /gateway/connection/{realm}
|
|
817
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
827
|
+
* HTTP POST /alarm
|
|
828
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
818
829
|
*/
|
|
819
|
-
|
|
830
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
831
|
+
assetIds?: string[];
|
|
832
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
820
833
|
/**
|
|
821
|
-
* HTTP
|
|
822
|
-
* Java method: org.openremote.model.
|
|
834
|
+
* HTTP GET /alarm
|
|
835
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
823
836
|
*/
|
|
824
|
-
|
|
837
|
+
getAlarms(queryParams?: {
|
|
838
|
+
realm?: string;
|
|
839
|
+
status?: Model.AlarmStatus;
|
|
840
|
+
assetId?: string;
|
|
841
|
+
assigneeId?: string;
|
|
842
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
825
843
|
/**
|
|
826
|
-
* HTTP
|
|
827
|
-
* Java method: org.openremote.model.
|
|
844
|
+
* HTTP DELETE /alarm
|
|
845
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
828
846
|
*/
|
|
829
|
-
|
|
830
|
-
}
|
|
831
|
-
export declare class AssetModelResourceClient<O> {
|
|
832
|
-
protected httpClient: HttpClient<O>;
|
|
833
|
-
constructor(httpClient: HttpClient<O>);
|
|
847
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
834
848
|
/**
|
|
835
|
-
* HTTP
|
|
836
|
-
* Java method: org.openremote.model.
|
|
849
|
+
* HTTP PUT /alarm/assets
|
|
850
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
837
851
|
*/
|
|
838
|
-
|
|
839
|
-
parentId?: string;
|
|
840
|
-
parentType?: string;
|
|
841
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
852
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
842
853
|
/**
|
|
843
|
-
* HTTP GET /
|
|
844
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP GET /alarm/{alarmId}
|
|
855
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
845
856
|
*/
|
|
846
|
-
|
|
847
|
-
parentId?: string;
|
|
848
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
857
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
849
858
|
/**
|
|
850
|
-
* HTTP
|
|
851
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
860
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
852
861
|
*/
|
|
853
|
-
|
|
854
|
-
parentId?: string;
|
|
855
|
-
parentType?: string;
|
|
856
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
862
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
857
863
|
/**
|
|
858
|
-
* HTTP
|
|
859
|
-
* Java method: org.openremote.model.
|
|
864
|
+
* HTTP PUT /alarm/{alarmId}
|
|
865
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
860
866
|
*/
|
|
861
|
-
|
|
862
|
-
parentId?: string;
|
|
863
|
-
}, options?: O): RestResponse<{
|
|
864
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
865
|
-
}>;
|
|
867
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
866
868
|
/**
|
|
867
|
-
* HTTP GET /
|
|
868
|
-
* Java method: org.openremote.model.
|
|
869
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
870
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
869
871
|
*/
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
}, options?: O): RestResponse<
|
|
873
|
-
[index: string]: Model.ValueDescriptor;
|
|
874
|
-
}>;
|
|
872
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
873
|
+
realm?: string;
|
|
874
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
879
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
880
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
881
878
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
882
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
883
879
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
884
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
885
880
|
protected _agentResource: AxiosAgentResourceClient;
|
|
886
|
-
protected
|
|
887
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
881
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
888
882
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
889
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
890
883
|
protected _userResource: AxiosUserResourceClient;
|
|
891
|
-
protected
|
|
884
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
885
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
886
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
892
887
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
893
|
-
protected
|
|
894
|
-
protected
|
|
888
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
889
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
890
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
891
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
892
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
893
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
895
894
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
895
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
896
|
+
protected _appResource: AxiosAppResourceClient;
|
|
896
897
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
897
|
-
protected
|
|
898
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
898
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
901
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
902
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
903
900
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
904
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
905
901
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
906
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
907
902
|
get AgentResource(): AxiosAgentResourceClient;
|
|
908
|
-
get
|
|
909
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
903
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
910
904
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
911
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
912
905
|
get UserResource(): AxiosUserResourceClient;
|
|
913
|
-
get
|
|
906
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
907
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
908
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
914
909
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
915
|
-
get
|
|
916
|
-
get
|
|
910
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
911
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
912
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
913
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
914
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
915
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
917
916
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
917
|
+
get MapResource(): AxiosMapResourceClient;
|
|
918
|
+
get AppResource(): AxiosAppResourceClient;
|
|
918
919
|
get RulesResource(): AxiosRulesResourceClient;
|
|
919
|
-
get
|
|
920
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
920
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
946
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
967
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|