@openremote/rest 1.11.0-snapshot.20251031111902 → 1.11.0-snapshot.20251103144513
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 +435 -435
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +1 -1
package/lib/restclient.d.ts
CHANGED
|
@@ -9,101 +9,197 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
17
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP PUT /
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
22
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
25
|
+
}
|
|
26
|
+
export declare class StatusResourceClient<O> {
|
|
27
|
+
protected httpClient: HttpClient<O>;
|
|
28
|
+
constructor(httpClient: HttpClient<O>);
|
|
25
29
|
/**
|
|
26
|
-
* HTTP
|
|
27
|
-
* Java method: org.openremote.model.
|
|
30
|
+
* HTTP GET /health
|
|
31
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
28
32
|
*/
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
}
|
|
33
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
34
|
+
[index: string]: any;
|
|
35
|
+
}>;
|
|
32
36
|
/**
|
|
33
|
-
* HTTP GET /
|
|
34
|
-
* Java method: org.openremote.model.
|
|
37
|
+
* HTTP GET /info
|
|
38
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
35
39
|
*/
|
|
36
|
-
|
|
40
|
+
getInfo(options?: O): RestResponse<{
|
|
41
|
+
[index: string]: any;
|
|
42
|
+
}>;
|
|
37
43
|
}
|
|
38
|
-
export declare class
|
|
44
|
+
export declare class FlowResourceClient<O> {
|
|
39
45
|
protected httpClient: HttpClient<O>;
|
|
40
46
|
constructor(httpClient: HttpClient<O>);
|
|
41
47
|
/**
|
|
42
|
-
* HTTP
|
|
43
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP GET /flow
|
|
49
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
44
50
|
*/
|
|
45
|
-
|
|
46
|
-
realm?: string[];
|
|
47
|
-
}, options?: O): RestResponse<void>;
|
|
51
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
48
52
|
/**
|
|
49
|
-
* HTTP GET /
|
|
50
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* HTTP GET /flow/{name}
|
|
54
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
51
55
|
*/
|
|
52
|
-
|
|
56
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
53
57
|
/**
|
|
54
|
-
* HTTP
|
|
55
|
-
* Java method: org.openremote.model.
|
|
58
|
+
* HTTP GET /flow/{type}
|
|
59
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
56
60
|
*/
|
|
57
|
-
|
|
61
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
62
|
+
}
|
|
63
|
+
export declare class AlarmResourceClient<O> {
|
|
64
|
+
protected httpClient: HttpClient<O>;
|
|
65
|
+
constructor(httpClient: HttpClient<O>);
|
|
58
66
|
/**
|
|
59
|
-
* HTTP
|
|
60
|
-
* Java method: org.openremote.model.
|
|
67
|
+
* HTTP POST /alarm
|
|
68
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
61
69
|
*/
|
|
62
|
-
|
|
70
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
71
|
+
assetIds?: string[];
|
|
72
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
63
73
|
/**
|
|
64
|
-
* HTTP
|
|
65
|
-
* Java method: org.openremote.model.
|
|
74
|
+
* HTTP GET /alarm
|
|
75
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
66
76
|
*/
|
|
67
|
-
|
|
77
|
+
getAlarms(queryParams?: {
|
|
78
|
+
realm?: string;
|
|
79
|
+
status?: Model.AlarmStatus;
|
|
80
|
+
assetId?: string;
|
|
81
|
+
assigneeId?: string;
|
|
82
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
68
83
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
84
|
+
* HTTP DELETE /alarm
|
|
85
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
71
86
|
*/
|
|
72
|
-
|
|
87
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
88
|
+
/**
|
|
89
|
+
* HTTP PUT /alarm/assets
|
|
90
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
91
|
+
*/
|
|
92
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
93
|
+
/**
|
|
94
|
+
* HTTP GET /alarm/{alarmId}
|
|
95
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
96
|
+
*/
|
|
97
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
98
|
+
/**
|
|
99
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
100
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
101
|
+
*/
|
|
102
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
103
|
+
/**
|
|
104
|
+
* HTTP PUT /alarm/{alarmId}
|
|
105
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
106
|
+
*/
|
|
107
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
108
|
+
/**
|
|
109
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
110
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
111
|
+
*/
|
|
112
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
113
|
+
realm?: string;
|
|
114
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
73
115
|
}
|
|
74
|
-
export declare class
|
|
116
|
+
export declare class RealmResourceClient<O> {
|
|
75
117
|
protected httpClient: HttpClient<O>;
|
|
76
118
|
constructor(httpClient: HttpClient<O>);
|
|
77
119
|
/**
|
|
78
|
-
* HTTP POST /
|
|
79
|
-
* Java method: org.openremote.model.
|
|
120
|
+
* HTTP POST /realm
|
|
121
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
80
122
|
*/
|
|
81
|
-
create(
|
|
123
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
82
124
|
/**
|
|
83
|
-
* HTTP
|
|
84
|
-
* Java method: org.openremote.model.
|
|
125
|
+
* HTTP GET /realm
|
|
126
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
85
127
|
*/
|
|
86
|
-
|
|
128
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
87
129
|
/**
|
|
88
|
-
* HTTP GET /
|
|
89
|
-
* Java method: org.openremote.model.
|
|
130
|
+
* HTTP GET /realm/accessible
|
|
131
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
90
132
|
*/
|
|
91
|
-
|
|
133
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
92
134
|
/**
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
135
|
+
* HTTP DELETE /realm/{name}
|
|
136
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
95
137
|
*/
|
|
96
|
-
|
|
138
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
97
139
|
/**
|
|
98
|
-
* HTTP
|
|
99
|
-
* Java method: org.openremote.model.
|
|
140
|
+
* HTTP GET /realm/{name}
|
|
141
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
100
142
|
*/
|
|
101
|
-
|
|
143
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
102
144
|
/**
|
|
103
|
-
* HTTP
|
|
104
|
-
* Java method: org.openremote.model.
|
|
145
|
+
* HTTP PUT /realm/{name}
|
|
146
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
105
147
|
*/
|
|
106
|
-
|
|
148
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
149
|
+
}
|
|
150
|
+
export declare class ConfigurationResourceClient<O> {
|
|
151
|
+
protected httpClient: HttpClient<O>;
|
|
152
|
+
constructor(httpClient: HttpClient<O>);
|
|
153
|
+
/**
|
|
154
|
+
* HTTP GET /configuration/manager
|
|
155
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
156
|
+
*/
|
|
157
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
158
|
+
/**
|
|
159
|
+
* HTTP PUT /configuration/manager
|
|
160
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
161
|
+
*/
|
|
162
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
163
|
+
/**
|
|
164
|
+
* HTTP POST /configuration/manager/file
|
|
165
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
166
|
+
*/
|
|
167
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
168
|
+
path?: string;
|
|
169
|
+
}, options?: O): RestResponse<string>;
|
|
170
|
+
/**
|
|
171
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
172
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
173
|
+
*/
|
|
174
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
175
|
+
}
|
|
176
|
+
export declare class ConsoleResourceClient<O> {
|
|
177
|
+
protected httpClient: HttpClient<O>;
|
|
178
|
+
constructor(httpClient: HttpClient<O>);
|
|
179
|
+
/**
|
|
180
|
+
* HTTP POST /console/register
|
|
181
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
182
|
+
*/
|
|
183
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
184
|
+
}
|
|
185
|
+
export declare class AppResourceClient<O> {
|
|
186
|
+
protected httpClient: HttpClient<O>;
|
|
187
|
+
constructor(httpClient: HttpClient<O>);
|
|
188
|
+
/**
|
|
189
|
+
* HTTP GET /apps
|
|
190
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
191
|
+
*/
|
|
192
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
193
|
+
/**
|
|
194
|
+
* HTTP GET /apps/consoleConfig
|
|
195
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
196
|
+
*/
|
|
197
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
198
|
+
/**
|
|
199
|
+
* HTTP GET /apps/info
|
|
200
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
201
|
+
*/
|
|
202
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
107
203
|
}
|
|
108
204
|
export declare class AssetResourceClient<O> {
|
|
109
205
|
protected httpClient: HttpClient<O>;
|
|
@@ -214,38 +310,6 @@ export declare class AssetResourceClient<O> {
|
|
|
214
310
|
assetIds?: string[];
|
|
215
311
|
}, options?: O): RestResponse<void>;
|
|
216
312
|
}
|
|
217
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
218
|
-
protected httpClient: HttpClient<O>;
|
|
219
|
-
constructor(httpClient: HttpClient<O>);
|
|
220
|
-
/**
|
|
221
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
222
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
223
|
-
*/
|
|
224
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
225
|
-
/**
|
|
226
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
227
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
228
|
-
*/
|
|
229
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
230
|
-
}
|
|
231
|
-
export declare class StatusResourceClient<O> {
|
|
232
|
-
protected httpClient: HttpClient<O>;
|
|
233
|
-
constructor(httpClient: HttpClient<O>);
|
|
234
|
-
/**
|
|
235
|
-
* HTTP GET /health
|
|
236
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
237
|
-
*/
|
|
238
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
239
|
-
[index: string]: any;
|
|
240
|
-
}>;
|
|
241
|
-
/**
|
|
242
|
-
* HTTP GET /info
|
|
243
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
244
|
-
*/
|
|
245
|
-
getInfo(options?: O): RestResponse<{
|
|
246
|
-
[index: string]: any;
|
|
247
|
-
}>;
|
|
248
|
-
}
|
|
249
313
|
export declare class UserResourceClient<O> {
|
|
250
314
|
protected httpClient: HttpClient<O>;
|
|
251
315
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -370,238 +434,23 @@ export declare class UserResourceClient<O> {
|
|
|
370
434
|
*/
|
|
371
435
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
372
436
|
}
|
|
373
|
-
export declare class
|
|
437
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
374
438
|
protected httpClient: HttpClient<O>;
|
|
375
439
|
constructor(httpClient: HttpClient<O>);
|
|
376
440
|
/**
|
|
377
|
-
*
|
|
378
|
-
*
|
|
441
|
+
* Response code 200 - List of registered external services
|
|
442
|
+
* HTTP GET /service
|
|
443
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
379
444
|
*/
|
|
380
|
-
|
|
445
|
+
getServices(queryParams?: {
|
|
446
|
+
realm?: string;
|
|
447
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
381
448
|
/**
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
388
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
389
|
-
*/
|
|
390
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
391
|
-
/**
|
|
392
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
393
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
394
|
-
*/
|
|
395
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
396
|
-
/**
|
|
397
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
398
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
399
|
-
*/
|
|
400
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
401
|
-
}
|
|
402
|
-
export declare class RealmResourceClient<O> {
|
|
403
|
-
protected httpClient: HttpClient<O>;
|
|
404
|
-
constructor(httpClient: HttpClient<O>);
|
|
405
|
-
/**
|
|
406
|
-
* HTTP POST /realm
|
|
407
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
408
|
-
*/
|
|
409
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
410
|
-
/**
|
|
411
|
-
* HTTP GET /realm
|
|
412
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
413
|
-
*/
|
|
414
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
415
|
-
/**
|
|
416
|
-
* HTTP GET /realm/accessible
|
|
417
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
418
|
-
*/
|
|
419
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
420
|
-
/**
|
|
421
|
-
* HTTP DELETE /realm/{name}
|
|
422
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
423
|
-
*/
|
|
424
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
425
|
-
/**
|
|
426
|
-
* HTTP GET /realm/{name}
|
|
427
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
428
|
-
*/
|
|
429
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
430
|
-
/**
|
|
431
|
-
* HTTP PUT /realm/{name}
|
|
432
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
433
|
-
*/
|
|
434
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
435
|
-
}
|
|
436
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
437
|
-
protected httpClient: HttpClient<O>;
|
|
438
|
-
constructor(httpClient: HttpClient<O>);
|
|
439
|
-
/**
|
|
440
|
-
* HTTP GET /asset/datapoint/export
|
|
441
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
442
|
-
*/
|
|
443
|
-
getDatapointExport(queryParams?: {
|
|
444
|
-
attributeRefs?: string;
|
|
445
|
-
fromTimestamp?: number;
|
|
446
|
-
toTimestamp?: number;
|
|
447
|
-
}, options?: O): RestResponse<any>;
|
|
448
|
-
/**
|
|
449
|
-
* HTTP GET /asset/datapoint/periods
|
|
450
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
451
|
-
*/
|
|
452
|
-
getDatapointPeriod(queryParams?: {
|
|
453
|
-
assetId?: string;
|
|
454
|
-
attributeName?: string;
|
|
455
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
456
|
-
/**
|
|
457
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
458
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
459
|
-
*/
|
|
460
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
461
|
-
}
|
|
462
|
-
export declare class AssetModelResourceClient<O> {
|
|
463
|
-
protected httpClient: HttpClient<O>;
|
|
464
|
-
constructor(httpClient: HttpClient<O>);
|
|
465
|
-
/**
|
|
466
|
-
* HTTP GET /model/assetDescriptors
|
|
467
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
468
|
-
*/
|
|
469
|
-
getAssetDescriptors(queryParams?: {
|
|
470
|
-
parentId?: string;
|
|
471
|
-
parentType?: string;
|
|
472
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
473
|
-
/**
|
|
474
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
475
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
476
|
-
*/
|
|
477
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
478
|
-
parentId?: string;
|
|
479
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
480
|
-
/**
|
|
481
|
-
* HTTP GET /model/assetInfos
|
|
482
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
483
|
-
*/
|
|
484
|
-
getAssetInfos(queryParams?: {
|
|
485
|
-
parentId?: string;
|
|
486
|
-
parentType?: string;
|
|
487
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
488
|
-
/**
|
|
489
|
-
* HTTP GET /model/getValueDescriptorSchema
|
|
490
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
491
|
-
*/
|
|
492
|
-
getValueDescriptorSchema(queryParams?: {
|
|
493
|
-
name?: string;
|
|
494
|
-
hash?: string;
|
|
495
|
-
}, options?: O): RestResponse<any>;
|
|
496
|
-
/**
|
|
497
|
-
* HTTP GET /model/metaItemDescriptors
|
|
498
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
499
|
-
*/
|
|
500
|
-
getMetaItemDescriptors(queryParams?: {
|
|
501
|
-
parentId?: string;
|
|
502
|
-
}, options?: O): RestResponse<{
|
|
503
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
504
|
-
}>;
|
|
505
|
-
/**
|
|
506
|
-
* HTTP GET /model/valueDescriptors
|
|
507
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
508
|
-
*/
|
|
509
|
-
getValueDescriptors(queryParams?: {
|
|
510
|
-
parentId?: string;
|
|
511
|
-
}, options?: O): RestResponse<{
|
|
512
|
-
[index: string]: Model.ValueDescriptor;
|
|
513
|
-
}>;
|
|
514
|
-
}
|
|
515
|
-
export declare class NotificationResourceClient<O> {
|
|
516
|
-
protected httpClient: HttpClient<O>;
|
|
517
|
-
constructor(httpClient: HttpClient<O>);
|
|
518
|
-
/**
|
|
519
|
-
* HTTP GET /notification
|
|
520
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
521
|
-
*/
|
|
522
|
-
getNotifications(queryParams?: {
|
|
523
|
-
id?: number;
|
|
524
|
-
type?: string;
|
|
525
|
-
from?: number;
|
|
526
|
-
to?: number;
|
|
527
|
-
realmId?: string;
|
|
528
|
-
userId?: string;
|
|
529
|
-
assetId?: string;
|
|
530
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
531
|
-
/**
|
|
532
|
-
* HTTP DELETE /notification
|
|
533
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
534
|
-
*/
|
|
535
|
-
removeNotifications(queryParams?: {
|
|
536
|
-
id?: number;
|
|
537
|
-
type?: string;
|
|
538
|
-
from?: number;
|
|
539
|
-
to?: number;
|
|
540
|
-
realmId?: string;
|
|
541
|
-
userId?: string;
|
|
542
|
-
assetId?: string;
|
|
543
|
-
}, options?: O): RestResponse<void>;
|
|
544
|
-
/**
|
|
545
|
-
* HTTP POST /notification/alert
|
|
546
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
547
|
-
*/
|
|
548
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
549
|
-
/**
|
|
550
|
-
* HTTP DELETE /notification/{notificationId}
|
|
551
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
552
|
-
*/
|
|
553
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
554
|
-
/**
|
|
555
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
556
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
557
|
-
*/
|
|
558
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
559
|
-
targetId?: string;
|
|
560
|
-
}, options?: O): RestResponse<void>;
|
|
561
|
-
/**
|
|
562
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
563
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
564
|
-
*/
|
|
565
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
566
|
-
targetId?: string;
|
|
567
|
-
}, options?: O): RestResponse<void>;
|
|
568
|
-
}
|
|
569
|
-
export declare class FlowResourceClient<O> {
|
|
570
|
-
protected httpClient: HttpClient<O>;
|
|
571
|
-
constructor(httpClient: HttpClient<O>);
|
|
572
|
-
/**
|
|
573
|
-
* HTTP GET /flow
|
|
574
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
575
|
-
*/
|
|
576
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
577
|
-
/**
|
|
578
|
-
* HTTP GET /flow/{name}
|
|
579
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
580
|
-
*/
|
|
581
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
582
|
-
/**
|
|
583
|
-
* HTTP GET /flow/{type}
|
|
584
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
585
|
-
*/
|
|
586
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
587
|
-
}
|
|
588
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
589
|
-
protected httpClient: HttpClient<O>;
|
|
590
|
-
constructor(httpClient: HttpClient<O>);
|
|
591
|
-
/**
|
|
592
|
-
* Response code 200 - List of registered external services
|
|
593
|
-
* HTTP GET /service
|
|
594
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
595
|
-
*/
|
|
596
|
-
getServices(queryParams?: {
|
|
597
|
-
realm?: string;
|
|
598
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
599
|
-
/**
|
|
600
|
-
* Response code 200 - Service registered successfully
|
|
601
|
-
* Response code 400 - Invalid external service object
|
|
602
|
-
* Response code 409 - ExternalService instance already registered
|
|
603
|
-
* HTTP POST /service
|
|
604
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
449
|
+
* Response code 200 - Service registered successfully
|
|
450
|
+
* Response code 400 - Invalid external service object
|
|
451
|
+
* Response code 409 - ExternalService instance already registered
|
|
452
|
+
* HTTP POST /service
|
|
453
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
605
454
|
*/
|
|
606
455
|
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
607
456
|
/**
|
|
@@ -664,6 +513,38 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
664
513
|
*/
|
|
665
514
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
666
515
|
}
|
|
516
|
+
export declare class SyslogResourceClient<O> {
|
|
517
|
+
protected httpClient: HttpClient<O>;
|
|
518
|
+
constructor(httpClient: HttpClient<O>);
|
|
519
|
+
/**
|
|
520
|
+
* HTTP GET /syslog/config
|
|
521
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
522
|
+
*/
|
|
523
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
524
|
+
/**
|
|
525
|
+
* HTTP PUT /syslog/config
|
|
526
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
527
|
+
*/
|
|
528
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
529
|
+
/**
|
|
530
|
+
* HTTP DELETE /syslog/event
|
|
531
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
532
|
+
*/
|
|
533
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
534
|
+
/**
|
|
535
|
+
* HTTP GET /syslog/event
|
|
536
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
537
|
+
*/
|
|
538
|
+
getEvents(queryParams?: {
|
|
539
|
+
level?: Model.SyslogLevel;
|
|
540
|
+
per_page?: number;
|
|
541
|
+
page?: number;
|
|
542
|
+
from?: number;
|
|
543
|
+
to?: number;
|
|
544
|
+
category?: Model.SyslogCategory[];
|
|
545
|
+
subCategory?: string[];
|
|
546
|
+
}, options?: O): RestResponse<any>;
|
|
547
|
+
}
|
|
667
548
|
export declare class RulesResourceClient<O> {
|
|
668
549
|
protected httpClient: HttpClient<O>;
|
|
669
550
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -772,37 +653,59 @@ export declare class RulesResourceClient<O> {
|
|
|
772
653
|
*/
|
|
773
654
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
774
655
|
}
|
|
775
|
-
export declare class
|
|
656
|
+
export declare class NotificationResourceClient<O> {
|
|
776
657
|
protected httpClient: HttpClient<O>;
|
|
777
658
|
constructor(httpClient: HttpClient<O>);
|
|
778
659
|
/**
|
|
779
|
-
* HTTP GET /
|
|
780
|
-
* Java method: org.openremote.model.
|
|
660
|
+
* HTTP GET /notification
|
|
661
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
781
662
|
*/
|
|
782
|
-
|
|
663
|
+
getNotifications(queryParams?: {
|
|
664
|
+
id?: number;
|
|
665
|
+
type?: string;
|
|
666
|
+
from?: number;
|
|
667
|
+
to?: number;
|
|
668
|
+
realmId?: string;
|
|
669
|
+
userId?: string;
|
|
670
|
+
assetId?: string;
|
|
671
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
783
672
|
/**
|
|
784
|
-
* HTTP
|
|
785
|
-
* Java method: org.openremote.model.
|
|
673
|
+
* HTTP DELETE /notification
|
|
674
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
786
675
|
*/
|
|
787
|
-
|
|
676
|
+
removeNotifications(queryParams?: {
|
|
677
|
+
id?: number;
|
|
678
|
+
type?: string;
|
|
679
|
+
from?: number;
|
|
680
|
+
to?: number;
|
|
681
|
+
realmId?: string;
|
|
682
|
+
userId?: string;
|
|
683
|
+
assetId?: string;
|
|
684
|
+
}, options?: O): RestResponse<void>;
|
|
788
685
|
/**
|
|
789
|
-
* HTTP
|
|
790
|
-
* Java method: org.openremote.model.
|
|
686
|
+
* HTTP POST /notification/alert
|
|
687
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
791
688
|
*/
|
|
792
|
-
|
|
689
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
793
690
|
/**
|
|
794
|
-
* HTTP
|
|
795
|
-
* Java method: org.openremote.model.
|
|
691
|
+
* HTTP DELETE /notification/{notificationId}
|
|
692
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
796
693
|
*/
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
694
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
695
|
+
/**
|
|
696
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
697
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
698
|
+
*/
|
|
699
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
700
|
+
targetId?: string;
|
|
701
|
+
}, options?: O): RestResponse<void>;
|
|
702
|
+
/**
|
|
703
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
704
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
705
|
+
*/
|
|
706
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
707
|
+
targetId?: string;
|
|
708
|
+
}, options?: O): RestResponse<void>;
|
|
806
709
|
}
|
|
807
710
|
export declare class MapResourceClient<O> {
|
|
808
711
|
protected httpClient: HttpClient<O>;
|
|
@@ -857,24 +760,101 @@ export declare class MapResourceClient<O> {
|
|
|
857
760
|
[id: string]: unknown;
|
|
858
761
|
}>;
|
|
859
762
|
}
|
|
860
|
-
export declare class
|
|
763
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
861
764
|
protected httpClient: HttpClient<O>;
|
|
862
765
|
constructor(httpClient: HttpClient<O>);
|
|
863
766
|
/**
|
|
864
|
-
* HTTP GET /
|
|
865
|
-
* Java method: org.openremote.model.
|
|
767
|
+
* HTTP GET /asset/datapoint/export
|
|
768
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
866
769
|
*/
|
|
867
|
-
|
|
770
|
+
getDatapointExport(queryParams?: {
|
|
771
|
+
attributeRefs?: string;
|
|
772
|
+
fromTimestamp?: number;
|
|
773
|
+
toTimestamp?: number;
|
|
774
|
+
}, options?: O): RestResponse<any>;
|
|
868
775
|
/**
|
|
869
|
-
* HTTP GET /
|
|
870
|
-
* Java method: org.openremote.model.
|
|
776
|
+
* HTTP GET /asset/datapoint/periods
|
|
777
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
871
778
|
*/
|
|
872
|
-
|
|
779
|
+
getDatapointPeriod(queryParams?: {
|
|
780
|
+
assetId?: string;
|
|
781
|
+
attributeName?: string;
|
|
782
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
873
783
|
/**
|
|
874
|
-
* HTTP
|
|
875
|
-
* Java method: org.openremote.model.
|
|
784
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
785
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
876
786
|
*/
|
|
877
|
-
|
|
787
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
788
|
+
}
|
|
789
|
+
export declare class DashboardResourceClient<O> {
|
|
790
|
+
protected httpClient: HttpClient<O>;
|
|
791
|
+
constructor(httpClient: HttpClient<O>);
|
|
792
|
+
/**
|
|
793
|
+
* HTTP POST /dashboard
|
|
794
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
795
|
+
*/
|
|
796
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
797
|
+
/**
|
|
798
|
+
* HTTP PUT /dashboard
|
|
799
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
800
|
+
*/
|
|
801
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
802
|
+
/**
|
|
803
|
+
* HTTP GET /dashboard/all/{realm}
|
|
804
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
805
|
+
*/
|
|
806
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
807
|
+
/**
|
|
808
|
+
* HTTP POST /dashboard/query
|
|
809
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
810
|
+
*/
|
|
811
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
812
|
+
/**
|
|
813
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
814
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
815
|
+
*/
|
|
816
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
817
|
+
/**
|
|
818
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
819
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
820
|
+
*/
|
|
821
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
822
|
+
}
|
|
823
|
+
export declare class GatewayClientResourceClient<O> {
|
|
824
|
+
protected httpClient: HttpClient<O>;
|
|
825
|
+
constructor(httpClient: HttpClient<O>);
|
|
826
|
+
/**
|
|
827
|
+
* HTTP DELETE /gateway/connection
|
|
828
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
829
|
+
*/
|
|
830
|
+
deleteConnections(queryParams?: {
|
|
831
|
+
realm?: string[];
|
|
832
|
+
}, options?: O): RestResponse<void>;
|
|
833
|
+
/**
|
|
834
|
+
* HTTP GET /gateway/connection
|
|
835
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
836
|
+
*/
|
|
837
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
838
|
+
/**
|
|
839
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
840
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
841
|
+
*/
|
|
842
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
843
|
+
/**
|
|
844
|
+
* HTTP GET /gateway/connection/{realm}
|
|
845
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
846
|
+
*/
|
|
847
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
848
|
+
/**
|
|
849
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
850
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
851
|
+
*/
|
|
852
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
853
|
+
/**
|
|
854
|
+
* HTTP GET /gateway/status/{realm}
|
|
855
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
856
|
+
*/
|
|
857
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
878
858
|
}
|
|
879
859
|
export declare class AgentResourceClient<O> {
|
|
880
860
|
protected httpClient: HttpClient<O>;
|
|
@@ -902,115 +882,135 @@ export declare class AgentResourceClient<O> {
|
|
|
902
882
|
realm?: string;
|
|
903
883
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
904
884
|
}
|
|
905
|
-
export declare class
|
|
885
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
906
886
|
protected httpClient: HttpClient<O>;
|
|
907
887
|
constructor(httpClient: HttpClient<O>);
|
|
908
888
|
/**
|
|
909
|
-
* HTTP POST /
|
|
910
|
-
* Java method: org.openremote.model.
|
|
889
|
+
* HTTP POST /gateway/tunnel
|
|
890
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
911
891
|
*/
|
|
912
|
-
|
|
913
|
-
assetIds?: string[];
|
|
914
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
892
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
915
893
|
/**
|
|
916
|
-
* HTTP
|
|
917
|
-
* Java method: org.openremote.model.
|
|
894
|
+
* HTTP DELETE /gateway/tunnel
|
|
895
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
918
896
|
*/
|
|
919
|
-
|
|
920
|
-
realm?: string;
|
|
921
|
-
status?: Model.AlarmStatus;
|
|
922
|
-
assetId?: string;
|
|
923
|
-
assigneeId?: string;
|
|
924
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
897
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
925
898
|
/**
|
|
926
|
-
* HTTP
|
|
927
|
-
* Java method: org.openremote.model.
|
|
899
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
900
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
928
901
|
*/
|
|
929
|
-
|
|
902
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
930
903
|
/**
|
|
931
|
-
* HTTP
|
|
932
|
-
* Java method: org.openremote.model.
|
|
904
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
905
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
933
906
|
*/
|
|
934
|
-
|
|
907
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
935
908
|
/**
|
|
936
|
-
* HTTP GET /
|
|
937
|
-
* Java method: org.openremote.model.
|
|
909
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
910
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
938
911
|
*/
|
|
939
|
-
|
|
912
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
913
|
+
}
|
|
914
|
+
export declare class AssetModelResourceClient<O> {
|
|
915
|
+
protected httpClient: HttpClient<O>;
|
|
916
|
+
constructor(httpClient: HttpClient<O>);
|
|
940
917
|
/**
|
|
941
|
-
* HTTP
|
|
942
|
-
* Java method: org.openremote.model.
|
|
918
|
+
* HTTP GET /model/assetDescriptors
|
|
919
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
943
920
|
*/
|
|
944
|
-
|
|
921
|
+
getAssetDescriptors(queryParams?: {
|
|
922
|
+
parentId?: string;
|
|
923
|
+
parentType?: string;
|
|
924
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
945
925
|
/**
|
|
946
|
-
* HTTP
|
|
947
|
-
* Java method: org.openremote.model.
|
|
926
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
927
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
948
928
|
*/
|
|
949
|
-
|
|
929
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
930
|
+
parentId?: string;
|
|
931
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
950
932
|
/**
|
|
951
|
-
* HTTP GET /
|
|
952
|
-
* Java method: org.openremote.model.
|
|
933
|
+
* HTTP GET /model/assetInfos
|
|
934
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
953
935
|
*/
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
}
|
|
958
|
-
export declare class ConsoleResourceClient<O> {
|
|
959
|
-
protected httpClient: HttpClient<O>;
|
|
960
|
-
constructor(httpClient: HttpClient<O>);
|
|
936
|
+
getAssetInfos(queryParams?: {
|
|
937
|
+
parentId?: string;
|
|
938
|
+
parentType?: string;
|
|
939
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
961
940
|
/**
|
|
962
|
-
* HTTP
|
|
963
|
-
* Java method: org.openremote.model.
|
|
941
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
942
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
964
943
|
*/
|
|
965
|
-
|
|
944
|
+
getValueDescriptorSchema(queryParams?: {
|
|
945
|
+
name?: string;
|
|
946
|
+
hash?: string;
|
|
947
|
+
}, options?: O): RestResponse<any>;
|
|
948
|
+
/**
|
|
949
|
+
* HTTP GET /model/metaItemDescriptors
|
|
950
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
951
|
+
*/
|
|
952
|
+
getMetaItemDescriptors(queryParams?: {
|
|
953
|
+
parentId?: string;
|
|
954
|
+
}, options?: O): RestResponse<{
|
|
955
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
956
|
+
}>;
|
|
957
|
+
/**
|
|
958
|
+
* HTTP GET /model/valueDescriptors
|
|
959
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
960
|
+
*/
|
|
961
|
+
getValueDescriptors(queryParams?: {
|
|
962
|
+
parentId?: string;
|
|
963
|
+
}, options?: O): RestResponse<{
|
|
964
|
+
[index: string]: Model.ValueDescriptor;
|
|
965
|
+
}>;
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
970
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
971
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
972
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
973
969
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
974
970
|
protected _statusResource: AxiosStatusResourceClient;
|
|
975
|
-
protected _userResource: AxiosUserResourceClient;
|
|
976
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
977
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
978
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
979
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
980
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
981
971
|
protected _flowResource: AxiosFlowResourceClient;
|
|
972
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
973
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
974
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
975
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
976
|
+
protected _appResource: AxiosAppResourceClient;
|
|
977
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
978
|
+
protected _userResource: AxiosUserResourceClient;
|
|
982
979
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
983
980
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
984
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
985
981
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
982
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
983
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
986
984
|
protected _mapResource: AxiosMapResourceClient;
|
|
987
|
-
protected
|
|
985
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
986
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
987
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
988
988
|
protected _agentResource: AxiosAgentResourceClient;
|
|
989
|
-
protected
|
|
990
|
-
protected
|
|
989
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
990
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
993
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
994
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
995
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
996
992
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
997
993
|
get StatusResource(): AxiosStatusResourceClient;
|
|
998
|
-
get UserResource(): AxiosUserResourceClient;
|
|
999
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1000
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1001
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1002
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1003
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1004
994
|
get FlowResource(): AxiosFlowResourceClient;
|
|
995
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
996
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
997
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
998
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
999
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1000
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1001
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1005
1002
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1006
1003
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1007
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1008
1004
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1005
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1006
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1009
1007
|
get MapResource(): AxiosMapResourceClient;
|
|
1010
|
-
get
|
|
1008
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1009
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1010
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1011
1011
|
get AgentResource(): AxiosAgentResourceClient;
|
|
1012
|
-
get
|
|
1013
|
-
get
|
|
1012
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1013
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1018,69 +1018,69 @@ declare module "axios" {
|
|
|
1018
1018
|
data: R;
|
|
1019
1019
|
}
|
|
1020
1020
|
}
|
|
1021
|
-
export declare class
|
|
1021
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
|
-
export declare class
|
|
1027
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
|
-
export declare class
|
|
1030
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1033
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1035
|
}
|
|
1036
|
-
export declare class
|
|
1036
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1038
|
}
|
|
1039
|
-
export declare class
|
|
1039
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1041
|
}
|
|
1042
|
-
export declare class
|
|
1042
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1044
|
}
|
|
1045
|
-
export declare class
|
|
1045
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1047
|
}
|
|
1048
|
-
export declare class
|
|
1048
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1050
|
}
|
|
1051
|
-
export declare class
|
|
1051
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1053
|
}
|
|
1054
|
-
export declare class
|
|
1054
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1056
|
}
|
|
1057
|
-
export declare class
|
|
1057
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1059
|
}
|
|
1060
|
-
export declare class
|
|
1060
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1062
|
}
|
|
1063
|
-
export declare class
|
|
1063
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1065
|
}
|
|
1066
|
-
export declare class
|
|
1066
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1068
|
}
|
|
1069
|
-
export declare class
|
|
1069
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1071
|
}
|
|
1072
|
-
export declare class
|
|
1072
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1074
|
}
|
|
1075
|
-
export declare class
|
|
1075
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1077
|
}
|
|
1078
1078
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1080
|
}
|
|
1081
|
-
export declare class
|
|
1081
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1083
|
}
|
|
1084
|
-
export declare class
|
|
1084
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|