@openremote/rest 1.8.0-snapshot.20250808124803 → 1.8.0-snapshot.20250811074902
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +458 -458
- 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,42 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class GatewayClientResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP DELETE /gateway/connection
|
|
17
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
18
|
+
*/
|
|
19
|
+
deleteConnections(queryParams?: {
|
|
20
|
+
realm?: string[];
|
|
21
|
+
}, options?: O): RestResponse<void>;
|
|
22
|
+
/**
|
|
23
|
+
* HTTP GET /gateway/connection
|
|
24
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
25
|
+
*/
|
|
26
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
27
|
+
/**
|
|
28
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
30
|
+
*/
|
|
31
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
32
|
+
/**
|
|
33
|
+
* HTTP GET /gateway/connection/{realm}
|
|
34
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
35
|
+
*/
|
|
36
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
37
|
+
/**
|
|
38
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
39
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
40
|
+
*/
|
|
41
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
42
|
+
/**
|
|
43
|
+
* HTTP GET /gateway/status/{realm}
|
|
44
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
45
|
+
*/
|
|
46
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
47
|
+
}
|
|
12
48
|
export declare class FlowResourceClient<O> {
|
|
13
49
|
protected httpClient: HttpClient<O>;
|
|
14
50
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -28,6 +64,167 @@ export declare class FlowResourceClient<O> {
|
|
|
28
64
|
*/
|
|
29
65
|
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
30
66
|
}
|
|
67
|
+
export declare class AppResourceClient<O> {
|
|
68
|
+
protected httpClient: HttpClient<O>;
|
|
69
|
+
constructor(httpClient: HttpClient<O>);
|
|
70
|
+
/**
|
|
71
|
+
* HTTP GET /apps
|
|
72
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
73
|
+
*/
|
|
74
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
75
|
+
/**
|
|
76
|
+
* HTTP GET /apps/consoleConfig
|
|
77
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
78
|
+
*/
|
|
79
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
80
|
+
/**
|
|
81
|
+
* HTTP GET /apps/info
|
|
82
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
83
|
+
*/
|
|
84
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
85
|
+
}
|
|
86
|
+
export declare class RealmResourceClient<O> {
|
|
87
|
+
protected httpClient: HttpClient<O>;
|
|
88
|
+
constructor(httpClient: HttpClient<O>);
|
|
89
|
+
/**
|
|
90
|
+
* HTTP POST /realm
|
|
91
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
92
|
+
*/
|
|
93
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
94
|
+
/**
|
|
95
|
+
* HTTP GET /realm
|
|
96
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
97
|
+
*/
|
|
98
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
99
|
+
/**
|
|
100
|
+
* HTTP GET /realm/accessible
|
|
101
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
102
|
+
*/
|
|
103
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
104
|
+
/**
|
|
105
|
+
* HTTP DELETE /realm/{name}
|
|
106
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
107
|
+
*/
|
|
108
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
109
|
+
/**
|
|
110
|
+
* HTTP GET /realm/{name}
|
|
111
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
112
|
+
*/
|
|
113
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
114
|
+
/**
|
|
115
|
+
* HTTP PUT /realm/{name}
|
|
116
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
117
|
+
*/
|
|
118
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
119
|
+
}
|
|
120
|
+
export declare class RulesResourceClient<O> {
|
|
121
|
+
protected httpClient: HttpClient<O>;
|
|
122
|
+
constructor(httpClient: HttpClient<O>);
|
|
123
|
+
/**
|
|
124
|
+
* HTTP POST /rules
|
|
125
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
126
|
+
*/
|
|
127
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
128
|
+
/**
|
|
129
|
+
* HTTP GET /rules
|
|
130
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
131
|
+
*/
|
|
132
|
+
getGlobalRulesets(queryParams?: {
|
|
133
|
+
language?: Model.RulesetLang[];
|
|
134
|
+
fullyPopulate?: boolean;
|
|
135
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
136
|
+
/**
|
|
137
|
+
* HTTP POST /rules/asset
|
|
138
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
139
|
+
*/
|
|
140
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
141
|
+
/**
|
|
142
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
143
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
144
|
+
*/
|
|
145
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
146
|
+
language?: Model.RulesetLang[];
|
|
147
|
+
fullyPopulate?: boolean;
|
|
148
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
149
|
+
/**
|
|
150
|
+
* HTTP DELETE /rules/asset/{id}
|
|
151
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
152
|
+
*/
|
|
153
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
154
|
+
/**
|
|
155
|
+
* HTTP GET /rules/asset/{id}
|
|
156
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
157
|
+
*/
|
|
158
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
159
|
+
/**
|
|
160
|
+
* HTTP PUT /rules/asset/{id}
|
|
161
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
162
|
+
*/
|
|
163
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
164
|
+
/**
|
|
165
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
166
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
167
|
+
*/
|
|
168
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
169
|
+
/**
|
|
170
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
171
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
172
|
+
*/
|
|
173
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
174
|
+
/**
|
|
175
|
+
* HTTP GET /rules/info/global
|
|
176
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
177
|
+
*/
|
|
178
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
179
|
+
/**
|
|
180
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
181
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
182
|
+
*/
|
|
183
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
184
|
+
/**
|
|
185
|
+
* HTTP POST /rules/realm
|
|
186
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
187
|
+
*/
|
|
188
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
189
|
+
/**
|
|
190
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
191
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
192
|
+
*/
|
|
193
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
194
|
+
language?: Model.RulesetLang[];
|
|
195
|
+
fullyPopulate?: boolean;
|
|
196
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
197
|
+
/**
|
|
198
|
+
* HTTP DELETE /rules/realm/{id}
|
|
199
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
200
|
+
*/
|
|
201
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
202
|
+
/**
|
|
203
|
+
* HTTP GET /rules/realm/{id}
|
|
204
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
205
|
+
*/
|
|
206
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
207
|
+
/**
|
|
208
|
+
* HTTP PUT /rules/realm/{id}
|
|
209
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
210
|
+
*/
|
|
211
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
212
|
+
/**
|
|
213
|
+
* HTTP DELETE /rules/{id}
|
|
214
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
215
|
+
*/
|
|
216
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
217
|
+
/**
|
|
218
|
+
* HTTP GET /rules/{id}
|
|
219
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
220
|
+
*/
|
|
221
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
222
|
+
/**
|
|
223
|
+
* HTTP PUT /rules/{id}
|
|
224
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
225
|
+
*/
|
|
226
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
227
|
+
}
|
|
31
228
|
export declare class AssetResourceClient<O> {
|
|
32
229
|
protected httpClient: HttpClient<O>;
|
|
33
230
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -132,50 +329,39 @@ export declare class AssetResourceClient<O> {
|
|
|
132
329
|
assetIds?: string[];
|
|
133
330
|
}, options?: O): RestResponse<void>;
|
|
134
331
|
}
|
|
135
|
-
export declare class
|
|
332
|
+
export declare class DashboardResourceClient<O> {
|
|
136
333
|
protected httpClient: HttpClient<O>;
|
|
137
334
|
constructor(httpClient: HttpClient<O>);
|
|
138
335
|
/**
|
|
139
|
-
* HTTP
|
|
140
|
-
* Java method: org.openremote.model.
|
|
336
|
+
* HTTP POST /dashboard
|
|
337
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
141
338
|
*/
|
|
142
|
-
|
|
143
|
-
parentId?: string;
|
|
144
|
-
parentType?: string;
|
|
145
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
339
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
146
340
|
/**
|
|
147
|
-
* HTTP
|
|
148
|
-
* Java method: org.openremote.model.
|
|
341
|
+
* HTTP PUT /dashboard
|
|
342
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
149
343
|
*/
|
|
150
|
-
|
|
151
|
-
parentId?: string;
|
|
152
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
344
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
153
345
|
/**
|
|
154
|
-
* HTTP GET /
|
|
155
|
-
* Java method: org.openremote.model.
|
|
346
|
+
* HTTP GET /dashboard/all/{realm}
|
|
347
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
156
348
|
*/
|
|
157
|
-
|
|
158
|
-
parentId?: string;
|
|
159
|
-
parentType?: string;
|
|
160
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
349
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
161
350
|
/**
|
|
162
|
-
* HTTP
|
|
163
|
-
* Java method: org.openremote.model.
|
|
351
|
+
* HTTP POST /dashboard/query
|
|
352
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
164
353
|
*/
|
|
165
|
-
|
|
166
|
-
parentId?: string;
|
|
167
|
-
}, options?: O): RestResponse<{
|
|
168
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
169
|
-
}>;
|
|
354
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
170
355
|
/**
|
|
171
|
-
* HTTP
|
|
172
|
-
* Java method: org.openremote.model.
|
|
356
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
357
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
173
358
|
*/
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
359
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
360
|
+
/**
|
|
361
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
362
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
363
|
+
*/
|
|
364
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
179
365
|
}
|
|
180
366
|
export declare class SyslogResourceClient<O> {
|
|
181
367
|
protected httpClient: HttpClient<O>;
|
|
@@ -209,46 +395,12 @@ export declare class SyslogResourceClient<O> {
|
|
|
209
395
|
subCategory?: string[];
|
|
210
396
|
}, options?: O): RestResponse<any>;
|
|
211
397
|
}
|
|
212
|
-
export declare class
|
|
398
|
+
export declare class MapResourceClient<O> {
|
|
213
399
|
protected httpClient: HttpClient<O>;
|
|
214
400
|
constructor(httpClient: HttpClient<O>);
|
|
215
401
|
/**
|
|
216
|
-
* HTTP
|
|
217
|
-
* Java method: org.openremote.model.
|
|
218
|
-
*/
|
|
219
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
220
|
-
/**
|
|
221
|
-
* HTTP GET /realm
|
|
222
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
223
|
-
*/
|
|
224
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
225
|
-
/**
|
|
226
|
-
* HTTP GET /realm/accessible
|
|
227
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
228
|
-
*/
|
|
229
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
230
|
-
/**
|
|
231
|
-
* HTTP DELETE /realm/{name}
|
|
232
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
233
|
-
*/
|
|
234
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
235
|
-
/**
|
|
236
|
-
* HTTP GET /realm/{name}
|
|
237
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
238
|
-
*/
|
|
239
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
240
|
-
/**
|
|
241
|
-
* HTTP PUT /realm/{name}
|
|
242
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
243
|
-
*/
|
|
244
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
245
|
-
}
|
|
246
|
-
export declare class MapResourceClient<O> {
|
|
247
|
-
protected httpClient: HttpClient<O>;
|
|
248
|
-
constructor(httpClient: HttpClient<O>);
|
|
249
|
-
/**
|
|
250
|
-
* HTTP GET /map
|
|
251
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
402
|
+
* HTTP GET /map
|
|
403
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
252
404
|
*/
|
|
253
405
|
getSettings(options?: O): RestResponse<{
|
|
254
406
|
[id: string]: unknown;
|
|
@@ -296,129 +448,28 @@ export declare class MapResourceClient<O> {
|
|
|
296
448
|
[id: string]: unknown;
|
|
297
449
|
}>;
|
|
298
450
|
}
|
|
299
|
-
export declare class
|
|
300
|
-
protected httpClient: HttpClient<O>;
|
|
301
|
-
constructor(httpClient: HttpClient<O>);
|
|
302
|
-
/**
|
|
303
|
-
* HTTP DELETE /gateway/connection
|
|
304
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
305
|
-
*/
|
|
306
|
-
deleteConnections(queryParams?: {
|
|
307
|
-
realm?: string[];
|
|
308
|
-
}, options?: O): RestResponse<void>;
|
|
309
|
-
/**
|
|
310
|
-
* HTTP GET /gateway/connection
|
|
311
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
312
|
-
*/
|
|
313
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
314
|
-
/**
|
|
315
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
316
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
317
|
-
*/
|
|
318
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
319
|
-
/**
|
|
320
|
-
* HTTP GET /gateway/connection/{realm}
|
|
321
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
322
|
-
*/
|
|
323
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
324
|
-
/**
|
|
325
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
326
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
327
|
-
*/
|
|
328
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
329
|
-
/**
|
|
330
|
-
* HTTP GET /gateway/status/{realm}
|
|
331
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
332
|
-
*/
|
|
333
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
334
|
-
}
|
|
335
|
-
export declare class DashboardResourceClient<O> {
|
|
451
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
336
452
|
protected httpClient: HttpClient<O>;
|
|
337
453
|
constructor(httpClient: HttpClient<O>);
|
|
338
454
|
/**
|
|
339
|
-
* HTTP POST /
|
|
340
|
-
* Java method: org.openremote.model.
|
|
341
|
-
*/
|
|
342
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
343
|
-
/**
|
|
344
|
-
* HTTP PUT /dashboard
|
|
345
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
346
|
-
*/
|
|
347
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
348
|
-
/**
|
|
349
|
-
* HTTP GET /dashboard/all/{realm}
|
|
350
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
351
|
-
*/
|
|
352
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
353
|
-
/**
|
|
354
|
-
* HTTP POST /dashboard/query
|
|
355
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
356
|
-
*/
|
|
357
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
358
|
-
/**
|
|
359
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
360
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
455
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
456
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
361
457
|
*/
|
|
362
|
-
|
|
458
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
363
459
|
/**
|
|
364
|
-
* HTTP
|
|
365
|
-
* Java method: org.openremote.model.
|
|
460
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
461
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
366
462
|
*/
|
|
367
|
-
|
|
463
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
368
464
|
}
|
|
369
|
-
export declare class
|
|
465
|
+
export declare class ConsoleResourceClient<O> {
|
|
370
466
|
protected httpClient: HttpClient<O>;
|
|
371
467
|
constructor(httpClient: HttpClient<O>);
|
|
372
468
|
/**
|
|
373
|
-
* HTTP
|
|
374
|
-
* Java method: org.openremote.model.
|
|
375
|
-
*/
|
|
376
|
-
getNotifications(queryParams?: {
|
|
377
|
-
id?: number;
|
|
378
|
-
type?: string;
|
|
379
|
-
from?: number;
|
|
380
|
-
to?: number;
|
|
381
|
-
realmId?: string;
|
|
382
|
-
userId?: string;
|
|
383
|
-
assetId?: string;
|
|
384
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
385
|
-
/**
|
|
386
|
-
* HTTP DELETE /notification
|
|
387
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
388
|
-
*/
|
|
389
|
-
removeNotifications(queryParams?: {
|
|
390
|
-
id?: number;
|
|
391
|
-
type?: string;
|
|
392
|
-
from?: number;
|
|
393
|
-
to?: number;
|
|
394
|
-
realmId?: string;
|
|
395
|
-
userId?: string;
|
|
396
|
-
assetId?: string;
|
|
397
|
-
}, options?: O): RestResponse<void>;
|
|
398
|
-
/**
|
|
399
|
-
* HTTP POST /notification/alert
|
|
400
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
401
|
-
*/
|
|
402
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
403
|
-
/**
|
|
404
|
-
* HTTP DELETE /notification/{notificationId}
|
|
405
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
406
|
-
*/
|
|
407
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
408
|
-
/**
|
|
409
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
410
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
411
|
-
*/
|
|
412
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
413
|
-
targetId?: string;
|
|
414
|
-
}, options?: O): RestResponse<void>;
|
|
415
|
-
/**
|
|
416
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
417
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
469
|
+
* HTTP POST /console/register
|
|
470
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
418
471
|
*/
|
|
419
|
-
|
|
420
|
-
targetId?: string;
|
|
421
|
-
}, options?: O): RestResponse<void>;
|
|
472
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
422
473
|
}
|
|
423
474
|
export declare class AssetDatapointResourceClient<O> {
|
|
424
475
|
protected httpClient: HttpClient<O>;
|
|
@@ -446,252 +497,50 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
446
497
|
*/
|
|
447
498
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
448
499
|
}
|
|
449
|
-
export declare class
|
|
450
|
-
protected httpClient: HttpClient<O>;
|
|
451
|
-
constructor(httpClient: HttpClient<O>);
|
|
452
|
-
/**
|
|
453
|
-
* HTTP POST /console/register
|
|
454
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
455
|
-
*/
|
|
456
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
457
|
-
}
|
|
458
|
-
export declare class StatusResourceClient<O> {
|
|
459
|
-
protected httpClient: HttpClient<O>;
|
|
460
|
-
constructor(httpClient: HttpClient<O>);
|
|
461
|
-
/**
|
|
462
|
-
* HTTP GET /health
|
|
463
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
464
|
-
*/
|
|
465
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
466
|
-
[index: string]: any;
|
|
467
|
-
}>;
|
|
468
|
-
/**
|
|
469
|
-
* HTTP GET /info
|
|
470
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
471
|
-
*/
|
|
472
|
-
getInfo(options?: O): RestResponse<{
|
|
473
|
-
[index: string]: any;
|
|
474
|
-
}>;
|
|
475
|
-
}
|
|
476
|
-
export declare class ProvisioningResourceClient<O> {
|
|
477
|
-
protected httpClient: HttpClient<O>;
|
|
478
|
-
constructor(httpClient: HttpClient<O>);
|
|
479
|
-
/**
|
|
480
|
-
* HTTP POST /provisioning
|
|
481
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
482
|
-
*/
|
|
483
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
484
|
-
/**
|
|
485
|
-
* HTTP GET /provisioning
|
|
486
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
487
|
-
*/
|
|
488
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
489
|
-
/**
|
|
490
|
-
* HTTP DELETE /provisioning/{id}
|
|
491
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
492
|
-
*/
|
|
493
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
494
|
-
/**
|
|
495
|
-
* HTTP PUT /provisioning/{id}
|
|
496
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
497
|
-
*/
|
|
498
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
499
|
-
}
|
|
500
|
-
export declare class RulesResourceClient<O> {
|
|
501
|
-
protected httpClient: HttpClient<O>;
|
|
502
|
-
constructor(httpClient: HttpClient<O>);
|
|
503
|
-
/**
|
|
504
|
-
* HTTP POST /rules
|
|
505
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
506
|
-
*/
|
|
507
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
508
|
-
/**
|
|
509
|
-
* HTTP GET /rules
|
|
510
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
511
|
-
*/
|
|
512
|
-
getGlobalRulesets(queryParams?: {
|
|
513
|
-
language?: Model.RulesetLang[];
|
|
514
|
-
fullyPopulate?: boolean;
|
|
515
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
516
|
-
/**
|
|
517
|
-
* HTTP POST /rules/asset
|
|
518
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
519
|
-
*/
|
|
520
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
521
|
-
/**
|
|
522
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
523
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
524
|
-
*/
|
|
525
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
526
|
-
language?: Model.RulesetLang[];
|
|
527
|
-
fullyPopulate?: boolean;
|
|
528
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
529
|
-
/**
|
|
530
|
-
* HTTP DELETE /rules/asset/{id}
|
|
531
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
532
|
-
*/
|
|
533
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
534
|
-
/**
|
|
535
|
-
* HTTP GET /rules/asset/{id}
|
|
536
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
537
|
-
*/
|
|
538
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
539
|
-
/**
|
|
540
|
-
* HTTP PUT /rules/asset/{id}
|
|
541
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
542
|
-
*/
|
|
543
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
544
|
-
/**
|
|
545
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
546
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
547
|
-
*/
|
|
548
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
549
|
-
/**
|
|
550
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
551
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
552
|
-
*/
|
|
553
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
554
|
-
/**
|
|
555
|
-
* HTTP GET /rules/info/global
|
|
556
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
557
|
-
*/
|
|
558
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
559
|
-
/**
|
|
560
|
-
* HTTP GET /rules/info/realm/{realm}
|
|
561
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
562
|
-
*/
|
|
563
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
564
|
-
/**
|
|
565
|
-
* HTTP POST /rules/realm
|
|
566
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
567
|
-
*/
|
|
568
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
569
|
-
/**
|
|
570
|
-
* HTTP GET /rules/realm/for/{realm}
|
|
571
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
572
|
-
*/
|
|
573
|
-
getRealmRulesets(realm: string, queryParams?: {
|
|
574
|
-
language?: Model.RulesetLang[];
|
|
575
|
-
fullyPopulate?: boolean;
|
|
576
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
577
|
-
/**
|
|
578
|
-
* HTTP DELETE /rules/realm/{id}
|
|
579
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
580
|
-
*/
|
|
581
|
-
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
582
|
-
/**
|
|
583
|
-
* HTTP GET /rules/realm/{id}
|
|
584
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
585
|
-
*/
|
|
586
|
-
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
587
|
-
/**
|
|
588
|
-
* HTTP PUT /rules/realm/{id}
|
|
589
|
-
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
590
|
-
*/
|
|
591
|
-
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
592
|
-
/**
|
|
593
|
-
* HTTP DELETE /rules/{id}
|
|
594
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
595
|
-
*/
|
|
596
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
597
|
-
/**
|
|
598
|
-
* HTTP GET /rules/{id}
|
|
599
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
600
|
-
*/
|
|
601
|
-
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
602
|
-
/**
|
|
603
|
-
* HTTP PUT /rules/{id}
|
|
604
|
-
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
605
|
-
*/
|
|
606
|
-
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
607
|
-
}
|
|
608
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
609
|
-
protected httpClient: HttpClient<O>;
|
|
610
|
-
constructor(httpClient: HttpClient<O>);
|
|
611
|
-
/**
|
|
612
|
-
* HTTP POST /gateway/tunnel
|
|
613
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
614
|
-
*/
|
|
615
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
616
|
-
/**
|
|
617
|
-
* HTTP DELETE /gateway/tunnel
|
|
618
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
619
|
-
*/
|
|
620
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
621
|
-
/**
|
|
622
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
623
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
624
|
-
*/
|
|
625
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
626
|
-
/**
|
|
627
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
628
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
629
|
-
*/
|
|
630
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
631
|
-
/**
|
|
632
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
633
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
634
|
-
*/
|
|
635
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
636
|
-
}
|
|
637
|
-
export declare class AgentResourceClient<O> {
|
|
500
|
+
export declare class AssetModelResourceClient<O> {
|
|
638
501
|
protected httpClient: HttpClient<O>;
|
|
639
502
|
constructor(httpClient: HttpClient<O>);
|
|
640
503
|
/**
|
|
641
|
-
* HTTP GET /
|
|
642
|
-
* Java method: org.openremote.model.asset.
|
|
643
|
-
*/
|
|
644
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
645
|
-
realm?: string;
|
|
646
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
647
|
-
/**
|
|
648
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
649
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
650
|
-
*/
|
|
651
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
652
|
-
realm?: string;
|
|
653
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
654
|
-
/**
|
|
655
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
656
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
504
|
+
* HTTP GET /model/assetDescriptors
|
|
505
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
657
506
|
*/
|
|
658
|
-
|
|
507
|
+
getAssetDescriptors(queryParams?: {
|
|
659
508
|
parentId?: string;
|
|
660
|
-
|
|
661
|
-
}, options?: O): RestResponse<Model.
|
|
662
|
-
}
|
|
663
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
664
|
-
protected httpClient: HttpClient<O>;
|
|
665
|
-
constructor(httpClient: HttpClient<O>);
|
|
666
|
-
/**
|
|
667
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
668
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
669
|
-
*/
|
|
670
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
509
|
+
parentType?: string;
|
|
510
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
671
511
|
/**
|
|
672
|
-
* HTTP
|
|
673
|
-
* Java method: org.openremote.model.
|
|
512
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
513
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
674
514
|
*/
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
protected httpClient: HttpClient<O>;
|
|
679
|
-
constructor(httpClient: HttpClient<O>);
|
|
515
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
516
|
+
parentId?: string;
|
|
517
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
680
518
|
/**
|
|
681
|
-
* HTTP GET /
|
|
682
|
-
* Java method: org.openremote.model.
|
|
519
|
+
* HTTP GET /model/assetInfos
|
|
520
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
683
521
|
*/
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
522
|
+
getAssetInfos(queryParams?: {
|
|
523
|
+
parentId?: string;
|
|
524
|
+
parentType?: string;
|
|
525
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
526
|
+
/**
|
|
527
|
+
* HTTP GET /model/metaItemDescriptors
|
|
528
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
688
529
|
*/
|
|
689
|
-
|
|
530
|
+
getMetaItemDescriptors(queryParams?: {
|
|
531
|
+
parentId?: string;
|
|
532
|
+
}, options?: O): RestResponse<{
|
|
533
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
534
|
+
}>;
|
|
690
535
|
/**
|
|
691
|
-
* HTTP GET /
|
|
692
|
-
* Java method: org.openremote.model.
|
|
536
|
+
* HTTP GET /model/valueDescriptors
|
|
537
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
693
538
|
*/
|
|
694
|
-
|
|
539
|
+
getValueDescriptors(queryParams?: {
|
|
540
|
+
parentId?: string;
|
|
541
|
+
}, options?: O): RestResponse<{
|
|
542
|
+
[index: string]: Model.ValueDescriptor;
|
|
543
|
+
}>;
|
|
695
544
|
}
|
|
696
545
|
export declare class UserResourceClient<O> {
|
|
697
546
|
protected httpClient: HttpClient<O>;
|
|
@@ -817,6 +666,32 @@ export declare class UserResourceClient<O> {
|
|
|
817
666
|
*/
|
|
818
667
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
819
668
|
}
|
|
669
|
+
export declare class AgentResourceClient<O> {
|
|
670
|
+
protected httpClient: HttpClient<O>;
|
|
671
|
+
constructor(httpClient: HttpClient<O>);
|
|
672
|
+
/**
|
|
673
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
674
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
675
|
+
*/
|
|
676
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
677
|
+
realm?: string;
|
|
678
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
679
|
+
/**
|
|
680
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
681
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
682
|
+
*/
|
|
683
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
684
|
+
realm?: string;
|
|
685
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
686
|
+
/**
|
|
687
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
688
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
689
|
+
*/
|
|
690
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
691
|
+
parentId?: string;
|
|
692
|
+
realm?: string;
|
|
693
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
694
|
+
}
|
|
820
695
|
export declare class ConfigurationResourceClient<O> {
|
|
821
696
|
protected httpClient: HttpClient<O>;
|
|
822
697
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -843,6 +718,131 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
843
718
|
*/
|
|
844
719
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
845
720
|
}
|
|
721
|
+
export declare class StatusResourceClient<O> {
|
|
722
|
+
protected httpClient: HttpClient<O>;
|
|
723
|
+
constructor(httpClient: HttpClient<O>);
|
|
724
|
+
/**
|
|
725
|
+
* HTTP GET /health
|
|
726
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
727
|
+
*/
|
|
728
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
729
|
+
[index: string]: any;
|
|
730
|
+
}>;
|
|
731
|
+
/**
|
|
732
|
+
* HTTP GET /info
|
|
733
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
734
|
+
*/
|
|
735
|
+
getInfo(options?: O): RestResponse<{
|
|
736
|
+
[index: string]: any;
|
|
737
|
+
}>;
|
|
738
|
+
}
|
|
739
|
+
export declare class ProvisioningResourceClient<O> {
|
|
740
|
+
protected httpClient: HttpClient<O>;
|
|
741
|
+
constructor(httpClient: HttpClient<O>);
|
|
742
|
+
/**
|
|
743
|
+
* HTTP POST /provisioning
|
|
744
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
745
|
+
*/
|
|
746
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
747
|
+
/**
|
|
748
|
+
* HTTP GET /provisioning
|
|
749
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
750
|
+
*/
|
|
751
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
752
|
+
/**
|
|
753
|
+
* HTTP DELETE /provisioning/{id}
|
|
754
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
755
|
+
*/
|
|
756
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
757
|
+
/**
|
|
758
|
+
* HTTP PUT /provisioning/{id}
|
|
759
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
760
|
+
*/
|
|
761
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
762
|
+
}
|
|
763
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
764
|
+
protected httpClient: HttpClient<O>;
|
|
765
|
+
constructor(httpClient: HttpClient<O>);
|
|
766
|
+
/**
|
|
767
|
+
* HTTP POST /gateway/tunnel
|
|
768
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
769
|
+
*/
|
|
770
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
771
|
+
/**
|
|
772
|
+
* HTTP DELETE /gateway/tunnel
|
|
773
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
774
|
+
*/
|
|
775
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
776
|
+
/**
|
|
777
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
778
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
779
|
+
*/
|
|
780
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
781
|
+
/**
|
|
782
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
783
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
784
|
+
*/
|
|
785
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
786
|
+
/**
|
|
787
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
788
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
789
|
+
*/
|
|
790
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
791
|
+
}
|
|
792
|
+
export declare class NotificationResourceClient<O> {
|
|
793
|
+
protected httpClient: HttpClient<O>;
|
|
794
|
+
constructor(httpClient: HttpClient<O>);
|
|
795
|
+
/**
|
|
796
|
+
* HTTP GET /notification
|
|
797
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
798
|
+
*/
|
|
799
|
+
getNotifications(queryParams?: {
|
|
800
|
+
id?: number;
|
|
801
|
+
type?: string;
|
|
802
|
+
from?: number;
|
|
803
|
+
to?: number;
|
|
804
|
+
realmId?: string;
|
|
805
|
+
userId?: string;
|
|
806
|
+
assetId?: string;
|
|
807
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
808
|
+
/**
|
|
809
|
+
* HTTP DELETE /notification
|
|
810
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
811
|
+
*/
|
|
812
|
+
removeNotifications(queryParams?: {
|
|
813
|
+
id?: number;
|
|
814
|
+
type?: string;
|
|
815
|
+
from?: number;
|
|
816
|
+
to?: number;
|
|
817
|
+
realmId?: string;
|
|
818
|
+
userId?: string;
|
|
819
|
+
assetId?: string;
|
|
820
|
+
}, options?: O): RestResponse<void>;
|
|
821
|
+
/**
|
|
822
|
+
* HTTP POST /notification/alert
|
|
823
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
824
|
+
*/
|
|
825
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
826
|
+
/**
|
|
827
|
+
* HTTP DELETE /notification/{notificationId}
|
|
828
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
829
|
+
*/
|
|
830
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
831
|
+
/**
|
|
832
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
833
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
834
|
+
*/
|
|
835
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
836
|
+
targetId?: string;
|
|
837
|
+
}, options?: O): RestResponse<void>;
|
|
838
|
+
/**
|
|
839
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
840
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
841
|
+
*/
|
|
842
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
843
|
+
targetId?: string;
|
|
844
|
+
}, options?: O): RestResponse<void>;
|
|
845
|
+
}
|
|
846
846
|
export declare class AlarmResourceClient<O> {
|
|
847
847
|
protected httpClient: HttpClient<O>;
|
|
848
848
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -898,48 +898,48 @@ export declare class AlarmResourceClient<O> {
|
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
901
902
|
protected _flowResource: AxiosFlowResourceClient;
|
|
903
|
+
protected _appResource: AxiosAppResourceClient;
|
|
904
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
905
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
902
906
|
protected _assetResource: AxiosAssetResourceClient;
|
|
903
|
-
protected
|
|
907
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
904
908
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
905
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
906
909
|
protected _mapResource: AxiosMapResourceClient;
|
|
907
|
-
protected
|
|
908
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
909
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
910
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
910
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
911
911
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
912
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
913
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
914
|
+
protected _userResource: AxiosUserResourceClient;
|
|
915
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
916
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
912
917
|
protected _statusResource: AxiosStatusResourceClient;
|
|
913
918
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
914
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
915
919
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
916
|
-
protected
|
|
917
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
918
|
-
protected _appResource: AxiosAppResourceClient;
|
|
919
|
-
protected _userResource: AxiosUserResourceClient;
|
|
920
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
920
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
921
921
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
923
924
|
get FlowResource(): AxiosFlowResourceClient;
|
|
925
|
+
get AppResource(): AxiosAppResourceClient;
|
|
926
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
927
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
924
928
|
get AssetResource(): AxiosAssetResourceClient;
|
|
925
|
-
get
|
|
929
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
926
930
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
927
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
928
931
|
get MapResource(): AxiosMapResourceClient;
|
|
929
|
-
get
|
|
930
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
931
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
932
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
932
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
933
933
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
934
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
935
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
936
|
+
get UserResource(): AxiosUserResourceClient;
|
|
937
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
938
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
934
939
|
get StatusResource(): AxiosStatusResourceClient;
|
|
935
940
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
936
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
937
941
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
938
|
-
get
|
|
939
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
940
|
-
get AppResource(): AxiosAppResourceClient;
|
|
941
|
-
get UserResource(): AxiosUserResourceClient;
|
|
942
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
942
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
943
943
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
@@ -948,64 +948,64 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
952
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
|
-
}
|
|
954
|
-
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
951
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
955
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
953
|
}
|
|
957
|
-
export declare class
|
|
954
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
958
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
956
|
}
|
|
960
|
-
export declare class
|
|
957
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
961
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
959
|
}
|
|
963
960
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
964
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
962
|
}
|
|
966
|
-
export declare class
|
|
963
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
967
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
965
|
}
|
|
969
|
-
export declare class
|
|
966
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
970
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
968
|
}
|
|
972
969
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
973
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
971
|
}
|
|
975
|
-
export declare class
|
|
972
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
976
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
974
|
}
|
|
978
|
-
export declare class
|
|
975
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
979
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
977
|
}
|
|
981
|
-
export declare class
|
|
978
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
982
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
980
|
}
|
|
984
|
-
export declare class
|
|
981
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
985
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
983
|
}
|
|
987
|
-
export declare class
|
|
984
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
988
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
986
|
}
|
|
990
|
-
export declare class
|
|
987
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
991
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
989
|
}
|
|
993
|
-
export declare class
|
|
990
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
994
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
992
|
}
|
|
996
993
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
997
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
995
|
}
|
|
999
|
-
export declare class
|
|
996
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
998
|
}
|
|
1002
|
-
export declare class
|
|
999
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1001
|
}
|
|
1005
|
-
export declare class
|
|
1002
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1004
|
}
|
|
1008
|
-
export declare class
|
|
1005
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
|
+
}
|
|
1008
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
1011
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|