@openremote/rest 1.7.0-snapshot.20250623190503 → 1.7.0-snapshot.20250624090028
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +467 -467
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,6 +9,142 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
17
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
18
|
+
*/
|
|
19
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
20
|
+
/**
|
|
21
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
22
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
23
|
+
*/
|
|
24
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
25
|
+
}
|
|
26
|
+
export declare class AssetResourceClient<O> {
|
|
27
|
+
protected httpClient: HttpClient<O>;
|
|
28
|
+
constructor(httpClient: HttpClient<O>);
|
|
29
|
+
/**
|
|
30
|
+
* HTTP POST /asset
|
|
31
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
32
|
+
*/
|
|
33
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
34
|
+
/**
|
|
35
|
+
* HTTP DELETE /asset
|
|
36
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
37
|
+
*/
|
|
38
|
+
delete(queryParams?: {
|
|
39
|
+
assetId?: string[];
|
|
40
|
+
}, options?: O): RestResponse<void>;
|
|
41
|
+
/**
|
|
42
|
+
* HTTP PUT /asset/attributes
|
|
43
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
44
|
+
*/
|
|
45
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
46
|
+
/**
|
|
47
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
48
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
49
|
+
*/
|
|
50
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
51
|
+
/**
|
|
52
|
+
* HTTP DELETE /asset/parent
|
|
53
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
54
|
+
*/
|
|
55
|
+
updateNoneParent(queryParams?: {
|
|
56
|
+
assetIds?: string[];
|
|
57
|
+
}, options?: O): RestResponse<void>;
|
|
58
|
+
/**
|
|
59
|
+
* HTTP GET /asset/partial/{assetId}
|
|
60
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
61
|
+
*/
|
|
62
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
63
|
+
/**
|
|
64
|
+
* HTTP POST /asset/query
|
|
65
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
66
|
+
*/
|
|
67
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
68
|
+
/**
|
|
69
|
+
* HTTP GET /asset/user/current
|
|
70
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
71
|
+
*/
|
|
72
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
73
|
+
/**
|
|
74
|
+
* HTTP POST /asset/user/link
|
|
75
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
76
|
+
*/
|
|
77
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
78
|
+
/**
|
|
79
|
+
* HTTP GET /asset/user/link
|
|
80
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
81
|
+
*/
|
|
82
|
+
getUserAssetLinks(queryParams?: {
|
|
83
|
+
realm?: string;
|
|
84
|
+
userId?: string;
|
|
85
|
+
assetId?: string;
|
|
86
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
87
|
+
/**
|
|
88
|
+
* HTTP POST /asset/user/link/delete
|
|
89
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
90
|
+
*/
|
|
91
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
92
|
+
/**
|
|
93
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
94
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
95
|
+
*/
|
|
96
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
97
|
+
/**
|
|
98
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
99
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
100
|
+
*/
|
|
101
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
102
|
+
/**
|
|
103
|
+
* HTTP GET /asset/{assetId}
|
|
104
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
105
|
+
*/
|
|
106
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
107
|
+
/**
|
|
108
|
+
* HTTP PUT /asset/{assetId}
|
|
109
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
110
|
+
*/
|
|
111
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
112
|
+
/**
|
|
113
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
114
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
115
|
+
*/
|
|
116
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
117
|
+
/**
|
|
118
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
119
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
120
|
+
*/
|
|
121
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
122
|
+
/**
|
|
123
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
124
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
125
|
+
*/
|
|
126
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
127
|
+
assetIds?: string[];
|
|
128
|
+
}, options?: O): RestResponse<void>;
|
|
129
|
+
}
|
|
130
|
+
export declare class StatusResourceClient<O> {
|
|
131
|
+
protected httpClient: HttpClient<O>;
|
|
132
|
+
constructor(httpClient: HttpClient<O>);
|
|
133
|
+
/**
|
|
134
|
+
* HTTP GET /health
|
|
135
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
136
|
+
*/
|
|
137
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
138
|
+
[index: string]: any;
|
|
139
|
+
}>;
|
|
140
|
+
/**
|
|
141
|
+
* HTTP GET /info
|
|
142
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
143
|
+
*/
|
|
144
|
+
getInfo(options?: O): RestResponse<{
|
|
145
|
+
[index: string]: any;
|
|
146
|
+
}>;
|
|
147
|
+
}
|
|
12
148
|
export declare class SyslogResourceClient<O> {
|
|
13
149
|
protected httpClient: HttpClient<O>;
|
|
14
150
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -41,53 +177,137 @@ export declare class SyslogResourceClient<O> {
|
|
|
41
177
|
subCategory?: string[];
|
|
42
178
|
}, options?: O): RestResponse<any>;
|
|
43
179
|
}
|
|
44
|
-
export declare class
|
|
180
|
+
export declare class RealmResourceClient<O> {
|
|
45
181
|
protected httpClient: HttpClient<O>;
|
|
46
182
|
constructor(httpClient: HttpClient<O>);
|
|
47
183
|
/**
|
|
48
|
-
* HTTP
|
|
49
|
-
* Java method: org.openremote.model.
|
|
184
|
+
* HTTP POST /realm
|
|
185
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
50
186
|
*/
|
|
51
|
-
|
|
187
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
52
188
|
/**
|
|
53
|
-
* HTTP GET /
|
|
54
|
-
* Java method: org.openremote.model.
|
|
189
|
+
* HTTP GET /realm
|
|
190
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
55
191
|
*/
|
|
56
|
-
|
|
192
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
57
193
|
/**
|
|
58
|
-
* HTTP GET /
|
|
59
|
-
* Java method: org.openremote.model.
|
|
194
|
+
* HTTP GET /realm/accessible
|
|
195
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
60
196
|
*/
|
|
61
|
-
|
|
197
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
198
|
+
/**
|
|
199
|
+
* HTTP DELETE /realm/{name}
|
|
200
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
201
|
+
*/
|
|
202
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
203
|
+
/**
|
|
204
|
+
* HTTP GET /realm/{name}
|
|
205
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
206
|
+
*/
|
|
207
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
208
|
+
/**
|
|
209
|
+
* HTTP PUT /realm/{name}
|
|
210
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
211
|
+
*/
|
|
212
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
62
213
|
}
|
|
63
|
-
export declare class
|
|
214
|
+
export declare class AlarmResourceClient<O> {
|
|
64
215
|
protected httpClient: HttpClient<O>;
|
|
65
216
|
constructor(httpClient: HttpClient<O>);
|
|
66
217
|
/**
|
|
67
|
-
* HTTP POST /
|
|
68
|
-
* Java method: org.openremote.model.
|
|
218
|
+
* HTTP POST /alarm
|
|
219
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
69
220
|
*/
|
|
70
|
-
|
|
221
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
222
|
+
assetIds?: string[];
|
|
223
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
71
224
|
/**
|
|
72
|
-
* HTTP
|
|
73
|
-
* Java method: org.openremote.model.
|
|
225
|
+
* HTTP GET /alarm
|
|
226
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
74
227
|
*/
|
|
75
|
-
|
|
228
|
+
getAlarms(queryParams?: {
|
|
229
|
+
realm?: string;
|
|
230
|
+
status?: Model.AlarmStatus;
|
|
231
|
+
assetId?: string;
|
|
232
|
+
assigneeId?: string;
|
|
233
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
76
234
|
/**
|
|
77
|
-
* HTTP
|
|
78
|
-
* Java method: org.openremote.model.
|
|
235
|
+
* HTTP DELETE /alarm
|
|
236
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
79
237
|
*/
|
|
80
|
-
|
|
238
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
81
239
|
/**
|
|
82
|
-
* HTTP
|
|
83
|
-
* Java method: org.openremote.model.
|
|
240
|
+
* HTTP PUT /alarm/assets
|
|
241
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
84
242
|
*/
|
|
85
|
-
|
|
243
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
86
244
|
/**
|
|
87
|
-
* HTTP GET /
|
|
88
|
-
* Java method: org.openremote.model.
|
|
245
|
+
* HTTP GET /alarm/{alarmId}
|
|
246
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
89
247
|
*/
|
|
90
|
-
|
|
248
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
249
|
+
/**
|
|
250
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
251
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
252
|
+
*/
|
|
253
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
254
|
+
/**
|
|
255
|
+
* HTTP PUT /alarm/{alarmId}
|
|
256
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
257
|
+
*/
|
|
258
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
259
|
+
/**
|
|
260
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
261
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
262
|
+
*/
|
|
263
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
264
|
+
realm?: string;
|
|
265
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
266
|
+
}
|
|
267
|
+
export declare class AssetModelResourceClient<O> {
|
|
268
|
+
protected httpClient: HttpClient<O>;
|
|
269
|
+
constructor(httpClient: HttpClient<O>);
|
|
270
|
+
/**
|
|
271
|
+
* HTTP GET /model/assetDescriptors
|
|
272
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
273
|
+
*/
|
|
274
|
+
getAssetDescriptors(queryParams?: {
|
|
275
|
+
parentId?: string;
|
|
276
|
+
parentType?: string;
|
|
277
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
278
|
+
/**
|
|
279
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
280
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
281
|
+
*/
|
|
282
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
283
|
+
parentId?: string;
|
|
284
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
285
|
+
/**
|
|
286
|
+
* HTTP GET /model/assetInfos
|
|
287
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
288
|
+
*/
|
|
289
|
+
getAssetInfos(queryParams?: {
|
|
290
|
+
parentId?: string;
|
|
291
|
+
parentType?: string;
|
|
292
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
293
|
+
/**
|
|
294
|
+
* HTTP GET /model/metaItemDescriptors
|
|
295
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
296
|
+
*/
|
|
297
|
+
getMetaItemDescriptors(queryParams?: {
|
|
298
|
+
parentId?: string;
|
|
299
|
+
}, options?: O): RestResponse<{
|
|
300
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
301
|
+
}>;
|
|
302
|
+
/**
|
|
303
|
+
* HTTP GET /model/valueDescriptors
|
|
304
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
305
|
+
*/
|
|
306
|
+
getValueDescriptors(queryParams?: {
|
|
307
|
+
parentId?: string;
|
|
308
|
+
}, options?: O): RestResponse<{
|
|
309
|
+
[index: string]: Model.ValueDescriptor;
|
|
310
|
+
}>;
|
|
91
311
|
}
|
|
92
312
|
export declare class RulesResourceClient<O> {
|
|
93
313
|
protected httpClient: HttpClient<O>;
|
|
@@ -197,174 +417,110 @@ export declare class RulesResourceClient<O> {
|
|
|
197
417
|
*/
|
|
198
418
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
199
419
|
}
|
|
200
|
-
export declare class
|
|
201
|
-
protected httpClient: HttpClient<O>;
|
|
202
|
-
constructor(httpClient: HttpClient<O>);
|
|
203
|
-
/**
|
|
204
|
-
* HTTP POST /dashboard
|
|
205
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
206
|
-
*/
|
|
207
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
208
|
-
/**
|
|
209
|
-
* HTTP PUT /dashboard
|
|
210
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
211
|
-
*/
|
|
212
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
213
|
-
/**
|
|
214
|
-
* HTTP GET /dashboard/all/{realm}
|
|
215
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
216
|
-
*/
|
|
217
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
218
|
-
/**
|
|
219
|
-
* HTTP POST /dashboard/query
|
|
220
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
221
|
-
*/
|
|
222
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
223
|
-
/**
|
|
224
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
225
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
226
|
-
*/
|
|
227
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
228
|
-
/**
|
|
229
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
230
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
231
|
-
*/
|
|
232
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
233
|
-
}
|
|
234
|
-
export declare class RealmResourceClient<O> {
|
|
420
|
+
export declare class AgentResourceClient<O> {
|
|
235
421
|
protected httpClient: HttpClient<O>;
|
|
236
422
|
constructor(httpClient: HttpClient<O>);
|
|
237
423
|
/**
|
|
238
|
-
* HTTP
|
|
239
|
-
* Java method: org.openremote.model.
|
|
240
|
-
*/
|
|
241
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
242
|
-
/**
|
|
243
|
-
* HTTP GET /realm
|
|
244
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
245
|
-
*/
|
|
246
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
247
|
-
/**
|
|
248
|
-
* HTTP GET /realm/accessible
|
|
249
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
250
|
-
*/
|
|
251
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
252
|
-
/**
|
|
253
|
-
* HTTP DELETE /realm/{name}
|
|
254
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
255
|
-
*/
|
|
256
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
257
|
-
/**
|
|
258
|
-
* HTTP GET /realm/{name}
|
|
259
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
260
|
-
*/
|
|
261
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
262
|
-
/**
|
|
263
|
-
* HTTP PUT /realm/{name}
|
|
264
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
424
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
425
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
265
426
|
*/
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
protected httpClient: HttpClient<O>;
|
|
270
|
-
constructor(httpClient: HttpClient<O>);
|
|
427
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
428
|
+
realm?: string;
|
|
429
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
271
430
|
/**
|
|
272
|
-
* HTTP POST /
|
|
273
|
-
* Java method: org.openremote.model.
|
|
431
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
432
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
274
433
|
*/
|
|
275
|
-
|
|
434
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
435
|
+
realm?: string;
|
|
436
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
276
437
|
/**
|
|
277
|
-
* HTTP
|
|
278
|
-
* Java method: org.openremote.model.
|
|
438
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
439
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
279
440
|
*/
|
|
280
|
-
|
|
441
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
442
|
+
parentId?: string;
|
|
443
|
+
realm?: string;
|
|
444
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
281
445
|
}
|
|
282
|
-
export declare class
|
|
446
|
+
export declare class ConfigurationResourceClient<O> {
|
|
283
447
|
protected httpClient: HttpClient<O>;
|
|
284
448
|
constructor(httpClient: HttpClient<O>);
|
|
285
449
|
/**
|
|
286
|
-
* HTTP
|
|
287
|
-
* Java method: org.openremote.model.
|
|
450
|
+
* HTTP GET /configuration/manager
|
|
451
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
288
452
|
*/
|
|
289
|
-
|
|
453
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
290
454
|
/**
|
|
291
|
-
* HTTP
|
|
292
|
-
* Java method: org.openremote.model.
|
|
455
|
+
* HTTP PUT /configuration/manager
|
|
456
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
293
457
|
*/
|
|
294
|
-
|
|
458
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
295
459
|
/**
|
|
296
|
-
* HTTP
|
|
297
|
-
* Java method: org.openremote.model.
|
|
460
|
+
* HTTP POST /configuration/manager/file
|
|
461
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
298
462
|
*/
|
|
299
|
-
|
|
463
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
464
|
+
path?: string;
|
|
465
|
+
}, options?: O): RestResponse<string>;
|
|
300
466
|
/**
|
|
301
|
-
* HTTP
|
|
302
|
-
* Java method: org.openremote.model.
|
|
467
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
468
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
303
469
|
*/
|
|
304
|
-
|
|
470
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
305
471
|
}
|
|
306
|
-
export declare class
|
|
472
|
+
export declare class DashboardResourceClient<O> {
|
|
307
473
|
protected httpClient: HttpClient<O>;
|
|
308
474
|
constructor(httpClient: HttpClient<O>);
|
|
309
475
|
/**
|
|
310
|
-
* HTTP
|
|
311
|
-
* Java method: org.openremote.model.
|
|
476
|
+
* HTTP POST /dashboard
|
|
477
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
312
478
|
*/
|
|
313
|
-
|
|
314
|
-
id?: number;
|
|
315
|
-
type?: string;
|
|
316
|
-
from?: number;
|
|
317
|
-
to?: number;
|
|
318
|
-
realmId?: string;
|
|
319
|
-
userId?: string;
|
|
320
|
-
assetId?: string;
|
|
321
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
479
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
322
480
|
/**
|
|
323
|
-
* HTTP
|
|
324
|
-
* Java method: org.openremote.model.
|
|
481
|
+
* HTTP PUT /dashboard
|
|
482
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
325
483
|
*/
|
|
326
|
-
|
|
327
|
-
id?: number;
|
|
328
|
-
type?: string;
|
|
329
|
-
from?: number;
|
|
330
|
-
to?: number;
|
|
331
|
-
realmId?: string;
|
|
332
|
-
userId?: string;
|
|
333
|
-
assetId?: string;
|
|
334
|
-
}, options?: O): RestResponse<void>;
|
|
484
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
335
485
|
/**
|
|
336
|
-
* HTTP
|
|
337
|
-
* Java method: org.openremote.model.
|
|
486
|
+
* HTTP GET /dashboard/all/{realm}
|
|
487
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
338
488
|
*/
|
|
339
|
-
|
|
489
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
340
490
|
/**
|
|
341
|
-
* HTTP
|
|
342
|
-
* Java method: org.openremote.model.
|
|
491
|
+
* HTTP POST /dashboard/query
|
|
492
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
343
493
|
*/
|
|
344
|
-
|
|
494
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
345
495
|
/**
|
|
346
|
-
* HTTP
|
|
347
|
-
* Java method: org.openremote.model.
|
|
496
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
497
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
348
498
|
*/
|
|
349
|
-
|
|
350
|
-
targetId?: string;
|
|
351
|
-
}, options?: O): RestResponse<void>;
|
|
499
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
352
500
|
/**
|
|
353
|
-
* HTTP
|
|
354
|
-
* Java method: org.openremote.model.
|
|
501
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
502
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
355
503
|
*/
|
|
356
|
-
|
|
357
|
-
targetId?: string;
|
|
358
|
-
}, options?: O): RestResponse<void>;
|
|
504
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
359
505
|
}
|
|
360
|
-
export declare class
|
|
506
|
+
export declare class FlowResourceClient<O> {
|
|
361
507
|
protected httpClient: HttpClient<O>;
|
|
362
508
|
constructor(httpClient: HttpClient<O>);
|
|
363
509
|
/**
|
|
364
|
-
* HTTP
|
|
365
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP GET /flow
|
|
511
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
366
512
|
*/
|
|
367
|
-
|
|
513
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
514
|
+
/**
|
|
515
|
+
* HTTP GET /flow/{name}
|
|
516
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
517
|
+
*/
|
|
518
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
519
|
+
/**
|
|
520
|
+
* HTTP GET /flow/{type}
|
|
521
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
522
|
+
*/
|
|
523
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
368
524
|
}
|
|
369
525
|
export declare class MapResourceClient<O> {
|
|
370
526
|
protected httpClient: HttpClient<O>;
|
|
@@ -419,109 +575,41 @@ export declare class MapResourceClient<O> {
|
|
|
419
575
|
[id: string]: unknown;
|
|
420
576
|
}>;
|
|
421
577
|
}
|
|
422
|
-
export declare class
|
|
578
|
+
export declare class GatewayClientResourceClient<O> {
|
|
423
579
|
protected httpClient: HttpClient<O>;
|
|
424
580
|
constructor(httpClient: HttpClient<O>);
|
|
425
581
|
/**
|
|
426
|
-
* HTTP
|
|
427
|
-
* Java method: org.openremote.model.
|
|
428
|
-
*/
|
|
429
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
430
|
-
/**
|
|
431
|
-
* HTTP DELETE /asset
|
|
432
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
433
|
-
*/
|
|
434
|
-
delete(queryParams?: {
|
|
435
|
-
assetId?: string[];
|
|
436
|
-
}, options?: O): RestResponse<void>;
|
|
437
|
-
/**
|
|
438
|
-
* HTTP PUT /asset/attributes
|
|
439
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
440
|
-
*/
|
|
441
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
442
|
-
/**
|
|
443
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
444
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
445
|
-
*/
|
|
446
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
447
|
-
/**
|
|
448
|
-
* HTTP DELETE /asset/parent
|
|
449
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
582
|
+
* HTTP DELETE /gateway/connection
|
|
583
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
450
584
|
*/
|
|
451
|
-
|
|
452
|
-
|
|
585
|
+
deleteConnections(queryParams?: {
|
|
586
|
+
realm?: string[];
|
|
453
587
|
}, options?: O): RestResponse<void>;
|
|
454
588
|
/**
|
|
455
|
-
* HTTP GET /
|
|
456
|
-
* Java method: org.openremote.model.
|
|
457
|
-
*/
|
|
458
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
459
|
-
/**
|
|
460
|
-
* HTTP POST /asset/query
|
|
461
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
462
|
-
*/
|
|
463
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
464
|
-
/**
|
|
465
|
-
* HTTP GET /asset/user/current
|
|
466
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
467
|
-
*/
|
|
468
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
469
|
-
/**
|
|
470
|
-
* HTTP POST /asset/user/link
|
|
471
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
472
|
-
*/
|
|
473
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
474
|
-
/**
|
|
475
|
-
* HTTP GET /asset/user/link
|
|
476
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
477
|
-
*/
|
|
478
|
-
getUserAssetLinks(queryParams?: {
|
|
479
|
-
realm?: string;
|
|
480
|
-
userId?: string;
|
|
481
|
-
assetId?: string;
|
|
482
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
483
|
-
/**
|
|
484
|
-
* HTTP POST /asset/user/link/delete
|
|
485
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
486
|
-
*/
|
|
487
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
488
|
-
/**
|
|
489
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
490
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
491
|
-
*/
|
|
492
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
493
|
-
/**
|
|
494
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
495
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
496
|
-
*/
|
|
497
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
498
|
-
/**
|
|
499
|
-
* HTTP GET /asset/{assetId}
|
|
500
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
589
|
+
* HTTP GET /gateway/connection
|
|
590
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
501
591
|
*/
|
|
502
|
-
|
|
592
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
503
593
|
/**
|
|
504
|
-
* HTTP
|
|
505
|
-
* Java method: org.openremote.model.
|
|
594
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
595
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
506
596
|
*/
|
|
507
|
-
|
|
597
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
508
598
|
/**
|
|
509
|
-
* HTTP
|
|
510
|
-
* Java method: org.openremote.model.
|
|
599
|
+
* HTTP GET /gateway/connection/{realm}
|
|
600
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
511
601
|
*/
|
|
512
|
-
|
|
602
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
513
603
|
/**
|
|
514
|
-
* HTTP PUT /
|
|
515
|
-
* Java method: org.openremote.model.
|
|
604
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
605
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
516
606
|
*/
|
|
517
|
-
|
|
607
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
518
608
|
/**
|
|
519
|
-
* HTTP
|
|
520
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* HTTP GET /gateway/status/{realm}
|
|
610
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
521
611
|
*/
|
|
522
|
-
|
|
523
|
-
assetIds?: string[];
|
|
524
|
-
}, options?: O): RestResponse<void>;
|
|
612
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
525
613
|
}
|
|
526
614
|
export declare class AssetDatapointResourceClient<O> {
|
|
527
615
|
protected httpClient: HttpClient<O>;
|
|
@@ -549,157 +637,111 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
549
637
|
*/
|
|
550
638
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
551
639
|
}
|
|
552
|
-
export declare class
|
|
640
|
+
export declare class NotificationResourceClient<O> {
|
|
553
641
|
protected httpClient: HttpClient<O>;
|
|
554
642
|
constructor(httpClient: HttpClient<O>);
|
|
555
643
|
/**
|
|
556
|
-
* HTTP
|
|
557
|
-
* Java method: org.openremote.model.
|
|
558
|
-
*/
|
|
559
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
560
|
-
assetIds?: string[];
|
|
561
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
562
|
-
/**
|
|
563
|
-
* HTTP GET /alarm
|
|
564
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
644
|
+
* HTTP GET /notification
|
|
645
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
565
646
|
*/
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
647
|
+
getNotifications(queryParams?: {
|
|
648
|
+
id?: number;
|
|
649
|
+
type?: string;
|
|
650
|
+
from?: number;
|
|
651
|
+
to?: number;
|
|
652
|
+
realmId?: string;
|
|
653
|
+
userId?: string;
|
|
569
654
|
assetId?: string;
|
|
570
|
-
|
|
571
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
572
|
-
/**
|
|
573
|
-
* HTTP DELETE /alarm
|
|
574
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
575
|
-
*/
|
|
576
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
577
|
-
/**
|
|
578
|
-
* HTTP PUT /alarm/assets
|
|
579
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
580
|
-
*/
|
|
581
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
582
|
-
/**
|
|
583
|
-
* HTTP GET /alarm/{alarmId}
|
|
584
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
585
|
-
*/
|
|
586
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
587
|
-
/**
|
|
588
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
589
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
590
|
-
*/
|
|
591
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
592
|
-
/**
|
|
593
|
-
* HTTP PUT /alarm/{alarmId}
|
|
594
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
595
|
-
*/
|
|
596
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
597
|
-
/**
|
|
598
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
599
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
600
|
-
*/
|
|
601
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
602
|
-
realm?: string;
|
|
603
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
604
|
-
}
|
|
605
|
-
export declare class GatewayClientResourceClient<O> {
|
|
606
|
-
protected httpClient: HttpClient<O>;
|
|
607
|
-
constructor(httpClient: HttpClient<O>);
|
|
655
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
608
656
|
/**
|
|
609
|
-
* HTTP DELETE /
|
|
610
|
-
* Java method: org.openremote.model.
|
|
657
|
+
* HTTP DELETE /notification
|
|
658
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
611
659
|
*/
|
|
612
|
-
|
|
613
|
-
|
|
660
|
+
removeNotifications(queryParams?: {
|
|
661
|
+
id?: number;
|
|
662
|
+
type?: string;
|
|
663
|
+
from?: number;
|
|
664
|
+
to?: number;
|
|
665
|
+
realmId?: string;
|
|
666
|
+
userId?: string;
|
|
667
|
+
assetId?: string;
|
|
614
668
|
}, options?: O): RestResponse<void>;
|
|
615
669
|
/**
|
|
616
|
-
* HTTP
|
|
617
|
-
* Java method: org.openremote.model.
|
|
618
|
-
*/
|
|
619
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
620
|
-
/**
|
|
621
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
622
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
670
|
+
* HTTP POST /notification/alert
|
|
671
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
623
672
|
*/
|
|
624
|
-
|
|
673
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
625
674
|
/**
|
|
626
|
-
* HTTP
|
|
627
|
-
* Java method: org.openremote.model.
|
|
675
|
+
* HTTP DELETE /notification/{notificationId}
|
|
676
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
628
677
|
*/
|
|
629
|
-
|
|
678
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
630
679
|
/**
|
|
631
|
-
* HTTP PUT /
|
|
632
|
-
* Java method: org.openremote.model.
|
|
680
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
681
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
633
682
|
*/
|
|
634
|
-
|
|
683
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
684
|
+
targetId?: string;
|
|
685
|
+
}, options?: O): RestResponse<void>;
|
|
635
686
|
/**
|
|
636
|
-
* HTTP
|
|
637
|
-
* Java method: org.openremote.model.
|
|
687
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
688
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
638
689
|
*/
|
|
639
|
-
|
|
690
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
691
|
+
targetId?: string;
|
|
692
|
+
}, options?: O): RestResponse<void>;
|
|
640
693
|
}
|
|
641
|
-
export declare class
|
|
694
|
+
export declare class ProvisioningResourceClient<O> {
|
|
642
695
|
protected httpClient: HttpClient<O>;
|
|
643
696
|
constructor(httpClient: HttpClient<O>);
|
|
644
697
|
/**
|
|
645
|
-
* HTTP
|
|
646
|
-
* Java method: org.openremote.model.
|
|
698
|
+
* HTTP POST /provisioning
|
|
699
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
647
700
|
*/
|
|
648
|
-
|
|
649
|
-
parentId?: string;
|
|
650
|
-
parentType?: string;
|
|
651
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
701
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
652
702
|
/**
|
|
653
|
-
* HTTP GET /
|
|
654
|
-
* Java method: org.openremote.model.
|
|
703
|
+
* HTTP GET /provisioning
|
|
704
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
655
705
|
*/
|
|
656
|
-
|
|
657
|
-
parentId?: string;
|
|
658
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
706
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
659
707
|
/**
|
|
660
|
-
* HTTP
|
|
661
|
-
* Java method: org.openremote.model.
|
|
708
|
+
* HTTP DELETE /provisioning/{id}
|
|
709
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
662
710
|
*/
|
|
663
|
-
|
|
664
|
-
parentId?: string;
|
|
665
|
-
parentType?: string;
|
|
666
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
711
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
667
712
|
/**
|
|
668
|
-
* HTTP
|
|
669
|
-
* Java method: org.openremote.model.
|
|
713
|
+
* HTTP PUT /provisioning/{id}
|
|
714
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
670
715
|
*/
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
716
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
717
|
+
}
|
|
718
|
+
export declare class ConsoleResourceClient<O> {
|
|
719
|
+
protected httpClient: HttpClient<O>;
|
|
720
|
+
constructor(httpClient: HttpClient<O>);
|
|
676
721
|
/**
|
|
677
|
-
* HTTP
|
|
678
|
-
* Java method: org.openremote.model.
|
|
722
|
+
* HTTP POST /console/register
|
|
723
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
679
724
|
*/
|
|
680
|
-
|
|
681
|
-
parentId?: string;
|
|
682
|
-
}, options?: O): RestResponse<{
|
|
683
|
-
[index: string]: Model.ValueDescriptor;
|
|
684
|
-
}>;
|
|
725
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
685
726
|
}
|
|
686
|
-
export declare class
|
|
727
|
+
export declare class AppResourceClient<O> {
|
|
687
728
|
protected httpClient: HttpClient<O>;
|
|
688
729
|
constructor(httpClient: HttpClient<O>);
|
|
689
730
|
/**
|
|
690
|
-
* HTTP GET /
|
|
691
|
-
* Java method: org.openremote.model.
|
|
731
|
+
* HTTP GET /apps
|
|
732
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
692
733
|
*/
|
|
693
|
-
|
|
694
|
-
[index: string]: any;
|
|
695
|
-
}>;
|
|
734
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
696
735
|
/**
|
|
697
|
-
* HTTP GET /
|
|
698
|
-
* Java method: org.openremote.model.
|
|
736
|
+
* HTTP GET /apps/consoleConfig
|
|
737
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
699
738
|
*/
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
739
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
740
|
+
/**
|
|
741
|
+
* HTTP GET /apps/info
|
|
742
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
743
|
+
*/
|
|
744
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
703
745
|
}
|
|
704
746
|
export declare class UserResourceClient<O> {
|
|
705
747
|
protected httpClient: HttpClient<O>;
|
|
@@ -805,122 +847,80 @@ export declare class UserResourceClient<O> {
|
|
|
805
847
|
*/
|
|
806
848
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
807
849
|
}
|
|
808
|
-
export declare class
|
|
809
|
-
protected httpClient: HttpClient<O>;
|
|
810
|
-
constructor(httpClient: HttpClient<O>);
|
|
811
|
-
/**
|
|
812
|
-
* HTTP GET /configuration/manager
|
|
813
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
814
|
-
*/
|
|
815
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
816
|
-
/**
|
|
817
|
-
* HTTP PUT /configuration/manager
|
|
818
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
819
|
-
*/
|
|
820
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
821
|
-
/**
|
|
822
|
-
* HTTP POST /configuration/manager/file
|
|
823
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
824
|
-
*/
|
|
825
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
826
|
-
path?: string;
|
|
827
|
-
}, options?: O): RestResponse<string>;
|
|
828
|
-
/**
|
|
829
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
830
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
831
|
-
*/
|
|
832
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
833
|
-
}
|
|
834
|
-
export declare class FlowResourceClient<O> {
|
|
850
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
835
851
|
protected httpClient: HttpClient<O>;
|
|
836
852
|
constructor(httpClient: HttpClient<O>);
|
|
837
853
|
/**
|
|
838
|
-
* HTTP
|
|
839
|
-
* Java method: org.openremote.model.
|
|
840
|
-
*/
|
|
841
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
842
|
-
/**
|
|
843
|
-
* HTTP GET /flow/{name}
|
|
844
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
854
|
+
* HTTP POST /gateway/tunnel
|
|
855
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
845
856
|
*/
|
|
846
|
-
|
|
857
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
847
858
|
/**
|
|
848
|
-
* HTTP
|
|
849
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP DELETE /gateway/tunnel
|
|
860
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
850
861
|
*/
|
|
851
|
-
|
|
852
|
-
}
|
|
853
|
-
export declare class AgentResourceClient<O> {
|
|
854
|
-
protected httpClient: HttpClient<O>;
|
|
855
|
-
constructor(httpClient: HttpClient<O>);
|
|
862
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
856
863
|
/**
|
|
857
|
-
* HTTP GET /
|
|
858
|
-
* Java method: org.openremote.model.
|
|
864
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
865
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
859
866
|
*/
|
|
860
|
-
|
|
861
|
-
realm?: string;
|
|
862
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
867
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
863
868
|
/**
|
|
864
|
-
* HTTP
|
|
865
|
-
* Java method: org.openremote.model.
|
|
869
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
870
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
866
871
|
*/
|
|
867
|
-
|
|
868
|
-
realm?: string;
|
|
869
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
872
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
870
873
|
/**
|
|
871
|
-
* HTTP GET /
|
|
872
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
875
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
873
876
|
*/
|
|
874
|
-
|
|
875
|
-
parentId?: string;
|
|
876
|
-
realm?: string;
|
|
877
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
877
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
878
878
|
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
882
|
-
protected _appResource: AxiosAppResourceClient;
|
|
883
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
884
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
885
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
886
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
887
881
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
888
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
889
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
890
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
891
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
892
882
|
protected _assetResource: AxiosAssetResourceClient;
|
|
893
|
-
protected
|
|
883
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
884
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
885
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
894
886
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
895
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
896
887
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
897
|
-
protected
|
|
898
|
-
protected
|
|
888
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
889
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
899
890
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
891
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
900
892
|
protected _flowResource: AxiosFlowResourceClient;
|
|
901
|
-
protected
|
|
893
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
894
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
895
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
896
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
897
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
898
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
899
|
+
protected _appResource: AxiosAppResourceClient;
|
|
900
|
+
protected _userResource: AxiosUserResourceClient;
|
|
901
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
904
|
-
get AppResource(): AxiosAppResourceClient;
|
|
905
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
906
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
907
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
908
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
909
903
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
910
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
911
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
912
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
913
|
-
get MapResource(): AxiosMapResourceClient;
|
|
914
904
|
get AssetResource(): AxiosAssetResourceClient;
|
|
915
|
-
get
|
|
905
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
906
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
907
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
916
908
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
917
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
918
909
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
919
|
-
get
|
|
920
|
-
get
|
|
910
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
911
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
921
912
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
913
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
922
914
|
get FlowResource(): AxiosFlowResourceClient;
|
|
923
|
-
get
|
|
915
|
+
get MapResource(): AxiosMapResourceClient;
|
|
916
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
917
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
918
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
919
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
920
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
921
|
+
get AppResource(): AxiosAppResourceClient;
|
|
922
|
+
get UserResource(): AxiosUserResourceClient;
|
|
923
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
932
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
|
-
}
|
|
934
|
-
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
931
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
935
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
933
|
}
|
|
937
|
-
export declare class
|
|
934
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
941
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
939
|
}
|
|
943
|
-
export declare class
|
|
940
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
943
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
|
-
export declare class
|
|
946
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
|
-
export declare class
|
|
949
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
|
-
export declare class
|
|
952
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
956
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
954
|
}
|
|
958
|
-
export declare class
|
|
955
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
959
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
957
|
}
|
|
961
|
-
export declare class
|
|
958
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
962
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
960
|
}
|
|
964
|
-
export declare class
|
|
961
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
965
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
963
|
}
|
|
967
|
-
export declare class
|
|
964
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
970
|
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
974
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
972
|
}
|
|
976
|
-
export declare class
|
|
973
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
977
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
975
|
}
|
|
979
|
-
export declare class
|
|
976
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
980
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
978
|
}
|
|
982
|
-
export declare class
|
|
979
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
983
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
981
|
}
|
|
985
|
-
export declare class
|
|
982
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
986
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
984
|
}
|
|
988
|
-
export declare class
|
|
985
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
989
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
987
|
}
|
|
991
|
-
export declare class
|
|
988
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
989
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
+
}
|
|
991
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|