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