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