@openremote/rest 1.17.0 → 1.18.0-snapshot.20260207081312
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.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +606 -606
- package/lib/restclient.d.ts.map +1 -1
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +2 -2
package/lib/restclient.d.ts
CHANGED
|
@@ -9,151 +9,201 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class ConfigurationResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /configuration/manager
|
|
17
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /configuration/manager
|
|
22
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
23
23
|
*/
|
|
24
|
-
|
|
25
|
-
language?: Model.RulesetLang[];
|
|
26
|
-
fullyPopulate?: boolean;
|
|
27
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
24
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
28
25
|
/**
|
|
29
|
-
* HTTP POST /
|
|
30
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP POST /configuration/manager/file
|
|
27
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
31
28
|
*/
|
|
32
|
-
|
|
29
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
30
|
+
path?: string;
|
|
31
|
+
}, options?: O): RestResponse<string>;
|
|
33
32
|
/**
|
|
34
|
-
* HTTP GET /
|
|
35
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
34
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
36
35
|
*/
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
36
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
37
|
+
}
|
|
38
|
+
export declare class AssetResourceClient<O> {
|
|
39
|
+
protected httpClient: HttpClient<O>;
|
|
40
|
+
constructor(httpClient: HttpClient<O>);
|
|
41
41
|
/**
|
|
42
|
-
* HTTP
|
|
43
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP POST /asset
|
|
43
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
44
44
|
*/
|
|
45
|
-
|
|
45
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
46
46
|
/**
|
|
47
|
-
* HTTP
|
|
48
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP DELETE /asset
|
|
48
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
49
49
|
*/
|
|
50
|
-
|
|
50
|
+
delete(queryParams?: {
|
|
51
|
+
assetId?: string[];
|
|
52
|
+
}, options?: O): RestResponse<void>;
|
|
51
53
|
/**
|
|
52
|
-
* HTTP PUT /
|
|
53
|
-
* Java method: org.openremote.model.
|
|
54
|
+
* HTTP PUT /asset/attributes
|
|
55
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
54
56
|
*/
|
|
55
|
-
|
|
57
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
56
58
|
/**
|
|
57
|
-
* HTTP
|
|
58
|
-
* Java method: org.openremote.model.
|
|
59
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
60
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
59
61
|
*/
|
|
60
|
-
|
|
62
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
61
63
|
/**
|
|
62
|
-
* HTTP
|
|
63
|
-
* Java method: org.openremote.model.
|
|
64
|
+
* HTTP POST /asset/count
|
|
65
|
+
* Java method: org.openremote.model.asset.AssetResource.queryCount
|
|
64
66
|
*/
|
|
65
|
-
|
|
67
|
+
queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
|
|
66
68
|
/**
|
|
67
|
-
* HTTP
|
|
68
|
-
* Java method: org.openremote.model.
|
|
69
|
+
* HTTP DELETE /asset/parent
|
|
70
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
69
71
|
*/
|
|
70
|
-
|
|
72
|
+
updateNoneParent(queryParams?: {
|
|
73
|
+
assetIds?: string[];
|
|
74
|
+
}, options?: O): RestResponse<void>;
|
|
71
75
|
/**
|
|
72
|
-
* HTTP GET /
|
|
73
|
-
* Java method: org.openremote.model.
|
|
76
|
+
* HTTP GET /asset/partial/{assetId}
|
|
77
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
74
78
|
*/
|
|
75
|
-
|
|
79
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
76
80
|
/**
|
|
77
|
-
* HTTP POST /
|
|
78
|
-
* Java method: org.openremote.model.
|
|
81
|
+
* HTTP POST /asset/query
|
|
82
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
79
83
|
*/
|
|
80
|
-
|
|
84
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
81
85
|
/**
|
|
82
|
-
* HTTP
|
|
83
|
-
* Java method: org.openremote.model.
|
|
86
|
+
* HTTP POST /asset/tree
|
|
87
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
84
88
|
*/
|
|
85
|
-
|
|
86
|
-
language?: Model.RulesetLang[];
|
|
87
|
-
fullyPopulate?: boolean;
|
|
88
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
89
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
89
90
|
/**
|
|
90
|
-
* HTTP
|
|
91
|
-
* Java method: org.openremote.model.
|
|
91
|
+
* HTTP GET /asset/user/current
|
|
92
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
92
93
|
*/
|
|
93
|
-
|
|
94
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
94
95
|
/**
|
|
95
|
-
* HTTP
|
|
96
|
-
* Java method: org.openremote.model.
|
|
96
|
+
* HTTP POST /asset/user/link
|
|
97
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
97
98
|
*/
|
|
98
|
-
|
|
99
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
99
100
|
/**
|
|
100
|
-
* HTTP
|
|
101
|
-
* Java method: org.openremote.model.
|
|
101
|
+
* HTTP GET /asset/user/link
|
|
102
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
102
103
|
*/
|
|
103
|
-
|
|
104
|
+
getUserAssetLinks(queryParams?: {
|
|
105
|
+
realm?: string;
|
|
106
|
+
userId?: string;
|
|
107
|
+
assetId?: string;
|
|
108
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
104
109
|
/**
|
|
105
|
-
* HTTP
|
|
106
|
-
* Java method: org.openremote.model.
|
|
110
|
+
* HTTP POST /asset/user/link/delete
|
|
111
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
107
112
|
*/
|
|
108
|
-
|
|
113
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
109
114
|
/**
|
|
110
|
-
* HTTP
|
|
111
|
-
* Java method: org.openremote.model.
|
|
115
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
116
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
112
117
|
*/
|
|
113
|
-
|
|
118
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
114
119
|
/**
|
|
115
|
-
* HTTP
|
|
116
|
-
* Java method: org.openremote.model.
|
|
120
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
121
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
117
122
|
*/
|
|
118
|
-
|
|
123
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
124
|
+
/**
|
|
125
|
+
* HTTP GET /asset/{assetId}
|
|
126
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
127
|
+
*/
|
|
128
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
129
|
+
/**
|
|
130
|
+
* HTTP PUT /asset/{assetId}
|
|
131
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
132
|
+
*/
|
|
133
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
134
|
+
/**
|
|
135
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
136
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
137
|
+
*/
|
|
138
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
139
|
+
/**
|
|
140
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
141
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
142
|
+
*/
|
|
143
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
144
|
+
/**
|
|
145
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
146
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
147
|
+
*/
|
|
148
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
149
|
+
assetIds?: string[];
|
|
150
|
+
}, options?: O): RestResponse<void>;
|
|
119
151
|
}
|
|
120
|
-
export declare class
|
|
152
|
+
export declare class ProvisioningResourceClient<O> {
|
|
121
153
|
protected httpClient: HttpClient<O>;
|
|
122
154
|
constructor(httpClient: HttpClient<O>);
|
|
123
155
|
/**
|
|
124
|
-
* HTTP POST /
|
|
125
|
-
* Java method: org.openremote.model.
|
|
126
|
-
*/
|
|
127
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
128
|
-
/**
|
|
129
|
-
* HTTP DELETE /gateway/tunnel
|
|
130
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
156
|
+
* HTTP POST /provisioning
|
|
157
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
131
158
|
*/
|
|
132
|
-
|
|
159
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
133
160
|
/**
|
|
134
|
-
* HTTP GET /
|
|
135
|
-
* Java method: org.openremote.model.
|
|
161
|
+
* HTTP GET /provisioning
|
|
162
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
136
163
|
*/
|
|
137
|
-
|
|
164
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
138
165
|
/**
|
|
139
|
-
* HTTP
|
|
140
|
-
* Java method: org.openremote.model.
|
|
166
|
+
* HTTP DELETE /provisioning/{id}
|
|
167
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
141
168
|
*/
|
|
142
|
-
|
|
169
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
143
170
|
/**
|
|
144
|
-
* HTTP
|
|
145
|
-
* Java method: org.openremote.model.
|
|
171
|
+
* HTTP PUT /provisioning/{id}
|
|
172
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
146
173
|
*/
|
|
147
|
-
|
|
174
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
148
175
|
}
|
|
149
|
-
export declare class
|
|
176
|
+
export declare class SyslogResourceClient<O> {
|
|
150
177
|
protected httpClient: HttpClient<O>;
|
|
151
178
|
constructor(httpClient: HttpClient<O>);
|
|
152
179
|
/**
|
|
153
|
-
* HTTP
|
|
154
|
-
* Java method: org.openremote.model.
|
|
180
|
+
* HTTP GET /syslog/config
|
|
181
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
155
182
|
*/
|
|
156
|
-
|
|
183
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
184
|
+
/**
|
|
185
|
+
* HTTP PUT /syslog/config
|
|
186
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
187
|
+
*/
|
|
188
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
189
|
+
/**
|
|
190
|
+
* HTTP DELETE /syslog/event
|
|
191
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
192
|
+
*/
|
|
193
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
194
|
+
/**
|
|
195
|
+
* HTTP GET /syslog/event
|
|
196
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
197
|
+
*/
|
|
198
|
+
getEvents(queryParams?: {
|
|
199
|
+
level?: Model.SyslogLevel;
|
|
200
|
+
per_page?: number;
|
|
201
|
+
page?: number;
|
|
202
|
+
from?: number;
|
|
203
|
+
to?: number;
|
|
204
|
+
category?: Model.SyslogCategory[];
|
|
205
|
+
subCategory?: string[];
|
|
206
|
+
}, options?: O): RestResponse<any>;
|
|
157
207
|
}
|
|
158
208
|
export declare class ExternalServiceResourceClient<O> {
|
|
159
209
|
protected httpClient: HttpClient<O>;
|
|
@@ -210,129 +260,178 @@ export declare class ExternalServiceResourceClient<O> {
|
|
|
210
260
|
*/
|
|
211
261
|
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
212
262
|
}
|
|
213
|
-
export declare class
|
|
263
|
+
export declare class NotificationResourceClient<O> {
|
|
214
264
|
protected httpClient: HttpClient<O>;
|
|
215
265
|
constructor(httpClient: HttpClient<O>);
|
|
216
266
|
/**
|
|
217
|
-
* HTTP
|
|
218
|
-
* Java method: org.openremote.model.
|
|
219
|
-
*/
|
|
220
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
221
|
-
/**
|
|
222
|
-
* HTTP POST /user/query
|
|
223
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
267
|
+
* HTTP GET /notification
|
|
268
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
224
269
|
*/
|
|
225
|
-
|
|
270
|
+
getNotifications(queryParams?: {
|
|
271
|
+
id?: number;
|
|
272
|
+
type?: string;
|
|
273
|
+
from?: number;
|
|
274
|
+
to?: number;
|
|
275
|
+
realmId?: string;
|
|
276
|
+
userId?: string;
|
|
277
|
+
assetId?: string;
|
|
278
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
226
279
|
/**
|
|
227
|
-
* HTTP
|
|
228
|
-
* Java method: org.openremote.model.
|
|
280
|
+
* HTTP DELETE /notification
|
|
281
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
229
282
|
*/
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
283
|
+
removeNotifications(queryParams?: {
|
|
284
|
+
id?: number;
|
|
285
|
+
type?: string;
|
|
286
|
+
from?: number;
|
|
287
|
+
to?: number;
|
|
288
|
+
realmId?: string;
|
|
289
|
+
userId?: string;
|
|
290
|
+
assetId?: string;
|
|
291
|
+
}, options?: O): RestResponse<void>;
|
|
292
|
+
/**
|
|
293
|
+
* HTTP POST /notification/alert
|
|
294
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
234
295
|
*/
|
|
235
|
-
|
|
296
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
236
297
|
/**
|
|
237
|
-
* HTTP
|
|
238
|
-
* Java method: org.openremote.model.
|
|
298
|
+
* HTTP DELETE /notification/{notificationId}
|
|
299
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
239
300
|
*/
|
|
240
|
-
|
|
301
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
241
302
|
/**
|
|
242
|
-
* HTTP
|
|
243
|
-
* Java method: org.openremote.model.
|
|
303
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
304
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
244
305
|
*/
|
|
245
|
-
|
|
306
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
307
|
+
targetId?: string;
|
|
308
|
+
}, options?: O): RestResponse<void>;
|
|
246
309
|
/**
|
|
247
|
-
* HTTP
|
|
248
|
-
* Java method: org.openremote.model.
|
|
310
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
311
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
249
312
|
*/
|
|
250
|
-
|
|
313
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
314
|
+
targetId?: string;
|
|
315
|
+
}, options?: O): RestResponse<void>;
|
|
316
|
+
}
|
|
317
|
+
export declare class ConsoleResourceClient<O> {
|
|
318
|
+
protected httpClient: HttpClient<O>;
|
|
319
|
+
constructor(httpClient: HttpClient<O>);
|
|
251
320
|
/**
|
|
252
|
-
* HTTP
|
|
253
|
-
* Java method: org.openremote.model.
|
|
321
|
+
* HTTP POST /console/register
|
|
322
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
254
323
|
*/
|
|
255
|
-
|
|
324
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
325
|
+
}
|
|
326
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
327
|
+
protected httpClient: HttpClient<O>;
|
|
328
|
+
constructor(httpClient: HttpClient<O>);
|
|
256
329
|
/**
|
|
257
|
-
* HTTP
|
|
258
|
-
* Java method: org.openremote.model.
|
|
330
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
331
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
259
332
|
*/
|
|
260
|
-
|
|
333
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
261
334
|
/**
|
|
262
|
-
* HTTP PUT /
|
|
263
|
-
* Java method: org.openremote.model.
|
|
335
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
336
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
264
337
|
*/
|
|
265
|
-
|
|
338
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
339
|
+
}
|
|
340
|
+
export declare class RealmResourceClient<O> {
|
|
341
|
+
protected httpClient: HttpClient<O>;
|
|
342
|
+
constructor(httpClient: HttpClient<O>);
|
|
266
343
|
/**
|
|
267
|
-
* HTTP
|
|
268
|
-
* Java method: org.openremote.model.security.
|
|
344
|
+
* HTTP POST /realm
|
|
345
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
269
346
|
*/
|
|
270
|
-
|
|
347
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
271
348
|
/**
|
|
272
|
-
* HTTP GET /
|
|
273
|
-
* Java method: org.openremote.model.security.
|
|
349
|
+
* HTTP GET /realm
|
|
350
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
274
351
|
*/
|
|
275
|
-
|
|
352
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
276
353
|
/**
|
|
277
|
-
* HTTP
|
|
278
|
-
* Java method: org.openremote.model.security.
|
|
354
|
+
* HTTP GET /realm/accessible
|
|
355
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
279
356
|
*/
|
|
280
|
-
|
|
357
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
281
358
|
/**
|
|
282
|
-
* HTTP
|
|
283
|
-
* Java method: org.openremote.model.security.
|
|
359
|
+
* HTTP DELETE /realm/{name}
|
|
360
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
284
361
|
*/
|
|
285
|
-
|
|
362
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
286
363
|
/**
|
|
287
|
-
* HTTP
|
|
288
|
-
* Java method: org.openremote.model.security.
|
|
364
|
+
* HTTP GET /realm/{name}
|
|
365
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
289
366
|
*/
|
|
290
|
-
|
|
367
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
291
368
|
/**
|
|
292
|
-
* HTTP
|
|
293
|
-
* Java method: org.openremote.model.security.
|
|
369
|
+
* HTTP PUT /realm/{name}
|
|
370
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
294
371
|
*/
|
|
295
|
-
|
|
372
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
373
|
+
}
|
|
374
|
+
export declare class GatewayClientResourceClient<O> {
|
|
375
|
+
protected httpClient: HttpClient<O>;
|
|
376
|
+
constructor(httpClient: HttpClient<O>);
|
|
296
377
|
/**
|
|
297
|
-
* HTTP
|
|
298
|
-
* Java method: org.openremote.model.
|
|
378
|
+
* HTTP DELETE /gateway/connection
|
|
379
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
299
380
|
*/
|
|
300
|
-
|
|
381
|
+
deleteConnections(queryParams?: {
|
|
382
|
+
realm?: string[];
|
|
383
|
+
}, options?: O): RestResponse<void>;
|
|
301
384
|
/**
|
|
302
|
-
* HTTP GET /
|
|
303
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP GET /gateway/connection
|
|
386
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
304
387
|
*/
|
|
305
|
-
|
|
388
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
306
389
|
/**
|
|
307
|
-
* HTTP
|
|
308
|
-
* Java method: org.openremote.model.
|
|
390
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
391
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
309
392
|
*/
|
|
310
|
-
|
|
393
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
311
394
|
/**
|
|
312
|
-
* HTTP
|
|
313
|
-
* Java method: org.openremote.model.
|
|
395
|
+
* HTTP GET /gateway/connection/{realm}
|
|
396
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
314
397
|
*/
|
|
315
|
-
|
|
398
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
316
399
|
/**
|
|
317
|
-
* HTTP
|
|
318
|
-
* Java method: org.openremote.model.
|
|
400
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
401
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
319
402
|
*/
|
|
320
|
-
|
|
403
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
321
404
|
/**
|
|
322
|
-
* HTTP GET /
|
|
323
|
-
* Java method: org.openremote.model.
|
|
405
|
+
* HTTP GET /gateway/status/{realm}
|
|
406
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
324
407
|
*/
|
|
325
|
-
|
|
408
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
409
|
+
}
|
|
410
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
411
|
+
protected httpClient: HttpClient<O>;
|
|
412
|
+
constructor(httpClient: HttpClient<O>);
|
|
326
413
|
/**
|
|
327
|
-
* HTTP
|
|
328
|
-
* Java method: org.openremote.model.
|
|
414
|
+
* HTTP GET /asset/datapoint/export
|
|
415
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
329
416
|
*/
|
|
330
|
-
|
|
417
|
+
getDatapointExport(queryParams?: {
|
|
418
|
+
attributeRefs?: string;
|
|
419
|
+
fromTimestamp?: number;
|
|
420
|
+
toTimestamp?: number;
|
|
421
|
+
}, options?: O): RestResponse<any>;
|
|
331
422
|
/**
|
|
332
|
-
* HTTP GET /
|
|
333
|
-
* Java method: org.openremote.model.
|
|
423
|
+
* HTTP GET /asset/datapoint/periods
|
|
424
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
334
425
|
*/
|
|
335
|
-
|
|
426
|
+
getDatapointPeriod(queryParams?: {
|
|
427
|
+
assetId?: string;
|
|
428
|
+
attributeName?: string;
|
|
429
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
430
|
+
/**
|
|
431
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
432
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
433
|
+
*/
|
|
434
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
336
435
|
}
|
|
337
436
|
export declare class DashboardResourceClient<O> {
|
|
338
437
|
protected httpClient: HttpClient<O>;
|
|
@@ -368,46 +467,6 @@ export declare class DashboardResourceClient<O> {
|
|
|
368
467
|
*/
|
|
369
468
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
370
469
|
}
|
|
371
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
372
|
-
protected httpClient: HttpClient<O>;
|
|
373
|
-
constructor(httpClient: HttpClient<O>);
|
|
374
|
-
/**
|
|
375
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
376
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
377
|
-
*/
|
|
378
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
379
|
-
/**
|
|
380
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
381
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
382
|
-
*/
|
|
383
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
384
|
-
}
|
|
385
|
-
export declare class AgentResourceClient<O> {
|
|
386
|
-
protected httpClient: HttpClient<O>;
|
|
387
|
-
constructor(httpClient: HttpClient<O>);
|
|
388
|
-
/**
|
|
389
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
390
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
391
|
-
*/
|
|
392
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
393
|
-
realm?: string;
|
|
394
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
395
|
-
/**
|
|
396
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
397
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
398
|
-
*/
|
|
399
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
400
|
-
realm?: string;
|
|
401
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
402
|
-
/**
|
|
403
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
404
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
405
|
-
*/
|
|
406
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
407
|
-
parentId?: string;
|
|
408
|
-
realm?: string;
|
|
409
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
410
|
-
}
|
|
411
470
|
export declare class MapResourceClient<O> {
|
|
412
471
|
protected httpClient: HttpClient<O>;
|
|
413
472
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -454,561 +513,502 @@ export declare class MapResourceClient<O> {
|
|
|
454
513
|
[id: string]: unknown;
|
|
455
514
|
}>;
|
|
456
515
|
}
|
|
457
|
-
export declare class
|
|
516
|
+
export declare class RulesResourceClient<O> {
|
|
458
517
|
protected httpClient: HttpClient<O>;
|
|
459
518
|
constructor(httpClient: HttpClient<O>);
|
|
460
519
|
/**
|
|
461
|
-
* HTTP
|
|
462
|
-
* Java method: org.openremote.model.
|
|
520
|
+
* HTTP POST /rules
|
|
521
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
463
522
|
*/
|
|
464
|
-
|
|
465
|
-
[index: string]: any;
|
|
466
|
-
}>;
|
|
523
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
467
524
|
/**
|
|
468
|
-
* HTTP GET /
|
|
469
|
-
* Java method: org.openremote.model.
|
|
525
|
+
* HTTP GET /rules
|
|
526
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
470
527
|
*/
|
|
471
|
-
|
|
472
|
-
[
|
|
473
|
-
|
|
474
|
-
}
|
|
475
|
-
export declare class AssetModelResourceClient<O> {
|
|
476
|
-
protected httpClient: HttpClient<O>;
|
|
477
|
-
constructor(httpClient: HttpClient<O>);
|
|
528
|
+
getGlobalRulesets(queryParams?: {
|
|
529
|
+
language?: Model.RulesetLang[];
|
|
530
|
+
fullyPopulate?: boolean;
|
|
531
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
478
532
|
/**
|
|
479
|
-
* HTTP
|
|
480
|
-
* Java method: org.openremote.model.
|
|
533
|
+
* HTTP POST /rules/asset
|
|
534
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
481
535
|
*/
|
|
482
|
-
|
|
483
|
-
parentId?: string;
|
|
484
|
-
parentType?: string;
|
|
485
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
536
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
486
537
|
/**
|
|
487
|
-
* HTTP GET /
|
|
488
|
-
* Java method: org.openremote.model.
|
|
538
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
539
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
489
540
|
*/
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
* HTTP GET /model/assetInfos
|
|
495
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
496
|
-
*/
|
|
497
|
-
getAssetInfos(queryParams?: {
|
|
498
|
-
parentId?: string;
|
|
499
|
-
parentType?: string;
|
|
500
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
541
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
542
|
+
language?: Model.RulesetLang[];
|
|
543
|
+
fullyPopulate?: boolean;
|
|
544
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
501
545
|
/**
|
|
502
|
-
* HTTP
|
|
503
|
-
* Java method: org.openremote.model.
|
|
546
|
+
* HTTP DELETE /rules/asset/{id}
|
|
547
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
504
548
|
*/
|
|
505
|
-
|
|
506
|
-
name?: string;
|
|
507
|
-
hash?: string;
|
|
508
|
-
}, options?: O): RestResponse<any>;
|
|
549
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
509
550
|
/**
|
|
510
|
-
* HTTP GET /
|
|
511
|
-
* Java method: org.openremote.model.
|
|
551
|
+
* HTTP GET /rules/asset/{id}
|
|
552
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
512
553
|
*/
|
|
513
|
-
|
|
514
|
-
parentId?: string;
|
|
515
|
-
}, options?: O): RestResponse<{
|
|
516
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
517
|
-
}>;
|
|
554
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
518
555
|
/**
|
|
519
|
-
* HTTP
|
|
520
|
-
* Java method: org.openremote.model.
|
|
556
|
+
* HTTP PUT /rules/asset/{id}
|
|
557
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
521
558
|
*/
|
|
522
|
-
|
|
523
|
-
parentId?: string;
|
|
524
|
-
}, options?: O): RestResponse<{
|
|
525
|
-
[index: string]: Model.ValueDescriptor;
|
|
526
|
-
}>;
|
|
527
|
-
}
|
|
528
|
-
export declare class GatewayClientResourceClient<O> {
|
|
529
|
-
protected httpClient: HttpClient<O>;
|
|
530
|
-
constructor(httpClient: HttpClient<O>);
|
|
559
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
531
560
|
/**
|
|
532
|
-
* HTTP
|
|
533
|
-
* Java method: org.openremote.model.
|
|
561
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
562
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
534
563
|
*/
|
|
535
|
-
|
|
536
|
-
realm?: string[];
|
|
537
|
-
}, options?: O): RestResponse<void>;
|
|
564
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
538
565
|
/**
|
|
539
|
-
* HTTP GET /
|
|
540
|
-
* Java method: org.openremote.model.
|
|
566
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
567
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
541
568
|
*/
|
|
542
|
-
|
|
569
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
543
570
|
/**
|
|
544
|
-
* HTTP
|
|
545
|
-
* Java method: org.openremote.model.
|
|
571
|
+
* HTTP GET /rules/info/global
|
|
572
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
546
573
|
*/
|
|
547
|
-
|
|
574
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
548
575
|
/**
|
|
549
|
-
* HTTP GET /
|
|
550
|
-
* Java method: org.openremote.model.
|
|
576
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
577
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
551
578
|
*/
|
|
552
|
-
|
|
579
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
553
580
|
/**
|
|
554
|
-
* HTTP
|
|
555
|
-
* Java method: org.openremote.model.
|
|
581
|
+
* HTTP POST /rules/realm
|
|
582
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
556
583
|
*/
|
|
557
|
-
|
|
584
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
558
585
|
/**
|
|
559
|
-
* HTTP GET /
|
|
560
|
-
* Java method: org.openremote.model.
|
|
586
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
587
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
561
588
|
*/
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
constructor(httpClient: HttpClient<O>);
|
|
589
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
590
|
+
language?: Model.RulesetLang[];
|
|
591
|
+
fullyPopulate?: boolean;
|
|
592
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
567
593
|
/**
|
|
568
|
-
* HTTP
|
|
569
|
-
* Java method: org.openremote.model.
|
|
594
|
+
* HTTP DELETE /rules/realm/{id}
|
|
595
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
570
596
|
*/
|
|
571
|
-
|
|
597
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
572
598
|
/**
|
|
573
|
-
* HTTP GET /realm
|
|
574
|
-
* Java method: org.openremote.model.
|
|
599
|
+
* HTTP GET /rules/realm/{id}
|
|
600
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
575
601
|
*/
|
|
576
|
-
|
|
602
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
577
603
|
/**
|
|
578
|
-
* HTTP
|
|
579
|
-
* Java method: org.openremote.model.
|
|
604
|
+
* HTTP PUT /rules/realm/{id}
|
|
605
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
580
606
|
*/
|
|
581
|
-
|
|
607
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
582
608
|
/**
|
|
583
|
-
* HTTP DELETE /
|
|
584
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* HTTP DELETE /rules/{id}
|
|
610
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
585
611
|
*/
|
|
586
|
-
|
|
612
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
587
613
|
/**
|
|
588
|
-
* HTTP GET /
|
|
589
|
-
* Java method: org.openremote.model.
|
|
614
|
+
* HTTP GET /rules/{id}
|
|
615
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
590
616
|
*/
|
|
591
|
-
|
|
617
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
592
618
|
/**
|
|
593
|
-
* HTTP PUT /
|
|
594
|
-
* Java method: org.openremote.model.
|
|
619
|
+
* HTTP PUT /rules/{id}
|
|
620
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
595
621
|
*/
|
|
596
|
-
|
|
622
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
597
623
|
}
|
|
598
|
-
export declare class
|
|
624
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
599
625
|
protected httpClient: HttpClient<O>;
|
|
600
626
|
constructor(httpClient: HttpClient<O>);
|
|
601
627
|
/**
|
|
602
|
-
* HTTP
|
|
603
|
-
* Java method: org.openremote.model.
|
|
628
|
+
* HTTP POST /gateway/tunnel
|
|
629
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
604
630
|
*/
|
|
605
|
-
|
|
631
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
606
632
|
/**
|
|
607
|
-
* HTTP
|
|
608
|
-
* Java method: org.openremote.model.
|
|
633
|
+
* HTTP DELETE /gateway/tunnel
|
|
634
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
609
635
|
*/
|
|
610
|
-
|
|
636
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
611
637
|
/**
|
|
612
|
-
* HTTP GET /
|
|
613
|
-
* Java method: org.openremote.model.
|
|
638
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
639
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
614
640
|
*/
|
|
615
|
-
|
|
616
|
-
}
|
|
617
|
-
export declare class AlarmResourceClient<O> {
|
|
618
|
-
protected httpClient: HttpClient<O>;
|
|
619
|
-
constructor(httpClient: HttpClient<O>);
|
|
641
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
620
642
|
/**
|
|
621
|
-
* HTTP
|
|
622
|
-
* Java method: org.openremote.model.
|
|
643
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
644
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
623
645
|
*/
|
|
624
|
-
|
|
625
|
-
assetIds?: string[];
|
|
626
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
646
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
627
647
|
/**
|
|
628
|
-
* HTTP GET /
|
|
629
|
-
* Java method: org.openremote.model.
|
|
648
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
649
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
630
650
|
*/
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
651
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
652
|
+
}
|
|
653
|
+
export declare class AgentResourceClient<O> {
|
|
654
|
+
protected httpClient: HttpClient<O>;
|
|
655
|
+
constructor(httpClient: HttpClient<O>);
|
|
637
656
|
/**
|
|
638
|
-
* HTTP
|
|
639
|
-
* Java method: org.openremote.model.
|
|
657
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
658
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
640
659
|
*/
|
|
641
|
-
|
|
660
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
661
|
+
realm?: string;
|
|
662
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
642
663
|
/**
|
|
643
|
-
* HTTP
|
|
644
|
-
* Java method: org.openremote.model.
|
|
664
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
665
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
645
666
|
*/
|
|
646
|
-
|
|
667
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
668
|
+
realm?: string;
|
|
669
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
647
670
|
/**
|
|
648
|
-
* HTTP GET /
|
|
649
|
-
* Java method: org.openremote.model.
|
|
671
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
672
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
650
673
|
*/
|
|
651
|
-
|
|
674
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
675
|
+
parentId?: string;
|
|
676
|
+
realm?: string;
|
|
677
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
678
|
+
}
|
|
679
|
+
export declare class AppResourceClient<O> {
|
|
680
|
+
protected httpClient: HttpClient<O>;
|
|
681
|
+
constructor(httpClient: HttpClient<O>);
|
|
652
682
|
/**
|
|
653
|
-
* HTTP
|
|
654
|
-
* Java method: org.openremote.model.
|
|
683
|
+
* HTTP GET /apps
|
|
684
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
655
685
|
*/
|
|
656
|
-
|
|
686
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
657
687
|
/**
|
|
658
|
-
* HTTP
|
|
659
|
-
* Java method: org.openremote.model.
|
|
688
|
+
* HTTP GET /apps/consoleConfig
|
|
689
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
660
690
|
*/
|
|
661
|
-
|
|
691
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
662
692
|
/**
|
|
663
|
-
* HTTP GET /
|
|
664
|
-
* Java method: org.openremote.model.
|
|
693
|
+
* HTTP GET /apps/info
|
|
694
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
665
695
|
*/
|
|
666
|
-
|
|
667
|
-
realm?: string;
|
|
668
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
696
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
669
697
|
}
|
|
670
|
-
export declare class
|
|
698
|
+
export declare class UserResourceClient<O> {
|
|
671
699
|
protected httpClient: HttpClient<O>;
|
|
672
700
|
constructor(httpClient: HttpClient<O>);
|
|
673
701
|
/**
|
|
674
|
-
* HTTP
|
|
675
|
-
* Java method: org.openremote.model.
|
|
702
|
+
* HTTP PUT /user/locale
|
|
703
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
676
704
|
*/
|
|
677
|
-
|
|
705
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
678
706
|
/**
|
|
679
|
-
* HTTP
|
|
680
|
-
* Java method: org.openremote.model.
|
|
707
|
+
* HTTP POST /user/query
|
|
708
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
681
709
|
*/
|
|
682
|
-
|
|
683
|
-
assetId?: string[];
|
|
684
|
-
}, options?: O): RestResponse<void>;
|
|
710
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
685
711
|
/**
|
|
686
|
-
* HTTP PUT /
|
|
687
|
-
* Java method: org.openremote.model.
|
|
712
|
+
* HTTP PUT /user/request-password-reset
|
|
713
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
688
714
|
*/
|
|
689
|
-
|
|
715
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
690
716
|
/**
|
|
691
|
-
* HTTP PUT /
|
|
692
|
-
* Java method: org.openremote.model.
|
|
717
|
+
* HTTP PUT /user/reset-password
|
|
718
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
693
719
|
*/
|
|
694
|
-
|
|
720
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
695
721
|
/**
|
|
696
|
-
* HTTP
|
|
697
|
-
* Java method: org.openremote.model.
|
|
722
|
+
* HTTP PUT /user/update
|
|
723
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
698
724
|
*/
|
|
699
|
-
|
|
725
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
700
726
|
/**
|
|
701
|
-
* HTTP
|
|
702
|
-
* Java method: org.openremote.model.
|
|
727
|
+
* HTTP GET /user/user
|
|
728
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
703
729
|
*/
|
|
704
|
-
|
|
705
|
-
assetIds?: string[];
|
|
706
|
-
}, options?: O): RestResponse<void>;
|
|
730
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
707
731
|
/**
|
|
708
|
-
* HTTP GET /
|
|
709
|
-
* Java method: org.openremote.model.
|
|
732
|
+
* HTTP GET /user/userRealmRoles
|
|
733
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
710
734
|
*/
|
|
711
|
-
|
|
735
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
712
736
|
/**
|
|
713
|
-
* HTTP
|
|
714
|
-
* Java method: org.openremote.model.
|
|
737
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
738
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
715
739
|
*/
|
|
716
|
-
|
|
740
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
717
741
|
/**
|
|
718
|
-
* HTTP
|
|
719
|
-
* Java method: org.openremote.model.
|
|
742
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
743
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
720
744
|
*/
|
|
721
|
-
|
|
745
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
722
746
|
/**
|
|
723
|
-
* HTTP
|
|
724
|
-
* Java method: org.openremote.model.
|
|
747
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
748
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
725
749
|
*/
|
|
726
|
-
|
|
750
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
727
751
|
/**
|
|
728
|
-
* HTTP
|
|
729
|
-
* Java method: org.openremote.model.
|
|
752
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
753
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
730
754
|
*/
|
|
731
|
-
|
|
755
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
732
756
|
/**
|
|
733
|
-
* HTTP GET /
|
|
734
|
-
* Java method: org.openremote.model.
|
|
757
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
758
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
735
759
|
*/
|
|
736
|
-
|
|
737
|
-
realm?: string;
|
|
738
|
-
userId?: string;
|
|
739
|
-
assetId?: string;
|
|
740
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
760
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
741
761
|
/**
|
|
742
|
-
* HTTP
|
|
743
|
-
* Java method: org.openremote.model.
|
|
762
|
+
* HTTP PUT /user/{realm}/roles
|
|
763
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
744
764
|
*/
|
|
745
|
-
|
|
765
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
746
766
|
/**
|
|
747
|
-
* HTTP
|
|
748
|
-
* Java method: org.openremote.model.
|
|
767
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
768
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
749
769
|
*/
|
|
750
|
-
|
|
770
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
751
771
|
/**
|
|
752
|
-
* HTTP
|
|
753
|
-
* Java method: org.openremote.model.
|
|
772
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
773
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
754
774
|
*/
|
|
755
|
-
|
|
775
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
756
776
|
/**
|
|
757
|
-
* HTTP GET /
|
|
758
|
-
* Java method: org.openremote.model.
|
|
777
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
778
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
759
779
|
*/
|
|
760
|
-
|
|
780
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
761
781
|
/**
|
|
762
|
-
* HTTP PUT /
|
|
763
|
-
* Java method: org.openremote.model.
|
|
782
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
783
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
764
784
|
*/
|
|
765
|
-
|
|
785
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
766
786
|
/**
|
|
767
|
-
* HTTP
|
|
768
|
-
* Java method: org.openremote.model.
|
|
787
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
788
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
769
789
|
*/
|
|
770
|
-
|
|
790
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
771
791
|
/**
|
|
772
|
-
* HTTP
|
|
773
|
-
* Java method: org.openremote.model.
|
|
792
|
+
* HTTP POST /user/{realm}/users
|
|
793
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
774
794
|
*/
|
|
775
|
-
|
|
795
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
776
796
|
/**
|
|
777
|
-
* HTTP PUT /
|
|
778
|
-
* Java method: org.openremote.model.
|
|
797
|
+
* HTTP PUT /user/{realm}/users
|
|
798
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
779
799
|
*/
|
|
780
|
-
|
|
781
|
-
assetIds?: string[];
|
|
782
|
-
}, options?: O): RestResponse<void>;
|
|
783
|
-
}
|
|
784
|
-
export declare class ProvisioningResourceClient<O> {
|
|
785
|
-
protected httpClient: HttpClient<O>;
|
|
786
|
-
constructor(httpClient: HttpClient<O>);
|
|
800
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
787
801
|
/**
|
|
788
|
-
* HTTP
|
|
789
|
-
* Java method: org.openremote.model.
|
|
802
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
803
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
790
804
|
*/
|
|
791
|
-
|
|
805
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
792
806
|
/**
|
|
793
|
-
* HTTP GET /
|
|
794
|
-
* Java method: org.openremote.model.
|
|
807
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
808
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
795
809
|
*/
|
|
796
|
-
|
|
810
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
797
811
|
/**
|
|
798
|
-
* HTTP
|
|
799
|
-
* Java method: org.openremote.model.
|
|
812
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
813
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
800
814
|
*/
|
|
801
|
-
|
|
815
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
802
816
|
/**
|
|
803
|
-
* HTTP
|
|
804
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP GET /user/{realm}/{userId}
|
|
818
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
805
819
|
*/
|
|
806
|
-
|
|
820
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
807
821
|
}
|
|
808
|
-
export declare class
|
|
822
|
+
export declare class StatusResourceClient<O> {
|
|
809
823
|
protected httpClient: HttpClient<O>;
|
|
810
824
|
constructor(httpClient: HttpClient<O>);
|
|
811
825
|
/**
|
|
812
|
-
* HTTP GET /
|
|
813
|
-
* Java method: org.openremote.model.
|
|
826
|
+
* HTTP GET /health
|
|
827
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
814
828
|
*/
|
|
815
|
-
|
|
829
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
830
|
+
[index: string]: any;
|
|
831
|
+
}>;
|
|
816
832
|
/**
|
|
817
|
-
* HTTP
|
|
818
|
-
* Java method: org.openremote.model.
|
|
833
|
+
* HTTP GET /info
|
|
834
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
819
835
|
*/
|
|
820
|
-
|
|
836
|
+
getInfo(options?: O): RestResponse<{
|
|
837
|
+
[index: string]: any;
|
|
838
|
+
}>;
|
|
839
|
+
}
|
|
840
|
+
export declare class AssetModelResourceClient<O> {
|
|
841
|
+
protected httpClient: HttpClient<O>;
|
|
842
|
+
constructor(httpClient: HttpClient<O>);
|
|
821
843
|
/**
|
|
822
|
-
* HTTP
|
|
823
|
-
* Java method: org.openremote.model.
|
|
844
|
+
* HTTP GET /model/assetDescriptors
|
|
845
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
824
846
|
*/
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
847
|
+
getAssetDescriptors(queryParams?: {
|
|
848
|
+
parentId?: string;
|
|
849
|
+
parentType?: string;
|
|
850
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
828
851
|
/**
|
|
829
|
-
* HTTP GET /
|
|
830
|
-
* Java method: org.openremote.model.
|
|
852
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
853
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
831
854
|
*/
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
protected httpClient: HttpClient<O>;
|
|
836
|
-
constructor(httpClient: HttpClient<O>);
|
|
855
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
856
|
+
parentId?: string;
|
|
857
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
837
858
|
/**
|
|
838
|
-
* HTTP GET /
|
|
839
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP GET /model/assetInfos
|
|
860
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
840
861
|
*/
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
862
|
+
getAssetInfos(queryParams?: {
|
|
863
|
+
parentId?: string;
|
|
864
|
+
parentType?: string;
|
|
865
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
866
|
+
/**
|
|
867
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
868
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
869
|
+
*/
|
|
870
|
+
getValueDescriptorSchema(queryParams?: {
|
|
871
|
+
name?: string;
|
|
872
|
+
hash?: string;
|
|
845
873
|
}, options?: O): RestResponse<any>;
|
|
846
874
|
/**
|
|
847
|
-
* HTTP GET /
|
|
848
|
-
* Java method: org.openremote.model.
|
|
875
|
+
* HTTP GET /model/metaItemDescriptors
|
|
876
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
849
877
|
*/
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
878
|
+
getMetaItemDescriptors(queryParams?: {
|
|
879
|
+
parentId?: string;
|
|
880
|
+
}, options?: O): RestResponse<{
|
|
881
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
882
|
+
}>;
|
|
854
883
|
/**
|
|
855
|
-
* HTTP
|
|
856
|
-
* Java method: org.openremote.model.
|
|
884
|
+
* HTTP GET /model/valueDescriptors
|
|
885
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
857
886
|
*/
|
|
858
|
-
|
|
887
|
+
getValueDescriptors(queryParams?: {
|
|
888
|
+
parentId?: string;
|
|
889
|
+
}, options?: O): RestResponse<{
|
|
890
|
+
[index: string]: Model.ValueDescriptor;
|
|
891
|
+
}>;
|
|
859
892
|
}
|
|
860
|
-
export declare class
|
|
893
|
+
export declare class AlarmResourceClient<O> {
|
|
861
894
|
protected httpClient: HttpClient<O>;
|
|
862
895
|
constructor(httpClient: HttpClient<O>);
|
|
863
896
|
/**
|
|
864
|
-
* HTTP
|
|
865
|
-
* Java method: org.openremote.model.
|
|
897
|
+
* HTTP POST /alarm
|
|
898
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
866
899
|
*/
|
|
867
|
-
|
|
900
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
901
|
+
assetIds?: string[];
|
|
902
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
868
903
|
/**
|
|
869
|
-
* HTTP GET /
|
|
870
|
-
* Java method: org.openremote.model.
|
|
904
|
+
* HTTP GET /alarm
|
|
905
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
871
906
|
*/
|
|
872
|
-
|
|
907
|
+
getAlarms(queryParams?: {
|
|
908
|
+
realm?: string;
|
|
909
|
+
status?: Model.AlarmStatus;
|
|
910
|
+
assetId?: string;
|
|
911
|
+
assigneeId?: string;
|
|
912
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
873
913
|
/**
|
|
874
|
-
* HTTP
|
|
875
|
-
* Java method: org.openremote.model.
|
|
914
|
+
* HTTP DELETE /alarm
|
|
915
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
876
916
|
*/
|
|
877
|
-
|
|
878
|
-
}
|
|
879
|
-
export declare class SyslogResourceClient<O> {
|
|
880
|
-
protected httpClient: HttpClient<O>;
|
|
881
|
-
constructor(httpClient: HttpClient<O>);
|
|
917
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
882
918
|
/**
|
|
883
|
-
* HTTP
|
|
884
|
-
* Java method: org.openremote.model.
|
|
919
|
+
* HTTP PUT /alarm/assets
|
|
920
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
885
921
|
*/
|
|
886
|
-
|
|
922
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
887
923
|
/**
|
|
888
|
-
* HTTP
|
|
889
|
-
* Java method: org.openremote.model.
|
|
924
|
+
* HTTP GET /alarm/{alarmId}
|
|
925
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
890
926
|
*/
|
|
891
|
-
|
|
927
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
892
928
|
/**
|
|
893
|
-
* HTTP DELETE /
|
|
894
|
-
* Java method: org.openremote.model.
|
|
929
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
930
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
895
931
|
*/
|
|
896
|
-
|
|
932
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
897
933
|
/**
|
|
898
|
-
* HTTP
|
|
899
|
-
* Java method: org.openremote.model.
|
|
934
|
+
* HTTP PUT /alarm/{alarmId}
|
|
935
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
900
936
|
*/
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
}, options?: O): RestResponse<any>;
|
|
937
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
938
|
+
/**
|
|
939
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
940
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
941
|
+
*/
|
|
942
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
943
|
+
realm?: string;
|
|
944
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
910
945
|
}
|
|
911
|
-
export declare class
|
|
946
|
+
export declare class FlowResourceClient<O> {
|
|
912
947
|
protected httpClient: HttpClient<O>;
|
|
913
948
|
constructor(httpClient: HttpClient<O>);
|
|
914
949
|
/**
|
|
915
|
-
* HTTP GET /
|
|
916
|
-
* Java method: org.openremote.model.
|
|
917
|
-
*/
|
|
918
|
-
getNotifications(queryParams?: {
|
|
919
|
-
id?: number;
|
|
920
|
-
type?: string;
|
|
921
|
-
from?: number;
|
|
922
|
-
to?: number;
|
|
923
|
-
realmId?: string;
|
|
924
|
-
userId?: string;
|
|
925
|
-
assetId?: string;
|
|
926
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
927
|
-
/**
|
|
928
|
-
* HTTP DELETE /notification
|
|
929
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
930
|
-
*/
|
|
931
|
-
removeNotifications(queryParams?: {
|
|
932
|
-
id?: number;
|
|
933
|
-
type?: string;
|
|
934
|
-
from?: number;
|
|
935
|
-
to?: number;
|
|
936
|
-
realmId?: string;
|
|
937
|
-
userId?: string;
|
|
938
|
-
assetId?: string;
|
|
939
|
-
}, options?: O): RestResponse<void>;
|
|
940
|
-
/**
|
|
941
|
-
* HTTP POST /notification/alert
|
|
942
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
943
|
-
*/
|
|
944
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
945
|
-
/**
|
|
946
|
-
* HTTP DELETE /notification/{notificationId}
|
|
947
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
950
|
+
* HTTP GET /flow
|
|
951
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
948
952
|
*/
|
|
949
|
-
|
|
953
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
950
954
|
/**
|
|
951
|
-
* HTTP
|
|
952
|
-
* Java method: org.openremote.model.
|
|
955
|
+
* HTTP GET /flow/{name}
|
|
956
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
953
957
|
*/
|
|
954
|
-
|
|
955
|
-
targetId?: string;
|
|
956
|
-
}, options?: O): RestResponse<void>;
|
|
958
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
957
959
|
/**
|
|
958
|
-
* HTTP
|
|
959
|
-
* Java method: org.openremote.model.
|
|
960
|
+
* HTTP GET /flow/{type}
|
|
961
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
960
962
|
*/
|
|
961
|
-
|
|
962
|
-
targetId?: string;
|
|
963
|
-
}, options?: O): RestResponse<void>;
|
|
963
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
964
964
|
}
|
|
965
965
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
966
966
|
export declare class ApiClient {
|
|
967
|
-
protected
|
|
968
|
-
protected
|
|
969
|
-
protected
|
|
967
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
968
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
969
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
970
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
970
971
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
971
|
-
protected
|
|
972
|
-
protected
|
|
972
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
973
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
973
974
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
974
|
-
protected
|
|
975
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
976
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
977
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
978
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
975
979
|
protected _mapResource: AxiosMapResourceClient;
|
|
980
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
981
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
982
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
983
|
+
protected _appResource: AxiosAppResourceClient;
|
|
984
|
+
protected _userResource: AxiosUserResourceClient;
|
|
976
985
|
protected _statusResource: AxiosStatusResourceClient;
|
|
977
986
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
978
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
979
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
980
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
981
987
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
982
|
-
protected
|
|
983
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
984
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
985
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
986
|
-
protected _appResource: AxiosAppResourceClient;
|
|
987
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
988
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
988
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
-
get
|
|
991
|
-
get
|
|
992
|
-
get
|
|
990
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
991
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
992
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
993
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
993
994
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
994
|
-
get
|
|
995
|
-
get
|
|
995
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
996
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
996
997
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
997
|
-
get
|
|
998
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
999
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1000
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1001
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
998
1002
|
get MapResource(): AxiosMapResourceClient;
|
|
1003
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1004
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1005
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1006
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1007
|
+
get UserResource(): AxiosUserResourceClient;
|
|
999
1008
|
get StatusResource(): AxiosStatusResourceClient;
|
|
1000
1009
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1001
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1002
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1003
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1004
1010
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1005
|
-
get
|
|
1006
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1007
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1008
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1009
|
-
get AppResource(): AxiosAppResourceClient;
|
|
1010
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1011
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1011
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1012
1012
|
}
|
|
1013
1013
|
import * as Axios from "axios";
|
|
1014
1014
|
declare module "axios" {
|
|
@@ -1016,70 +1016,70 @@ declare module "axios" {
|
|
|
1016
1016
|
data: R;
|
|
1017
1017
|
}
|
|
1018
1018
|
}
|
|
1019
|
-
export declare class
|
|
1019
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1020
1020
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1021
1021
|
}
|
|
1022
|
-
export declare class
|
|
1022
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1023
1023
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1024
1024
|
}
|
|
1025
|
-
export declare class
|
|
1025
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1026
1026
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1027
1027
|
}
|
|
1028
|
-
export declare class
|
|
1028
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1029
1029
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1030
1030
|
}
|
|
1031
|
-
export declare class
|
|
1031
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1032
1032
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1033
1033
|
}
|
|
1034
|
-
export declare class
|
|
1034
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1035
1035
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1036
1036
|
}
|
|
1037
|
-
export declare class
|
|
1037
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1038
1038
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1039
1039
|
}
|
|
1040
|
-
export declare class
|
|
1040
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1041
1041
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1042
1042
|
}
|
|
1043
|
-
export declare class
|
|
1043
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1044
1044
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1045
1045
|
}
|
|
1046
|
-
export declare class
|
|
1046
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1047
1047
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1048
1048
|
}
|
|
1049
|
-
export declare class
|
|
1049
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1050
1050
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1051
1051
|
}
|
|
1052
|
-
export declare class
|
|
1052
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1053
1053
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1054
1054
|
}
|
|
1055
|
-
export declare class
|
|
1055
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1056
1056
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1057
1057
|
}
|
|
1058
|
-
export declare class
|
|
1058
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1059
1059
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1060
1060
|
}
|
|
1061
|
-
export declare class
|
|
1061
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1062
1062
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1063
1063
|
}
|
|
1064
|
-
export declare class
|
|
1064
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1065
1065
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1066
1066
|
}
|
|
1067
|
-
export declare class
|
|
1067
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1068
1068
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1069
1069
|
}
|
|
1070
|
-
export declare class
|
|
1070
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1071
1071
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1072
1072
|
}
|
|
1073
|
-
export declare class
|
|
1073
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1074
1074
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1075
1075
|
}
|
|
1076
|
-
export declare class
|
|
1076
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1077
1077
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1078
1078
|
}
|
|
1079
|
-
export declare class
|
|
1079
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1080
1080
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1081
1081
|
}
|
|
1082
|
-
export declare class
|
|
1082
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1083
1083
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1084
1084
|
}
|
|
1085
1085
|
//# sourceMappingURL=restclient.d.ts.map
|