@openremote/rest 1.3.2 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +407 -407
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,95 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
17
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
18
|
-
*/
|
|
19
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
22
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
23
|
-
*/
|
|
24
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
25
|
-
}
|
|
26
|
-
export declare class GatewayClientResourceClient<O> {
|
|
27
|
-
protected httpClient: HttpClient<O>;
|
|
28
|
-
constructor(httpClient: HttpClient<O>);
|
|
29
|
-
/**
|
|
30
|
-
* HTTP DELETE /gateway/connection
|
|
31
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
32
|
-
*/
|
|
33
|
-
deleteConnections(queryParams?: {
|
|
34
|
-
realm?: string[];
|
|
35
|
-
}, options?: O): RestResponse<void>;
|
|
36
|
-
/**
|
|
37
|
-
* HTTP GET /gateway/connection
|
|
38
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
39
|
-
*/
|
|
40
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
43
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
44
|
-
*/
|
|
45
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
46
|
-
/**
|
|
47
|
-
* HTTP GET /gateway/connection/{realm}
|
|
48
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
49
|
-
*/
|
|
50
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
51
|
-
/**
|
|
52
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
53
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
54
|
-
*/
|
|
55
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
56
|
-
/**
|
|
57
|
-
* HTTP GET /gateway/status/{realm}
|
|
58
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
59
|
-
*/
|
|
60
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
61
|
-
}
|
|
62
|
-
export declare class ConsoleResourceClient<O> {
|
|
63
|
-
protected httpClient: HttpClient<O>;
|
|
64
|
-
constructor(httpClient: HttpClient<O>);
|
|
65
|
-
/**
|
|
66
|
-
* HTTP POST /console/register
|
|
67
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
68
|
-
*/
|
|
69
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
70
|
-
}
|
|
71
|
-
export declare class MapResourceClient<O> {
|
|
72
|
-
protected httpClient: HttpClient<O>;
|
|
73
|
-
constructor(httpClient: HttpClient<O>);
|
|
74
|
-
/**
|
|
75
|
-
* HTTP GET /map
|
|
76
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
77
|
-
*/
|
|
78
|
-
getSettings(options?: O): RestResponse<{
|
|
79
|
-
[id: string]: unknown;
|
|
80
|
-
}>;
|
|
81
|
-
/**
|
|
82
|
-
* HTTP PUT /map
|
|
83
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
84
|
-
*/
|
|
85
|
-
saveSettings(mapConfig: {
|
|
86
|
-
[index: string]: Model.MapRealmConfig;
|
|
87
|
-
}, options?: O): RestResponse<any>;
|
|
88
|
-
/**
|
|
89
|
-
* HTTP GET /map/js
|
|
90
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
91
|
-
*/
|
|
92
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
93
|
-
[id: string]: unknown;
|
|
94
|
-
}>;
|
|
95
|
-
/**
|
|
96
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
97
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
98
|
-
*/
|
|
99
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
100
|
-
}
|
|
101
12
|
export declare class RulesResourceClient<O> {
|
|
102
13
|
protected httpClient: HttpClient<O>;
|
|
103
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -206,6 +117,30 @@ export declare class RulesResourceClient<O> {
|
|
|
206
117
|
*/
|
|
207
118
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
208
119
|
}
|
|
120
|
+
export declare class ProvisioningResourceClient<O> {
|
|
121
|
+
protected httpClient: HttpClient<O>;
|
|
122
|
+
constructor(httpClient: HttpClient<O>);
|
|
123
|
+
/**
|
|
124
|
+
* HTTP POST /provisioning
|
|
125
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
126
|
+
*/
|
|
127
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
128
|
+
/**
|
|
129
|
+
* HTTP GET /provisioning
|
|
130
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
131
|
+
*/
|
|
132
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
133
|
+
/**
|
|
134
|
+
* HTTP DELETE /provisioning/{id}
|
|
135
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
136
|
+
*/
|
|
137
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
138
|
+
/**
|
|
139
|
+
* HTTP PUT /provisioning/{id}
|
|
140
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
141
|
+
*/
|
|
142
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
143
|
+
}
|
|
209
144
|
export declare class AssetModelResourceClient<O> {
|
|
210
145
|
protected httpClient: HttpClient<O>;
|
|
211
146
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -251,177 +186,215 @@ export declare class AssetModelResourceClient<O> {
|
|
|
251
186
|
[index: string]: Model.ValueDescriptor;
|
|
252
187
|
}>;
|
|
253
188
|
}
|
|
254
|
-
export declare class
|
|
189
|
+
export declare class ConfigurationResourceClient<O> {
|
|
255
190
|
protected httpClient: HttpClient<O>;
|
|
256
191
|
constructor(httpClient: HttpClient<O>);
|
|
257
192
|
/**
|
|
258
|
-
* HTTP GET /
|
|
259
|
-
* Java method: org.openremote.model.
|
|
193
|
+
* HTTP GET /configuration/manager
|
|
194
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
260
195
|
*/
|
|
261
|
-
|
|
196
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
262
197
|
/**
|
|
263
|
-
* HTTP
|
|
264
|
-
* Java method: org.openremote.model.
|
|
198
|
+
* HTTP PUT /configuration/manager
|
|
199
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
265
200
|
*/
|
|
266
|
-
|
|
201
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
267
202
|
/**
|
|
268
|
-
* HTTP
|
|
269
|
-
* Java method: org.openremote.model.
|
|
203
|
+
* HTTP POST /configuration/manager/file
|
|
204
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
270
205
|
*/
|
|
271
|
-
|
|
206
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
207
|
+
path?: string;
|
|
208
|
+
}, options?: O): RestResponse<string>;
|
|
209
|
+
/**
|
|
210
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
211
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
212
|
+
*/
|
|
213
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
272
214
|
}
|
|
273
|
-
export declare class
|
|
215
|
+
export declare class MapResourceClient<O> {
|
|
274
216
|
protected httpClient: HttpClient<O>;
|
|
275
217
|
constructor(httpClient: HttpClient<O>);
|
|
276
218
|
/**
|
|
277
|
-
* HTTP
|
|
278
|
-
* Java method: org.openremote.model.
|
|
279
|
-
*/
|
|
280
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
281
|
-
/**
|
|
282
|
-
* HTTP DELETE /gateway/tunnel
|
|
283
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
219
|
+
* HTTP GET /map
|
|
220
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
284
221
|
*/
|
|
285
|
-
|
|
222
|
+
getSettings(options?: O): RestResponse<{
|
|
223
|
+
[id: string]: unknown;
|
|
224
|
+
}>;
|
|
286
225
|
/**
|
|
287
|
-
* HTTP
|
|
288
|
-
* Java method: org.openremote.model.
|
|
226
|
+
* HTTP PUT /map
|
|
227
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
289
228
|
*/
|
|
290
|
-
|
|
229
|
+
saveSettings(mapConfig: {
|
|
230
|
+
[index: string]: Model.MapRealmConfig;
|
|
231
|
+
}, options?: O): RestResponse<any>;
|
|
291
232
|
/**
|
|
292
|
-
* HTTP GET /
|
|
293
|
-
* Java method: org.openremote.model.
|
|
233
|
+
* HTTP GET /map/js
|
|
234
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
294
235
|
*/
|
|
295
|
-
|
|
236
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
237
|
+
[id: string]: unknown;
|
|
238
|
+
}>;
|
|
296
239
|
/**
|
|
297
|
-
* HTTP GET /
|
|
298
|
-
* Java method: org.openremote.model.
|
|
240
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
241
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
299
242
|
*/
|
|
300
|
-
|
|
243
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
301
244
|
}
|
|
302
|
-
export declare class
|
|
245
|
+
export declare class AlarmResourceClient<O> {
|
|
303
246
|
protected httpClient: HttpClient<O>;
|
|
304
247
|
constructor(httpClient: HttpClient<O>);
|
|
305
248
|
/**
|
|
306
|
-
* HTTP
|
|
307
|
-
* Java method: org.openremote.model.
|
|
249
|
+
* HTTP POST /alarm
|
|
250
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
308
251
|
*/
|
|
309
|
-
|
|
252
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
253
|
+
assetIds?: string[];
|
|
254
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
310
255
|
/**
|
|
311
|
-
* HTTP
|
|
312
|
-
* Java method: org.openremote.model.
|
|
256
|
+
* HTTP GET /alarm
|
|
257
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
313
258
|
*/
|
|
314
|
-
|
|
259
|
+
getAlarms(queryParams?: {
|
|
260
|
+
realm?: string;
|
|
261
|
+
status?: Model.AlarmStatus;
|
|
262
|
+
assetId?: string;
|
|
263
|
+
assigneeId?: string;
|
|
264
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
315
265
|
/**
|
|
316
|
-
* HTTP
|
|
317
|
-
* Java method: org.openremote.model.
|
|
266
|
+
* HTTP DELETE /alarm
|
|
267
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
318
268
|
*/
|
|
319
|
-
|
|
269
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
320
270
|
/**
|
|
321
|
-
* HTTP
|
|
322
|
-
* Java method: org.openremote.model.
|
|
271
|
+
* HTTP PUT /alarm/assets
|
|
272
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
323
273
|
*/
|
|
324
|
-
|
|
274
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
325
275
|
/**
|
|
326
|
-
* HTTP GET /
|
|
327
|
-
* Java method: org.openremote.model.
|
|
276
|
+
* HTTP GET /alarm/{alarmId}
|
|
277
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
328
278
|
*/
|
|
329
|
-
|
|
279
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
330
280
|
/**
|
|
331
|
-
* HTTP
|
|
332
|
-
* Java method: org.openremote.model.
|
|
281
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
282
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
333
283
|
*/
|
|
334
|
-
|
|
284
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
335
285
|
/**
|
|
336
|
-
* HTTP
|
|
337
|
-
* Java method: org.openremote.model.
|
|
286
|
+
* HTTP PUT /alarm/{alarmId}
|
|
287
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
338
288
|
*/
|
|
339
|
-
|
|
289
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
340
290
|
/**
|
|
341
|
-
* HTTP
|
|
342
|
-
* Java method: org.openremote.model.
|
|
291
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
292
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
343
293
|
*/
|
|
344
|
-
|
|
294
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
295
|
+
realm?: string;
|
|
296
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
297
|
+
}
|
|
298
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
299
|
+
protected httpClient: HttpClient<O>;
|
|
300
|
+
constructor(httpClient: HttpClient<O>);
|
|
345
301
|
/**
|
|
346
|
-
* HTTP
|
|
347
|
-
* Java method: org.openremote.model.
|
|
302
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
303
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
348
304
|
*/
|
|
349
|
-
|
|
305
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
350
306
|
/**
|
|
351
|
-
* HTTP
|
|
352
|
-
* Java method: org.openremote.model.
|
|
307
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
308
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
353
309
|
*/
|
|
354
|
-
|
|
310
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
311
|
+
}
|
|
312
|
+
export declare class AgentResourceClient<O> {
|
|
313
|
+
protected httpClient: HttpClient<O>;
|
|
314
|
+
constructor(httpClient: HttpClient<O>);
|
|
355
315
|
/**
|
|
356
|
-
* HTTP
|
|
357
|
-
* Java method: org.openremote.model.
|
|
358
|
-
*/
|
|
359
|
-
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
360
|
-
/**
|
|
361
|
-
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
362
|
-
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
363
|
-
*/
|
|
364
|
-
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
365
|
-
/**
|
|
366
|
-
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
367
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
316
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
317
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
368
318
|
*/
|
|
369
|
-
|
|
319
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
320
|
+
realm?: string;
|
|
321
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
370
322
|
/**
|
|
371
|
-
* HTTP
|
|
372
|
-
* Java method: org.openremote.model.
|
|
323
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
324
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
373
325
|
*/
|
|
374
|
-
|
|
326
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
327
|
+
realm?: string;
|
|
328
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
375
329
|
/**
|
|
376
|
-
* HTTP
|
|
377
|
-
* Java method: org.openremote.model.
|
|
330
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
331
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
378
332
|
*/
|
|
379
|
-
|
|
333
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
334
|
+
parentId?: string;
|
|
335
|
+
realm?: string;
|
|
336
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
337
|
+
}
|
|
338
|
+
export declare class SyslogResourceClient<O> {
|
|
339
|
+
protected httpClient: HttpClient<O>;
|
|
340
|
+
constructor(httpClient: HttpClient<O>);
|
|
380
341
|
/**
|
|
381
|
-
* HTTP GET /
|
|
382
|
-
* Java method: org.openremote.model.
|
|
342
|
+
* HTTP GET /syslog/config
|
|
343
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
383
344
|
*/
|
|
384
|
-
|
|
345
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
385
346
|
/**
|
|
386
|
-
* HTTP PUT /
|
|
387
|
-
* Java method: org.openremote.model.
|
|
347
|
+
* HTTP PUT /syslog/config
|
|
348
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
388
349
|
*/
|
|
389
|
-
|
|
350
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
390
351
|
/**
|
|
391
|
-
* HTTP
|
|
392
|
-
* Java method: org.openremote.model.
|
|
352
|
+
* HTTP DELETE /syslog/event
|
|
353
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
393
354
|
*/
|
|
394
|
-
|
|
355
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
395
356
|
/**
|
|
396
|
-
* HTTP
|
|
397
|
-
* Java method: org.openremote.model.
|
|
357
|
+
* HTTP GET /syslog/event
|
|
358
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
398
359
|
*/
|
|
399
|
-
|
|
360
|
+
getEvents(queryParams?: {
|
|
361
|
+
level?: Model.SyslogLevel;
|
|
362
|
+
per_page?: number;
|
|
363
|
+
page?: number;
|
|
364
|
+
from?: number;
|
|
365
|
+
to?: number;
|
|
366
|
+
category?: Model.SyslogCategory[];
|
|
367
|
+
subCategory?: string[];
|
|
368
|
+
}, options?: O): RestResponse<any>;
|
|
369
|
+
}
|
|
370
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
371
|
+
protected httpClient: HttpClient<O>;
|
|
372
|
+
constructor(httpClient: HttpClient<O>);
|
|
400
373
|
/**
|
|
401
|
-
* HTTP
|
|
402
|
-
* Java method: org.openremote.model.
|
|
374
|
+
* HTTP POST /gateway/tunnel
|
|
375
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
403
376
|
*/
|
|
404
|
-
|
|
377
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
405
378
|
/**
|
|
406
|
-
* HTTP DELETE /
|
|
407
|
-
* Java method: org.openremote.model.
|
|
379
|
+
* HTTP DELETE /gateway/tunnel
|
|
380
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
408
381
|
*/
|
|
409
|
-
|
|
382
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
410
383
|
/**
|
|
411
|
-
* HTTP GET /
|
|
412
|
-
* Java method: org.openremote.model.
|
|
384
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
385
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
413
386
|
*/
|
|
414
|
-
|
|
387
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
415
388
|
/**
|
|
416
|
-
* HTTP
|
|
417
|
-
* Java method: org.openremote.model.
|
|
389
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
390
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
418
391
|
*/
|
|
419
|
-
|
|
392
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
420
393
|
/**
|
|
421
|
-
* HTTP GET /
|
|
422
|
-
* Java method: org.openremote.model.
|
|
394
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
395
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
423
396
|
*/
|
|
424
|
-
|
|
397
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
425
398
|
}
|
|
426
399
|
export declare class AssetResourceClient<O> {
|
|
427
400
|
protected httpClient: HttpClient<O>;
|
|
@@ -527,31 +500,24 @@ export declare class AssetResourceClient<O> {
|
|
|
527
500
|
assetIds?: string[];
|
|
528
501
|
}, options?: O): RestResponse<void>;
|
|
529
502
|
}
|
|
530
|
-
export declare class
|
|
503
|
+
export declare class AppResourceClient<O> {
|
|
531
504
|
protected httpClient: HttpClient<O>;
|
|
532
505
|
constructor(httpClient: HttpClient<O>);
|
|
533
506
|
/**
|
|
534
|
-
* HTTP GET /
|
|
535
|
-
* Java method: org.openremote.model.
|
|
507
|
+
* HTTP GET /apps
|
|
508
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
536
509
|
*/
|
|
537
|
-
|
|
538
|
-
realm?: string;
|
|
539
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
510
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
540
511
|
/**
|
|
541
|
-
* HTTP
|
|
542
|
-
* Java method: org.openremote.model.
|
|
512
|
+
* HTTP GET /apps/consoleConfig
|
|
513
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
543
514
|
*/
|
|
544
|
-
|
|
545
|
-
realm?: string;
|
|
546
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
515
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
547
516
|
/**
|
|
548
|
-
* HTTP GET /
|
|
549
|
-
* Java method: org.openremote.model.
|
|
517
|
+
* HTTP GET /apps/info
|
|
518
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
550
519
|
*/
|
|
551
|
-
|
|
552
|
-
parentId?: string;
|
|
553
|
-
realm?: string;
|
|
554
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
520
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
555
521
|
}
|
|
556
522
|
export declare class DashboardResourceClient<O> {
|
|
557
523
|
protected httpClient: HttpClient<O>;
|
|
@@ -587,55 +553,41 @@ export declare class DashboardResourceClient<O> {
|
|
|
587
553
|
*/
|
|
588
554
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
589
555
|
}
|
|
590
|
-
export declare class
|
|
556
|
+
export declare class GatewayClientResourceClient<O> {
|
|
591
557
|
protected httpClient: HttpClient<O>;
|
|
592
558
|
constructor(httpClient: HttpClient<O>);
|
|
593
559
|
/**
|
|
594
|
-
* HTTP
|
|
595
|
-
* Java method: org.openremote.model.
|
|
596
|
-
*/
|
|
597
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
598
|
-
/**
|
|
599
|
-
* HTTP GET /provisioning
|
|
600
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
560
|
+
* HTTP DELETE /gateway/connection
|
|
561
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
601
562
|
*/
|
|
602
|
-
|
|
563
|
+
deleteConnections(queryParams?: {
|
|
564
|
+
realm?: string[];
|
|
565
|
+
}, options?: O): RestResponse<void>;
|
|
603
566
|
/**
|
|
604
|
-
* HTTP
|
|
605
|
-
* Java method: org.openremote.model.
|
|
567
|
+
* HTTP GET /gateway/connection
|
|
568
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
606
569
|
*/
|
|
607
|
-
|
|
570
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
608
571
|
/**
|
|
609
|
-
* HTTP
|
|
610
|
-
* Java method: org.openremote.model.
|
|
572
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
573
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
611
574
|
*/
|
|
612
|
-
|
|
613
|
-
}
|
|
614
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
615
|
-
protected httpClient: HttpClient<O>;
|
|
616
|
-
constructor(httpClient: HttpClient<O>);
|
|
575
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
617
576
|
/**
|
|
618
|
-
* HTTP GET /
|
|
619
|
-
* Java method: org.openremote.model.
|
|
577
|
+
* HTTP GET /gateway/connection/{realm}
|
|
578
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
620
579
|
*/
|
|
621
|
-
|
|
622
|
-
attributeRefs?: string;
|
|
623
|
-
fromTimestamp?: number;
|
|
624
|
-
toTimestamp?: number;
|
|
625
|
-
}, options?: O): RestResponse<any>;
|
|
580
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
626
581
|
/**
|
|
627
|
-
* HTTP
|
|
628
|
-
* Java method: org.openremote.model.
|
|
582
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
583
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
629
584
|
*/
|
|
630
|
-
|
|
631
|
-
assetId?: string;
|
|
632
|
-
attributeName?: string;
|
|
633
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
585
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
634
586
|
/**
|
|
635
|
-
* HTTP
|
|
636
|
-
* Java method: org.openremote.model.
|
|
587
|
+
* HTTP GET /gateway/status/{realm}
|
|
588
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
637
589
|
*/
|
|
638
|
-
|
|
590
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
639
591
|
}
|
|
640
592
|
export declare class FlowResourceClient<O> {
|
|
641
593
|
protected httpClient: HttpClient<O>;
|
|
@@ -656,6 +608,15 @@ export declare class FlowResourceClient<O> {
|
|
|
656
608
|
*/
|
|
657
609
|
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
658
610
|
}
|
|
611
|
+
export declare class ConsoleResourceClient<O> {
|
|
612
|
+
protected httpClient: HttpClient<O>;
|
|
613
|
+
constructor(httpClient: HttpClient<O>);
|
|
614
|
+
/**
|
|
615
|
+
* HTTP POST /console/register
|
|
616
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
617
|
+
*/
|
|
618
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
619
|
+
}
|
|
659
620
|
export declare class RealmResourceClient<O> {
|
|
660
621
|
protected httpClient: HttpClient<O>;
|
|
661
622
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -690,90 +651,85 @@ export declare class RealmResourceClient<O> {
|
|
|
690
651
|
*/
|
|
691
652
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
692
653
|
}
|
|
693
|
-
export declare class
|
|
654
|
+
export declare class NotificationResourceClient<O> {
|
|
694
655
|
protected httpClient: HttpClient<O>;
|
|
695
656
|
constructor(httpClient: HttpClient<O>);
|
|
696
657
|
/**
|
|
697
|
-
* HTTP
|
|
698
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP GET /notification
|
|
659
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
699
660
|
*/
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
661
|
+
getNotifications(queryParams?: {
|
|
662
|
+
id?: number;
|
|
663
|
+
type?: string;
|
|
664
|
+
from?: number;
|
|
665
|
+
to?: number;
|
|
666
|
+
realmId?: string;
|
|
667
|
+
userId?: string;
|
|
668
|
+
assetId?: string;
|
|
669
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
703
670
|
/**
|
|
704
|
-
* HTTP
|
|
705
|
-
* Java method: org.openremote.model.
|
|
671
|
+
* HTTP DELETE /notification
|
|
672
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
706
673
|
*/
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
674
|
+
removeNotifications(queryParams?: {
|
|
675
|
+
id?: number;
|
|
676
|
+
type?: string;
|
|
677
|
+
from?: number;
|
|
678
|
+
to?: number;
|
|
679
|
+
realmId?: string;
|
|
680
|
+
userId?: string;
|
|
710
681
|
assetId?: string;
|
|
711
|
-
|
|
712
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
682
|
+
}, options?: O): RestResponse<void>;
|
|
713
683
|
/**
|
|
714
|
-
* HTTP
|
|
715
|
-
* Java method: org.openremote.model.
|
|
684
|
+
* HTTP POST /notification/alert
|
|
685
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
716
686
|
*/
|
|
717
|
-
|
|
687
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
718
688
|
/**
|
|
719
|
-
* HTTP
|
|
720
|
-
* Java method: org.openremote.model.
|
|
689
|
+
* HTTP DELETE /notification/{notificationId}
|
|
690
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
721
691
|
*/
|
|
722
|
-
|
|
692
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
723
693
|
/**
|
|
724
|
-
* HTTP
|
|
725
|
-
* Java method: org.openremote.model.
|
|
694
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
695
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
726
696
|
*/
|
|
727
|
-
|
|
697
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
698
|
+
targetId?: string;
|
|
699
|
+
}, options?: O): RestResponse<void>;
|
|
728
700
|
/**
|
|
729
|
-
* HTTP
|
|
730
|
-
* Java method: org.openremote.model.
|
|
701
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
702
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
731
703
|
*/
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
736
|
-
*/
|
|
737
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
738
|
-
/**
|
|
739
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
740
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
741
|
-
*/
|
|
742
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
743
|
-
realm?: string;
|
|
744
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
704
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
705
|
+
targetId?: string;
|
|
706
|
+
}, options?: O): RestResponse<void>;
|
|
745
707
|
}
|
|
746
|
-
export declare class
|
|
708
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
747
709
|
protected httpClient: HttpClient<O>;
|
|
748
710
|
constructor(httpClient: HttpClient<O>);
|
|
749
711
|
/**
|
|
750
|
-
* HTTP GET /
|
|
751
|
-
* Java method: org.openremote.model.
|
|
752
|
-
*/
|
|
753
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
754
|
-
/**
|
|
755
|
-
* HTTP PUT /syslog/config
|
|
756
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
712
|
+
* HTTP GET /asset/datapoint/export
|
|
713
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
757
714
|
*/
|
|
758
|
-
|
|
715
|
+
getDatapointExport(queryParams?: {
|
|
716
|
+
attributeRefs?: string;
|
|
717
|
+
fromTimestamp?: number;
|
|
718
|
+
toTimestamp?: number;
|
|
719
|
+
}, options?: O): RestResponse<any>;
|
|
759
720
|
/**
|
|
760
|
-
* HTTP
|
|
761
|
-
* Java method: org.openremote.model.
|
|
721
|
+
* HTTP GET /asset/datapoint/periods
|
|
722
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
762
723
|
*/
|
|
763
|
-
|
|
724
|
+
getDatapointPeriod(queryParams?: {
|
|
725
|
+
assetId?: string;
|
|
726
|
+
attributeName?: string;
|
|
727
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
764
728
|
/**
|
|
765
|
-
* HTTP
|
|
766
|
-
* Java method: org.openremote.model.
|
|
729
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
730
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
767
731
|
*/
|
|
768
|
-
|
|
769
|
-
level?: Model.SyslogLevel;
|
|
770
|
-
per_page?: number;
|
|
771
|
-
page?: number;
|
|
772
|
-
from?: number;
|
|
773
|
-
to?: number;
|
|
774
|
-
category?: Model.SyslogCategory[];
|
|
775
|
-
subCategory?: string[];
|
|
776
|
-
}, options?: O): RestResponse<any>;
|
|
732
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
777
733
|
}
|
|
778
734
|
export declare class StatusResourceClient<O> {
|
|
779
735
|
protected httpClient: HttpClient<O>;
|
|
@@ -793,131 +749,175 @@ export declare class StatusResourceClient<O> {
|
|
|
793
749
|
[index: string]: any;
|
|
794
750
|
}>;
|
|
795
751
|
}
|
|
796
|
-
export declare class
|
|
752
|
+
export declare class UserResourceClient<O> {
|
|
797
753
|
protected httpClient: HttpClient<O>;
|
|
798
754
|
constructor(httpClient: HttpClient<O>);
|
|
799
755
|
/**
|
|
800
|
-
* HTTP
|
|
801
|
-
* Java method: org.openremote.model.
|
|
756
|
+
* HTTP PUT /user/locale
|
|
757
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
802
758
|
*/
|
|
803
|
-
|
|
804
|
-
id?: number;
|
|
805
|
-
type?: string;
|
|
806
|
-
from?: number;
|
|
807
|
-
to?: number;
|
|
808
|
-
realmId?: string;
|
|
809
|
-
userId?: string;
|
|
810
|
-
assetId?: string;
|
|
811
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
759
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
812
760
|
/**
|
|
813
|
-
* HTTP
|
|
814
|
-
* Java method: org.openremote.model.
|
|
761
|
+
* HTTP POST /user/query
|
|
762
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
815
763
|
*/
|
|
816
|
-
|
|
817
|
-
id?: number;
|
|
818
|
-
type?: string;
|
|
819
|
-
from?: number;
|
|
820
|
-
to?: number;
|
|
821
|
-
realmId?: string;
|
|
822
|
-
userId?: string;
|
|
823
|
-
assetId?: string;
|
|
824
|
-
}, options?: O): RestResponse<void>;
|
|
764
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
825
765
|
/**
|
|
826
|
-
* HTTP
|
|
827
|
-
* Java method: org.openremote.model.
|
|
766
|
+
* HTTP GET /user/user
|
|
767
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
828
768
|
*/
|
|
829
|
-
|
|
769
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
830
770
|
/**
|
|
831
|
-
* HTTP
|
|
832
|
-
* Java method: org.openremote.model.
|
|
771
|
+
* HTTP GET /user/userRealmRoles
|
|
772
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
833
773
|
*/
|
|
834
|
-
|
|
774
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<Model.Role[]>;
|
|
835
775
|
/**
|
|
836
|
-
* HTTP
|
|
837
|
-
* Java method: org.openremote.model.
|
|
776
|
+
* HTTP GET /user/userRoles
|
|
777
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRoles
|
|
838
778
|
*/
|
|
839
|
-
|
|
840
|
-
targetId?: string;
|
|
841
|
-
}, options?: O): RestResponse<void>;
|
|
779
|
+
getCurrentUserRoles(options?: O): RestResponse<Model.Role[]>;
|
|
842
780
|
/**
|
|
843
|
-
* HTTP
|
|
844
|
-
* Java method: org.openremote.model.
|
|
781
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
782
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
845
783
|
*/
|
|
846
|
-
|
|
847
|
-
targetId?: string;
|
|
848
|
-
}, options?: O): RestResponse<void>;
|
|
849
|
-
}
|
|
850
|
-
export declare class ConfigurationResourceClient<O> {
|
|
851
|
-
protected httpClient: HttpClient<O>;
|
|
852
|
-
constructor(httpClient: HttpClient<O>);
|
|
784
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
853
785
|
/**
|
|
854
|
-
* HTTP GET /
|
|
855
|
-
* Java method: org.openremote.model.
|
|
786
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
787
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
856
788
|
*/
|
|
857
|
-
|
|
789
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
858
790
|
/**
|
|
859
|
-
* HTTP PUT /
|
|
860
|
-
* Java method: org.openremote.model.
|
|
791
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
792
|
+
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
861
793
|
*/
|
|
862
|
-
|
|
794
|
+
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
863
795
|
/**
|
|
864
|
-
* HTTP
|
|
865
|
-
* Java method: org.openremote.model.
|
|
796
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
797
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
866
798
|
*/
|
|
867
|
-
|
|
868
|
-
path?: string;
|
|
869
|
-
}, options?: O): RestResponse<string>;
|
|
799
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
870
800
|
/**
|
|
871
|
-
* HTTP GET /
|
|
872
|
-
* Java method: org.openremote.model.
|
|
801
|
+
* HTTP GET /user/{realm}/roles
|
|
802
|
+
* Java method: org.openremote.model.security.UserResource.getRoles
|
|
873
803
|
*/
|
|
874
|
-
|
|
804
|
+
getRoles(realm: string, options?: O): RestResponse<Model.Role[]>;
|
|
805
|
+
/**
|
|
806
|
+
* HTTP PUT /user/{realm}/roles
|
|
807
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
808
|
+
*/
|
|
809
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
810
|
+
/**
|
|
811
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
812
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
813
|
+
*/
|
|
814
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
815
|
+
/**
|
|
816
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
817
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
818
|
+
*/
|
|
819
|
+
updateUserRealmRoles(realm: string, userId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
820
|
+
/**
|
|
821
|
+
* HTTP GET /user/{realm}/userRoles/{userId}
|
|
822
|
+
* Java method: org.openremote.model.security.UserResource.getUserRoles
|
|
823
|
+
*/
|
|
824
|
+
getUserRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
825
|
+
/**
|
|
826
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}
|
|
827
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRoles
|
|
828
|
+
*/
|
|
829
|
+
updateUserRoles(realm: string, userId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
830
|
+
/**
|
|
831
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
832
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
833
|
+
*/
|
|
834
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
835
|
+
/**
|
|
836
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
837
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
838
|
+
*/
|
|
839
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
840
|
+
/**
|
|
841
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
842
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
843
|
+
*/
|
|
844
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
845
|
+
/**
|
|
846
|
+
* HTTP POST /user/{realm}/users
|
|
847
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
848
|
+
*/
|
|
849
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
850
|
+
/**
|
|
851
|
+
* HTTP PUT /user/{realm}/users
|
|
852
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
853
|
+
*/
|
|
854
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
855
|
+
/**
|
|
856
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
857
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
858
|
+
*/
|
|
859
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
860
|
+
/**
|
|
861
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
862
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
863
|
+
*/
|
|
864
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
865
|
+
/**
|
|
866
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
867
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
868
|
+
*/
|
|
869
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
870
|
+
/**
|
|
871
|
+
* HTTP GET /user/{realm}/{userId}
|
|
872
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
873
|
+
*/
|
|
874
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
879
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
880
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
881
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
882
878
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
879
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
883
880
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
884
|
-
protected
|
|
881
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
882
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
883
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
884
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
885
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
886
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
885
887
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
886
|
-
protected _userResource: AxiosUserResourceClient;
|
|
887
888
|
protected _assetResource: AxiosAssetResourceClient;
|
|
888
|
-
protected
|
|
889
|
+
protected _appResource: AxiosAppResourceClient;
|
|
889
890
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
890
|
-
protected
|
|
891
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
891
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
892
892
|
protected _flowResource: AxiosFlowResourceClient;
|
|
893
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
893
894
|
protected _realmResource: AxiosRealmResourceClient;
|
|
894
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
895
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
896
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
897
895
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
898
|
-
protected
|
|
896
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
897
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
898
|
+
protected _userResource: AxiosUserResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
901
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
902
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
903
|
-
get MapResource(): AxiosMapResourceClient;
|
|
904
900
|
get RulesResource(): AxiosRulesResourceClient;
|
|
901
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
905
902
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
906
|
-
get
|
|
903
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
904
|
+
get MapResource(): AxiosMapResourceClient;
|
|
905
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
906
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
907
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
908
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
907
909
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
908
|
-
get UserResource(): AxiosUserResourceClient;
|
|
909
910
|
get AssetResource(): AxiosAssetResourceClient;
|
|
910
|
-
get
|
|
911
|
+
get AppResource(): AxiosAppResourceClient;
|
|
911
912
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
912
|
-
get
|
|
913
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
913
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
914
914
|
get FlowResource(): AxiosFlowResourceClient;
|
|
915
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
915
916
|
get RealmResource(): AxiosRealmResourceClient;
|
|
916
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
917
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
918
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
919
917
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
920
|
-
get
|
|
918
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
919
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
920
|
+
get UserResource(): AxiosUserResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
935
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
|
+
}
|
|
937
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
935
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
939
|
}
|
|
937
940
|
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
938
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
942
|
}
|
|
940
|
-
export declare class
|
|
943
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
941
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
945
|
}
|
|
943
|
-
export declare class
|
|
946
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
944
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
948
|
}
|
|
946
|
-
export declare class
|
|
949
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
947
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
951
|
}
|
|
949
|
-
export declare class
|
|
952
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
950
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
954
|
}
|
|
952
|
-
export declare class
|
|
955
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
953
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
957
|
}
|
|
955
958
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
956
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
960
|
}
|
|
958
|
-
export declare class
|
|
961
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
959
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
963
|
}
|
|
961
964
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
962
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
966
|
}
|
|
964
|
-
export declare class
|
|
967
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
965
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
969
|
}
|
|
967
|
-
export declare class
|
|
970
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
968
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
972
|
}
|
|
970
|
-
export declare class
|
|
973
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
971
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
975
|
}
|
|
973
976
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
974
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
978
|
}
|
|
976
|
-
export declare class
|
|
979
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
977
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
981
|
}
|
|
979
|
-
export declare class
|
|
982
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
980
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
984
|
}
|
|
982
985
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
983
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
987
|
}
|
|
985
|
-
export declare class
|
|
986
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
|
-
}
|
|
988
|
-
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
988
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|