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