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