@openremote/rest 1.9.0-snapshot.20250901125810 → 1.9.0-snapshot.20250902151924
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 +463 -463
- 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,50 +9,124 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class SyslogResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /syslog/config
|
|
17
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
parentId?: string;
|
|
21
|
-
parentType?: string;
|
|
22
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
19
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
23
20
|
/**
|
|
24
|
-
* HTTP
|
|
25
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /syslog/config
|
|
22
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
26
23
|
*/
|
|
27
|
-
|
|
28
|
-
parentId?: string;
|
|
29
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
24
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
30
25
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP DELETE /syslog/event
|
|
27
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
33
28
|
*/
|
|
34
|
-
|
|
35
|
-
parentId?: string;
|
|
36
|
-
parentType?: string;
|
|
37
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
29
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
38
30
|
/**
|
|
39
|
-
* HTTP GET /
|
|
40
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP GET /syslog/event
|
|
32
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
41
33
|
*/
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
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 RealmResourceClient<O> {
|
|
45
|
+
protected httpClient: HttpClient<O>;
|
|
46
|
+
constructor(httpClient: HttpClient<O>);
|
|
47
47
|
/**
|
|
48
|
-
* HTTP
|
|
49
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP POST /realm
|
|
49
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
50
50
|
*/
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
51
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
52
|
+
/**
|
|
53
|
+
* HTTP GET /realm
|
|
54
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
55
|
+
*/
|
|
56
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
57
|
+
/**
|
|
58
|
+
* HTTP GET /realm/accessible
|
|
59
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
60
|
+
*/
|
|
61
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
62
|
+
/**
|
|
63
|
+
* HTTP DELETE /realm/{name}
|
|
64
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
65
|
+
*/
|
|
66
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
67
|
+
/**
|
|
68
|
+
* HTTP GET /realm/{name}
|
|
69
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
70
|
+
*/
|
|
71
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
72
|
+
/**
|
|
73
|
+
* HTTP PUT /realm/{name}
|
|
74
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
75
|
+
*/
|
|
76
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
77
|
+
}
|
|
78
|
+
export declare class DashboardResourceClient<O> {
|
|
79
|
+
protected httpClient: HttpClient<O>;
|
|
80
|
+
constructor(httpClient: HttpClient<O>);
|
|
81
|
+
/**
|
|
82
|
+
* HTTP POST /dashboard
|
|
83
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
84
|
+
*/
|
|
85
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
86
|
+
/**
|
|
87
|
+
* HTTP PUT /dashboard
|
|
88
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
89
|
+
*/
|
|
90
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
91
|
+
/**
|
|
92
|
+
* HTTP GET /dashboard/all/{realm}
|
|
93
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
94
|
+
*/
|
|
95
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
96
|
+
/**
|
|
97
|
+
* HTTP POST /dashboard/query
|
|
98
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
99
|
+
*/
|
|
100
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
101
|
+
/**
|
|
102
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
103
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
104
|
+
*/
|
|
105
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
106
|
+
/**
|
|
107
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
108
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
109
|
+
*/
|
|
110
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
111
|
+
}
|
|
112
|
+
export declare class FlowResourceClient<O> {
|
|
113
|
+
protected httpClient: HttpClient<O>;
|
|
114
|
+
constructor(httpClient: HttpClient<O>);
|
|
115
|
+
/**
|
|
116
|
+
* HTTP GET /flow
|
|
117
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
118
|
+
*/
|
|
119
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
120
|
+
/**
|
|
121
|
+
* HTTP GET /flow/{name}
|
|
122
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
123
|
+
*/
|
|
124
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
125
|
+
/**
|
|
126
|
+
* HTTP GET /flow/{type}
|
|
127
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
128
|
+
*/
|
|
129
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
56
130
|
}
|
|
57
131
|
export declare class RulesResourceClient<O> {
|
|
58
132
|
protected httpClient: HttpClient<O>;
|
|
@@ -162,83 +236,6 @@ export declare class RulesResourceClient<O> {
|
|
|
162
236
|
*/
|
|
163
237
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
164
238
|
}
|
|
165
|
-
export declare class AlarmResourceClient<O> {
|
|
166
|
-
protected httpClient: HttpClient<O>;
|
|
167
|
-
constructor(httpClient: HttpClient<O>);
|
|
168
|
-
/**
|
|
169
|
-
* HTTP POST /alarm
|
|
170
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
171
|
-
*/
|
|
172
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
173
|
-
assetIds?: string[];
|
|
174
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
175
|
-
/**
|
|
176
|
-
* HTTP GET /alarm
|
|
177
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
178
|
-
*/
|
|
179
|
-
getAlarms(queryParams?: {
|
|
180
|
-
realm?: string;
|
|
181
|
-
status?: Model.AlarmStatus;
|
|
182
|
-
assetId?: string;
|
|
183
|
-
assigneeId?: string;
|
|
184
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
185
|
-
/**
|
|
186
|
-
* HTTP DELETE /alarm
|
|
187
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
188
|
-
*/
|
|
189
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
190
|
-
/**
|
|
191
|
-
* HTTP PUT /alarm/assets
|
|
192
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
193
|
-
*/
|
|
194
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
195
|
-
/**
|
|
196
|
-
* HTTP GET /alarm/{alarmId}
|
|
197
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
198
|
-
*/
|
|
199
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
200
|
-
/**
|
|
201
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
202
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
203
|
-
*/
|
|
204
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
205
|
-
/**
|
|
206
|
-
* HTTP PUT /alarm/{alarmId}
|
|
207
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
208
|
-
*/
|
|
209
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
210
|
-
/**
|
|
211
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
212
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
213
|
-
*/
|
|
214
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
215
|
-
realm?: string;
|
|
216
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
217
|
-
}
|
|
218
|
-
export declare class ProvisioningResourceClient<O> {
|
|
219
|
-
protected httpClient: HttpClient<O>;
|
|
220
|
-
constructor(httpClient: HttpClient<O>);
|
|
221
|
-
/**
|
|
222
|
-
* HTTP POST /provisioning
|
|
223
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
224
|
-
*/
|
|
225
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
226
|
-
/**
|
|
227
|
-
* HTTP GET /provisioning
|
|
228
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
229
|
-
*/
|
|
230
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
231
|
-
/**
|
|
232
|
-
* HTTP DELETE /provisioning/{id}
|
|
233
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
234
|
-
*/
|
|
235
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
236
|
-
/**
|
|
237
|
-
* HTTP PUT /provisioning/{id}
|
|
238
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
239
|
-
*/
|
|
240
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
241
|
-
}
|
|
242
239
|
export declare class AgentResourceClient<O> {
|
|
243
240
|
protected httpClient: HttpClient<O>;
|
|
244
241
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -265,14 +262,41 @@ export declare class AgentResourceClient<O> {
|
|
|
265
262
|
realm?: string;
|
|
266
263
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
267
264
|
}
|
|
268
|
-
export declare class
|
|
265
|
+
export declare class GatewayClientResourceClient<O> {
|
|
269
266
|
protected httpClient: HttpClient<O>;
|
|
270
267
|
constructor(httpClient: HttpClient<O>);
|
|
271
268
|
/**
|
|
272
|
-
* HTTP
|
|
273
|
-
* Java method: org.openremote.model.
|
|
269
|
+
* HTTP DELETE /gateway/connection
|
|
270
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
274
271
|
*/
|
|
275
|
-
|
|
272
|
+
deleteConnections(queryParams?: {
|
|
273
|
+
realm?: string[];
|
|
274
|
+
}, options?: O): RestResponse<void>;
|
|
275
|
+
/**
|
|
276
|
+
* HTTP GET /gateway/connection
|
|
277
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
278
|
+
*/
|
|
279
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
280
|
+
/**
|
|
281
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
282
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
283
|
+
*/
|
|
284
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
285
|
+
/**
|
|
286
|
+
* HTTP GET /gateway/connection/{realm}
|
|
287
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
288
|
+
*/
|
|
289
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
290
|
+
/**
|
|
291
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
292
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
293
|
+
*/
|
|
294
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
295
|
+
/**
|
|
296
|
+
* HTTP GET /gateway/status/{realm}
|
|
297
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
298
|
+
*/
|
|
299
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
276
300
|
}
|
|
277
301
|
export declare class AssetResourceClient<O> {
|
|
278
302
|
protected httpClient: HttpClient<O>;
|
|
@@ -378,140 +402,128 @@ export declare class AssetResourceClient<O> {
|
|
|
378
402
|
assetIds?: string[];
|
|
379
403
|
}, options?: O): RestResponse<void>;
|
|
380
404
|
}
|
|
381
|
-
export declare class
|
|
405
|
+
export declare class ConfigurationResourceClient<O> {
|
|
382
406
|
protected httpClient: HttpClient<O>;
|
|
383
407
|
constructor(httpClient: HttpClient<O>);
|
|
384
408
|
/**
|
|
385
|
-
* HTTP
|
|
386
|
-
* Java method: org.openremote.model.
|
|
409
|
+
* HTTP GET /configuration/manager
|
|
410
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
387
411
|
*/
|
|
388
|
-
|
|
412
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
389
413
|
/**
|
|
390
|
-
* HTTP
|
|
391
|
-
* Java method: org.openremote.model.
|
|
414
|
+
* HTTP PUT /configuration/manager
|
|
415
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
392
416
|
*/
|
|
393
|
-
|
|
417
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
394
418
|
/**
|
|
395
|
-
* HTTP
|
|
396
|
-
* Java method: org.openremote.model.
|
|
419
|
+
* HTTP POST /configuration/manager/file
|
|
420
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
397
421
|
*/
|
|
398
|
-
|
|
422
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
423
|
+
path?: string;
|
|
424
|
+
}, options?: O): RestResponse<string>;
|
|
399
425
|
/**
|
|
400
|
-
* HTTP
|
|
401
|
-
* Java method: org.openremote.model.
|
|
426
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
427
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
402
428
|
*/
|
|
403
|
-
|
|
429
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
430
|
+
}
|
|
431
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
432
|
+
protected httpClient: HttpClient<O>;
|
|
433
|
+
constructor(httpClient: HttpClient<O>);
|
|
404
434
|
/**
|
|
405
|
-
* HTTP
|
|
406
|
-
* Java method: org.openremote.model.
|
|
435
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
436
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
407
437
|
*/
|
|
408
|
-
|
|
438
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
409
439
|
/**
|
|
410
|
-
* HTTP PUT /
|
|
411
|
-
* Java method: org.openremote.model.
|
|
440
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
441
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
412
442
|
*/
|
|
413
|
-
|
|
443
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
414
444
|
}
|
|
415
|
-
export declare class
|
|
445
|
+
export declare class AssetModelResourceClient<O> {
|
|
416
446
|
protected httpClient: HttpClient<O>;
|
|
417
447
|
constructor(httpClient: HttpClient<O>);
|
|
418
448
|
/**
|
|
419
|
-
* HTTP
|
|
420
|
-
* Java method: org.openremote.model.
|
|
421
|
-
*/
|
|
422
|
-
deleteConnections(queryParams?: {
|
|
423
|
-
realm?: string[];
|
|
424
|
-
}, options?: O): RestResponse<void>;
|
|
425
|
-
/**
|
|
426
|
-
* HTTP GET /gateway/connection
|
|
427
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
449
|
+
* HTTP GET /model/assetDescriptors
|
|
450
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
428
451
|
*/
|
|
429
|
-
|
|
452
|
+
getAssetDescriptors(queryParams?: {
|
|
453
|
+
parentId?: string;
|
|
454
|
+
parentType?: string;
|
|
455
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
430
456
|
/**
|
|
431
|
-
* HTTP
|
|
432
|
-
* Java method: org.openremote.model.
|
|
457
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
458
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
433
459
|
*/
|
|
434
|
-
|
|
460
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
461
|
+
parentId?: string;
|
|
462
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
435
463
|
/**
|
|
436
|
-
* HTTP GET /
|
|
437
|
-
* Java method: org.openremote.model.
|
|
464
|
+
* HTTP GET /model/assetInfos
|
|
465
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
438
466
|
*/
|
|
439
|
-
|
|
467
|
+
getAssetInfos(queryParams?: {
|
|
468
|
+
parentId?: string;
|
|
469
|
+
parentType?: string;
|
|
470
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
440
471
|
/**
|
|
441
|
-
* HTTP
|
|
442
|
-
* Java method: org.openremote.model.
|
|
472
|
+
* HTTP GET /model/metaItemDescriptors
|
|
473
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
443
474
|
*/
|
|
444
|
-
|
|
475
|
+
getMetaItemDescriptors(queryParams?: {
|
|
476
|
+
parentId?: string;
|
|
477
|
+
}, options?: O): RestResponse<{
|
|
478
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
479
|
+
}>;
|
|
445
480
|
/**
|
|
446
|
-
* HTTP GET /
|
|
447
|
-
* Java method: org.openremote.model.
|
|
481
|
+
* HTTP GET /model/valueDescriptors
|
|
482
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
448
483
|
*/
|
|
449
|
-
|
|
484
|
+
getValueDescriptors(queryParams?: {
|
|
485
|
+
parentId?: string;
|
|
486
|
+
}, options?: O): RestResponse<{
|
|
487
|
+
[index: string]: Model.ValueDescriptor;
|
|
488
|
+
}>;
|
|
450
489
|
}
|
|
451
|
-
export declare class
|
|
490
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
452
491
|
protected httpClient: HttpClient<O>;
|
|
453
492
|
constructor(httpClient: HttpClient<O>);
|
|
454
493
|
/**
|
|
455
|
-
* HTTP
|
|
456
|
-
* Java method: org.openremote.model.
|
|
494
|
+
* HTTP POST /gateway/tunnel
|
|
495
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
457
496
|
*/
|
|
458
|
-
|
|
497
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
459
498
|
/**
|
|
460
|
-
* HTTP
|
|
461
|
-
* Java method: org.openremote.model.
|
|
499
|
+
* HTTP DELETE /gateway/tunnel
|
|
500
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
462
501
|
*/
|
|
463
|
-
|
|
502
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
464
503
|
/**
|
|
465
|
-
* HTTP GET /
|
|
466
|
-
* Java method: org.openremote.model.
|
|
504
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
505
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
467
506
|
*/
|
|
468
|
-
|
|
469
|
-
}
|
|
470
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
471
|
-
protected httpClient: HttpClient<O>;
|
|
472
|
-
constructor(httpClient: HttpClient<O>);
|
|
507
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
473
508
|
/**
|
|
474
|
-
* HTTP
|
|
475
|
-
* Java method: org.openremote.model.
|
|
509
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
510
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
476
511
|
*/
|
|
477
|
-
|
|
512
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
478
513
|
/**
|
|
479
|
-
* HTTP
|
|
480
|
-
* Java method: org.openremote.model.
|
|
514
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
515
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
481
516
|
*/
|
|
482
|
-
|
|
517
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
483
518
|
}
|
|
484
|
-
export declare class
|
|
519
|
+
export declare class ConsoleResourceClient<O> {
|
|
485
520
|
protected httpClient: HttpClient<O>;
|
|
486
521
|
constructor(httpClient: HttpClient<O>);
|
|
487
522
|
/**
|
|
488
|
-
* HTTP
|
|
489
|
-
* Java method: org.openremote.model.
|
|
490
|
-
*/
|
|
491
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
492
|
-
/**
|
|
493
|
-
* HTTP PUT /syslog/config
|
|
494
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
495
|
-
*/
|
|
496
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
497
|
-
/**
|
|
498
|
-
* HTTP DELETE /syslog/event
|
|
499
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
500
|
-
*/
|
|
501
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
502
|
-
/**
|
|
503
|
-
* HTTP GET /syslog/event
|
|
504
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
523
|
+
* HTTP POST /console/register
|
|
524
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
505
525
|
*/
|
|
506
|
-
|
|
507
|
-
level?: Model.SyslogLevel;
|
|
508
|
-
per_page?: number;
|
|
509
|
-
page?: number;
|
|
510
|
-
from?: number;
|
|
511
|
-
to?: number;
|
|
512
|
-
category?: Model.SyslogCategory[];
|
|
513
|
-
subCategory?: string[];
|
|
514
|
-
}, options?: O): RestResponse<any>;
|
|
526
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
515
527
|
}
|
|
516
528
|
export declare class StatusResourceClient<O> {
|
|
517
529
|
protected httpClient: HttpClient<O>;
|
|
@@ -531,129 +543,181 @@ export declare class StatusResourceClient<O> {
|
|
|
531
543
|
[index: string]: any;
|
|
532
544
|
}>;
|
|
533
545
|
}
|
|
534
|
-
export declare class
|
|
546
|
+
export declare class AppResourceClient<O> {
|
|
535
547
|
protected httpClient: HttpClient<O>;
|
|
536
548
|
constructor(httpClient: HttpClient<O>);
|
|
537
549
|
/**
|
|
538
|
-
* HTTP
|
|
539
|
-
* Java method: org.openremote.model.
|
|
550
|
+
* HTTP GET /apps
|
|
551
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
540
552
|
*/
|
|
541
|
-
|
|
553
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
542
554
|
/**
|
|
543
|
-
* HTTP
|
|
544
|
-
* Java method: org.openremote.model.
|
|
555
|
+
* HTTP GET /apps/consoleConfig
|
|
556
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
545
557
|
*/
|
|
546
|
-
|
|
558
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
547
559
|
/**
|
|
548
|
-
* HTTP
|
|
549
|
-
* Java method: org.openremote.model.
|
|
560
|
+
* HTTP GET /apps/info
|
|
561
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
550
562
|
*/
|
|
551
|
-
|
|
563
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
564
|
+
}
|
|
565
|
+
export declare class AlarmResourceClient<O> {
|
|
566
|
+
protected httpClient: HttpClient<O>;
|
|
567
|
+
constructor(httpClient: HttpClient<O>);
|
|
552
568
|
/**
|
|
553
|
-
* HTTP
|
|
554
|
-
* Java method: org.openremote.model.
|
|
569
|
+
* HTTP POST /alarm
|
|
570
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
555
571
|
*/
|
|
556
|
-
|
|
572
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
573
|
+
assetIds?: string[];
|
|
574
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
557
575
|
/**
|
|
558
|
-
* HTTP
|
|
559
|
-
* Java method: org.openremote.model.
|
|
576
|
+
* HTTP GET /alarm
|
|
577
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
560
578
|
*/
|
|
561
|
-
|
|
579
|
+
getAlarms(queryParams?: {
|
|
580
|
+
realm?: string;
|
|
581
|
+
status?: Model.AlarmStatus;
|
|
582
|
+
assetId?: string;
|
|
583
|
+
assigneeId?: string;
|
|
584
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
562
585
|
/**
|
|
563
|
-
* HTTP
|
|
564
|
-
* Java method: org.openremote.model.
|
|
586
|
+
* HTTP DELETE /alarm
|
|
587
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
565
588
|
*/
|
|
566
|
-
|
|
589
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
567
590
|
/**
|
|
568
|
-
* HTTP
|
|
569
|
-
* Java method: org.openremote.model.
|
|
591
|
+
* HTTP PUT /alarm/assets
|
|
592
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
570
593
|
*/
|
|
571
|
-
|
|
594
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
572
595
|
/**
|
|
573
|
-
* HTTP GET /
|
|
574
|
-
* Java method: org.openremote.model.
|
|
596
|
+
* HTTP GET /alarm/{alarmId}
|
|
597
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
575
598
|
*/
|
|
576
|
-
|
|
599
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
577
600
|
/**
|
|
578
|
-
* HTTP
|
|
579
|
-
* Java method: org.openremote.model.
|
|
601
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
602
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
580
603
|
*/
|
|
581
|
-
|
|
604
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
582
605
|
/**
|
|
583
|
-
* HTTP PUT /
|
|
584
|
-
* Java method: org.openremote.model.
|
|
606
|
+
* HTTP PUT /alarm/{alarmId}
|
|
607
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
585
608
|
*/
|
|
586
|
-
|
|
609
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
587
610
|
/**
|
|
588
|
-
* HTTP
|
|
589
|
-
* Java method: org.openremote.model.
|
|
611
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
612
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
590
613
|
*/
|
|
591
|
-
|
|
614
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
615
|
+
realm?: string;
|
|
616
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
617
|
+
}
|
|
618
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
619
|
+
protected httpClient: HttpClient<O>;
|
|
620
|
+
constructor(httpClient: HttpClient<O>);
|
|
592
621
|
/**
|
|
593
|
-
* HTTP GET /
|
|
594
|
-
* Java method: org.openremote.model.
|
|
622
|
+
* HTTP GET /asset/datapoint/export
|
|
623
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
595
624
|
*/
|
|
596
|
-
|
|
625
|
+
getDatapointExport(queryParams?: {
|
|
626
|
+
attributeRefs?: string;
|
|
627
|
+
fromTimestamp?: number;
|
|
628
|
+
toTimestamp?: number;
|
|
629
|
+
}, options?: O): RestResponse<any>;
|
|
597
630
|
/**
|
|
598
|
-
* HTTP
|
|
599
|
-
* Java method: org.openremote.model.
|
|
631
|
+
* HTTP GET /asset/datapoint/periods
|
|
632
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
600
633
|
*/
|
|
601
|
-
|
|
634
|
+
getDatapointPeriod(queryParams?: {
|
|
635
|
+
assetId?: string;
|
|
636
|
+
attributeName?: string;
|
|
637
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
602
638
|
/**
|
|
603
|
-
* HTTP
|
|
604
|
-
* Java method: org.openremote.model.
|
|
639
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
640
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
605
641
|
*/
|
|
606
|
-
|
|
642
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
643
|
+
}
|
|
644
|
+
export declare class ProvisioningResourceClient<O> {
|
|
645
|
+
protected httpClient: HttpClient<O>;
|
|
646
|
+
constructor(httpClient: HttpClient<O>);
|
|
607
647
|
/**
|
|
608
|
-
* HTTP
|
|
609
|
-
* Java method: org.openremote.model.
|
|
648
|
+
* HTTP POST /provisioning
|
|
649
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
610
650
|
*/
|
|
611
|
-
|
|
651
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
612
652
|
/**
|
|
613
|
-
* HTTP GET /
|
|
614
|
-
* Java method: org.openremote.model.
|
|
653
|
+
* HTTP GET /provisioning
|
|
654
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
615
655
|
*/
|
|
616
|
-
|
|
656
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
617
657
|
/**
|
|
618
|
-
* HTTP
|
|
619
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP DELETE /provisioning/{id}
|
|
659
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
620
660
|
*/
|
|
621
|
-
|
|
661
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
622
662
|
/**
|
|
623
|
-
* HTTP
|
|
624
|
-
* Java method: org.openremote.model.
|
|
663
|
+
* HTTP PUT /provisioning/{id}
|
|
664
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
625
665
|
*/
|
|
626
|
-
|
|
666
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
667
|
+
}
|
|
668
|
+
export declare class NotificationResourceClient<O> {
|
|
669
|
+
protected httpClient: HttpClient<O>;
|
|
670
|
+
constructor(httpClient: HttpClient<O>);
|
|
627
671
|
/**
|
|
628
|
-
* HTTP
|
|
629
|
-
* Java method: org.openremote.model.
|
|
672
|
+
* HTTP GET /notification
|
|
673
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
630
674
|
*/
|
|
631
|
-
|
|
675
|
+
getNotifications(queryParams?: {
|
|
676
|
+
id?: number;
|
|
677
|
+
type?: string;
|
|
678
|
+
from?: number;
|
|
679
|
+
to?: number;
|
|
680
|
+
realmId?: string;
|
|
681
|
+
userId?: string;
|
|
682
|
+
assetId?: string;
|
|
683
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
632
684
|
/**
|
|
633
|
-
* HTTP
|
|
634
|
-
* Java method: org.openremote.model.
|
|
685
|
+
* HTTP DELETE /notification
|
|
686
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
635
687
|
*/
|
|
636
|
-
|
|
688
|
+
removeNotifications(queryParams?: {
|
|
689
|
+
id?: number;
|
|
690
|
+
type?: string;
|
|
691
|
+
from?: number;
|
|
692
|
+
to?: number;
|
|
693
|
+
realmId?: string;
|
|
694
|
+
userId?: string;
|
|
695
|
+
assetId?: string;
|
|
696
|
+
}, options?: O): RestResponse<void>;
|
|
637
697
|
/**
|
|
638
|
-
* HTTP
|
|
639
|
-
* Java method: org.openremote.model.
|
|
698
|
+
* HTTP POST /notification/alert
|
|
699
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
640
700
|
*/
|
|
641
|
-
|
|
701
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
642
702
|
/**
|
|
643
|
-
* HTTP
|
|
644
|
-
* Java method: org.openremote.model.
|
|
703
|
+
* HTTP DELETE /notification/{notificationId}
|
|
704
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
645
705
|
*/
|
|
646
|
-
|
|
706
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
647
707
|
/**
|
|
648
|
-
* HTTP PUT /
|
|
649
|
-
* Java method: org.openremote.model.
|
|
708
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
709
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
650
710
|
*/
|
|
651
|
-
|
|
711
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
712
|
+
targetId?: string;
|
|
713
|
+
}, options?: O): RestResponse<void>;
|
|
652
714
|
/**
|
|
653
|
-
* HTTP
|
|
654
|
-
* Java method: org.openremote.model.
|
|
715
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
716
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
655
717
|
*/
|
|
656
|
-
|
|
718
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
719
|
+
targetId?: string;
|
|
720
|
+
}, options?: O): RestResponse<void>;
|
|
657
721
|
}
|
|
658
722
|
export declare class MapResourceClient<O> {
|
|
659
723
|
protected httpClient: HttpClient<O>;
|
|
@@ -708,239 +772,175 @@ export declare class MapResourceClient<O> {
|
|
|
708
772
|
[id: string]: unknown;
|
|
709
773
|
}>;
|
|
710
774
|
}
|
|
711
|
-
export declare class
|
|
712
|
-
protected httpClient: HttpClient<O>;
|
|
713
|
-
constructor(httpClient: HttpClient<O>);
|
|
714
|
-
/**
|
|
715
|
-
* HTTP GET /configuration/manager
|
|
716
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
717
|
-
*/
|
|
718
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
719
|
-
/**
|
|
720
|
-
* HTTP PUT /configuration/manager
|
|
721
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
722
|
-
*/
|
|
723
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
724
|
-
/**
|
|
725
|
-
* HTTP POST /configuration/manager/file
|
|
726
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
727
|
-
*/
|
|
728
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
729
|
-
path?: string;
|
|
730
|
-
}, options?: O): RestResponse<string>;
|
|
731
|
-
/**
|
|
732
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
733
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
734
|
-
*/
|
|
735
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
736
|
-
}
|
|
737
|
-
export declare class NotificationResourceClient<O> {
|
|
775
|
+
export declare class UserResourceClient<O> {
|
|
738
776
|
protected httpClient: HttpClient<O>;
|
|
739
777
|
constructor(httpClient: HttpClient<O>);
|
|
740
778
|
/**
|
|
741
|
-
* HTTP
|
|
742
|
-
* Java method: org.openremote.model.
|
|
779
|
+
* HTTP PUT /user/locale
|
|
780
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
743
781
|
*/
|
|
744
|
-
|
|
745
|
-
id?: number;
|
|
746
|
-
type?: string;
|
|
747
|
-
from?: number;
|
|
748
|
-
to?: number;
|
|
749
|
-
realmId?: string;
|
|
750
|
-
userId?: string;
|
|
751
|
-
assetId?: string;
|
|
752
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
782
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
753
783
|
/**
|
|
754
|
-
* HTTP
|
|
755
|
-
* Java method: org.openremote.model.
|
|
756
|
-
*/
|
|
757
|
-
|
|
758
|
-
id?: number;
|
|
759
|
-
type?: string;
|
|
760
|
-
from?: number;
|
|
761
|
-
to?: number;
|
|
762
|
-
realmId?: string;
|
|
763
|
-
userId?: string;
|
|
764
|
-
assetId?: string;
|
|
765
|
-
}, options?: O): RestResponse<void>;
|
|
784
|
+
* HTTP POST /user/query
|
|
785
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
786
|
+
*/
|
|
787
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
766
788
|
/**
|
|
767
|
-
* HTTP
|
|
768
|
-
* Java method: org.openremote.model.
|
|
789
|
+
* HTTP PUT /user/request-password-reset
|
|
790
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
769
791
|
*/
|
|
770
|
-
|
|
792
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
771
793
|
/**
|
|
772
|
-
* HTTP
|
|
773
|
-
* Java method: org.openremote.model.
|
|
794
|
+
* HTTP PUT /user/reset-password
|
|
795
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
774
796
|
*/
|
|
775
|
-
|
|
797
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
776
798
|
/**
|
|
777
|
-
* HTTP PUT /
|
|
778
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP PUT /user/update
|
|
800
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
779
801
|
*/
|
|
780
|
-
|
|
781
|
-
targetId?: string;
|
|
782
|
-
}, options?: O): RestResponse<void>;
|
|
802
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
783
803
|
/**
|
|
784
|
-
* HTTP
|
|
785
|
-
* Java method: org.openremote.model.
|
|
804
|
+
* HTTP GET /user/user
|
|
805
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
786
806
|
*/
|
|
787
|
-
|
|
788
|
-
targetId?: string;
|
|
789
|
-
}, options?: O): RestResponse<void>;
|
|
790
|
-
}
|
|
791
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
792
|
-
protected httpClient: HttpClient<O>;
|
|
793
|
-
constructor(httpClient: HttpClient<O>);
|
|
807
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
794
808
|
/**
|
|
795
|
-
* HTTP
|
|
796
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP GET /user/userRealmRoles
|
|
810
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
797
811
|
*/
|
|
798
|
-
|
|
812
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
799
813
|
/**
|
|
800
|
-
* HTTP
|
|
801
|
-
* Java method: org.openremote.model.
|
|
814
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
815
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
802
816
|
*/
|
|
803
|
-
|
|
817
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
804
818
|
/**
|
|
805
|
-
* HTTP GET /
|
|
806
|
-
* Java method: org.openremote.model.
|
|
819
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
820
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
807
821
|
*/
|
|
808
|
-
|
|
822
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
809
823
|
/**
|
|
810
|
-
* HTTP
|
|
811
|
-
* Java method: org.openremote.model.
|
|
824
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
825
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
812
826
|
*/
|
|
813
|
-
|
|
827
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
814
828
|
/**
|
|
815
|
-
* HTTP
|
|
816
|
-
* Java method: org.openremote.model.
|
|
829
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
830
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
817
831
|
*/
|
|
818
|
-
|
|
819
|
-
}
|
|
820
|
-
export declare class DashboardResourceClient<O> {
|
|
821
|
-
protected httpClient: HttpClient<O>;
|
|
822
|
-
constructor(httpClient: HttpClient<O>);
|
|
832
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
823
833
|
/**
|
|
824
|
-
* HTTP
|
|
825
|
-
* Java method: org.openremote.model.
|
|
834
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
835
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
826
836
|
*/
|
|
827
|
-
|
|
837
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
828
838
|
/**
|
|
829
|
-
* HTTP PUT /
|
|
830
|
-
* Java method: org.openremote.model.
|
|
839
|
+
* HTTP PUT /user/{realm}/roles
|
|
840
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
831
841
|
*/
|
|
832
|
-
|
|
842
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
833
843
|
/**
|
|
834
|
-
* HTTP GET /
|
|
835
|
-
* Java method: org.openremote.model.
|
|
844
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
845
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
836
846
|
*/
|
|
837
|
-
|
|
847
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
838
848
|
/**
|
|
839
|
-
* HTTP
|
|
840
|
-
* Java method: org.openremote.model.
|
|
849
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
850
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
841
851
|
*/
|
|
842
|
-
|
|
852
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
843
853
|
/**
|
|
844
|
-
* HTTP
|
|
845
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
855
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
846
856
|
*/
|
|
847
|
-
|
|
857
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
848
858
|
/**
|
|
849
|
-
* HTTP
|
|
850
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
860
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
851
861
|
*/
|
|
852
|
-
|
|
853
|
-
}
|
|
854
|
-
export declare class AppResourceClient<O> {
|
|
855
|
-
protected httpClient: HttpClient<O>;
|
|
856
|
-
constructor(httpClient: HttpClient<O>);
|
|
862
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
857
863
|
/**
|
|
858
|
-
* HTTP GET /
|
|
859
|
-
* Java method: org.openremote.model.
|
|
864
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
865
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
860
866
|
*/
|
|
861
|
-
|
|
867
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
862
868
|
/**
|
|
863
|
-
* HTTP
|
|
864
|
-
* Java method: org.openremote.model.
|
|
869
|
+
* HTTP POST /user/{realm}/users
|
|
870
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
865
871
|
*/
|
|
866
|
-
|
|
872
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
867
873
|
/**
|
|
868
|
-
* HTTP
|
|
869
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP PUT /user/{realm}/users
|
|
875
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
870
876
|
*/
|
|
871
|
-
|
|
872
|
-
}
|
|
873
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
874
|
-
protected httpClient: HttpClient<O>;
|
|
875
|
-
constructor(httpClient: HttpClient<O>);
|
|
877
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
876
878
|
/**
|
|
877
|
-
* HTTP
|
|
878
|
-
* Java method: org.openremote.model.
|
|
879
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
880
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
879
881
|
*/
|
|
880
|
-
|
|
881
|
-
attributeRefs?: string;
|
|
882
|
-
fromTimestamp?: number;
|
|
883
|
-
toTimestamp?: number;
|
|
884
|
-
}, options?: O): RestResponse<any>;
|
|
882
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
885
883
|
/**
|
|
886
|
-
* HTTP GET /
|
|
887
|
-
* Java method: org.openremote.model.
|
|
884
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
885
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
888
886
|
*/
|
|
889
|
-
|
|
890
|
-
assetId?: string;
|
|
891
|
-
attributeName?: string;
|
|
892
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
887
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
893
888
|
/**
|
|
894
|
-
* HTTP
|
|
895
|
-
* Java method: org.openremote.model.
|
|
889
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
890
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
896
891
|
*/
|
|
897
|
-
|
|
892
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
893
|
+
/**
|
|
894
|
+
* HTTP GET /user/{realm}/{userId}
|
|
895
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
896
|
+
*/
|
|
897
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
901
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
902
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
903
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
904
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
902
905
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
903
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
904
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
905
906
|
protected _agentResource: AxiosAgentResourceClient;
|
|
906
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
907
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
908
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
909
907
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
910
|
-
protected
|
|
911
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
912
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
913
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
914
|
-
protected _userResource: AxiosUserResourceClient;
|
|
915
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
908
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
916
909
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
917
|
-
protected
|
|
910
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
911
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
918
912
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
919
|
-
protected
|
|
913
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
914
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
920
915
|
protected _appResource: AxiosAppResourceClient;
|
|
916
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
921
917
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
918
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
919
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
920
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
921
|
+
protected _userResource: AxiosUserResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
923
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
924
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
925
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
926
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
924
927
|
get RulesResource(): AxiosRulesResourceClient;
|
|
925
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
926
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
927
928
|
get AgentResource(): AxiosAgentResourceClient;
|
|
928
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
929
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
930
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
931
929
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
932
|
-
get
|
|
933
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
934
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
935
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
936
|
-
get UserResource(): AxiosUserResourceClient;
|
|
937
|
-
get MapResource(): AxiosMapResourceClient;
|
|
930
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
938
931
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
939
|
-
get
|
|
932
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
933
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
940
934
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
941
|
-
get
|
|
935
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
936
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
942
937
|
get AppResource(): AxiosAppResourceClient;
|
|
938
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
943
939
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
940
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
941
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
942
|
+
get MapResource(): AxiosMapResourceClient;
|
|
943
|
+
get UserResource(): AxiosUserResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
961
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
|
+
}
|
|
963
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
961
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
965
|
}
|
|
963
966
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
964
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
968
|
}
|
|
966
|
-
export declare class
|
|
969
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
967
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
971
|
}
|
|
969
972
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
970
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
974
|
}
|
|
972
|
-
export declare class
|
|
975
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
973
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
977
|
}
|
|
975
|
-
export declare class
|
|
978
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
976
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
980
|
}
|
|
978
|
-
export declare class
|
|
981
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
979
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
983
|
}
|
|
981
|
-
export declare class
|
|
984
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
982
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
986
|
}
|
|
984
|
-
export declare class
|
|
987
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
985
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
989
|
}
|
|
987
990
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
988
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
992
|
}
|
|
990
|
-
export declare class
|
|
991
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
}
|
|
993
|
-
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
993
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|