@openremote/rest 1.4.0-snapshot.20250225102402 → 1.4.0-snapshot.20250226142611
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 +457 -457
- 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,24 +9,133 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class StatusResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /health
|
|
17
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
20
|
+
[index: string]: any;
|
|
21
|
+
}>;
|
|
20
22
|
/**
|
|
21
|
-
* HTTP GET /
|
|
22
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /info
|
|
24
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
23
25
|
*/
|
|
24
|
-
|
|
26
|
+
getInfo(options?: O): RestResponse<{
|
|
27
|
+
[index: string]: any;
|
|
28
|
+
}>;
|
|
29
|
+
}
|
|
30
|
+
export declare class AlarmResourceClient<O> {
|
|
31
|
+
protected httpClient: HttpClient<O>;
|
|
32
|
+
constructor(httpClient: HttpClient<O>);
|
|
25
33
|
/**
|
|
26
|
-
* HTTP
|
|
27
|
-
* Java method: org.openremote.model.
|
|
34
|
+
* HTTP POST /alarm
|
|
35
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
28
36
|
*/
|
|
29
|
-
|
|
37
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
38
|
+
assetIds?: string[];
|
|
39
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
40
|
+
/**
|
|
41
|
+
* HTTP GET /alarm
|
|
42
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
43
|
+
*/
|
|
44
|
+
getAlarms(queryParams?: {
|
|
45
|
+
realm?: string;
|
|
46
|
+
status?: Model.AlarmStatus;
|
|
47
|
+
assetId?: string;
|
|
48
|
+
assigneeId?: string;
|
|
49
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
50
|
+
/**
|
|
51
|
+
* HTTP DELETE /alarm
|
|
52
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
53
|
+
*/
|
|
54
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
55
|
+
/**
|
|
56
|
+
* HTTP PUT /alarm/assets
|
|
57
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
58
|
+
*/
|
|
59
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
60
|
+
/**
|
|
61
|
+
* HTTP GET /alarm/{alarmId}
|
|
62
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
63
|
+
*/
|
|
64
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
65
|
+
/**
|
|
66
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
67
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
68
|
+
*/
|
|
69
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
70
|
+
/**
|
|
71
|
+
* HTTP PUT /alarm/{alarmId}
|
|
72
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
73
|
+
*/
|
|
74
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
75
|
+
/**
|
|
76
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
77
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
78
|
+
*/
|
|
79
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
80
|
+
realm?: string;
|
|
81
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
82
|
+
}
|
|
83
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
84
|
+
protected httpClient: HttpClient<O>;
|
|
85
|
+
constructor(httpClient: HttpClient<O>);
|
|
86
|
+
/**
|
|
87
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
88
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
89
|
+
*/
|
|
90
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
91
|
+
/**
|
|
92
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
93
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
94
|
+
*/
|
|
95
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
96
|
+
}
|
|
97
|
+
export declare class ProvisioningResourceClient<O> {
|
|
98
|
+
protected httpClient: HttpClient<O>;
|
|
99
|
+
constructor(httpClient: HttpClient<O>);
|
|
100
|
+
/**
|
|
101
|
+
* HTTP POST /provisioning
|
|
102
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
103
|
+
*/
|
|
104
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
105
|
+
/**
|
|
106
|
+
* HTTP GET /provisioning
|
|
107
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
108
|
+
*/
|
|
109
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
110
|
+
/**
|
|
111
|
+
* HTTP DELETE /provisioning/{id}
|
|
112
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
113
|
+
*/
|
|
114
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
115
|
+
/**
|
|
116
|
+
* HTTP PUT /provisioning/{id}
|
|
117
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
118
|
+
*/
|
|
119
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
120
|
+
}
|
|
121
|
+
export declare class FlowResourceClient<O> {
|
|
122
|
+
protected httpClient: HttpClient<O>;
|
|
123
|
+
constructor(httpClient: HttpClient<O>);
|
|
124
|
+
/**
|
|
125
|
+
* HTTP GET /flow
|
|
126
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
127
|
+
*/
|
|
128
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
129
|
+
/**
|
|
130
|
+
* HTTP GET /flow/{name}
|
|
131
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
132
|
+
*/
|
|
133
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
134
|
+
/**
|
|
135
|
+
* HTTP GET /flow/{type}
|
|
136
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
137
|
+
*/
|
|
138
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
30
139
|
}
|
|
31
140
|
export declare class RealmResourceClient<O> {
|
|
32
141
|
protected httpClient: HttpClient<O>;
|
|
@@ -62,58 +171,74 @@ export declare class RealmResourceClient<O> {
|
|
|
62
171
|
*/
|
|
63
172
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
64
173
|
}
|
|
65
|
-
export declare class
|
|
174
|
+
export declare class DashboardResourceClient<O> {
|
|
66
175
|
protected httpClient: HttpClient<O>;
|
|
67
176
|
constructor(httpClient: HttpClient<O>);
|
|
68
177
|
/**
|
|
69
|
-
* HTTP POST /
|
|
70
|
-
* Java method: org.openremote.model.
|
|
178
|
+
* HTTP POST /dashboard
|
|
179
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
71
180
|
*/
|
|
72
|
-
|
|
73
|
-
assetIds?: string[];
|
|
74
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
181
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
75
182
|
/**
|
|
76
|
-
* HTTP
|
|
77
|
-
* Java method: org.openremote.model.
|
|
183
|
+
* HTTP PUT /dashboard
|
|
184
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
78
185
|
*/
|
|
79
|
-
|
|
80
|
-
realm?: string;
|
|
81
|
-
status?: Model.AlarmStatus;
|
|
82
|
-
assetId?: string;
|
|
83
|
-
assigneeId?: string;
|
|
84
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
186
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
85
187
|
/**
|
|
86
|
-
* HTTP
|
|
87
|
-
* Java method: org.openremote.model.
|
|
188
|
+
* HTTP GET /dashboard/all/{realm}
|
|
189
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
88
190
|
*/
|
|
89
|
-
|
|
191
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
90
192
|
/**
|
|
91
|
-
* HTTP
|
|
92
|
-
* Java method: org.openremote.model.
|
|
193
|
+
* HTTP POST /dashboard/query
|
|
194
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
93
195
|
*/
|
|
94
|
-
|
|
196
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
95
197
|
/**
|
|
96
|
-
* HTTP
|
|
97
|
-
* Java method: org.openremote.model.
|
|
198
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
199
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
98
200
|
*/
|
|
99
|
-
|
|
201
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
100
202
|
/**
|
|
101
|
-
* HTTP
|
|
102
|
-
* Java method: org.openremote.model.
|
|
203
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
204
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
103
205
|
*/
|
|
104
|
-
|
|
206
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
207
|
+
}
|
|
208
|
+
export declare class ConsoleResourceClient<O> {
|
|
209
|
+
protected httpClient: HttpClient<O>;
|
|
210
|
+
constructor(httpClient: HttpClient<O>);
|
|
105
211
|
/**
|
|
106
|
-
* HTTP
|
|
107
|
-
* Java method: org.openremote.model.
|
|
212
|
+
* HTTP POST /console/register
|
|
213
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
108
214
|
*/
|
|
109
|
-
|
|
215
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
216
|
+
}
|
|
217
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
218
|
+
protected httpClient: HttpClient<O>;
|
|
219
|
+
constructor(httpClient: HttpClient<O>);
|
|
110
220
|
/**
|
|
111
|
-
* HTTP GET /
|
|
112
|
-
* Java method: org.openremote.model.
|
|
221
|
+
* HTTP GET /asset/datapoint/export
|
|
222
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
113
223
|
*/
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
224
|
+
getDatapointExport(queryParams?: {
|
|
225
|
+
attributeRefs?: string;
|
|
226
|
+
fromTimestamp?: number;
|
|
227
|
+
toTimestamp?: number;
|
|
228
|
+
}, options?: O): RestResponse<any>;
|
|
229
|
+
/**
|
|
230
|
+
* HTTP GET /asset/datapoint/periods
|
|
231
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
232
|
+
*/
|
|
233
|
+
getDatapointPeriod(queryParams?: {
|
|
234
|
+
assetId?: string;
|
|
235
|
+
attributeName?: string;
|
|
236
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
237
|
+
/**
|
|
238
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
239
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
240
|
+
*/
|
|
241
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
117
242
|
}
|
|
118
243
|
export declare class AgentResourceClient<O> {
|
|
119
244
|
protected httpClient: HttpClient<O>;
|
|
@@ -227,58 +352,115 @@ export declare class NotificationResourceClient<O> {
|
|
|
227
352
|
targetId?: string;
|
|
228
353
|
}, options?: O): RestResponse<void>;
|
|
229
354
|
}
|
|
230
|
-
export declare class
|
|
355
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
231
356
|
protected httpClient: HttpClient<O>;
|
|
232
357
|
constructor(httpClient: HttpClient<O>);
|
|
233
358
|
/**
|
|
234
|
-
* HTTP
|
|
235
|
-
* Java method: org.openremote.model.
|
|
359
|
+
* HTTP POST /gateway/tunnel
|
|
360
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
236
361
|
*/
|
|
237
|
-
|
|
362
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
238
363
|
/**
|
|
239
|
-
* HTTP
|
|
240
|
-
* Java method: org.openremote.model.
|
|
364
|
+
* HTTP DELETE /gateway/tunnel
|
|
365
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
241
366
|
*/
|
|
242
|
-
|
|
367
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
243
368
|
/**
|
|
244
|
-
* HTTP GET /
|
|
245
|
-
* Java method: org.openremote.model.
|
|
369
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
370
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
246
371
|
*/
|
|
247
|
-
|
|
372
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
373
|
+
/**
|
|
374
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
375
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
376
|
+
*/
|
|
377
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
378
|
+
/**
|
|
379
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
380
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
381
|
+
*/
|
|
382
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
248
383
|
}
|
|
249
|
-
export declare class
|
|
384
|
+
export declare class GatewayClientResourceClient<O> {
|
|
250
385
|
protected httpClient: HttpClient<O>;
|
|
251
386
|
constructor(httpClient: HttpClient<O>);
|
|
252
387
|
/**
|
|
253
|
-
* HTTP
|
|
254
|
-
* Java method: org.openremote.model.
|
|
388
|
+
* HTTP DELETE /gateway/connection
|
|
389
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
255
390
|
*/
|
|
256
|
-
|
|
391
|
+
deleteConnections(queryParams?: {
|
|
392
|
+
realm?: string[];
|
|
393
|
+
}, options?: O): RestResponse<void>;
|
|
257
394
|
/**
|
|
258
|
-
* HTTP
|
|
259
|
-
* Java method: org.openremote.model.
|
|
260
|
-
*/
|
|
261
|
-
|
|
395
|
+
* HTTP GET /gateway/connection
|
|
396
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
397
|
+
*/
|
|
398
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
262
399
|
/**
|
|
263
|
-
* HTTP
|
|
264
|
-
* Java method: org.openremote.model.
|
|
400
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
401
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
265
402
|
*/
|
|
266
|
-
|
|
403
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
267
404
|
/**
|
|
268
|
-
* HTTP
|
|
269
|
-
* Java method: org.openremote.model.
|
|
405
|
+
* HTTP GET /gateway/connection/{realm}
|
|
406
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
270
407
|
*/
|
|
271
|
-
|
|
408
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
272
409
|
/**
|
|
273
|
-
* HTTP
|
|
274
|
-
* Java method: org.openremote.model.
|
|
410
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
411
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
275
412
|
*/
|
|
276
|
-
|
|
413
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
277
414
|
/**
|
|
278
|
-
* HTTP GET /
|
|
279
|
-
* Java method: org.openremote.model.
|
|
415
|
+
* HTTP GET /gateway/status/{realm}
|
|
416
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
280
417
|
*/
|
|
281
|
-
|
|
418
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
419
|
+
}
|
|
420
|
+
export declare class AssetModelResourceClient<O> {
|
|
421
|
+
protected httpClient: HttpClient<O>;
|
|
422
|
+
constructor(httpClient: HttpClient<O>);
|
|
423
|
+
/**
|
|
424
|
+
* HTTP GET /model/assetDescriptors
|
|
425
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
426
|
+
*/
|
|
427
|
+
getAssetDescriptors(queryParams?: {
|
|
428
|
+
parentId?: string;
|
|
429
|
+
parentType?: string;
|
|
430
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
431
|
+
/**
|
|
432
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
433
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
434
|
+
*/
|
|
435
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
436
|
+
parentId?: string;
|
|
437
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
438
|
+
/**
|
|
439
|
+
* HTTP GET /model/assetInfos
|
|
440
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
441
|
+
*/
|
|
442
|
+
getAssetInfos(queryParams?: {
|
|
443
|
+
parentId?: string;
|
|
444
|
+
parentType?: string;
|
|
445
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
446
|
+
/**
|
|
447
|
+
* HTTP GET /model/metaItemDescriptors
|
|
448
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
449
|
+
*/
|
|
450
|
+
getMetaItemDescriptors(queryParams?: {
|
|
451
|
+
parentId?: string;
|
|
452
|
+
}, options?: O): RestResponse<{
|
|
453
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
454
|
+
}>;
|
|
455
|
+
/**
|
|
456
|
+
* HTTP GET /model/valueDescriptors
|
|
457
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
458
|
+
*/
|
|
459
|
+
getValueDescriptors(queryParams?: {
|
|
460
|
+
parentId?: string;
|
|
461
|
+
}, options?: O): RestResponse<{
|
|
462
|
+
[index: string]: Model.ValueDescriptor;
|
|
463
|
+
}>;
|
|
282
464
|
}
|
|
283
465
|
export declare class UserResourceClient<O> {
|
|
284
466
|
protected httpClient: HttpClient<O>;
|
|
@@ -404,31 +586,143 @@ export declare class UserResourceClient<O> {
|
|
|
404
586
|
*/
|
|
405
587
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
406
588
|
}
|
|
407
|
-
export declare class
|
|
589
|
+
export declare class RulesResourceClient<O> {
|
|
408
590
|
protected httpClient: HttpClient<O>;
|
|
409
591
|
constructor(httpClient: HttpClient<O>);
|
|
410
592
|
/**
|
|
411
|
-
* HTTP
|
|
412
|
-
* Java method: org.openremote.model.
|
|
593
|
+
* HTTP POST /rules
|
|
594
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
413
595
|
*/
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
596
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
597
|
+
/**
|
|
598
|
+
* HTTP GET /rules
|
|
599
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
600
|
+
*/
|
|
601
|
+
getGlobalRulesets(queryParams?: {
|
|
602
|
+
language?: Model.RulesetLang[];
|
|
603
|
+
fullyPopulate?: boolean;
|
|
604
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
605
|
+
/**
|
|
606
|
+
* HTTP POST /rules/asset
|
|
607
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
608
|
+
*/
|
|
609
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
610
|
+
/**
|
|
611
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
612
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
613
|
+
*/
|
|
614
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
615
|
+
language?: Model.RulesetLang[];
|
|
616
|
+
fullyPopulate?: boolean;
|
|
617
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
618
|
+
/**
|
|
619
|
+
* HTTP DELETE /rules/asset/{id}
|
|
620
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
621
|
+
*/
|
|
622
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
623
|
+
/**
|
|
624
|
+
* HTTP GET /rules/asset/{id}
|
|
625
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
626
|
+
*/
|
|
627
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
628
|
+
/**
|
|
629
|
+
* HTTP PUT /rules/asset/{id}
|
|
630
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
631
|
+
*/
|
|
632
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
633
|
+
/**
|
|
634
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
635
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
636
|
+
*/
|
|
637
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
638
|
+
/**
|
|
639
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
640
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
641
|
+
*/
|
|
642
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
643
|
+
/**
|
|
644
|
+
* HTTP GET /rules/info/global
|
|
645
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
646
|
+
*/
|
|
647
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
648
|
+
/**
|
|
649
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
650
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
651
|
+
*/
|
|
652
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
653
|
+
/**
|
|
654
|
+
* HTTP POST /rules/realm
|
|
655
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
656
|
+
*/
|
|
657
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
658
|
+
/**
|
|
659
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
660
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
661
|
+
*/
|
|
662
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
663
|
+
language?: Model.RulesetLang[];
|
|
664
|
+
fullyPopulate?: boolean;
|
|
665
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
666
|
+
/**
|
|
667
|
+
* HTTP DELETE /rules/realm/{id}
|
|
668
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
669
|
+
*/
|
|
670
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
671
|
+
/**
|
|
672
|
+
* HTTP GET /rules/realm/{id}
|
|
673
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
674
|
+
*/
|
|
675
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
676
|
+
/**
|
|
677
|
+
* HTTP PUT /rules/realm/{id}
|
|
678
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
679
|
+
*/
|
|
680
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
681
|
+
/**
|
|
682
|
+
* HTTP DELETE /rules/{id}
|
|
683
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
684
|
+
*/
|
|
685
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
686
|
+
/**
|
|
687
|
+
* HTTP GET /rules/{id}
|
|
688
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
689
|
+
*/
|
|
690
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
691
|
+
/**
|
|
692
|
+
* HTTP PUT /rules/{id}
|
|
693
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
694
|
+
*/
|
|
695
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
696
|
+
}
|
|
697
|
+
export declare class MapResourceClient<O> {
|
|
698
|
+
protected httpClient: HttpClient<O>;
|
|
699
|
+
constructor(httpClient: HttpClient<O>);
|
|
700
|
+
/**
|
|
701
|
+
* HTTP GET /map
|
|
702
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
703
|
+
*/
|
|
704
|
+
getSettings(options?: O): RestResponse<{
|
|
705
|
+
[id: string]: unknown;
|
|
706
|
+
}>;
|
|
707
|
+
/**
|
|
708
|
+
* HTTP PUT /map
|
|
709
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
710
|
+
*/
|
|
711
|
+
saveSettings(mapConfig: {
|
|
712
|
+
[index: string]: Model.MapRealmConfig;
|
|
418
713
|
}, options?: O): RestResponse<any>;
|
|
419
714
|
/**
|
|
420
|
-
* HTTP GET /
|
|
421
|
-
* Java method: org.openremote.model.
|
|
715
|
+
* HTTP GET /map/js
|
|
716
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
422
717
|
*/
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
718
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
719
|
+
[id: string]: unknown;
|
|
720
|
+
}>;
|
|
427
721
|
/**
|
|
428
|
-
* HTTP
|
|
429
|
-
* Java method: org.openremote.model.
|
|
722
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
723
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
430
724
|
*/
|
|
431
|
-
|
|
725
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
432
726
|
}
|
|
433
727
|
export declare class AssetResourceClient<O> {
|
|
434
728
|
protected httpClient: HttpClient<O>;
|
|
@@ -534,390 +828,96 @@ export declare class AssetResourceClient<O> {
|
|
|
534
828
|
assetIds?: string[];
|
|
535
829
|
}, options?: O): RestResponse<void>;
|
|
536
830
|
}
|
|
537
|
-
export declare class
|
|
831
|
+
export declare class ConfigurationResourceClient<O> {
|
|
538
832
|
protected httpClient: HttpClient<O>;
|
|
539
833
|
constructor(httpClient: HttpClient<O>);
|
|
540
834
|
/**
|
|
541
|
-
* HTTP GET /
|
|
542
|
-
* Java method: org.openremote.model.
|
|
835
|
+
* HTTP GET /configuration/manager
|
|
836
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
543
837
|
*/
|
|
544
|
-
|
|
545
|
-
[id: string]: unknown;
|
|
546
|
-
}>;
|
|
838
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
547
839
|
/**
|
|
548
|
-
* HTTP PUT /
|
|
549
|
-
* Java method: org.openremote.model.
|
|
840
|
+
* HTTP PUT /configuration/manager
|
|
841
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
550
842
|
*/
|
|
551
|
-
|
|
552
|
-
[index: string]: Model.MapRealmConfig;
|
|
553
|
-
}, options?: O): RestResponse<any>;
|
|
843
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
554
844
|
/**
|
|
555
|
-
* HTTP
|
|
556
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* HTTP POST /configuration/manager/file
|
|
846
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
557
847
|
*/
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
}>;
|
|
848
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
849
|
+
path?: string;
|
|
850
|
+
}, options?: O): RestResponse<string>;
|
|
561
851
|
/**
|
|
562
|
-
* HTTP GET /
|
|
563
|
-
* Java method: org.openremote.model.
|
|
852
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
853
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
564
854
|
*/
|
|
565
|
-
|
|
855
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
566
856
|
}
|
|
567
|
-
export declare class
|
|
857
|
+
export declare class AppResourceClient<O> {
|
|
568
858
|
protected httpClient: HttpClient<O>;
|
|
569
859
|
constructor(httpClient: HttpClient<O>);
|
|
570
860
|
/**
|
|
571
|
-
* HTTP
|
|
572
|
-
* Java method: org.openremote.model.
|
|
573
|
-
*/
|
|
574
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
575
|
-
}
|
|
576
|
-
export declare class StatusResourceClient<O> {
|
|
577
|
-
protected httpClient: HttpClient<O>;
|
|
578
|
-
constructor(httpClient: HttpClient<O>);
|
|
579
|
-
/**
|
|
580
|
-
* HTTP GET /health
|
|
581
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
582
|
-
*/
|
|
583
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
584
|
-
[index: string]: any;
|
|
585
|
-
}>;
|
|
586
|
-
/**
|
|
587
|
-
* HTTP GET /info
|
|
588
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
589
|
-
*/
|
|
590
|
-
getInfo(options?: O): RestResponse<{
|
|
591
|
-
[index: string]: any;
|
|
592
|
-
}>;
|
|
593
|
-
}
|
|
594
|
-
export declare class ConfigurationResourceClient<O> {
|
|
595
|
-
protected httpClient: HttpClient<O>;
|
|
596
|
-
constructor(httpClient: HttpClient<O>);
|
|
597
|
-
/**
|
|
598
|
-
* HTTP GET /configuration/manager
|
|
599
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
600
|
-
*/
|
|
601
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
602
|
-
/**
|
|
603
|
-
* HTTP PUT /configuration/manager
|
|
604
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
605
|
-
*/
|
|
606
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
607
|
-
/**
|
|
608
|
-
* HTTP POST /configuration/manager/file
|
|
609
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
610
|
-
*/
|
|
611
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
612
|
-
path?: string;
|
|
613
|
-
}, options?: O): RestResponse<string>;
|
|
614
|
-
/**
|
|
615
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
616
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
617
|
-
*/
|
|
618
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
619
|
-
}
|
|
620
|
-
export declare class RulesResourceClient<O> {
|
|
621
|
-
protected httpClient: HttpClient<O>;
|
|
622
|
-
constructor(httpClient: HttpClient<O>);
|
|
623
|
-
/**
|
|
624
|
-
* HTTP POST /rules
|
|
625
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
626
|
-
*/
|
|
627
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
628
|
-
/**
|
|
629
|
-
* HTTP GET /rules
|
|
630
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
631
|
-
*/
|
|
632
|
-
getGlobalRulesets(queryParams?: {
|
|
633
|
-
language?: Model.RulesetLang[];
|
|
634
|
-
fullyPopulate?: boolean;
|
|
635
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
636
|
-
/**
|
|
637
|
-
* HTTP POST /rules/asset
|
|
638
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
639
|
-
*/
|
|
640
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
641
|
-
/**
|
|
642
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
643
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
644
|
-
*/
|
|
645
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
646
|
-
language?: Model.RulesetLang[];
|
|
647
|
-
fullyPopulate?: boolean;
|
|
648
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
649
|
-
/**
|
|
650
|
-
* HTTP DELETE /rules/asset/{id}
|
|
651
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
652
|
-
*/
|
|
653
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
654
|
-
/**
|
|
655
|
-
* HTTP GET /rules/asset/{id}
|
|
656
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
657
|
-
*/
|
|
658
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
659
|
-
/**
|
|
660
|
-
* HTTP PUT /rules/asset/{id}
|
|
661
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
662
|
-
*/
|
|
663
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
664
|
-
/**
|
|
665
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
666
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
667
|
-
*/
|
|
668
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
669
|
-
/**
|
|
670
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
671
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
672
|
-
*/
|
|
673
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
674
|
-
/**
|
|
675
|
-
* HTTP GET /rules/info/global
|
|
676
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
677
|
-
*/
|
|
678
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
679
|
-
/**
|
|
680
|
-
* HTTP GET /rules/info/realm/{realm}
|
|
681
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
682
|
-
*/
|
|
683
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
684
|
-
/**
|
|
685
|
-
* HTTP POST /rules/realm
|
|
686
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
687
|
-
*/
|
|
688
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
689
|
-
/**
|
|
690
|
-
* HTTP GET /rules/realm/for/{realm}
|
|
691
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
692
|
-
*/
|
|
693
|
-
getRealmRulesets(realm: string, queryParams?: {
|
|
694
|
-
language?: Model.RulesetLang[];
|
|
695
|
-
fullyPopulate?: boolean;
|
|
696
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
697
|
-
/**
|
|
698
|
-
* HTTP DELETE /rules/realm/{id}
|
|
699
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
700
|
-
*/
|
|
701
|
-
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
702
|
-
/**
|
|
703
|
-
* HTTP GET /rules/realm/{id}
|
|
704
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
705
|
-
*/
|
|
706
|
-
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
707
|
-
/**
|
|
708
|
-
* HTTP PUT /rules/realm/{id}
|
|
709
|
-
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
710
|
-
*/
|
|
711
|
-
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
712
|
-
/**
|
|
713
|
-
* HTTP DELETE /rules/{id}
|
|
714
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
715
|
-
*/
|
|
716
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
717
|
-
/**
|
|
718
|
-
* HTTP GET /rules/{id}
|
|
719
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
720
|
-
*/
|
|
721
|
-
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
722
|
-
/**
|
|
723
|
-
* HTTP PUT /rules/{id}
|
|
724
|
-
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
725
|
-
*/
|
|
726
|
-
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
727
|
-
}
|
|
728
|
-
export declare class GatewayClientResourceClient<O> {
|
|
729
|
-
protected httpClient: HttpClient<O>;
|
|
730
|
-
constructor(httpClient: HttpClient<O>);
|
|
731
|
-
/**
|
|
732
|
-
* HTTP DELETE /gateway/connection
|
|
733
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
734
|
-
*/
|
|
735
|
-
deleteConnections(queryParams?: {
|
|
736
|
-
realm?: string[];
|
|
737
|
-
}, options?: O): RestResponse<void>;
|
|
738
|
-
/**
|
|
739
|
-
* HTTP GET /gateway/connection
|
|
740
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
741
|
-
*/
|
|
742
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
743
|
-
/**
|
|
744
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
745
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
746
|
-
*/
|
|
747
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
748
|
-
/**
|
|
749
|
-
* HTTP GET /gateway/connection/{realm}
|
|
750
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
751
|
-
*/
|
|
752
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
753
|
-
/**
|
|
754
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
755
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
756
|
-
*/
|
|
757
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
758
|
-
/**
|
|
759
|
-
* HTTP GET /gateway/status/{realm}
|
|
760
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
761
|
-
*/
|
|
762
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
763
|
-
}
|
|
764
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
765
|
-
protected httpClient: HttpClient<O>;
|
|
766
|
-
constructor(httpClient: HttpClient<O>);
|
|
767
|
-
/**
|
|
768
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
769
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
770
|
-
*/
|
|
771
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
772
|
-
/**
|
|
773
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
774
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
775
|
-
*/
|
|
776
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
777
|
-
}
|
|
778
|
-
export declare class AssetModelResourceClient<O> {
|
|
779
|
-
protected httpClient: HttpClient<O>;
|
|
780
|
-
constructor(httpClient: HttpClient<O>);
|
|
781
|
-
/**
|
|
782
|
-
* HTTP GET /model/assetDescriptors
|
|
783
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
784
|
-
*/
|
|
785
|
-
getAssetDescriptors(queryParams?: {
|
|
786
|
-
parentId?: string;
|
|
787
|
-
parentType?: string;
|
|
788
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
789
|
-
/**
|
|
790
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
791
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
792
|
-
*/
|
|
793
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
794
|
-
parentId?: string;
|
|
795
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
796
|
-
/**
|
|
797
|
-
* HTTP GET /model/assetInfos
|
|
798
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
799
|
-
*/
|
|
800
|
-
getAssetInfos(queryParams?: {
|
|
801
|
-
parentId?: string;
|
|
802
|
-
parentType?: string;
|
|
803
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
804
|
-
/**
|
|
805
|
-
* HTTP GET /model/metaItemDescriptors
|
|
806
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
807
|
-
*/
|
|
808
|
-
getMetaItemDescriptors(queryParams?: {
|
|
809
|
-
parentId?: string;
|
|
810
|
-
}, options?: O): RestResponse<{
|
|
811
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
812
|
-
}>;
|
|
813
|
-
/**
|
|
814
|
-
* HTTP GET /model/valueDescriptors
|
|
815
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
816
|
-
*/
|
|
817
|
-
getValueDescriptors(queryParams?: {
|
|
818
|
-
parentId?: string;
|
|
819
|
-
}, options?: O): RestResponse<{
|
|
820
|
-
[index: string]: Model.ValueDescriptor;
|
|
821
|
-
}>;
|
|
822
|
-
}
|
|
823
|
-
export declare class ProvisioningResourceClient<O> {
|
|
824
|
-
protected httpClient: HttpClient<O>;
|
|
825
|
-
constructor(httpClient: HttpClient<O>);
|
|
826
|
-
/**
|
|
827
|
-
* HTTP POST /provisioning
|
|
828
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
829
|
-
*/
|
|
830
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
831
|
-
/**
|
|
832
|
-
* HTTP GET /provisioning
|
|
833
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
834
|
-
*/
|
|
835
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
836
|
-
/**
|
|
837
|
-
* HTTP DELETE /provisioning/{id}
|
|
838
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
839
|
-
*/
|
|
840
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
841
|
-
/**
|
|
842
|
-
* HTTP PUT /provisioning/{id}
|
|
843
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
844
|
-
*/
|
|
845
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
846
|
-
}
|
|
847
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
848
|
-
protected httpClient: HttpClient<O>;
|
|
849
|
-
constructor(httpClient: HttpClient<O>);
|
|
850
|
-
/**
|
|
851
|
-
* HTTP POST /gateway/tunnel
|
|
852
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
853
|
-
*/
|
|
854
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
855
|
-
/**
|
|
856
|
-
* HTTP DELETE /gateway/tunnel
|
|
857
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
858
|
-
*/
|
|
859
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
860
|
-
/**
|
|
861
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
862
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
861
|
+
* HTTP GET /apps
|
|
862
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
863
863
|
*/
|
|
864
|
-
|
|
864
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
865
865
|
/**
|
|
866
|
-
* HTTP GET /
|
|
867
|
-
* Java method: org.openremote.model.
|
|
866
|
+
* HTTP GET /apps/consoleConfig
|
|
867
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
868
868
|
*/
|
|
869
|
-
|
|
869
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
870
870
|
/**
|
|
871
|
-
* HTTP GET /
|
|
872
|
-
* Java method: org.openremote.model.
|
|
871
|
+
* HTTP GET /apps/info
|
|
872
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
873
873
|
*/
|
|
874
|
-
|
|
874
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
879
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
878
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
880
879
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
880
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
881
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
882
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
883
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
884
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
885
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
886
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
881
887
|
protected _agentResource: AxiosAgentResourceClient;
|
|
882
888
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
883
889
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
884
|
-
protected
|
|
885
|
-
protected
|
|
890
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
891
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
892
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
886
893
|
protected _userResource: AxiosUserResourceClient;
|
|
887
|
-
protected
|
|
888
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
894
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
889
895
|
protected _mapResource: AxiosMapResourceClient;
|
|
890
|
-
protected
|
|
891
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
896
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
892
897
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
893
|
-
protected
|
|
894
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
895
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
896
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
897
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
898
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
898
|
+
protected _appResource: AxiosAppResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
901
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
900
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
902
901
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
902
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
903
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
904
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
905
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
906
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
907
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
908
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
903
909
|
get AgentResource(): AxiosAgentResourceClient;
|
|
904
910
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
905
911
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
906
|
-
get
|
|
907
|
-
get
|
|
912
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
913
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
914
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
908
915
|
get UserResource(): AxiosUserResourceClient;
|
|
909
|
-
get
|
|
910
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
916
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
911
917
|
get MapResource(): AxiosMapResourceClient;
|
|
912
|
-
get
|
|
913
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
918
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
914
919
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
915
|
-
get
|
|
916
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
917
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
918
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
919
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
920
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
920
|
+
get AppResource(): AxiosAppResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
929
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
|
-
}
|
|
931
|
-
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
928
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
932
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
930
|
}
|
|
934
931
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
935
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
933
|
}
|
|
937
|
-
export declare class
|
|
934
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
941
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
939
|
}
|
|
943
|
-
export declare class
|
|
940
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
|
-
export declare class
|
|
943
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
946
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
|
-
export declare class
|
|
949
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
952
|
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
956
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
954
|
}
|
|
958
|
-
export declare class
|
|
955
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
959
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
957
|
}
|
|
961
|
-
export declare class
|
|
958
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
962
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
960
|
}
|
|
964
|
-
export declare class
|
|
961
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
965
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
963
|
}
|
|
967
|
-
export declare class
|
|
964
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
974
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
972
|
}
|
|
976
|
-
export declare class
|
|
973
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
977
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
975
|
}
|
|
979
|
-
export declare class
|
|
976
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
980
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
978
|
}
|
|
982
|
-
export declare class
|
|
979
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
983
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
981
|
}
|
|
985
|
-
export declare class
|
|
982
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
986
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
984
|
}
|
|
988
|
-
export declare class
|
|
985
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
986
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
|
+
}
|
|
988
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|