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