@openremote/rest 1.4.0-snapshot.20250304170726 → 1.4.0-snapshot.20250311100033
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 +455 -455
- 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,200 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class ConfigurationResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /configuration/manager
|
|
17
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
18
|
-
*/
|
|
19
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP PUT /configuration/manager
|
|
22
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
23
|
-
*/
|
|
24
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP POST /configuration/manager/file
|
|
27
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
28
|
-
*/
|
|
29
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
30
|
-
path?: string;
|
|
31
|
-
}, options?: O): RestResponse<string>;
|
|
32
|
-
/**
|
|
33
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
34
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
35
|
-
*/
|
|
36
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
37
|
-
}
|
|
38
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
39
|
-
protected httpClient: HttpClient<O>;
|
|
40
|
-
constructor(httpClient: HttpClient<O>);
|
|
41
|
-
/**
|
|
42
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
43
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
44
|
-
*/
|
|
45
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
46
|
-
/**
|
|
47
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
48
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
49
|
-
*/
|
|
50
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
51
|
-
}
|
|
52
|
-
export declare class StatusResourceClient<O> {
|
|
53
|
-
protected httpClient: HttpClient<O>;
|
|
54
|
-
constructor(httpClient: HttpClient<O>);
|
|
55
|
-
/**
|
|
56
|
-
* HTTP GET /health
|
|
57
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
58
|
-
*/
|
|
59
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
60
|
-
[index: string]: any;
|
|
61
|
-
}>;
|
|
62
|
-
/**
|
|
63
|
-
* HTTP GET /info
|
|
64
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
65
|
-
*/
|
|
66
|
-
getInfo(options?: O): RestResponse<{
|
|
67
|
-
[index: string]: any;
|
|
68
|
-
}>;
|
|
69
|
-
}
|
|
70
|
-
export declare class AppResourceClient<O> {
|
|
71
|
-
protected httpClient: HttpClient<O>;
|
|
72
|
-
constructor(httpClient: HttpClient<O>);
|
|
73
|
-
/**
|
|
74
|
-
* HTTP GET /apps
|
|
75
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
76
|
-
*/
|
|
77
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
78
|
-
/**
|
|
79
|
-
* HTTP GET /apps/consoleConfig
|
|
80
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
81
|
-
*/
|
|
82
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
83
|
-
/**
|
|
84
|
-
* HTTP GET /apps/info
|
|
85
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
86
|
-
*/
|
|
87
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
88
|
-
}
|
|
89
|
-
export declare class DashboardResourceClient<O> {
|
|
90
|
-
protected httpClient: HttpClient<O>;
|
|
91
|
-
constructor(httpClient: HttpClient<O>);
|
|
92
|
-
/**
|
|
93
|
-
* HTTP POST /dashboard
|
|
94
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
95
|
-
*/
|
|
96
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
97
|
-
/**
|
|
98
|
-
* HTTP PUT /dashboard
|
|
99
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
100
|
-
*/
|
|
101
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
102
|
-
/**
|
|
103
|
-
* HTTP GET /dashboard/all/{realm}
|
|
104
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
105
|
-
*/
|
|
106
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
107
|
-
/**
|
|
108
|
-
* HTTP POST /dashboard/query
|
|
109
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
110
|
-
*/
|
|
111
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
112
|
-
/**
|
|
113
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
114
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
115
|
-
*/
|
|
116
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
117
|
-
/**
|
|
118
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
119
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
120
|
-
*/
|
|
121
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
122
|
-
}
|
|
123
|
-
export declare class AlarmResourceClient<O> {
|
|
124
|
-
protected httpClient: HttpClient<O>;
|
|
125
|
-
constructor(httpClient: HttpClient<O>);
|
|
126
|
-
/**
|
|
127
|
-
* HTTP POST /alarm
|
|
128
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
129
|
-
*/
|
|
130
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
131
|
-
assetIds?: string[];
|
|
132
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
133
|
-
/**
|
|
134
|
-
* HTTP GET /alarm
|
|
135
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
136
|
-
*/
|
|
137
|
-
getAlarms(queryParams?: {
|
|
138
|
-
realm?: string;
|
|
139
|
-
status?: Model.AlarmStatus;
|
|
140
|
-
assetId?: string;
|
|
141
|
-
assigneeId?: string;
|
|
142
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
143
|
-
/**
|
|
144
|
-
* HTTP DELETE /alarm
|
|
145
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
146
|
-
*/
|
|
147
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
148
|
-
/**
|
|
149
|
-
* HTTP PUT /alarm/assets
|
|
150
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
151
|
-
*/
|
|
152
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
153
|
-
/**
|
|
154
|
-
* HTTP GET /alarm/{alarmId}
|
|
155
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
156
|
-
*/
|
|
157
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
158
|
-
/**
|
|
159
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
160
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
161
|
-
*/
|
|
162
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
163
|
-
/**
|
|
164
|
-
* HTTP PUT /alarm/{alarmId}
|
|
165
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
166
|
-
*/
|
|
167
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
168
|
-
/**
|
|
169
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
170
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
171
|
-
*/
|
|
172
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
173
|
-
realm?: string;
|
|
174
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
175
|
-
}
|
|
176
|
-
export declare class MapResourceClient<O> {
|
|
177
|
-
protected httpClient: HttpClient<O>;
|
|
178
|
-
constructor(httpClient: HttpClient<O>);
|
|
179
|
-
/**
|
|
180
|
-
* HTTP GET /map
|
|
181
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
182
|
-
*/
|
|
183
|
-
getSettings(options?: O): RestResponse<{
|
|
184
|
-
[id: string]: unknown;
|
|
185
|
-
}>;
|
|
186
|
-
/**
|
|
187
|
-
* HTTP PUT /map
|
|
188
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
189
|
-
*/
|
|
190
|
-
saveSettings(mapConfig: {
|
|
191
|
-
[index: string]: Model.MapRealmConfig;
|
|
192
|
-
}, options?: O): RestResponse<any>;
|
|
193
|
-
/**
|
|
194
|
-
* HTTP GET /map/js
|
|
195
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
196
|
-
*/
|
|
197
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
198
|
-
[id: string]: unknown;
|
|
199
|
-
}>;
|
|
200
|
-
/**
|
|
201
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
202
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
203
|
-
*/
|
|
204
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
205
|
-
}
|
|
206
12
|
export declare class UserResourceClient<O> {
|
|
207
13
|
protected httpClient: HttpClient<O>;
|
|
208
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -327,39 +133,40 @@ export declare class UserResourceClient<O> {
|
|
|
327
133
|
*/
|
|
328
134
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
329
135
|
}
|
|
330
|
-
export declare class
|
|
136
|
+
export declare class ConsoleResourceClient<O> {
|
|
331
137
|
protected httpClient: HttpClient<O>;
|
|
332
138
|
constructor(httpClient: HttpClient<O>);
|
|
333
139
|
/**
|
|
334
|
-
* HTTP POST /
|
|
335
|
-
* Java method: org.openremote.model.
|
|
336
|
-
*/
|
|
337
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
338
|
-
/**
|
|
339
|
-
* HTTP GET /realm
|
|
340
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
341
|
-
*/
|
|
342
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
343
|
-
/**
|
|
344
|
-
* HTTP GET /realm/accessible
|
|
345
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
140
|
+
* HTTP POST /console/register
|
|
141
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
346
142
|
*/
|
|
347
|
-
|
|
143
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
144
|
+
}
|
|
145
|
+
export declare class AgentResourceClient<O> {
|
|
146
|
+
protected httpClient: HttpClient<O>;
|
|
147
|
+
constructor(httpClient: HttpClient<O>);
|
|
348
148
|
/**
|
|
349
|
-
* HTTP
|
|
350
|
-
* Java method: org.openremote.model.
|
|
149
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
150
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
351
151
|
*/
|
|
352
|
-
|
|
152
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
153
|
+
realm?: string;
|
|
154
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
353
155
|
/**
|
|
354
|
-
* HTTP
|
|
355
|
-
* Java method: org.openremote.model.
|
|
156
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
157
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
356
158
|
*/
|
|
357
|
-
|
|
159
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
160
|
+
realm?: string;
|
|
161
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
358
162
|
/**
|
|
359
|
-
* HTTP
|
|
360
|
-
* Java method: org.openremote.model.
|
|
163
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
164
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
361
165
|
*/
|
|
362
|
-
|
|
166
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
167
|
+
parentId?: string;
|
|
168
|
+
realm?: string;
|
|
169
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
363
170
|
}
|
|
364
171
|
export declare class AssetModelResourceClient<O> {
|
|
365
172
|
protected httpClient: HttpClient<O>;
|
|
@@ -430,37 +237,41 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
430
237
|
*/
|
|
431
238
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
432
239
|
}
|
|
433
|
-
export declare class
|
|
240
|
+
export declare class GatewayClientResourceClient<O> {
|
|
434
241
|
protected httpClient: HttpClient<O>;
|
|
435
242
|
constructor(httpClient: HttpClient<O>);
|
|
436
243
|
/**
|
|
437
|
-
* HTTP
|
|
438
|
-
* Java method: org.openremote.model.
|
|
244
|
+
* HTTP DELETE /gateway/connection
|
|
245
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
439
246
|
*/
|
|
440
|
-
|
|
247
|
+
deleteConnections(queryParams?: {
|
|
248
|
+
realm?: string[];
|
|
249
|
+
}, options?: O): RestResponse<void>;
|
|
441
250
|
/**
|
|
442
|
-
* HTTP
|
|
443
|
-
* Java method: org.openremote.model.
|
|
251
|
+
* HTTP GET /gateway/connection
|
|
252
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
444
253
|
*/
|
|
445
|
-
|
|
254
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
446
255
|
/**
|
|
447
|
-
* HTTP DELETE /
|
|
448
|
-
* Java method: org.openremote.model.
|
|
256
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
257
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
449
258
|
*/
|
|
450
|
-
|
|
259
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
451
260
|
/**
|
|
452
|
-
* HTTP GET /
|
|
453
|
-
* Java method: org.openremote.model.
|
|
261
|
+
* HTTP GET /gateway/connection/{realm}
|
|
262
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
454
263
|
*/
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
264
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
265
|
+
/**
|
|
266
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
267
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
268
|
+
*/
|
|
269
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
270
|
+
/**
|
|
271
|
+
* HTTP GET /gateway/status/{realm}
|
|
272
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
273
|
+
*/
|
|
274
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
464
275
|
}
|
|
465
276
|
export declare class FlowResourceClient<O> {
|
|
466
277
|
protected httpClient: HttpClient<O>;
|
|
@@ -481,6 +292,253 @@ export declare class FlowResourceClient<O> {
|
|
|
481
292
|
*/
|
|
482
293
|
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
483
294
|
}
|
|
295
|
+
export declare class StatusResourceClient<O> {
|
|
296
|
+
protected httpClient: HttpClient<O>;
|
|
297
|
+
constructor(httpClient: HttpClient<O>);
|
|
298
|
+
/**
|
|
299
|
+
* HTTP GET /health
|
|
300
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
301
|
+
*/
|
|
302
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
303
|
+
[index: string]: any;
|
|
304
|
+
}>;
|
|
305
|
+
/**
|
|
306
|
+
* HTTP GET /info
|
|
307
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
308
|
+
*/
|
|
309
|
+
getInfo(options?: O): RestResponse<{
|
|
310
|
+
[index: string]: any;
|
|
311
|
+
}>;
|
|
312
|
+
}
|
|
313
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
314
|
+
protected httpClient: HttpClient<O>;
|
|
315
|
+
constructor(httpClient: HttpClient<O>);
|
|
316
|
+
/**
|
|
317
|
+
* HTTP POST /gateway/tunnel
|
|
318
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
319
|
+
*/
|
|
320
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
321
|
+
/**
|
|
322
|
+
* HTTP DELETE /gateway/tunnel
|
|
323
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
324
|
+
*/
|
|
325
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
326
|
+
/**
|
|
327
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
328
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
329
|
+
*/
|
|
330
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
331
|
+
/**
|
|
332
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
333
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
334
|
+
*/
|
|
335
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
336
|
+
/**
|
|
337
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
338
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
339
|
+
*/
|
|
340
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
341
|
+
}
|
|
342
|
+
export declare class MapResourceClient<O> {
|
|
343
|
+
protected httpClient: HttpClient<O>;
|
|
344
|
+
constructor(httpClient: HttpClient<O>);
|
|
345
|
+
/**
|
|
346
|
+
* HTTP GET /map
|
|
347
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
348
|
+
*/
|
|
349
|
+
getSettings(options?: O): RestResponse<{
|
|
350
|
+
[id: string]: unknown;
|
|
351
|
+
}>;
|
|
352
|
+
/**
|
|
353
|
+
* HTTP PUT /map
|
|
354
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
355
|
+
*/
|
|
356
|
+
saveSettings(mapConfig: {
|
|
357
|
+
[index: string]: Model.MapRealmConfig;
|
|
358
|
+
}, options?: O): RestResponse<any>;
|
|
359
|
+
/**
|
|
360
|
+
* HTTP GET /map/js
|
|
361
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
362
|
+
*/
|
|
363
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
364
|
+
[id: string]: unknown;
|
|
365
|
+
}>;
|
|
366
|
+
/**
|
|
367
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
368
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
369
|
+
*/
|
|
370
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
371
|
+
}
|
|
372
|
+
export declare class AssetResourceClient<O> {
|
|
373
|
+
protected httpClient: HttpClient<O>;
|
|
374
|
+
constructor(httpClient: HttpClient<O>);
|
|
375
|
+
/**
|
|
376
|
+
* HTTP POST /asset
|
|
377
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
378
|
+
*/
|
|
379
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
380
|
+
/**
|
|
381
|
+
* HTTP DELETE /asset
|
|
382
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
383
|
+
*/
|
|
384
|
+
delete(queryParams?: {
|
|
385
|
+
assetId?: string[];
|
|
386
|
+
}, options?: O): RestResponse<void>;
|
|
387
|
+
/**
|
|
388
|
+
* HTTP PUT /asset/attributes
|
|
389
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
390
|
+
*/
|
|
391
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
392
|
+
/**
|
|
393
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
394
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
395
|
+
*/
|
|
396
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
397
|
+
/**
|
|
398
|
+
* HTTP DELETE /asset/parent
|
|
399
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
400
|
+
*/
|
|
401
|
+
updateNoneParent(queryParams?: {
|
|
402
|
+
assetIds?: string[];
|
|
403
|
+
}, options?: O): RestResponse<void>;
|
|
404
|
+
/**
|
|
405
|
+
* HTTP GET /asset/partial/{assetId}
|
|
406
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
407
|
+
*/
|
|
408
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
409
|
+
/**
|
|
410
|
+
* HTTP POST /asset/query
|
|
411
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
412
|
+
*/
|
|
413
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
414
|
+
/**
|
|
415
|
+
* HTTP GET /asset/user/current
|
|
416
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
417
|
+
*/
|
|
418
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
419
|
+
/**
|
|
420
|
+
* HTTP POST /asset/user/link
|
|
421
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
422
|
+
*/
|
|
423
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
424
|
+
/**
|
|
425
|
+
* HTTP GET /asset/user/link
|
|
426
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
427
|
+
*/
|
|
428
|
+
getUserAssetLinks(queryParams?: {
|
|
429
|
+
realm?: string;
|
|
430
|
+
userId?: string;
|
|
431
|
+
assetId?: string;
|
|
432
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
433
|
+
/**
|
|
434
|
+
* HTTP POST /asset/user/link/delete
|
|
435
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
436
|
+
*/
|
|
437
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
438
|
+
/**
|
|
439
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
440
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
441
|
+
*/
|
|
442
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
443
|
+
/**
|
|
444
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
445
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
446
|
+
*/
|
|
447
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
448
|
+
/**
|
|
449
|
+
* HTTP GET /asset/{assetId}
|
|
450
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
451
|
+
*/
|
|
452
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
453
|
+
/**
|
|
454
|
+
* HTTP PUT /asset/{assetId}
|
|
455
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
456
|
+
*/
|
|
457
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
458
|
+
/**
|
|
459
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
460
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
461
|
+
*/
|
|
462
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
463
|
+
/**
|
|
464
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
465
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
466
|
+
*/
|
|
467
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
468
|
+
/**
|
|
469
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
470
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
471
|
+
*/
|
|
472
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
473
|
+
assetIds?: string[];
|
|
474
|
+
}, options?: O): RestResponse<void>;
|
|
475
|
+
}
|
|
476
|
+
export declare class RealmResourceClient<O> {
|
|
477
|
+
protected httpClient: HttpClient<O>;
|
|
478
|
+
constructor(httpClient: HttpClient<O>);
|
|
479
|
+
/**
|
|
480
|
+
* HTTP POST /realm
|
|
481
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
482
|
+
*/
|
|
483
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
484
|
+
/**
|
|
485
|
+
* HTTP GET /realm
|
|
486
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
487
|
+
*/
|
|
488
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
489
|
+
/**
|
|
490
|
+
* HTTP GET /realm/accessible
|
|
491
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
492
|
+
*/
|
|
493
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
494
|
+
/**
|
|
495
|
+
* HTTP DELETE /realm/{name}
|
|
496
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
497
|
+
*/
|
|
498
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
499
|
+
/**
|
|
500
|
+
* HTTP GET /realm/{name}
|
|
501
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
502
|
+
*/
|
|
503
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
504
|
+
/**
|
|
505
|
+
* HTTP PUT /realm/{name}
|
|
506
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
507
|
+
*/
|
|
508
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
509
|
+
}
|
|
510
|
+
export declare class SyslogResourceClient<O> {
|
|
511
|
+
protected httpClient: HttpClient<O>;
|
|
512
|
+
constructor(httpClient: HttpClient<O>);
|
|
513
|
+
/**
|
|
514
|
+
* HTTP GET /syslog/config
|
|
515
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
516
|
+
*/
|
|
517
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
518
|
+
/**
|
|
519
|
+
* HTTP PUT /syslog/config
|
|
520
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
521
|
+
*/
|
|
522
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
523
|
+
/**
|
|
524
|
+
* HTTP DELETE /syslog/event
|
|
525
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
526
|
+
*/
|
|
527
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
528
|
+
/**
|
|
529
|
+
* HTTP GET /syslog/event
|
|
530
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
531
|
+
*/
|
|
532
|
+
getEvents(queryParams?: {
|
|
533
|
+
level?: Model.SyslogLevel;
|
|
534
|
+
per_page?: number;
|
|
535
|
+
page?: number;
|
|
536
|
+
from?: number;
|
|
537
|
+
to?: number;
|
|
538
|
+
category?: Model.SyslogCategory[];
|
|
539
|
+
subCategory?: string[];
|
|
540
|
+
}, options?: O): RestResponse<any>;
|
|
541
|
+
}
|
|
484
542
|
export declare class NotificationResourceClient<O> {
|
|
485
543
|
protected httpClient: HttpClient<O>;
|
|
486
544
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -535,41 +593,19 @@ export declare class NotificationResourceClient<O> {
|
|
|
535
593
|
targetId?: string;
|
|
536
594
|
}, options?: O): RestResponse<void>;
|
|
537
595
|
}
|
|
538
|
-
export declare class
|
|
596
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
539
597
|
protected httpClient: HttpClient<O>;
|
|
540
598
|
constructor(httpClient: HttpClient<O>);
|
|
541
599
|
/**
|
|
542
|
-
* HTTP
|
|
543
|
-
* Java method: org.openremote.model.
|
|
544
|
-
*/
|
|
545
|
-
deleteConnections(queryParams?: {
|
|
546
|
-
realm?: string[];
|
|
547
|
-
}, options?: O): RestResponse<void>;
|
|
548
|
-
/**
|
|
549
|
-
* HTTP GET /gateway/connection
|
|
550
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
551
|
-
*/
|
|
552
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
553
|
-
/**
|
|
554
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
555
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
556
|
-
*/
|
|
557
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
558
|
-
/**
|
|
559
|
-
* HTTP GET /gateway/connection/{realm}
|
|
560
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
561
|
-
*/
|
|
562
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
563
|
-
/**
|
|
564
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
565
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
600
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
601
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
566
602
|
*/
|
|
567
|
-
|
|
603
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
568
604
|
/**
|
|
569
|
-
* HTTP
|
|
570
|
-
* Java method: org.openremote.model.
|
|
605
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
606
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
571
607
|
*/
|
|
572
|
-
|
|
608
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
573
609
|
}
|
|
574
610
|
export declare class RulesResourceClient<O> {
|
|
575
611
|
protected httpClient: HttpClient<O>;
|
|
@@ -679,245 +715,209 @@ export declare class RulesResourceClient<O> {
|
|
|
679
715
|
*/
|
|
680
716
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
681
717
|
}
|
|
682
|
-
export declare class
|
|
683
|
-
protected httpClient: HttpClient<O>;
|
|
684
|
-
constructor(httpClient: HttpClient<O>);
|
|
685
|
-
/**
|
|
686
|
-
* HTTP GET /asset/datapoint/export
|
|
687
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
688
|
-
*/
|
|
689
|
-
getDatapointExport(queryParams?: {
|
|
690
|
-
attributeRefs?: string;
|
|
691
|
-
fromTimestamp?: number;
|
|
692
|
-
toTimestamp?: number;
|
|
693
|
-
}, options?: O): RestResponse<any>;
|
|
694
|
-
/**
|
|
695
|
-
* HTTP GET /asset/datapoint/periods
|
|
696
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
697
|
-
*/
|
|
698
|
-
getDatapointPeriod(queryParams?: {
|
|
699
|
-
assetId?: string;
|
|
700
|
-
attributeName?: string;
|
|
701
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
702
|
-
/**
|
|
703
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
704
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
705
|
-
*/
|
|
706
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
707
|
-
}
|
|
708
|
-
export declare class ConsoleResourceClient<O> {
|
|
709
|
-
protected httpClient: HttpClient<O>;
|
|
710
|
-
constructor(httpClient: HttpClient<O>);
|
|
711
|
-
/**
|
|
712
|
-
* HTTP POST /console/register
|
|
713
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
714
|
-
*/
|
|
715
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
716
|
-
}
|
|
717
|
-
export declare class AssetResourceClient<O> {
|
|
718
|
+
export declare class DashboardResourceClient<O> {
|
|
718
719
|
protected httpClient: HttpClient<O>;
|
|
719
720
|
constructor(httpClient: HttpClient<O>);
|
|
720
721
|
/**
|
|
721
|
-
* HTTP POST /
|
|
722
|
-
* Java method: org.openremote.model.
|
|
723
|
-
*/
|
|
724
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
725
|
-
/**
|
|
726
|
-
* HTTP DELETE /asset
|
|
727
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
728
|
-
*/
|
|
729
|
-
delete(queryParams?: {
|
|
730
|
-
assetId?: string[];
|
|
731
|
-
}, options?: O): RestResponse<void>;
|
|
732
|
-
/**
|
|
733
|
-
* HTTP PUT /asset/attributes
|
|
734
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
735
|
-
*/
|
|
736
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
737
|
-
/**
|
|
738
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
739
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
740
|
-
*/
|
|
741
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
742
|
-
/**
|
|
743
|
-
* HTTP DELETE /asset/parent
|
|
744
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
722
|
+
* HTTP POST /dashboard
|
|
723
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
745
724
|
*/
|
|
746
|
-
|
|
747
|
-
assetIds?: string[];
|
|
748
|
-
}, options?: O): RestResponse<void>;
|
|
725
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
749
726
|
/**
|
|
750
|
-
* HTTP
|
|
751
|
-
* Java method: org.openremote.model.
|
|
727
|
+
* HTTP PUT /dashboard
|
|
728
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
752
729
|
*/
|
|
753
|
-
|
|
730
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
754
731
|
/**
|
|
755
|
-
* HTTP
|
|
756
|
-
* Java method: org.openremote.model.
|
|
732
|
+
* HTTP GET /dashboard/all/{realm}
|
|
733
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
757
734
|
*/
|
|
758
|
-
|
|
735
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
759
736
|
/**
|
|
760
|
-
* HTTP
|
|
761
|
-
* Java method: org.openremote.model.
|
|
737
|
+
* HTTP POST /dashboard/query
|
|
738
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
762
739
|
*/
|
|
763
|
-
|
|
740
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
764
741
|
/**
|
|
765
|
-
* HTTP
|
|
766
|
-
* Java method: org.openremote.model.
|
|
742
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
743
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
767
744
|
*/
|
|
768
|
-
|
|
745
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
769
746
|
/**
|
|
770
|
-
* HTTP GET /
|
|
771
|
-
* Java method: org.openremote.model.
|
|
747
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
748
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
772
749
|
*/
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
750
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
751
|
+
}
|
|
752
|
+
export declare class AlarmResourceClient<O> {
|
|
753
|
+
protected httpClient: HttpClient<O>;
|
|
754
|
+
constructor(httpClient: HttpClient<O>);
|
|
778
755
|
/**
|
|
779
|
-
* HTTP POST /
|
|
780
|
-
* Java method: org.openremote.model.
|
|
756
|
+
* HTTP POST /alarm
|
|
757
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
781
758
|
*/
|
|
782
|
-
|
|
759
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
760
|
+
assetIds?: string[];
|
|
761
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
783
762
|
/**
|
|
784
|
-
* HTTP
|
|
785
|
-
* Java method: org.openremote.model.
|
|
763
|
+
* HTTP GET /alarm
|
|
764
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
786
765
|
*/
|
|
787
|
-
|
|
766
|
+
getAlarms(queryParams?: {
|
|
767
|
+
realm?: string;
|
|
768
|
+
status?: Model.AlarmStatus;
|
|
769
|
+
assetId?: string;
|
|
770
|
+
assigneeId?: string;
|
|
771
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
788
772
|
/**
|
|
789
|
-
* HTTP DELETE /
|
|
790
|
-
* Java method: org.openremote.model.
|
|
773
|
+
* HTTP DELETE /alarm
|
|
774
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
791
775
|
*/
|
|
792
|
-
|
|
776
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
793
777
|
/**
|
|
794
|
-
* HTTP
|
|
795
|
-
* Java method: org.openremote.model.
|
|
778
|
+
* HTTP PUT /alarm/assets
|
|
779
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
796
780
|
*/
|
|
797
|
-
|
|
781
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
798
782
|
/**
|
|
799
|
-
* HTTP
|
|
800
|
-
* Java method: org.openremote.model.
|
|
783
|
+
* HTTP GET /alarm/{alarmId}
|
|
784
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
801
785
|
*/
|
|
802
|
-
|
|
786
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
803
787
|
/**
|
|
804
|
-
* HTTP
|
|
805
|
-
* Java method: org.openremote.model.
|
|
788
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
789
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
806
790
|
*/
|
|
807
|
-
|
|
791
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
808
792
|
/**
|
|
809
|
-
* HTTP PUT /
|
|
810
|
-
* Java method: org.openremote.model.
|
|
793
|
+
* HTTP PUT /alarm/{alarmId}
|
|
794
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
811
795
|
*/
|
|
812
|
-
|
|
796
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
813
797
|
/**
|
|
814
|
-
* HTTP
|
|
815
|
-
* Java method: org.openremote.model.
|
|
798
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
799
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
816
800
|
*/
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
}, options?: O): RestResponse<
|
|
801
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
802
|
+
realm?: string;
|
|
803
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
820
804
|
}
|
|
821
|
-
export declare class
|
|
805
|
+
export declare class ConfigurationResourceClient<O> {
|
|
822
806
|
protected httpClient: HttpClient<O>;
|
|
823
807
|
constructor(httpClient: HttpClient<O>);
|
|
824
808
|
/**
|
|
825
|
-
* HTTP GET /
|
|
826
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP GET /configuration/manager
|
|
810
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
827
811
|
*/
|
|
828
|
-
|
|
829
|
-
realm?: string;
|
|
830
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
812
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
831
813
|
/**
|
|
832
|
-
* HTTP
|
|
833
|
-
* Java method: org.openremote.model.
|
|
814
|
+
* HTTP PUT /configuration/manager
|
|
815
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
834
816
|
*/
|
|
835
|
-
|
|
836
|
-
realm?: string;
|
|
837
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
817
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
838
818
|
/**
|
|
839
|
-
* HTTP
|
|
840
|
-
* Java method: org.openremote.model.
|
|
819
|
+
* HTTP POST /configuration/manager/file
|
|
820
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
841
821
|
*/
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
822
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
823
|
+
path?: string;
|
|
824
|
+
}, options?: O): RestResponse<string>;
|
|
825
|
+
/**
|
|
826
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
827
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
828
|
+
*/
|
|
829
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
846
830
|
}
|
|
847
|
-
export declare class
|
|
831
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
848
832
|
protected httpClient: HttpClient<O>;
|
|
849
833
|
constructor(httpClient: HttpClient<O>);
|
|
850
834
|
/**
|
|
851
|
-
* HTTP
|
|
852
|
-
* Java method: org.openremote.model.
|
|
835
|
+
* HTTP GET /asset/datapoint/export
|
|
836
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
853
837
|
*/
|
|
854
|
-
|
|
838
|
+
getDatapointExport(queryParams?: {
|
|
839
|
+
attributeRefs?: string;
|
|
840
|
+
fromTimestamp?: number;
|
|
841
|
+
toTimestamp?: number;
|
|
842
|
+
}, options?: O): RestResponse<any>;
|
|
855
843
|
/**
|
|
856
|
-
* HTTP
|
|
857
|
-
* Java method: org.openremote.model.
|
|
844
|
+
* HTTP GET /asset/datapoint/periods
|
|
845
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
858
846
|
*/
|
|
859
|
-
|
|
847
|
+
getDatapointPeriod(queryParams?: {
|
|
848
|
+
assetId?: string;
|
|
849
|
+
attributeName?: string;
|
|
850
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
860
851
|
/**
|
|
861
|
-
* HTTP
|
|
862
|
-
* Java method: org.openremote.model.
|
|
852
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
853
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
863
854
|
*/
|
|
864
|
-
|
|
855
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
856
|
+
}
|
|
857
|
+
export declare class AppResourceClient<O> {
|
|
858
|
+
protected httpClient: HttpClient<O>;
|
|
859
|
+
constructor(httpClient: HttpClient<O>);
|
|
865
860
|
/**
|
|
866
|
-
* HTTP GET /
|
|
867
|
-
* Java method: org.openremote.model.
|
|
861
|
+
* HTTP GET /apps
|
|
862
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
868
863
|
*/
|
|
869
|
-
|
|
864
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
870
865
|
/**
|
|
871
|
-
* HTTP GET /
|
|
872
|
-
* Java method: org.openremote.model.
|
|
866
|
+
* HTTP GET /apps/consoleConfig
|
|
867
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
873
868
|
*/
|
|
874
|
-
|
|
869
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
870
|
+
/**
|
|
871
|
+
* HTTP GET /apps/info
|
|
872
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
873
|
+
*/
|
|
874
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
879
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
880
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
881
|
-
protected _appResource: AxiosAppResourceClient;
|
|
882
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
883
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
884
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
885
878
|
protected _userResource: AxiosUserResourceClient;
|
|
886
|
-
protected
|
|
879
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
880
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
887
881
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
888
882
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
889
|
-
protected
|
|
883
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
890
884
|
protected _flowResource: AxiosFlowResourceClient;
|
|
885
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
886
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
887
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
888
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
889
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
890
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
891
891
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
892
|
-
protected
|
|
892
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
893
893
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
894
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
895
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
896
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
894
897
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
895
|
-
protected
|
|
896
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
897
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
898
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
898
|
+
protected _appResource: AxiosAppResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
901
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
902
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
903
|
-
get AppResource(): AxiosAppResourceClient;
|
|
904
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
905
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
906
|
-
get MapResource(): AxiosMapResourceClient;
|
|
907
900
|
get UserResource(): AxiosUserResourceClient;
|
|
908
|
-
get
|
|
901
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
902
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
909
903
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
910
904
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
911
|
-
get
|
|
905
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
912
906
|
get FlowResource(): AxiosFlowResourceClient;
|
|
907
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
908
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
909
|
+
get MapResource(): AxiosMapResourceClient;
|
|
910
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
911
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
912
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
913
913
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
914
|
-
get
|
|
914
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
915
915
|
get RulesResource(): AxiosRulesResourceClient;
|
|
916
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
917
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
918
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
916
919
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
917
|
-
get
|
|
918
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
919
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
920
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
920
|
+
get AppResource(): AxiosAppResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
967
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
973
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|