@openremote/rest 1.4.0-snapshot.20250228134346 → 1.4.0-snapshot.20250304170726
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 +460 -460
- 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,118 +9,63 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP POST /console/register
|
|
17
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
18
|
-
*/
|
|
19
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
20
|
-
}
|
|
21
|
-
export declare class AssetResourceClient<O> {
|
|
12
|
+
export declare class ConfigurationResourceClient<O> {
|
|
22
13
|
protected httpClient: HttpClient<O>;
|
|
23
14
|
constructor(httpClient: HttpClient<O>);
|
|
24
15
|
/**
|
|
25
|
-
* HTTP
|
|
26
|
-
* Java method: org.openremote.model.
|
|
27
|
-
*/
|
|
28
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
29
|
-
/**
|
|
30
|
-
* HTTP DELETE /asset
|
|
31
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
32
|
-
*/
|
|
33
|
-
delete(queryParams?: {
|
|
34
|
-
assetId?: string[];
|
|
35
|
-
}, options?: O): RestResponse<void>;
|
|
36
|
-
/**
|
|
37
|
-
* HTTP PUT /asset/attributes
|
|
38
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
39
|
-
*/
|
|
40
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
43
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
44
|
-
*/
|
|
45
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
46
|
-
/**
|
|
47
|
-
* HTTP DELETE /asset/parent
|
|
48
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
49
|
-
*/
|
|
50
|
-
updateNoneParent(queryParams?: {
|
|
51
|
-
assetIds?: string[];
|
|
52
|
-
}, options?: O): RestResponse<void>;
|
|
53
|
-
/**
|
|
54
|
-
* HTTP GET /asset/partial/{assetId}
|
|
55
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
56
|
-
*/
|
|
57
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
58
|
-
/**
|
|
59
|
-
* HTTP POST /asset/query
|
|
60
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
61
|
-
*/
|
|
62
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
63
|
-
/**
|
|
64
|
-
* HTTP GET /asset/user/current
|
|
65
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
66
|
-
*/
|
|
67
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
68
|
-
/**
|
|
69
|
-
* HTTP POST /asset/user/link
|
|
70
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
71
|
-
*/
|
|
72
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
73
|
-
/**
|
|
74
|
-
* HTTP GET /asset/user/link
|
|
75
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
76
|
-
*/
|
|
77
|
-
getUserAssetLinks(queryParams?: {
|
|
78
|
-
realm?: string;
|
|
79
|
-
userId?: string;
|
|
80
|
-
assetId?: string;
|
|
81
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
82
|
-
/**
|
|
83
|
-
* HTTP POST /asset/user/link/delete
|
|
84
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
16
|
+
* HTTP GET /configuration/manager
|
|
17
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
85
18
|
*/
|
|
86
|
-
|
|
19
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
87
20
|
/**
|
|
88
|
-
* HTTP
|
|
89
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /configuration/manager
|
|
22
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
90
23
|
*/
|
|
91
|
-
|
|
24
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
92
25
|
/**
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP POST /configuration/manager/file
|
|
27
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
95
28
|
*/
|
|
96
|
-
|
|
29
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
30
|
+
path?: string;
|
|
31
|
+
}, options?: O): RestResponse<string>;
|
|
97
32
|
/**
|
|
98
|
-
* HTTP GET /
|
|
99
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
34
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
100
35
|
*/
|
|
101
|
-
|
|
36
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
37
|
+
}
|
|
38
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
39
|
+
protected httpClient: HttpClient<O>;
|
|
40
|
+
constructor(httpClient: HttpClient<O>);
|
|
102
41
|
/**
|
|
103
|
-
* HTTP
|
|
104
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
43
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
105
44
|
*/
|
|
106
|
-
|
|
45
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
107
46
|
/**
|
|
108
|
-
* HTTP PUT /asset/{assetId}/
|
|
109
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
48
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
110
49
|
*/
|
|
111
|
-
|
|
50
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
51
|
+
}
|
|
52
|
+
export declare class StatusResourceClient<O> {
|
|
53
|
+
protected httpClient: HttpClient<O>;
|
|
54
|
+
constructor(httpClient: HttpClient<O>);
|
|
112
55
|
/**
|
|
113
|
-
* HTTP
|
|
114
|
-
* Java method: org.openremote.model.
|
|
56
|
+
* HTTP GET /health
|
|
57
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
115
58
|
*/
|
|
116
|
-
|
|
59
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
60
|
+
[index: string]: any;
|
|
61
|
+
}>;
|
|
117
62
|
/**
|
|
118
|
-
* HTTP
|
|
119
|
-
* Java method: org.openremote.model.
|
|
63
|
+
* HTTP GET /info
|
|
64
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
120
65
|
*/
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
}
|
|
66
|
+
getInfo(options?: O): RestResponse<{
|
|
67
|
+
[index: string]: any;
|
|
68
|
+
}>;
|
|
124
69
|
}
|
|
125
70
|
export declare class AppResourceClient<O> {
|
|
126
71
|
protected httpClient: HttpClient<O>;
|
|
@@ -141,131 +86,6 @@ export declare class AppResourceClient<O> {
|
|
|
141
86
|
*/
|
|
142
87
|
getAppInfos(options?: O): RestResponse<any>;
|
|
143
88
|
}
|
|
144
|
-
export declare class AssetModelResourceClient<O> {
|
|
145
|
-
protected httpClient: HttpClient<O>;
|
|
146
|
-
constructor(httpClient: HttpClient<O>);
|
|
147
|
-
/**
|
|
148
|
-
* HTTP GET /model/assetDescriptors
|
|
149
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
150
|
-
*/
|
|
151
|
-
getAssetDescriptors(queryParams?: {
|
|
152
|
-
parentId?: string;
|
|
153
|
-
parentType?: string;
|
|
154
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
155
|
-
/**
|
|
156
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
157
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
158
|
-
*/
|
|
159
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
160
|
-
parentId?: string;
|
|
161
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
162
|
-
/**
|
|
163
|
-
* HTTP GET /model/assetInfos
|
|
164
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
165
|
-
*/
|
|
166
|
-
getAssetInfos(queryParams?: {
|
|
167
|
-
parentId?: string;
|
|
168
|
-
parentType?: string;
|
|
169
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
170
|
-
/**
|
|
171
|
-
* HTTP GET /model/metaItemDescriptors
|
|
172
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
173
|
-
*/
|
|
174
|
-
getMetaItemDescriptors(queryParams?: {
|
|
175
|
-
parentId?: string;
|
|
176
|
-
}, options?: O): RestResponse<{
|
|
177
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
178
|
-
}>;
|
|
179
|
-
/**
|
|
180
|
-
* HTTP GET /model/valueDescriptors
|
|
181
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
182
|
-
*/
|
|
183
|
-
getValueDescriptors(queryParams?: {
|
|
184
|
-
parentId?: string;
|
|
185
|
-
}, options?: O): RestResponse<{
|
|
186
|
-
[index: string]: Model.ValueDescriptor;
|
|
187
|
-
}>;
|
|
188
|
-
}
|
|
189
|
-
export declare class NotificationResourceClient<O> {
|
|
190
|
-
protected httpClient: HttpClient<O>;
|
|
191
|
-
constructor(httpClient: HttpClient<O>);
|
|
192
|
-
/**
|
|
193
|
-
* HTTP GET /notification
|
|
194
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
195
|
-
*/
|
|
196
|
-
getNotifications(queryParams?: {
|
|
197
|
-
id?: number;
|
|
198
|
-
type?: string;
|
|
199
|
-
from?: number;
|
|
200
|
-
to?: number;
|
|
201
|
-
realmId?: string;
|
|
202
|
-
userId?: string;
|
|
203
|
-
assetId?: string;
|
|
204
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
205
|
-
/**
|
|
206
|
-
* HTTP DELETE /notification
|
|
207
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
208
|
-
*/
|
|
209
|
-
removeNotifications(queryParams?: {
|
|
210
|
-
id?: number;
|
|
211
|
-
type?: string;
|
|
212
|
-
from?: number;
|
|
213
|
-
to?: number;
|
|
214
|
-
realmId?: string;
|
|
215
|
-
userId?: string;
|
|
216
|
-
assetId?: string;
|
|
217
|
-
}, options?: O): RestResponse<void>;
|
|
218
|
-
/**
|
|
219
|
-
* HTTP POST /notification/alert
|
|
220
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
221
|
-
*/
|
|
222
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
223
|
-
/**
|
|
224
|
-
* HTTP DELETE /notification/{notificationId}
|
|
225
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
226
|
-
*/
|
|
227
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
228
|
-
/**
|
|
229
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
230
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
231
|
-
*/
|
|
232
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
233
|
-
targetId?: string;
|
|
234
|
-
}, options?: O): RestResponse<void>;
|
|
235
|
-
/**
|
|
236
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
237
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
238
|
-
*/
|
|
239
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
240
|
-
targetId?: string;
|
|
241
|
-
}, options?: O): RestResponse<void>;
|
|
242
|
-
}
|
|
243
|
-
export declare class ConfigurationResourceClient<O> {
|
|
244
|
-
protected httpClient: HttpClient<O>;
|
|
245
|
-
constructor(httpClient: HttpClient<O>);
|
|
246
|
-
/**
|
|
247
|
-
* HTTP GET /configuration/manager
|
|
248
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
249
|
-
*/
|
|
250
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
251
|
-
/**
|
|
252
|
-
* HTTP PUT /configuration/manager
|
|
253
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
254
|
-
*/
|
|
255
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
256
|
-
/**
|
|
257
|
-
* HTTP POST /configuration/manager/file
|
|
258
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
259
|
-
*/
|
|
260
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
261
|
-
path?: string;
|
|
262
|
-
}, options?: O): RestResponse<string>;
|
|
263
|
-
/**
|
|
264
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
265
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
266
|
-
*/
|
|
267
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
268
|
-
}
|
|
269
89
|
export declare class DashboardResourceClient<O> {
|
|
270
90
|
protected httpClient: HttpClient<O>;
|
|
271
91
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -300,20 +120,6 @@ export declare class DashboardResourceClient<O> {
|
|
|
300
120
|
*/
|
|
301
121
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
302
122
|
}
|
|
303
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
304
|
-
protected httpClient: HttpClient<O>;
|
|
305
|
-
constructor(httpClient: HttpClient<O>);
|
|
306
|
-
/**
|
|
307
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
308
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
309
|
-
*/
|
|
310
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
311
|
-
/**
|
|
312
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
313
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
314
|
-
*/
|
|
315
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
316
|
-
}
|
|
317
123
|
export declare class AlarmResourceClient<O> {
|
|
318
124
|
protected httpClient: HttpClient<O>;
|
|
319
125
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -367,34 +173,35 @@ export declare class AlarmResourceClient<O> {
|
|
|
367
173
|
realm?: string;
|
|
368
174
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
369
175
|
}
|
|
370
|
-
export declare class
|
|
176
|
+
export declare class MapResourceClient<O> {
|
|
371
177
|
protected httpClient: HttpClient<O>;
|
|
372
178
|
constructor(httpClient: HttpClient<O>);
|
|
373
179
|
/**
|
|
374
|
-
* HTTP
|
|
375
|
-
* Java method: org.openremote.model.
|
|
376
|
-
*/
|
|
377
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
378
|
-
/**
|
|
379
|
-
* HTTP DELETE /gateway/tunnel
|
|
380
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
180
|
+
* HTTP GET /map
|
|
181
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
381
182
|
*/
|
|
382
|
-
|
|
183
|
+
getSettings(options?: O): RestResponse<{
|
|
184
|
+
[id: string]: unknown;
|
|
185
|
+
}>;
|
|
383
186
|
/**
|
|
384
|
-
* HTTP
|
|
385
|
-
* Java method: org.openremote.model.
|
|
187
|
+
* HTTP PUT /map
|
|
188
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
386
189
|
*/
|
|
387
|
-
|
|
190
|
+
saveSettings(mapConfig: {
|
|
191
|
+
[index: string]: Model.MapRealmConfig;
|
|
192
|
+
}, options?: O): RestResponse<any>;
|
|
388
193
|
/**
|
|
389
|
-
* HTTP GET /
|
|
390
|
-
* Java method: org.openremote.model.
|
|
194
|
+
* HTTP GET /map/js
|
|
195
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
391
196
|
*/
|
|
392
|
-
|
|
197
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
198
|
+
[id: string]: unknown;
|
|
199
|
+
}>;
|
|
393
200
|
/**
|
|
394
|
-
* HTTP GET /
|
|
395
|
-
* Java method: org.openremote.model.
|
|
201
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
202
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
396
203
|
*/
|
|
397
|
-
|
|
204
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
398
205
|
}
|
|
399
206
|
export declare class UserResourceClient<O> {
|
|
400
207
|
protected httpClient: HttpClient<O>;
|
|
@@ -520,24 +327,108 @@ export declare class UserResourceClient<O> {
|
|
|
520
327
|
*/
|
|
521
328
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
522
329
|
}
|
|
523
|
-
export declare class
|
|
330
|
+
export declare class RealmResourceClient<O> {
|
|
524
331
|
protected httpClient: HttpClient<O>;
|
|
525
332
|
constructor(httpClient: HttpClient<O>);
|
|
526
333
|
/**
|
|
527
|
-
* HTTP
|
|
528
|
-
* Java method: org.openremote.model.
|
|
334
|
+
* HTTP POST /realm
|
|
335
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
529
336
|
*/
|
|
530
|
-
|
|
337
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
531
338
|
/**
|
|
532
|
-
* HTTP GET /
|
|
533
|
-
* Java method: org.openremote.model.
|
|
339
|
+
* HTTP GET /realm
|
|
340
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
534
341
|
*/
|
|
535
|
-
|
|
342
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
536
343
|
/**
|
|
537
|
-
* HTTP GET /
|
|
538
|
-
* Java method: org.openremote.model.
|
|
344
|
+
* HTTP GET /realm/accessible
|
|
345
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
346
|
+
*/
|
|
347
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
348
|
+
/**
|
|
349
|
+
* HTTP DELETE /realm/{name}
|
|
350
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
351
|
+
*/
|
|
352
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
353
|
+
/**
|
|
354
|
+
* HTTP GET /realm/{name}
|
|
355
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
356
|
+
*/
|
|
357
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
358
|
+
/**
|
|
359
|
+
* HTTP PUT /realm/{name}
|
|
360
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
361
|
+
*/
|
|
362
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
363
|
+
}
|
|
364
|
+
export declare class AssetModelResourceClient<O> {
|
|
365
|
+
protected httpClient: HttpClient<O>;
|
|
366
|
+
constructor(httpClient: HttpClient<O>);
|
|
367
|
+
/**
|
|
368
|
+
* HTTP GET /model/assetDescriptors
|
|
369
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
370
|
+
*/
|
|
371
|
+
getAssetDescriptors(queryParams?: {
|
|
372
|
+
parentId?: string;
|
|
373
|
+
parentType?: string;
|
|
374
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
375
|
+
/**
|
|
376
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
377
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
378
|
+
*/
|
|
379
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
380
|
+
parentId?: string;
|
|
381
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
382
|
+
/**
|
|
383
|
+
* HTTP GET /model/assetInfos
|
|
384
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
385
|
+
*/
|
|
386
|
+
getAssetInfos(queryParams?: {
|
|
387
|
+
parentId?: string;
|
|
388
|
+
parentType?: string;
|
|
389
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
390
|
+
/**
|
|
391
|
+
* HTTP GET /model/metaItemDescriptors
|
|
392
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
393
|
+
*/
|
|
394
|
+
getMetaItemDescriptors(queryParams?: {
|
|
395
|
+
parentId?: string;
|
|
396
|
+
}, options?: O): RestResponse<{
|
|
397
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
398
|
+
}>;
|
|
399
|
+
/**
|
|
400
|
+
* HTTP GET /model/valueDescriptors
|
|
401
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
402
|
+
*/
|
|
403
|
+
getValueDescriptors(queryParams?: {
|
|
404
|
+
parentId?: string;
|
|
405
|
+
}, options?: O): RestResponse<{
|
|
406
|
+
[index: string]: Model.ValueDescriptor;
|
|
407
|
+
}>;
|
|
408
|
+
}
|
|
409
|
+
export declare class ProvisioningResourceClient<O> {
|
|
410
|
+
protected httpClient: HttpClient<O>;
|
|
411
|
+
constructor(httpClient: HttpClient<O>);
|
|
412
|
+
/**
|
|
413
|
+
* HTTP POST /provisioning
|
|
414
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
415
|
+
*/
|
|
416
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
417
|
+
/**
|
|
418
|
+
* HTTP GET /provisioning
|
|
419
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
420
|
+
*/
|
|
421
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
422
|
+
/**
|
|
423
|
+
* HTTP DELETE /provisioning/{id}
|
|
424
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
425
|
+
*/
|
|
426
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
427
|
+
/**
|
|
428
|
+
* HTTP PUT /provisioning/{id}
|
|
429
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
539
430
|
*/
|
|
540
|
-
|
|
431
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
541
432
|
}
|
|
542
433
|
export declare class SyslogResourceClient<O> {
|
|
543
434
|
protected httpClient: HttpClient<O>;
|
|
@@ -571,6 +462,115 @@ export declare class SyslogResourceClient<O> {
|
|
|
571
462
|
subCategory?: string[];
|
|
572
463
|
}, options?: O): RestResponse<any>;
|
|
573
464
|
}
|
|
465
|
+
export declare class FlowResourceClient<O> {
|
|
466
|
+
protected httpClient: HttpClient<O>;
|
|
467
|
+
constructor(httpClient: HttpClient<O>);
|
|
468
|
+
/**
|
|
469
|
+
* HTTP GET /flow
|
|
470
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
471
|
+
*/
|
|
472
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
473
|
+
/**
|
|
474
|
+
* HTTP GET /flow/{name}
|
|
475
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
476
|
+
*/
|
|
477
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
478
|
+
/**
|
|
479
|
+
* HTTP GET /flow/{type}
|
|
480
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
481
|
+
*/
|
|
482
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
483
|
+
}
|
|
484
|
+
export declare class NotificationResourceClient<O> {
|
|
485
|
+
protected httpClient: HttpClient<O>;
|
|
486
|
+
constructor(httpClient: HttpClient<O>);
|
|
487
|
+
/**
|
|
488
|
+
* HTTP GET /notification
|
|
489
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
490
|
+
*/
|
|
491
|
+
getNotifications(queryParams?: {
|
|
492
|
+
id?: number;
|
|
493
|
+
type?: string;
|
|
494
|
+
from?: number;
|
|
495
|
+
to?: number;
|
|
496
|
+
realmId?: string;
|
|
497
|
+
userId?: string;
|
|
498
|
+
assetId?: string;
|
|
499
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
500
|
+
/**
|
|
501
|
+
* HTTP DELETE /notification
|
|
502
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
503
|
+
*/
|
|
504
|
+
removeNotifications(queryParams?: {
|
|
505
|
+
id?: number;
|
|
506
|
+
type?: string;
|
|
507
|
+
from?: number;
|
|
508
|
+
to?: number;
|
|
509
|
+
realmId?: string;
|
|
510
|
+
userId?: string;
|
|
511
|
+
assetId?: string;
|
|
512
|
+
}, options?: O): RestResponse<void>;
|
|
513
|
+
/**
|
|
514
|
+
* HTTP POST /notification/alert
|
|
515
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
516
|
+
*/
|
|
517
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
518
|
+
/**
|
|
519
|
+
* HTTP DELETE /notification/{notificationId}
|
|
520
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
521
|
+
*/
|
|
522
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
523
|
+
/**
|
|
524
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
525
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
526
|
+
*/
|
|
527
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
528
|
+
targetId?: string;
|
|
529
|
+
}, options?: O): RestResponse<void>;
|
|
530
|
+
/**
|
|
531
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
532
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
533
|
+
*/
|
|
534
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
535
|
+
targetId?: string;
|
|
536
|
+
}, options?: O): RestResponse<void>;
|
|
537
|
+
}
|
|
538
|
+
export declare class GatewayClientResourceClient<O> {
|
|
539
|
+
protected httpClient: HttpClient<O>;
|
|
540
|
+
constructor(httpClient: HttpClient<O>);
|
|
541
|
+
/**
|
|
542
|
+
* HTTP DELETE /gateway/connection
|
|
543
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
544
|
+
*/
|
|
545
|
+
deleteConnections(queryParams?: {
|
|
546
|
+
realm?: string[];
|
|
547
|
+
}, options?: O): RestResponse<void>;
|
|
548
|
+
/**
|
|
549
|
+
* HTTP GET /gateway/connection
|
|
550
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
551
|
+
*/
|
|
552
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
553
|
+
/**
|
|
554
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
555
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
556
|
+
*/
|
|
557
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
558
|
+
/**
|
|
559
|
+
* HTTP GET /gateway/connection/{realm}
|
|
560
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
561
|
+
*/
|
|
562
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
563
|
+
/**
|
|
564
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
565
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
566
|
+
*/
|
|
567
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
568
|
+
/**
|
|
569
|
+
* HTTP GET /gateway/status/{realm}
|
|
570
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
571
|
+
*/
|
|
572
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
573
|
+
}
|
|
574
574
|
export declare class RulesResourceClient<O> {
|
|
575
575
|
protected httpClient: HttpClient<O>;
|
|
576
576
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -662,164 +662,22 @@ export declare class RulesResourceClient<O> {
|
|
|
662
662
|
* HTTP PUT /rules/realm/{id}
|
|
663
663
|
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
664
664
|
*/
|
|
665
|
-
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
666
|
-
/**
|
|
667
|
-
* HTTP DELETE /rules/{id}
|
|
668
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
669
|
-
*/
|
|
670
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
671
|
-
/**
|
|
672
|
-
* HTTP GET /rules/{id}
|
|
673
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
674
|
-
*/
|
|
675
|
-
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
676
|
-
/**
|
|
677
|
-
* HTTP PUT /rules/{id}
|
|
678
|
-
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
679
|
-
*/
|
|
680
|
-
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
681
|
-
}
|
|
682
|
-
export declare class MapResourceClient<O> {
|
|
683
|
-
protected httpClient: HttpClient<O>;
|
|
684
|
-
constructor(httpClient: HttpClient<O>);
|
|
685
|
-
/**
|
|
686
|
-
* HTTP GET /map
|
|
687
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
688
|
-
*/
|
|
689
|
-
getSettings(options?: O): RestResponse<{
|
|
690
|
-
[id: string]: unknown;
|
|
691
|
-
}>;
|
|
692
|
-
/**
|
|
693
|
-
* HTTP PUT /map
|
|
694
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
695
|
-
*/
|
|
696
|
-
saveSettings(mapConfig: {
|
|
697
|
-
[index: string]: Model.MapRealmConfig;
|
|
698
|
-
}, options?: O): RestResponse<any>;
|
|
699
|
-
/**
|
|
700
|
-
* HTTP GET /map/js
|
|
701
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
702
|
-
*/
|
|
703
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
704
|
-
[id: string]: unknown;
|
|
705
|
-
}>;
|
|
706
|
-
/**
|
|
707
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
708
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
709
|
-
*/
|
|
710
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
711
|
-
}
|
|
712
|
-
export declare class ProvisioningResourceClient<O> {
|
|
713
|
-
protected httpClient: HttpClient<O>;
|
|
714
|
-
constructor(httpClient: HttpClient<O>);
|
|
715
|
-
/**
|
|
716
|
-
* HTTP POST /provisioning
|
|
717
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
718
|
-
*/
|
|
719
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
720
|
-
/**
|
|
721
|
-
* HTTP GET /provisioning
|
|
722
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
723
|
-
*/
|
|
724
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
725
|
-
/**
|
|
726
|
-
* HTTP DELETE /provisioning/{id}
|
|
727
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
728
|
-
*/
|
|
729
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
730
|
-
/**
|
|
731
|
-
* HTTP PUT /provisioning/{id}
|
|
732
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
733
|
-
*/
|
|
734
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
735
|
-
}
|
|
736
|
-
export declare class StatusResourceClient<O> {
|
|
737
|
-
protected httpClient: HttpClient<O>;
|
|
738
|
-
constructor(httpClient: HttpClient<O>);
|
|
739
|
-
/**
|
|
740
|
-
* HTTP GET /health
|
|
741
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
742
|
-
*/
|
|
743
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
744
|
-
[index: string]: any;
|
|
745
|
-
}>;
|
|
746
|
-
/**
|
|
747
|
-
* HTTP GET /info
|
|
748
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
749
|
-
*/
|
|
750
|
-
getInfo(options?: O): RestResponse<{
|
|
751
|
-
[index: string]: any;
|
|
752
|
-
}>;
|
|
753
|
-
}
|
|
754
|
-
export declare class RealmResourceClient<O> {
|
|
755
|
-
protected httpClient: HttpClient<O>;
|
|
756
|
-
constructor(httpClient: HttpClient<O>);
|
|
757
|
-
/**
|
|
758
|
-
* HTTP POST /realm
|
|
759
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
760
|
-
*/
|
|
761
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
762
|
-
/**
|
|
763
|
-
* HTTP GET /realm
|
|
764
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
765
|
-
*/
|
|
766
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
767
|
-
/**
|
|
768
|
-
* HTTP GET /realm/accessible
|
|
769
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
770
|
-
*/
|
|
771
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
772
|
-
/**
|
|
773
|
-
* HTTP DELETE /realm/{name}
|
|
774
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
775
|
-
*/
|
|
776
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
777
|
-
/**
|
|
778
|
-
* HTTP GET /realm/{name}
|
|
779
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
780
|
-
*/
|
|
781
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
782
|
-
/**
|
|
783
|
-
* HTTP PUT /realm/{name}
|
|
784
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
785
|
-
*/
|
|
786
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
787
|
-
}
|
|
788
|
-
export declare class GatewayClientResourceClient<O> {
|
|
789
|
-
protected httpClient: HttpClient<O>;
|
|
790
|
-
constructor(httpClient: HttpClient<O>);
|
|
791
|
-
/**
|
|
792
|
-
* HTTP DELETE /gateway/connection
|
|
793
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
794
|
-
*/
|
|
795
|
-
deleteConnections(queryParams?: {
|
|
796
|
-
realm?: string[];
|
|
797
|
-
}, options?: O): RestResponse<void>;
|
|
798
|
-
/**
|
|
799
|
-
* HTTP GET /gateway/connection
|
|
800
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
801
|
-
*/
|
|
802
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
803
|
-
/**
|
|
804
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
805
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
806
|
-
*/
|
|
807
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
665
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
808
666
|
/**
|
|
809
|
-
* HTTP
|
|
810
|
-
* Java method: org.openremote.model.
|
|
667
|
+
* HTTP DELETE /rules/{id}
|
|
668
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
811
669
|
*/
|
|
812
|
-
|
|
670
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
813
671
|
/**
|
|
814
|
-
* HTTP
|
|
815
|
-
* Java method: org.openremote.model.
|
|
672
|
+
* HTTP GET /rules/{id}
|
|
673
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
816
674
|
*/
|
|
817
|
-
|
|
675
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
818
676
|
/**
|
|
819
|
-
* HTTP
|
|
820
|
-
* Java method: org.openremote.model.
|
|
677
|
+
* HTTP PUT /rules/{id}
|
|
678
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
821
679
|
*/
|
|
822
|
-
|
|
680
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
823
681
|
}
|
|
824
682
|
export declare class AssetDatapointResourceClient<O> {
|
|
825
683
|
protected httpClient: HttpClient<O>;
|
|
@@ -847,6 +705,119 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
847
705
|
*/
|
|
848
706
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
849
707
|
}
|
|
708
|
+
export declare class ConsoleResourceClient<O> {
|
|
709
|
+
protected httpClient: HttpClient<O>;
|
|
710
|
+
constructor(httpClient: HttpClient<O>);
|
|
711
|
+
/**
|
|
712
|
+
* HTTP POST /console/register
|
|
713
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
714
|
+
*/
|
|
715
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
716
|
+
}
|
|
717
|
+
export declare class AssetResourceClient<O> {
|
|
718
|
+
protected httpClient: HttpClient<O>;
|
|
719
|
+
constructor(httpClient: HttpClient<O>);
|
|
720
|
+
/**
|
|
721
|
+
* HTTP POST /asset
|
|
722
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
723
|
+
*/
|
|
724
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
725
|
+
/**
|
|
726
|
+
* HTTP DELETE /asset
|
|
727
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
728
|
+
*/
|
|
729
|
+
delete(queryParams?: {
|
|
730
|
+
assetId?: string[];
|
|
731
|
+
}, options?: O): RestResponse<void>;
|
|
732
|
+
/**
|
|
733
|
+
* HTTP PUT /asset/attributes
|
|
734
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
735
|
+
*/
|
|
736
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
737
|
+
/**
|
|
738
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
739
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
740
|
+
*/
|
|
741
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
742
|
+
/**
|
|
743
|
+
* HTTP DELETE /asset/parent
|
|
744
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
745
|
+
*/
|
|
746
|
+
updateNoneParent(queryParams?: {
|
|
747
|
+
assetIds?: string[];
|
|
748
|
+
}, options?: O): RestResponse<void>;
|
|
749
|
+
/**
|
|
750
|
+
* HTTP GET /asset/partial/{assetId}
|
|
751
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
752
|
+
*/
|
|
753
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
754
|
+
/**
|
|
755
|
+
* HTTP POST /asset/query
|
|
756
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
757
|
+
*/
|
|
758
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
759
|
+
/**
|
|
760
|
+
* HTTP GET /asset/user/current
|
|
761
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
762
|
+
*/
|
|
763
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
764
|
+
/**
|
|
765
|
+
* HTTP POST /asset/user/link
|
|
766
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
767
|
+
*/
|
|
768
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
769
|
+
/**
|
|
770
|
+
* HTTP GET /asset/user/link
|
|
771
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
772
|
+
*/
|
|
773
|
+
getUserAssetLinks(queryParams?: {
|
|
774
|
+
realm?: string;
|
|
775
|
+
userId?: string;
|
|
776
|
+
assetId?: string;
|
|
777
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
778
|
+
/**
|
|
779
|
+
* HTTP POST /asset/user/link/delete
|
|
780
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
781
|
+
*/
|
|
782
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
783
|
+
/**
|
|
784
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
785
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
786
|
+
*/
|
|
787
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
788
|
+
/**
|
|
789
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
790
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
791
|
+
*/
|
|
792
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
793
|
+
/**
|
|
794
|
+
* HTTP GET /asset/{assetId}
|
|
795
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
796
|
+
*/
|
|
797
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
798
|
+
/**
|
|
799
|
+
* HTTP PUT /asset/{assetId}
|
|
800
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
801
|
+
*/
|
|
802
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
803
|
+
/**
|
|
804
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
805
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
806
|
+
*/
|
|
807
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
808
|
+
/**
|
|
809
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
810
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
811
|
+
*/
|
|
812
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
815
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
816
|
+
*/
|
|
817
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
818
|
+
assetIds?: string[];
|
|
819
|
+
}, options?: O): RestResponse<void>;
|
|
820
|
+
}
|
|
850
821
|
export declare class AgentResourceClient<O> {
|
|
851
822
|
protected httpClient: HttpClient<O>;
|
|
852
823
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -873,51 +844,80 @@ export declare class AgentResourceClient<O> {
|
|
|
873
844
|
realm?: string;
|
|
874
845
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
875
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
|
|
863
|
+
*/
|
|
864
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
865
|
+
/**
|
|
866
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
867
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
868
|
+
*/
|
|
869
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
870
|
+
/**
|
|
871
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
872
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
873
|
+
*/
|
|
874
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
875
|
+
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
879
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
880
|
-
protected _appResource: AxiosAppResourceClient;
|
|
881
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
882
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
883
878
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
884
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
885
879
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
880
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
881
|
+
protected _appResource: AxiosAppResourceClient;
|
|
882
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
886
883
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
887
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
888
|
-
protected _userResource: AxiosUserResourceClient;
|
|
889
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
890
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
891
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
892
884
|
protected _mapResource: AxiosMapResourceClient;
|
|
893
|
-
protected
|
|
894
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
885
|
+
protected _userResource: AxiosUserResourceClient;
|
|
895
886
|
protected _realmResource: AxiosRealmResourceClient;
|
|
887
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
888
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
889
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
890
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
891
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
896
892
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
893
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
897
894
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
895
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
896
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
898
897
|
protected _agentResource: AxiosAgentResourceClient;
|
|
898
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
901
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
902
|
-
get AppResource(): AxiosAppResourceClient;
|
|
903
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
904
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
905
900
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
906
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
907
901
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
902
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
903
|
+
get AppResource(): AxiosAppResourceClient;
|
|
904
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
908
905
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
909
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
910
|
-
get UserResource(): AxiosUserResourceClient;
|
|
911
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
912
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
913
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
914
906
|
get MapResource(): AxiosMapResourceClient;
|
|
915
|
-
get
|
|
916
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
907
|
+
get UserResource(): AxiosUserResourceClient;
|
|
917
908
|
get RealmResource(): AxiosRealmResourceClient;
|
|
909
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
910
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
911
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
912
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
913
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
918
914
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
915
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
919
916
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
917
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
918
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
920
919
|
get AgentResource(): AxiosAgentResourceClient;
|
|
920
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
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 AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
928
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
932
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
930
|
}
|
|
934
|
-
export declare class
|
|
931
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
935
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
933
|
}
|
|
937
|
-
export declare class
|
|
934
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
941
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
939
|
}
|
|
943
|
-
export declare class
|
|
940
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
|
-
export declare class
|
|
943
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
|
-
export declare class
|
|
946
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
|
-
export declare class
|
|
949
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
|
-
export declare class
|
|
952
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
956
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
954
|
}
|
|
958
|
-
export declare class
|
|
955
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
959
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
957
|
}
|
|
961
|
-
export declare class
|
|
958
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
962
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
960
|
}
|
|
964
961
|
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
965
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
963
|
}
|
|
967
|
-
export declare class
|
|
964
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
|
-
export declare class
|
|
970
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
974
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
972
|
}
|
|
976
|
-
export declare class
|
|
973
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
977
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
975
|
}
|
|
979
|
-
export declare class
|
|
976
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
980
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
978
|
}
|
|
982
|
-
export declare class
|
|
979
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<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
985
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
989
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
987
|
}
|
|
988
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
989
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
+
}
|