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