@openremote/rest 1.7.0-snapshot.20250623193034 → 1.7.0-snapshot.20250624092918
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 +470 -470
- 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,71 +9,24 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /health
|
|
17
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
18
|
-
*/
|
|
19
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
20
|
-
[index: string]: any;
|
|
21
|
-
}>;
|
|
22
|
-
/**
|
|
23
|
-
* HTTP GET /info
|
|
24
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
25
|
-
*/
|
|
26
|
-
getInfo(options?: O): RestResponse<{
|
|
27
|
-
[index: string]: any;
|
|
28
|
-
}>;
|
|
29
|
-
}
|
|
30
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
31
|
-
protected httpClient: HttpClient<O>;
|
|
32
|
-
constructor(httpClient: HttpClient<O>);
|
|
33
|
-
/**
|
|
34
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
35
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
36
|
-
*/
|
|
37
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
38
|
-
/**
|
|
39
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
40
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
41
|
-
*/
|
|
42
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
43
|
-
}
|
|
44
|
-
export declare class RealmResourceClient<O> {
|
|
12
|
+
export declare class AppResourceClient<O> {
|
|
45
13
|
protected httpClient: HttpClient<O>;
|
|
46
14
|
constructor(httpClient: HttpClient<O>);
|
|
47
15
|
/**
|
|
48
|
-
* HTTP
|
|
49
|
-
* Java method: org.openremote.model.
|
|
50
|
-
*/
|
|
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
|
|
16
|
+
* HTTP GET /apps
|
|
17
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
65
18
|
*/
|
|
66
|
-
|
|
19
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
67
20
|
/**
|
|
68
|
-
* HTTP GET /
|
|
69
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /apps/consoleConfig
|
|
22
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
70
23
|
*/
|
|
71
|
-
|
|
24
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
72
25
|
/**
|
|
73
|
-
* HTTP
|
|
74
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /apps/info
|
|
27
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
75
28
|
*/
|
|
76
|
-
|
|
29
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
77
30
|
}
|
|
78
31
|
export declare class GatewayServiceResourceClient<O> {
|
|
79
32
|
protected httpClient: HttpClient<O>;
|
|
@@ -104,6 +57,54 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
104
57
|
*/
|
|
105
58
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
106
59
|
}
|
|
60
|
+
export declare class DashboardResourceClient<O> {
|
|
61
|
+
protected httpClient: HttpClient<O>;
|
|
62
|
+
constructor(httpClient: HttpClient<O>);
|
|
63
|
+
/**
|
|
64
|
+
* HTTP POST /dashboard
|
|
65
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
66
|
+
*/
|
|
67
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
68
|
+
/**
|
|
69
|
+
* HTTP PUT /dashboard
|
|
70
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
71
|
+
*/
|
|
72
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
73
|
+
/**
|
|
74
|
+
* HTTP GET /dashboard/all/{realm}
|
|
75
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
76
|
+
*/
|
|
77
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
78
|
+
/**
|
|
79
|
+
* HTTP POST /dashboard/query
|
|
80
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
81
|
+
*/
|
|
82
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
83
|
+
/**
|
|
84
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
85
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
86
|
+
*/
|
|
87
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
88
|
+
/**
|
|
89
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
90
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
91
|
+
*/
|
|
92
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
93
|
+
}
|
|
94
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
95
|
+
protected httpClient: HttpClient<O>;
|
|
96
|
+
constructor(httpClient: HttpClient<O>);
|
|
97
|
+
/**
|
|
98
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
99
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
100
|
+
*/
|
|
101
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
102
|
+
/**
|
|
103
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
104
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
105
|
+
*/
|
|
106
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
107
|
+
}
|
|
107
108
|
export declare class ProvisioningResourceClient<O> {
|
|
108
109
|
protected httpClient: HttpClient<O>;
|
|
109
110
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -128,24 +129,63 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
128
129
|
*/
|
|
129
130
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
130
131
|
}
|
|
131
|
-
export declare class
|
|
132
|
+
export declare class SyslogResourceClient<O> {
|
|
132
133
|
protected httpClient: HttpClient<O>;
|
|
133
134
|
constructor(httpClient: HttpClient<O>);
|
|
134
135
|
/**
|
|
135
|
-
* HTTP GET /
|
|
136
|
-
* Java method: org.openremote.model.
|
|
136
|
+
* HTTP GET /syslog/config
|
|
137
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
137
138
|
*/
|
|
138
|
-
|
|
139
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
139
140
|
/**
|
|
140
|
-
* HTTP
|
|
141
|
-
* Java method: org.openremote.model.
|
|
141
|
+
* HTTP PUT /syslog/config
|
|
142
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
142
143
|
*/
|
|
143
|
-
|
|
144
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
144
145
|
/**
|
|
145
|
-
* HTTP
|
|
146
|
-
* Java method: org.openremote.model.
|
|
146
|
+
* HTTP DELETE /syslog/event
|
|
147
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
147
148
|
*/
|
|
148
|
-
|
|
149
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
150
|
+
/**
|
|
151
|
+
* HTTP GET /syslog/event
|
|
152
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
153
|
+
*/
|
|
154
|
+
getEvents(queryParams?: {
|
|
155
|
+
level?: Model.SyslogLevel;
|
|
156
|
+
per_page?: number;
|
|
157
|
+
page?: number;
|
|
158
|
+
from?: number;
|
|
159
|
+
to?: number;
|
|
160
|
+
category?: Model.SyslogCategory[];
|
|
161
|
+
subCategory?: string[];
|
|
162
|
+
}, options?: O): RestResponse<any>;
|
|
163
|
+
}
|
|
164
|
+
export declare class ConfigurationResourceClient<O> {
|
|
165
|
+
protected httpClient: HttpClient<O>;
|
|
166
|
+
constructor(httpClient: HttpClient<O>);
|
|
167
|
+
/**
|
|
168
|
+
* HTTP GET /configuration/manager
|
|
169
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
170
|
+
*/
|
|
171
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
172
|
+
/**
|
|
173
|
+
* HTTP PUT /configuration/manager
|
|
174
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
175
|
+
*/
|
|
176
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
177
|
+
/**
|
|
178
|
+
* HTTP POST /configuration/manager/file
|
|
179
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
180
|
+
*/
|
|
181
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
182
|
+
path?: string;
|
|
183
|
+
}, options?: O): RestResponse<string>;
|
|
184
|
+
/**
|
|
185
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
186
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
187
|
+
*/
|
|
188
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
149
189
|
}
|
|
150
190
|
export declare class AssetResourceClient<O> {
|
|
151
191
|
protected httpClient: HttpClient<O>;
|
|
@@ -251,214 +291,261 @@ export declare class AssetResourceClient<O> {
|
|
|
251
291
|
assetIds?: string[];
|
|
252
292
|
}, options?: O): RestResponse<void>;
|
|
253
293
|
}
|
|
254
|
-
export declare class
|
|
294
|
+
export declare class AlarmResourceClient<O> {
|
|
255
295
|
protected httpClient: HttpClient<O>;
|
|
256
296
|
constructor(httpClient: HttpClient<O>);
|
|
257
297
|
/**
|
|
258
|
-
* HTTP
|
|
259
|
-
* Java method: org.openremote.model.
|
|
260
|
-
*/
|
|
261
|
-
getAssetDescriptors(queryParams?: {
|
|
262
|
-
parentId?: string;
|
|
263
|
-
parentType?: string;
|
|
264
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
265
|
-
/**
|
|
266
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
267
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
298
|
+
* HTTP POST /alarm
|
|
299
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
268
300
|
*/
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
}, options?: O): RestResponse<Model.
|
|
301
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
302
|
+
assetIds?: string[];
|
|
303
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
272
304
|
/**
|
|
273
|
-
* HTTP GET /
|
|
274
|
-
* Java method: org.openremote.model.
|
|
305
|
+
* HTTP GET /alarm
|
|
306
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
275
307
|
*/
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
308
|
+
getAlarms(queryParams?: {
|
|
309
|
+
realm?: string;
|
|
310
|
+
status?: Model.AlarmStatus;
|
|
311
|
+
assetId?: string;
|
|
312
|
+
assigneeId?: string;
|
|
313
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
280
314
|
/**
|
|
281
|
-
* HTTP
|
|
282
|
-
* Java method: org.openremote.model.
|
|
315
|
+
* HTTP DELETE /alarm
|
|
316
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
283
317
|
*/
|
|
284
|
-
|
|
285
|
-
parentId?: string;
|
|
286
|
-
}, options?: O): RestResponse<{
|
|
287
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
288
|
-
}>;
|
|
318
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
289
319
|
/**
|
|
290
|
-
* HTTP
|
|
291
|
-
* Java method: org.openremote.model.
|
|
320
|
+
* HTTP PUT /alarm/assets
|
|
321
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
292
322
|
*/
|
|
293
|
-
|
|
294
|
-
parentId?: string;
|
|
295
|
-
}, options?: O): RestResponse<{
|
|
296
|
-
[index: string]: Model.ValueDescriptor;
|
|
297
|
-
}>;
|
|
298
|
-
}
|
|
299
|
-
export declare class ConfigurationResourceClient<O> {
|
|
300
|
-
protected httpClient: HttpClient<O>;
|
|
301
|
-
constructor(httpClient: HttpClient<O>);
|
|
323
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
302
324
|
/**
|
|
303
|
-
* HTTP GET /
|
|
304
|
-
* Java method: org.openremote.model.
|
|
325
|
+
* HTTP GET /alarm/{alarmId}
|
|
326
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
305
327
|
*/
|
|
306
|
-
|
|
328
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
307
329
|
/**
|
|
308
|
-
* HTTP
|
|
309
|
-
* Java method: org.openremote.model.
|
|
330
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
331
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
310
332
|
*/
|
|
311
|
-
|
|
333
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
312
334
|
/**
|
|
313
|
-
* HTTP
|
|
314
|
-
* Java method: org.openremote.model.
|
|
335
|
+
* HTTP PUT /alarm/{alarmId}
|
|
336
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
315
337
|
*/
|
|
316
|
-
|
|
317
|
-
path?: string;
|
|
318
|
-
}, options?: O): RestResponse<string>;
|
|
338
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
319
339
|
/**
|
|
320
|
-
* HTTP GET /
|
|
321
|
-
* Java method: org.openremote.model.
|
|
340
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
341
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
322
342
|
*/
|
|
323
|
-
|
|
343
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
344
|
+
realm?: string;
|
|
345
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
324
346
|
}
|
|
325
|
-
export declare class
|
|
347
|
+
export declare class ConsoleResourceClient<O> {
|
|
326
348
|
protected httpClient: HttpClient<O>;
|
|
327
349
|
constructor(httpClient: HttpClient<O>);
|
|
328
350
|
/**
|
|
329
|
-
* HTTP POST /
|
|
330
|
-
* Java method: org.openremote.model.
|
|
351
|
+
* HTTP POST /console/register
|
|
352
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
331
353
|
*/
|
|
332
|
-
|
|
354
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
355
|
+
}
|
|
356
|
+
export declare class StatusResourceClient<O> {
|
|
357
|
+
protected httpClient: HttpClient<O>;
|
|
358
|
+
constructor(httpClient: HttpClient<O>);
|
|
333
359
|
/**
|
|
334
|
-
* HTTP
|
|
335
|
-
* Java method: org.openremote.model.
|
|
360
|
+
* HTTP GET /health
|
|
361
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
336
362
|
*/
|
|
337
|
-
|
|
363
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
364
|
+
[index: string]: any;
|
|
365
|
+
}>;
|
|
338
366
|
/**
|
|
339
|
-
* HTTP GET /
|
|
340
|
-
* Java method: org.openremote.model.
|
|
367
|
+
* HTTP GET /info
|
|
368
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
341
369
|
*/
|
|
342
|
-
|
|
370
|
+
getInfo(options?: O): RestResponse<{
|
|
371
|
+
[index: string]: any;
|
|
372
|
+
}>;
|
|
373
|
+
}
|
|
374
|
+
export declare class GatewayClientResourceClient<O> {
|
|
375
|
+
protected httpClient: HttpClient<O>;
|
|
376
|
+
constructor(httpClient: HttpClient<O>);
|
|
343
377
|
/**
|
|
344
|
-
* HTTP
|
|
345
|
-
* Java method: org.openremote.model.
|
|
378
|
+
* HTTP DELETE /gateway/connection
|
|
379
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
346
380
|
*/
|
|
347
|
-
|
|
381
|
+
deleteConnections(queryParams?: {
|
|
382
|
+
realm?: string[];
|
|
383
|
+
}, options?: O): RestResponse<void>;
|
|
348
384
|
/**
|
|
349
|
-
* HTTP
|
|
350
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP GET /gateway/connection
|
|
386
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
351
387
|
*/
|
|
352
|
-
|
|
388
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
353
389
|
/**
|
|
354
|
-
* HTTP
|
|
355
|
-
* Java method: org.openremote.model.
|
|
390
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
391
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
356
392
|
*/
|
|
357
|
-
|
|
358
|
-
}
|
|
359
|
-
export declare class UserResourceClient<O> {
|
|
360
|
-
protected httpClient: HttpClient<O>;
|
|
361
|
-
constructor(httpClient: HttpClient<O>);
|
|
393
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
362
394
|
/**
|
|
363
|
-
* HTTP
|
|
364
|
-
* Java method: org.openremote.model.
|
|
395
|
+
* HTTP GET /gateway/connection/{realm}
|
|
396
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
365
397
|
*/
|
|
366
|
-
|
|
398
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
367
399
|
/**
|
|
368
|
-
* HTTP
|
|
369
|
-
* Java method: org.openremote.model.
|
|
400
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
401
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
370
402
|
*/
|
|
371
|
-
|
|
403
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
372
404
|
/**
|
|
373
|
-
* HTTP GET /
|
|
374
|
-
* Java method: org.openremote.model.
|
|
405
|
+
* HTTP GET /gateway/status/{realm}
|
|
406
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
375
407
|
*/
|
|
376
|
-
|
|
408
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
409
|
+
}
|
|
410
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
411
|
+
protected httpClient: HttpClient<O>;
|
|
412
|
+
constructor(httpClient: HttpClient<O>);
|
|
377
413
|
/**
|
|
378
|
-
* HTTP GET /
|
|
379
|
-
* Java method: org.openremote.model.
|
|
414
|
+
* HTTP GET /asset/datapoint/export
|
|
415
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
380
416
|
*/
|
|
381
|
-
|
|
417
|
+
getDatapointExport(queryParams?: {
|
|
418
|
+
attributeRefs?: string;
|
|
419
|
+
fromTimestamp?: number;
|
|
420
|
+
toTimestamp?: number;
|
|
421
|
+
}, options?: O): RestResponse<any>;
|
|
382
422
|
/**
|
|
383
|
-
* HTTP GET /
|
|
384
|
-
* Java method: org.openremote.model.
|
|
423
|
+
* HTTP GET /asset/datapoint/periods
|
|
424
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
385
425
|
*/
|
|
386
|
-
|
|
426
|
+
getDatapointPeriod(queryParams?: {
|
|
427
|
+
assetId?: string;
|
|
428
|
+
attributeName?: string;
|
|
429
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
387
430
|
/**
|
|
388
|
-
* HTTP
|
|
389
|
-
* Java method: org.openremote.model.
|
|
431
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
432
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
390
433
|
*/
|
|
391
|
-
|
|
434
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
435
|
+
}
|
|
436
|
+
export declare class AgentResourceClient<O> {
|
|
437
|
+
protected httpClient: HttpClient<O>;
|
|
438
|
+
constructor(httpClient: HttpClient<O>);
|
|
392
439
|
/**
|
|
393
|
-
* HTTP
|
|
394
|
-
* Java method: org.openremote.model.
|
|
440
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
441
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
395
442
|
*/
|
|
396
|
-
|
|
443
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
444
|
+
realm?: string;
|
|
445
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
397
446
|
/**
|
|
398
|
-
* HTTP
|
|
399
|
-
* Java method: org.openremote.model.
|
|
447
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
448
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
400
449
|
*/
|
|
401
|
-
|
|
450
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
451
|
+
realm?: string;
|
|
452
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
402
453
|
/**
|
|
403
|
-
* HTTP
|
|
404
|
-
* Java method: org.openremote.model.
|
|
454
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
455
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
405
456
|
*/
|
|
406
|
-
|
|
457
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
458
|
+
parentId?: string;
|
|
459
|
+
realm?: string;
|
|
460
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
461
|
+
}
|
|
462
|
+
export declare class RealmResourceClient<O> {
|
|
463
|
+
protected httpClient: HttpClient<O>;
|
|
464
|
+
constructor(httpClient: HttpClient<O>);
|
|
407
465
|
/**
|
|
408
|
-
* HTTP
|
|
409
|
-
* Java method: org.openremote.model.security.
|
|
466
|
+
* HTTP POST /realm
|
|
467
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
410
468
|
*/
|
|
411
|
-
|
|
469
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
412
470
|
/**
|
|
413
|
-
* HTTP
|
|
414
|
-
* Java method: org.openremote.model.security.
|
|
471
|
+
* HTTP GET /realm
|
|
472
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
415
473
|
*/
|
|
416
|
-
|
|
474
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
417
475
|
/**
|
|
418
|
-
* HTTP GET /
|
|
419
|
-
* Java method: org.openremote.model.security.
|
|
476
|
+
* HTTP GET /realm/accessible
|
|
477
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
420
478
|
*/
|
|
421
|
-
|
|
479
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
422
480
|
/**
|
|
423
|
-
* HTTP
|
|
424
|
-
* Java method: org.openremote.model.security.
|
|
481
|
+
* HTTP DELETE /realm/{name}
|
|
482
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
425
483
|
*/
|
|
426
|
-
|
|
484
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
427
485
|
/**
|
|
428
|
-
* HTTP GET /
|
|
429
|
-
* Java method: org.openremote.model.security.
|
|
486
|
+
* HTTP GET /realm/{name}
|
|
487
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
430
488
|
*/
|
|
431
|
-
|
|
489
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
432
490
|
/**
|
|
433
|
-
* HTTP
|
|
434
|
-
* Java method: org.openremote.model.security.
|
|
491
|
+
* HTTP PUT /realm/{name}
|
|
492
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
435
493
|
*/
|
|
436
|
-
|
|
494
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
495
|
+
}
|
|
496
|
+
export declare class NotificationResourceClient<O> {
|
|
497
|
+
protected httpClient: HttpClient<O>;
|
|
498
|
+
constructor(httpClient: HttpClient<O>);
|
|
437
499
|
/**
|
|
438
|
-
* HTTP
|
|
439
|
-
* Java method: org.openremote.model.
|
|
500
|
+
* HTTP GET /notification
|
|
501
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
440
502
|
*/
|
|
441
|
-
|
|
503
|
+
getNotifications(queryParams?: {
|
|
504
|
+
id?: number;
|
|
505
|
+
type?: string;
|
|
506
|
+
from?: number;
|
|
507
|
+
to?: number;
|
|
508
|
+
realmId?: string;
|
|
509
|
+
userId?: string;
|
|
510
|
+
assetId?: string;
|
|
511
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
442
512
|
/**
|
|
443
|
-
* HTTP DELETE /
|
|
444
|
-
* Java method: org.openremote.model.
|
|
513
|
+
* HTTP DELETE /notification
|
|
514
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
445
515
|
*/
|
|
446
|
-
|
|
516
|
+
removeNotifications(queryParams?: {
|
|
517
|
+
id?: number;
|
|
518
|
+
type?: string;
|
|
519
|
+
from?: number;
|
|
520
|
+
to?: number;
|
|
521
|
+
realmId?: string;
|
|
522
|
+
userId?: string;
|
|
523
|
+
assetId?: string;
|
|
524
|
+
}, options?: O): RestResponse<void>;
|
|
447
525
|
/**
|
|
448
|
-
* HTTP
|
|
449
|
-
* Java method: org.openremote.model.
|
|
526
|
+
* HTTP POST /notification/alert
|
|
527
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
450
528
|
*/
|
|
451
|
-
|
|
529
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
452
530
|
/**
|
|
453
|
-
* HTTP
|
|
454
|
-
* Java method: org.openremote.model.
|
|
531
|
+
* HTTP DELETE /notification/{notificationId}
|
|
532
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
455
533
|
*/
|
|
456
|
-
|
|
534
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
457
535
|
/**
|
|
458
|
-
* HTTP
|
|
459
|
-
* Java method: org.openremote.model.
|
|
536
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
537
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
460
538
|
*/
|
|
461
|
-
|
|
539
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
540
|
+
targetId?: string;
|
|
541
|
+
}, options?: O): RestResponse<void>;
|
|
542
|
+
/**
|
|
543
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
544
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
545
|
+
*/
|
|
546
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
547
|
+
targetId?: string;
|
|
548
|
+
}, options?: O): RestResponse<void>;
|
|
462
549
|
}
|
|
463
550
|
export declare class MapResourceClient<O> {
|
|
464
551
|
protected httpClient: HttpClient<O>;
|
|
@@ -513,181 +600,24 @@ export declare class MapResourceClient<O> {
|
|
|
513
600
|
[id: string]: unknown;
|
|
514
601
|
}>;
|
|
515
602
|
}
|
|
516
|
-
export declare class
|
|
603
|
+
export declare class FlowResourceClient<O> {
|
|
517
604
|
protected httpClient: HttpClient<O>;
|
|
518
605
|
constructor(httpClient: HttpClient<O>);
|
|
519
606
|
/**
|
|
520
|
-
* HTTP GET /
|
|
521
|
-
* Java method: org.openremote.model.
|
|
607
|
+
* HTTP GET /flow
|
|
608
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
522
609
|
*/
|
|
523
|
-
|
|
610
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
524
611
|
/**
|
|
525
|
-
* HTTP GET /
|
|
526
|
-
* Java method: org.openremote.model.
|
|
612
|
+
* HTTP GET /flow/{name}
|
|
613
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
527
614
|
*/
|
|
528
|
-
|
|
615
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
529
616
|
/**
|
|
530
|
-
* HTTP GET /
|
|
531
|
-
* Java method: org.openremote.model.
|
|
617
|
+
* HTTP GET /flow/{type}
|
|
618
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
532
619
|
*/
|
|
533
|
-
|
|
534
|
-
}
|
|
535
|
-
export declare class GatewayClientResourceClient<O> {
|
|
536
|
-
protected httpClient: HttpClient<O>;
|
|
537
|
-
constructor(httpClient: HttpClient<O>);
|
|
538
|
-
/**
|
|
539
|
-
* HTTP DELETE /gateway/connection
|
|
540
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
541
|
-
*/
|
|
542
|
-
deleteConnections(queryParams?: {
|
|
543
|
-
realm?: string[];
|
|
544
|
-
}, options?: O): RestResponse<void>;
|
|
545
|
-
/**
|
|
546
|
-
* HTTP GET /gateway/connection
|
|
547
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
548
|
-
*/
|
|
549
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
550
|
-
/**
|
|
551
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
552
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
553
|
-
*/
|
|
554
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
555
|
-
/**
|
|
556
|
-
* HTTP GET /gateway/connection/{realm}
|
|
557
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
558
|
-
*/
|
|
559
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
560
|
-
/**
|
|
561
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
562
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
563
|
-
*/
|
|
564
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
565
|
-
/**
|
|
566
|
-
* HTTP GET /gateway/status/{realm}
|
|
567
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
568
|
-
*/
|
|
569
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
570
|
-
}
|
|
571
|
-
export declare class AgentResourceClient<O> {
|
|
572
|
-
protected httpClient: HttpClient<O>;
|
|
573
|
-
constructor(httpClient: HttpClient<O>);
|
|
574
|
-
/**
|
|
575
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
576
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
577
|
-
*/
|
|
578
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
579
|
-
realm?: string;
|
|
580
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
581
|
-
/**
|
|
582
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
583
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
584
|
-
*/
|
|
585
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
586
|
-
realm?: string;
|
|
587
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
588
|
-
/**
|
|
589
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
590
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
591
|
-
*/
|
|
592
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
593
|
-
parentId?: string;
|
|
594
|
-
realm?: string;
|
|
595
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
596
|
-
}
|
|
597
|
-
export declare class ConsoleResourceClient<O> {
|
|
598
|
-
protected httpClient: HttpClient<O>;
|
|
599
|
-
constructor(httpClient: HttpClient<O>);
|
|
600
|
-
/**
|
|
601
|
-
* HTTP POST /console/register
|
|
602
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
603
|
-
*/
|
|
604
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
605
|
-
}
|
|
606
|
-
export declare class SyslogResourceClient<O> {
|
|
607
|
-
protected httpClient: HttpClient<O>;
|
|
608
|
-
constructor(httpClient: HttpClient<O>);
|
|
609
|
-
/**
|
|
610
|
-
* HTTP GET /syslog/config
|
|
611
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
612
|
-
*/
|
|
613
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
614
|
-
/**
|
|
615
|
-
* HTTP PUT /syslog/config
|
|
616
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
617
|
-
*/
|
|
618
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
619
|
-
/**
|
|
620
|
-
* HTTP DELETE /syslog/event
|
|
621
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
622
|
-
*/
|
|
623
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
624
|
-
/**
|
|
625
|
-
* HTTP GET /syslog/event
|
|
626
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
627
|
-
*/
|
|
628
|
-
getEvents(queryParams?: {
|
|
629
|
-
level?: Model.SyslogLevel;
|
|
630
|
-
per_page?: number;
|
|
631
|
-
page?: number;
|
|
632
|
-
from?: number;
|
|
633
|
-
to?: number;
|
|
634
|
-
category?: Model.SyslogCategory[];
|
|
635
|
-
subCategory?: string[];
|
|
636
|
-
}, options?: O): RestResponse<any>;
|
|
637
|
-
}
|
|
638
|
-
export declare class NotificationResourceClient<O> {
|
|
639
|
-
protected httpClient: HttpClient<O>;
|
|
640
|
-
constructor(httpClient: HttpClient<O>);
|
|
641
|
-
/**
|
|
642
|
-
* HTTP GET /notification
|
|
643
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
644
|
-
*/
|
|
645
|
-
getNotifications(queryParams?: {
|
|
646
|
-
id?: number;
|
|
647
|
-
type?: string;
|
|
648
|
-
from?: number;
|
|
649
|
-
to?: number;
|
|
650
|
-
realmId?: string;
|
|
651
|
-
userId?: string;
|
|
652
|
-
assetId?: string;
|
|
653
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
654
|
-
/**
|
|
655
|
-
* HTTP DELETE /notification
|
|
656
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
657
|
-
*/
|
|
658
|
-
removeNotifications(queryParams?: {
|
|
659
|
-
id?: number;
|
|
660
|
-
type?: string;
|
|
661
|
-
from?: number;
|
|
662
|
-
to?: number;
|
|
663
|
-
realmId?: string;
|
|
664
|
-
userId?: string;
|
|
665
|
-
assetId?: string;
|
|
666
|
-
}, options?: O): RestResponse<void>;
|
|
667
|
-
/**
|
|
668
|
-
* HTTP POST /notification/alert
|
|
669
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
670
|
-
*/
|
|
671
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
672
|
-
/**
|
|
673
|
-
* HTTP DELETE /notification/{notificationId}
|
|
674
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
675
|
-
*/
|
|
676
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
677
|
-
/**
|
|
678
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
679
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
680
|
-
*/
|
|
681
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
682
|
-
targetId?: string;
|
|
683
|
-
}, options?: O): RestResponse<void>;
|
|
684
|
-
/**
|
|
685
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
686
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
687
|
-
*/
|
|
688
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
689
|
-
targetId?: string;
|
|
690
|
-
}, options?: O): RestResponse<void>;
|
|
620
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
691
621
|
}
|
|
692
622
|
export declare class RulesResourceClient<O> {
|
|
693
623
|
protected httpClient: HttpClient<O>;
|
|
@@ -797,130 +727,200 @@ export declare class RulesResourceClient<O> {
|
|
|
797
727
|
*/
|
|
798
728
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
799
729
|
}
|
|
800
|
-
export declare class
|
|
730
|
+
export declare class UserResourceClient<O> {
|
|
801
731
|
protected httpClient: HttpClient<O>;
|
|
802
732
|
constructor(httpClient: HttpClient<O>);
|
|
803
733
|
/**
|
|
804
|
-
* HTTP
|
|
805
|
-
* Java method: org.openremote.model.
|
|
734
|
+
* HTTP PUT /user/locale
|
|
735
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
806
736
|
*/
|
|
807
|
-
|
|
808
|
-
attributeRefs?: string;
|
|
809
|
-
fromTimestamp?: number;
|
|
810
|
-
toTimestamp?: number;
|
|
811
|
-
}, options?: O): RestResponse<any>;
|
|
737
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
812
738
|
/**
|
|
813
|
-
* HTTP
|
|
814
|
-
* Java method: org.openremote.model.
|
|
739
|
+
* HTTP POST /user/query
|
|
740
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
815
741
|
*/
|
|
816
|
-
|
|
817
|
-
assetId?: string;
|
|
818
|
-
attributeName?: string;
|
|
819
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
742
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
820
743
|
/**
|
|
821
|
-
* HTTP
|
|
822
|
-
* Java method: org.openremote.model.
|
|
744
|
+
* HTTP GET /user/user
|
|
745
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
823
746
|
*/
|
|
824
|
-
|
|
825
|
-
}
|
|
826
|
-
export declare class AlarmResourceClient<O> {
|
|
827
|
-
protected httpClient: HttpClient<O>;
|
|
828
|
-
constructor(httpClient: HttpClient<O>);
|
|
747
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
829
748
|
/**
|
|
830
|
-
* HTTP
|
|
831
|
-
* Java method: org.openremote.model.
|
|
749
|
+
* HTTP GET /user/userRealmRoles
|
|
750
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
832
751
|
*/
|
|
833
|
-
|
|
834
|
-
assetIds?: string[];
|
|
835
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
752
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
836
753
|
/**
|
|
837
|
-
* HTTP GET /
|
|
838
|
-
* Java method: org.openremote.model.
|
|
754
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
755
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
839
756
|
*/
|
|
840
|
-
|
|
841
|
-
realm?: string;
|
|
842
|
-
status?: Model.AlarmStatus;
|
|
843
|
-
assetId?: string;
|
|
844
|
-
assigneeId?: string;
|
|
845
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
757
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
846
758
|
/**
|
|
847
|
-
* HTTP
|
|
848
|
-
* Java method: org.openremote.model.
|
|
759
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
760
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
849
761
|
*/
|
|
850
|
-
|
|
762
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
851
763
|
/**
|
|
852
|
-
* HTTP PUT /
|
|
853
|
-
* Java method: org.openremote.model.
|
|
764
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
765
|
+
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
854
766
|
*/
|
|
855
|
-
|
|
767
|
+
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
856
768
|
/**
|
|
857
|
-
* HTTP GET /
|
|
858
|
-
* Java method: org.openremote.model.
|
|
769
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
770
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
859
771
|
*/
|
|
860
|
-
|
|
772
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
861
773
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
774
|
+
* HTTP PUT /user/{realm}/roles
|
|
775
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
864
776
|
*/
|
|
865
|
-
|
|
777
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
866
778
|
/**
|
|
867
|
-
* HTTP
|
|
868
|
-
* Java method: org.openremote.model.
|
|
779
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
780
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
869
781
|
*/
|
|
870
|
-
|
|
782
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
871
783
|
/**
|
|
872
|
-
* HTTP
|
|
873
|
-
* Java method: org.openremote.model.
|
|
784
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
785
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
874
786
|
*/
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
787
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
788
|
+
/**
|
|
789
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
790
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
791
|
+
*/
|
|
792
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
793
|
+
/**
|
|
794
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
795
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
796
|
+
*/
|
|
797
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
798
|
+
/**
|
|
799
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
800
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
801
|
+
*/
|
|
802
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
803
|
+
/**
|
|
804
|
+
* HTTP POST /user/{realm}/users
|
|
805
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
806
|
+
*/
|
|
807
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
808
|
+
/**
|
|
809
|
+
* HTTP PUT /user/{realm}/users
|
|
810
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
811
|
+
*/
|
|
812
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
815
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
816
|
+
*/
|
|
817
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
820
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
821
|
+
*/
|
|
822
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
823
|
+
/**
|
|
824
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
825
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
826
|
+
*/
|
|
827
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
828
|
+
/**
|
|
829
|
+
* HTTP GET /user/{realm}/{userId}
|
|
830
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
831
|
+
*/
|
|
832
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
833
|
+
}
|
|
834
|
+
export declare class AssetModelResourceClient<O> {
|
|
835
|
+
protected httpClient: HttpClient<O>;
|
|
836
|
+
constructor(httpClient: HttpClient<O>);
|
|
837
|
+
/**
|
|
838
|
+
* HTTP GET /model/assetDescriptors
|
|
839
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
840
|
+
*/
|
|
841
|
+
getAssetDescriptors(queryParams?: {
|
|
842
|
+
parentId?: string;
|
|
843
|
+
parentType?: string;
|
|
844
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
845
|
+
/**
|
|
846
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
847
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
848
|
+
*/
|
|
849
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
850
|
+
parentId?: string;
|
|
851
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
852
|
+
/**
|
|
853
|
+
* HTTP GET /model/assetInfos
|
|
854
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
855
|
+
*/
|
|
856
|
+
getAssetInfos(queryParams?: {
|
|
857
|
+
parentId?: string;
|
|
858
|
+
parentType?: string;
|
|
859
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
860
|
+
/**
|
|
861
|
+
* HTTP GET /model/metaItemDescriptors
|
|
862
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
863
|
+
*/
|
|
864
|
+
getMetaItemDescriptors(queryParams?: {
|
|
865
|
+
parentId?: string;
|
|
866
|
+
}, options?: O): RestResponse<{
|
|
867
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
868
|
+
}>;
|
|
869
|
+
/**
|
|
870
|
+
* HTTP GET /model/valueDescriptors
|
|
871
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
872
|
+
*/
|
|
873
|
+
getValueDescriptors(queryParams?: {
|
|
874
|
+
parentId?: string;
|
|
875
|
+
}, options?: O): RestResponse<{
|
|
876
|
+
[index: string]: Model.ValueDescriptor;
|
|
877
|
+
}>;
|
|
878
878
|
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected
|
|
882
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
883
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
881
|
+
protected _appResource: AxiosAppResourceClient;
|
|
884
882
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
883
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
884
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
885
885
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
886
|
-
protected
|
|
887
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
888
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
886
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
889
887
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
890
|
-
protected
|
|
891
|
-
protected
|
|
892
|
-
protected
|
|
893
|
-
protected
|
|
888
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
889
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
890
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
891
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
894
892
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
893
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
895
894
|
protected _agentResource: AxiosAgentResourceClient;
|
|
896
|
-
protected
|
|
897
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
895
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
898
896
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
897
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
898
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
899
899
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
900
|
-
protected
|
|
901
|
-
protected
|
|
900
|
+
protected _userResource: AxiosUserResourceClient;
|
|
901
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get
|
|
904
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
905
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
903
|
+
get AppResource(): AxiosAppResourceClient;
|
|
906
904
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
905
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
906
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
907
907
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
908
|
-
get
|
|
909
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
910
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
908
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
911
909
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
912
|
-
get
|
|
913
|
-
get
|
|
914
|
-
get
|
|
915
|
-
get
|
|
910
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
911
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
912
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
913
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
916
914
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
915
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
917
916
|
get AgentResource(): AxiosAgentResourceClient;
|
|
918
|
-
get
|
|
919
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
917
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
920
918
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
919
|
+
get MapResource(): AxiosMapResourceClient;
|
|
920
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
921
921
|
get RulesResource(): AxiosRulesResourceClient;
|
|
922
|
-
get
|
|
923
|
-
get
|
|
922
|
+
get UserResource(): AxiosUserResourceClient;
|
|
923
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
943
|
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
985
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|
|
991
|
-
export declare class
|
|
991
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|