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