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