@openremote/rest 1.6.0-snapshot.20250512145140 → 1.6.0-snapshot.20250513081115
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 +418 -418
- 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,125 +9,55 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP POST /realm
|
|
17
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
18
|
-
*/
|
|
19
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP GET /realm
|
|
22
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
23
|
-
*/
|
|
24
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP GET /realm/accessible
|
|
27
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
28
|
-
*/
|
|
29
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
30
|
-
/**
|
|
31
|
-
* HTTP DELETE /realm/{name}
|
|
32
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
33
|
-
*/
|
|
34
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
35
|
-
/**
|
|
36
|
-
* HTTP GET /realm/{name}
|
|
37
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
38
|
-
*/
|
|
39
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
40
|
-
/**
|
|
41
|
-
* HTTP PUT /realm/{name}
|
|
42
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
43
|
-
*/
|
|
44
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
45
|
-
}
|
|
46
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
47
|
-
protected httpClient: HttpClient<O>;
|
|
48
|
-
constructor(httpClient: HttpClient<O>);
|
|
49
|
-
/**
|
|
50
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
51
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
52
|
-
*/
|
|
53
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
54
|
-
/**
|
|
55
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
56
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
57
|
-
*/
|
|
58
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
59
|
-
}
|
|
60
|
-
export declare class AppResourceClient<O> {
|
|
12
|
+
export declare class AgentResourceClient<O> {
|
|
61
13
|
protected httpClient: HttpClient<O>;
|
|
62
14
|
constructor(httpClient: HttpClient<O>);
|
|
63
15
|
/**
|
|
64
|
-
* HTTP GET /
|
|
65
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
17
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
66
18
|
*/
|
|
67
|
-
|
|
19
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
20
|
+
realm?: string;
|
|
21
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
68
22
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
24
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
71
25
|
*/
|
|
72
|
-
|
|
26
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
27
|
+
realm?: string;
|
|
28
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
73
29
|
/**
|
|
74
|
-
* HTTP GET /
|
|
75
|
-
* Java method: org.openremote.model.
|
|
30
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
31
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
76
32
|
*/
|
|
77
|
-
|
|
33
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
34
|
+
parentId?: string;
|
|
35
|
+
realm?: string;
|
|
36
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
78
37
|
}
|
|
79
|
-
export declare class
|
|
38
|
+
export declare class ProvisioningResourceClient<O> {
|
|
80
39
|
protected httpClient: HttpClient<O>;
|
|
81
40
|
constructor(httpClient: HttpClient<O>);
|
|
82
41
|
/**
|
|
83
|
-
* HTTP
|
|
84
|
-
* Java method: org.openremote.model.
|
|
85
|
-
*/
|
|
86
|
-
getSettings(options?: O): RestResponse<{
|
|
87
|
-
[id: string]: unknown;
|
|
88
|
-
}>;
|
|
89
|
-
/**
|
|
90
|
-
* HTTP PUT /map
|
|
91
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
92
|
-
*/
|
|
93
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
94
|
-
[id: string]: unknown;
|
|
95
|
-
}>;
|
|
96
|
-
/**
|
|
97
|
-
* HTTP DELETE /map/deleteMap
|
|
98
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
99
|
-
*/
|
|
100
|
-
deleteMap(options?: O): RestResponse<{
|
|
101
|
-
[id: string]: unknown;
|
|
102
|
-
}>;
|
|
103
|
-
/**
|
|
104
|
-
* HTTP GET /map/getCustomMapInfo
|
|
105
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
42
|
+
* HTTP POST /provisioning
|
|
43
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
106
44
|
*/
|
|
107
|
-
|
|
108
|
-
[id: string]: unknown;
|
|
109
|
-
}>;
|
|
45
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
110
46
|
/**
|
|
111
|
-
* HTTP GET /
|
|
112
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP GET /provisioning
|
|
48
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
113
49
|
*/
|
|
114
|
-
|
|
115
|
-
[id: string]: unknown;
|
|
116
|
-
}>;
|
|
50
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
117
51
|
/**
|
|
118
|
-
* HTTP
|
|
119
|
-
* Java method: org.openremote.model.
|
|
52
|
+
* HTTP DELETE /provisioning/{id}
|
|
53
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
120
54
|
*/
|
|
121
|
-
|
|
55
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
122
56
|
/**
|
|
123
|
-
* HTTP
|
|
124
|
-
* Java method: org.openremote.model.
|
|
57
|
+
* HTTP PUT /provisioning/{id}
|
|
58
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
125
59
|
*/
|
|
126
|
-
|
|
127
|
-
filename?: string;
|
|
128
|
-
}, options?: O): RestResponse<{
|
|
129
|
-
[id: string]: unknown;
|
|
130
|
-
}>;
|
|
60
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
131
61
|
}
|
|
132
62
|
export declare class GatewayServiceResourceClient<O> {
|
|
133
63
|
protected httpClient: HttpClient<O>;
|
|
@@ -158,15 +88,6 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
158
88
|
*/
|
|
159
89
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
160
90
|
}
|
|
161
|
-
export declare class ConsoleResourceClient<O> {
|
|
162
|
-
protected httpClient: HttpClient<O>;
|
|
163
|
-
constructor(httpClient: HttpClient<O>);
|
|
164
|
-
/**
|
|
165
|
-
* HTTP POST /console/register
|
|
166
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
167
|
-
*/
|
|
168
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
169
|
-
}
|
|
170
91
|
export declare class ConfigurationResourceClient<O> {
|
|
171
92
|
protected httpClient: HttpClient<O>;
|
|
172
93
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -193,68 +114,6 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
193
114
|
*/
|
|
194
115
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
195
116
|
}
|
|
196
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
197
|
-
protected httpClient: HttpClient<O>;
|
|
198
|
-
constructor(httpClient: HttpClient<O>);
|
|
199
|
-
/**
|
|
200
|
-
* HTTP GET /asset/datapoint/export
|
|
201
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
202
|
-
*/
|
|
203
|
-
getDatapointExport(queryParams?: {
|
|
204
|
-
attributeRefs?: string;
|
|
205
|
-
fromTimestamp?: number;
|
|
206
|
-
toTimestamp?: number;
|
|
207
|
-
}, options?: O): RestResponse<any>;
|
|
208
|
-
/**
|
|
209
|
-
* HTTP GET /asset/datapoint/periods
|
|
210
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
211
|
-
*/
|
|
212
|
-
getDatapointPeriod(queryParams?: {
|
|
213
|
-
assetId?: string;
|
|
214
|
-
attributeName?: string;
|
|
215
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
216
|
-
/**
|
|
217
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
218
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
219
|
-
*/
|
|
220
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
221
|
-
}
|
|
222
|
-
export declare class GatewayClientResourceClient<O> {
|
|
223
|
-
protected httpClient: HttpClient<O>;
|
|
224
|
-
constructor(httpClient: HttpClient<O>);
|
|
225
|
-
/**
|
|
226
|
-
* HTTP DELETE /gateway/connection
|
|
227
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
228
|
-
*/
|
|
229
|
-
deleteConnections(queryParams?: {
|
|
230
|
-
realm?: string[];
|
|
231
|
-
}, options?: O): RestResponse<void>;
|
|
232
|
-
/**
|
|
233
|
-
* HTTP GET /gateway/connection
|
|
234
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
235
|
-
*/
|
|
236
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
237
|
-
/**
|
|
238
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
239
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
240
|
-
*/
|
|
241
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
242
|
-
/**
|
|
243
|
-
* HTTP GET /gateway/connection/{realm}
|
|
244
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
245
|
-
*/
|
|
246
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
247
|
-
/**
|
|
248
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
249
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
250
|
-
*/
|
|
251
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
252
|
-
/**
|
|
253
|
-
* HTTP GET /gateway/status/{realm}
|
|
254
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
255
|
-
*/
|
|
256
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
257
|
-
}
|
|
258
117
|
export declare class SyslogResourceClient<O> {
|
|
259
118
|
protected httpClient: HttpClient<O>;
|
|
260
119
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -287,162 +146,121 @@ export declare class SyslogResourceClient<O> {
|
|
|
287
146
|
subCategory?: string[];
|
|
288
147
|
}, options?: O): RestResponse<any>;
|
|
289
148
|
}
|
|
290
|
-
export declare class
|
|
149
|
+
export declare class AssetModelResourceClient<O> {
|
|
291
150
|
protected httpClient: HttpClient<O>;
|
|
292
151
|
constructor(httpClient: HttpClient<O>);
|
|
293
152
|
/**
|
|
294
|
-
* HTTP
|
|
295
|
-
* Java method: org.openremote.model.
|
|
153
|
+
* HTTP GET /model/assetDescriptors
|
|
154
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
296
155
|
*/
|
|
297
|
-
|
|
156
|
+
getAssetDescriptors(queryParams?: {
|
|
157
|
+
parentId?: string;
|
|
158
|
+
parentType?: string;
|
|
159
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
298
160
|
/**
|
|
299
|
-
* HTTP GET /
|
|
300
|
-
* Java method: org.openremote.model.
|
|
161
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
162
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
301
163
|
*/
|
|
302
|
-
|
|
164
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
165
|
+
parentId?: string;
|
|
166
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
303
167
|
/**
|
|
304
|
-
* HTTP
|
|
305
|
-
* Java method: org.openremote.model.
|
|
168
|
+
* HTTP GET /model/assetInfos
|
|
169
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
306
170
|
*/
|
|
307
|
-
|
|
171
|
+
getAssetInfos(queryParams?: {
|
|
172
|
+
parentId?: string;
|
|
173
|
+
parentType?: string;
|
|
174
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
308
175
|
/**
|
|
309
|
-
* HTTP
|
|
310
|
-
* Java method: org.openremote.model.
|
|
176
|
+
* HTTP GET /model/metaItemDescriptors
|
|
177
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
311
178
|
*/
|
|
312
|
-
|
|
179
|
+
getMetaItemDescriptors(queryParams?: {
|
|
180
|
+
parentId?: string;
|
|
181
|
+
}, options?: O): RestResponse<{
|
|
182
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
183
|
+
}>;
|
|
184
|
+
/**
|
|
185
|
+
* HTTP GET /model/valueDescriptors
|
|
186
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
187
|
+
*/
|
|
188
|
+
getValueDescriptors(queryParams?: {
|
|
189
|
+
parentId?: string;
|
|
190
|
+
}, options?: O): RestResponse<{
|
|
191
|
+
[index: string]: Model.ValueDescriptor;
|
|
192
|
+
}>;
|
|
313
193
|
}
|
|
314
|
-
export declare class
|
|
194
|
+
export declare class AlarmResourceClient<O> {
|
|
315
195
|
protected httpClient: HttpClient<O>;
|
|
316
196
|
constructor(httpClient: HttpClient<O>);
|
|
317
197
|
/**
|
|
318
|
-
* HTTP POST /
|
|
319
|
-
* Java method: org.openremote.model.
|
|
198
|
+
* HTTP POST /alarm
|
|
199
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
320
200
|
*/
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
325
|
-
*/
|
|
326
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
327
|
-
/**
|
|
328
|
-
* HTTP GET /dashboard/all/{realm}
|
|
329
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
330
|
-
*/
|
|
331
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
332
|
-
/**
|
|
333
|
-
* HTTP POST /dashboard/query
|
|
334
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
335
|
-
*/
|
|
336
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
337
|
-
/**
|
|
338
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
339
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
340
|
-
*/
|
|
341
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
342
|
-
/**
|
|
343
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
344
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
345
|
-
*/
|
|
346
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
347
|
-
}
|
|
348
|
-
export declare class AgentResourceClient<O> {
|
|
349
|
-
protected httpClient: HttpClient<O>;
|
|
350
|
-
constructor(httpClient: HttpClient<O>);
|
|
351
|
-
/**
|
|
352
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
353
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
354
|
-
*/
|
|
355
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
356
|
-
realm?: string;
|
|
357
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
358
|
-
/**
|
|
359
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
360
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
361
|
-
*/
|
|
362
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
363
|
-
realm?: string;
|
|
364
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
201
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
202
|
+
assetIds?: string[];
|
|
203
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
365
204
|
/**
|
|
366
|
-
* HTTP GET /
|
|
367
|
-
* Java method: org.openremote.model.
|
|
205
|
+
* HTTP GET /alarm
|
|
206
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
368
207
|
*/
|
|
369
|
-
|
|
370
|
-
parentId?: string;
|
|
208
|
+
getAlarms(queryParams?: {
|
|
371
209
|
realm?: string;
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
constructor(httpClient: HttpClient<O>);
|
|
210
|
+
status?: Model.AlarmStatus;
|
|
211
|
+
assetId?: string;
|
|
212
|
+
assigneeId?: string;
|
|
213
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
377
214
|
/**
|
|
378
|
-
* HTTP
|
|
379
|
-
* Java method: org.openremote.model.
|
|
215
|
+
* HTTP DELETE /alarm
|
|
216
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
380
217
|
*/
|
|
381
|
-
|
|
382
|
-
id?: number;
|
|
383
|
-
type?: string;
|
|
384
|
-
from?: number;
|
|
385
|
-
to?: number;
|
|
386
|
-
realmId?: string;
|
|
387
|
-
userId?: string;
|
|
388
|
-
assetId?: string;
|
|
389
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
218
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
390
219
|
/**
|
|
391
|
-
* HTTP
|
|
392
|
-
* Java method: org.openremote.model.
|
|
220
|
+
* HTTP PUT /alarm/assets
|
|
221
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
393
222
|
*/
|
|
394
|
-
|
|
395
|
-
id?: number;
|
|
396
|
-
type?: string;
|
|
397
|
-
from?: number;
|
|
398
|
-
to?: number;
|
|
399
|
-
realmId?: string;
|
|
400
|
-
userId?: string;
|
|
401
|
-
assetId?: string;
|
|
402
|
-
}, options?: O): RestResponse<void>;
|
|
223
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
403
224
|
/**
|
|
404
|
-
* HTTP
|
|
405
|
-
* Java method: org.openremote.model.
|
|
225
|
+
* HTTP GET /alarm/{alarmId}
|
|
226
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
406
227
|
*/
|
|
407
|
-
|
|
228
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
408
229
|
/**
|
|
409
|
-
* HTTP DELETE /
|
|
410
|
-
* Java method: org.openremote.model.
|
|
230
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
231
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
411
232
|
*/
|
|
412
|
-
|
|
233
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
413
234
|
/**
|
|
414
|
-
* HTTP PUT /
|
|
415
|
-
* Java method: org.openremote.model.
|
|
235
|
+
* HTTP PUT /alarm/{alarmId}
|
|
236
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
416
237
|
*/
|
|
417
|
-
|
|
418
|
-
targetId?: string;
|
|
419
|
-
}, options?: O): RestResponse<void>;
|
|
238
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
420
239
|
/**
|
|
421
|
-
* HTTP
|
|
422
|
-
* Java method: org.openremote.model.
|
|
240
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
241
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
423
242
|
*/
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
}, options?: O): RestResponse<
|
|
243
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
244
|
+
realm?: string;
|
|
245
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
427
246
|
}
|
|
428
|
-
export declare class
|
|
247
|
+
export declare class StatusResourceClient<O> {
|
|
429
248
|
protected httpClient: HttpClient<O>;
|
|
430
249
|
constructor(httpClient: HttpClient<O>);
|
|
431
250
|
/**
|
|
432
|
-
* HTTP GET /
|
|
433
|
-
* Java method: org.openremote.model.
|
|
434
|
-
*/
|
|
435
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
436
|
-
/**
|
|
437
|
-
* HTTP GET /flow/{name}
|
|
438
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
251
|
+
* HTTP GET /health
|
|
252
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
439
253
|
*/
|
|
440
|
-
|
|
254
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
255
|
+
[index: string]: any;
|
|
256
|
+
}>;
|
|
441
257
|
/**
|
|
442
|
-
* HTTP GET /
|
|
443
|
-
* Java method: org.openremote.model.
|
|
258
|
+
* HTTP GET /info
|
|
259
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
444
260
|
*/
|
|
445
|
-
|
|
261
|
+
getInfo(options?: O): RestResponse<{
|
|
262
|
+
[index: string]: any;
|
|
263
|
+
}>;
|
|
446
264
|
}
|
|
447
265
|
export declare class UserResourceClient<O> {
|
|
448
266
|
protected httpClient: HttpClient<O>;
|
|
@@ -548,68 +366,241 @@ export declare class UserResourceClient<O> {
|
|
|
548
366
|
*/
|
|
549
367
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
550
368
|
}
|
|
551
|
-
export declare class
|
|
369
|
+
export declare class RealmResourceClient<O> {
|
|
370
|
+
protected httpClient: HttpClient<O>;
|
|
371
|
+
constructor(httpClient: HttpClient<O>);
|
|
372
|
+
/**
|
|
373
|
+
* HTTP POST /realm
|
|
374
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
375
|
+
*/
|
|
376
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
377
|
+
/**
|
|
378
|
+
* HTTP GET /realm
|
|
379
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
380
|
+
*/
|
|
381
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
382
|
+
/**
|
|
383
|
+
* HTTP GET /realm/accessible
|
|
384
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
385
|
+
*/
|
|
386
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
387
|
+
/**
|
|
388
|
+
* HTTP DELETE /realm/{name}
|
|
389
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
390
|
+
*/
|
|
391
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
392
|
+
/**
|
|
393
|
+
* HTTP GET /realm/{name}
|
|
394
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
395
|
+
*/
|
|
396
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
397
|
+
/**
|
|
398
|
+
* HTTP PUT /realm/{name}
|
|
399
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
400
|
+
*/
|
|
401
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
402
|
+
}
|
|
403
|
+
export declare class GatewayClientResourceClient<O> {
|
|
404
|
+
protected httpClient: HttpClient<O>;
|
|
405
|
+
constructor(httpClient: HttpClient<O>);
|
|
406
|
+
/**
|
|
407
|
+
* HTTP DELETE /gateway/connection
|
|
408
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
409
|
+
*/
|
|
410
|
+
deleteConnections(queryParams?: {
|
|
411
|
+
realm?: string[];
|
|
412
|
+
}, options?: O): RestResponse<void>;
|
|
413
|
+
/**
|
|
414
|
+
* HTTP GET /gateway/connection
|
|
415
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
416
|
+
*/
|
|
417
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
418
|
+
/**
|
|
419
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
420
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
421
|
+
*/
|
|
422
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
423
|
+
/**
|
|
424
|
+
* HTTP GET /gateway/connection/{realm}
|
|
425
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
426
|
+
*/
|
|
427
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
428
|
+
/**
|
|
429
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
430
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
431
|
+
*/
|
|
432
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
433
|
+
/**
|
|
434
|
+
* HTTP GET /gateway/status/{realm}
|
|
435
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
436
|
+
*/
|
|
437
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
438
|
+
}
|
|
439
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
440
|
+
protected httpClient: HttpClient<O>;
|
|
441
|
+
constructor(httpClient: HttpClient<O>);
|
|
442
|
+
/**
|
|
443
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
444
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
445
|
+
*/
|
|
446
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
447
|
+
/**
|
|
448
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
449
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
450
|
+
*/
|
|
451
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
452
|
+
}
|
|
453
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
454
|
+
protected httpClient: HttpClient<O>;
|
|
455
|
+
constructor(httpClient: HttpClient<O>);
|
|
456
|
+
/**
|
|
457
|
+
* HTTP GET /asset/datapoint/export
|
|
458
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
459
|
+
*/
|
|
460
|
+
getDatapointExport(queryParams?: {
|
|
461
|
+
attributeRefs?: string;
|
|
462
|
+
fromTimestamp?: number;
|
|
463
|
+
toTimestamp?: number;
|
|
464
|
+
}, options?: O): RestResponse<any>;
|
|
465
|
+
/**
|
|
466
|
+
* HTTP GET /asset/datapoint/periods
|
|
467
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
468
|
+
*/
|
|
469
|
+
getDatapointPeriod(queryParams?: {
|
|
470
|
+
assetId?: string;
|
|
471
|
+
attributeName?: string;
|
|
472
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
473
|
+
/**
|
|
474
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
475
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
476
|
+
*/
|
|
477
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
478
|
+
}
|
|
479
|
+
export declare class AppResourceClient<O> {
|
|
480
|
+
protected httpClient: HttpClient<O>;
|
|
481
|
+
constructor(httpClient: HttpClient<O>);
|
|
482
|
+
/**
|
|
483
|
+
* HTTP GET /apps
|
|
484
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
485
|
+
*/
|
|
486
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
487
|
+
/**
|
|
488
|
+
* HTTP GET /apps/consoleConfig
|
|
489
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
490
|
+
*/
|
|
491
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
492
|
+
/**
|
|
493
|
+
* HTTP GET /apps/info
|
|
494
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
495
|
+
*/
|
|
496
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
497
|
+
}
|
|
498
|
+
export declare class NotificationResourceClient<O> {
|
|
499
|
+
protected httpClient: HttpClient<O>;
|
|
500
|
+
constructor(httpClient: HttpClient<O>);
|
|
501
|
+
/**
|
|
502
|
+
* HTTP GET /notification
|
|
503
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
504
|
+
*/
|
|
505
|
+
getNotifications(queryParams?: {
|
|
506
|
+
id?: number;
|
|
507
|
+
type?: string;
|
|
508
|
+
from?: number;
|
|
509
|
+
to?: number;
|
|
510
|
+
realmId?: string;
|
|
511
|
+
userId?: string;
|
|
512
|
+
assetId?: string;
|
|
513
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
514
|
+
/**
|
|
515
|
+
* HTTP DELETE /notification
|
|
516
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
517
|
+
*/
|
|
518
|
+
removeNotifications(queryParams?: {
|
|
519
|
+
id?: number;
|
|
520
|
+
type?: string;
|
|
521
|
+
from?: number;
|
|
522
|
+
to?: number;
|
|
523
|
+
realmId?: string;
|
|
524
|
+
userId?: string;
|
|
525
|
+
assetId?: string;
|
|
526
|
+
}, options?: O): RestResponse<void>;
|
|
527
|
+
/**
|
|
528
|
+
* HTTP POST /notification/alert
|
|
529
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
530
|
+
*/
|
|
531
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
532
|
+
/**
|
|
533
|
+
* HTTP DELETE /notification/{notificationId}
|
|
534
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
535
|
+
*/
|
|
536
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
537
|
+
/**
|
|
538
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
539
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
540
|
+
*/
|
|
541
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
542
|
+
targetId?: string;
|
|
543
|
+
}, options?: O): RestResponse<void>;
|
|
544
|
+
/**
|
|
545
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
546
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
547
|
+
*/
|
|
548
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
549
|
+
targetId?: string;
|
|
550
|
+
}, options?: O): RestResponse<void>;
|
|
551
|
+
}
|
|
552
|
+
export declare class DashboardResourceClient<O> {
|
|
552
553
|
protected httpClient: HttpClient<O>;
|
|
553
554
|
constructor(httpClient: HttpClient<O>);
|
|
554
555
|
/**
|
|
555
|
-
* HTTP
|
|
556
|
-
* Java method: org.openremote.model.
|
|
556
|
+
* HTTP POST /dashboard
|
|
557
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
557
558
|
*/
|
|
558
|
-
|
|
559
|
-
parentId?: string;
|
|
560
|
-
parentType?: string;
|
|
561
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
559
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
562
560
|
/**
|
|
563
|
-
* HTTP
|
|
564
|
-
* Java method: org.openremote.model.
|
|
561
|
+
* HTTP PUT /dashboard
|
|
562
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
565
563
|
*/
|
|
566
|
-
|
|
567
|
-
parentId?: string;
|
|
568
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
564
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
569
565
|
/**
|
|
570
|
-
* HTTP GET /
|
|
571
|
-
* Java method: org.openremote.model.
|
|
566
|
+
* HTTP GET /dashboard/all/{realm}
|
|
567
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
572
568
|
*/
|
|
573
|
-
|
|
574
|
-
parentId?: string;
|
|
575
|
-
parentType?: string;
|
|
576
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
569
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
577
570
|
/**
|
|
578
|
-
* HTTP
|
|
579
|
-
* Java method: org.openremote.model.
|
|
571
|
+
* HTTP POST /dashboard/query
|
|
572
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
580
573
|
*/
|
|
581
|
-
|
|
582
|
-
parentId?: string;
|
|
583
|
-
}, options?: O): RestResponse<{
|
|
584
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
585
|
-
}>;
|
|
574
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
586
575
|
/**
|
|
587
|
-
* HTTP
|
|
588
|
-
* Java method: org.openremote.model.
|
|
576
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
577
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
589
578
|
*/
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
579
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
580
|
+
/**
|
|
581
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
582
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
583
|
+
*/
|
|
584
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
595
585
|
}
|
|
596
|
-
export declare class
|
|
586
|
+
export declare class FlowResourceClient<O> {
|
|
597
587
|
protected httpClient: HttpClient<O>;
|
|
598
588
|
constructor(httpClient: HttpClient<O>);
|
|
599
589
|
/**
|
|
600
|
-
* HTTP GET /
|
|
601
|
-
* Java method: org.openremote.model.
|
|
590
|
+
* HTTP GET /flow
|
|
591
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
602
592
|
*/
|
|
603
|
-
|
|
604
|
-
[index: string]: any;
|
|
605
|
-
}>;
|
|
593
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
606
594
|
/**
|
|
607
|
-
* HTTP GET /
|
|
608
|
-
* Java method: org.openremote.model.
|
|
595
|
+
* HTTP GET /flow/{name}
|
|
596
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
609
597
|
*/
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
598
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
599
|
+
/**
|
|
600
|
+
* HTTP GET /flow/{type}
|
|
601
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
602
|
+
*/
|
|
603
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
613
604
|
}
|
|
614
605
|
export declare class RulesResourceClient<O> {
|
|
615
606
|
protected httpClient: HttpClient<O>;
|
|
@@ -719,58 +710,58 @@ export declare class RulesResourceClient<O> {
|
|
|
719
710
|
*/
|
|
720
711
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
721
712
|
}
|
|
722
|
-
export declare class
|
|
713
|
+
export declare class MapResourceClient<O> {
|
|
723
714
|
protected httpClient: HttpClient<O>;
|
|
724
715
|
constructor(httpClient: HttpClient<O>);
|
|
725
716
|
/**
|
|
726
|
-
* HTTP
|
|
727
|
-
* Java method: org.openremote.model.
|
|
728
|
-
*/
|
|
729
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
730
|
-
assetIds?: string[];
|
|
731
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
732
|
-
/**
|
|
733
|
-
* HTTP GET /alarm
|
|
734
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
717
|
+
* HTTP GET /map
|
|
718
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
735
719
|
*/
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
assetId?: string;
|
|
740
|
-
assigneeId?: string;
|
|
741
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
720
|
+
getSettings(options?: O): RestResponse<{
|
|
721
|
+
[id: string]: unknown;
|
|
722
|
+
}>;
|
|
742
723
|
/**
|
|
743
|
-
* HTTP
|
|
744
|
-
* Java method: org.openremote.model.
|
|
724
|
+
* HTTP PUT /map
|
|
725
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
745
726
|
*/
|
|
746
|
-
|
|
727
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
728
|
+
[id: string]: unknown;
|
|
729
|
+
}>;
|
|
747
730
|
/**
|
|
748
|
-
* HTTP
|
|
749
|
-
* Java method: org.openremote.model.
|
|
731
|
+
* HTTP DELETE /map/deleteMap
|
|
732
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
750
733
|
*/
|
|
751
|
-
|
|
734
|
+
deleteMap(options?: O): RestResponse<{
|
|
735
|
+
[id: string]: unknown;
|
|
736
|
+
}>;
|
|
752
737
|
/**
|
|
753
|
-
* HTTP GET /
|
|
754
|
-
* Java method: org.openremote.model.
|
|
738
|
+
* HTTP GET /map/getCustomMapInfo
|
|
739
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
755
740
|
*/
|
|
756
|
-
|
|
741
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
742
|
+
[id: string]: unknown;
|
|
743
|
+
}>;
|
|
757
744
|
/**
|
|
758
|
-
* HTTP
|
|
759
|
-
* Java method: org.openremote.model.
|
|
745
|
+
* HTTP GET /map/js
|
|
746
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
760
747
|
*/
|
|
761
|
-
|
|
748
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
749
|
+
[id: string]: unknown;
|
|
750
|
+
}>;
|
|
762
751
|
/**
|
|
763
|
-
* HTTP
|
|
764
|
-
* Java method: org.openremote.model.
|
|
752
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
753
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
765
754
|
*/
|
|
766
|
-
|
|
755
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
767
756
|
/**
|
|
768
|
-
* HTTP
|
|
769
|
-
* Java method: org.openremote.model.
|
|
757
|
+
* HTTP POST /map/upload
|
|
758
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
770
759
|
*/
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
}, options?: O): RestResponse<
|
|
760
|
+
uploadMap(queryParams?: {
|
|
761
|
+
filename?: string;
|
|
762
|
+
}, options?: O): RestResponse<{
|
|
763
|
+
[id: string]: unknown;
|
|
764
|
+
}>;
|
|
774
765
|
}
|
|
775
766
|
export declare class AssetResourceClient<O> {
|
|
776
767
|
protected httpClient: HttpClient<O>;
|
|
@@ -876,51 +867,60 @@ export declare class AssetResourceClient<O> {
|
|
|
876
867
|
assetIds?: string[];
|
|
877
868
|
}, options?: O): RestResponse<void>;
|
|
878
869
|
}
|
|
870
|
+
export declare class ConsoleResourceClient<O> {
|
|
871
|
+
protected httpClient: HttpClient<O>;
|
|
872
|
+
constructor(httpClient: HttpClient<O>);
|
|
873
|
+
/**
|
|
874
|
+
* HTTP POST /console/register
|
|
875
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
876
|
+
*/
|
|
877
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
878
|
+
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected
|
|
882
|
-
protected
|
|
883
|
-
protected _appResource: AxiosAppResourceClient;
|
|
884
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
881
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
882
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
885
883
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
886
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
887
884
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
888
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
889
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
890
885
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
891
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
892
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
893
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
894
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
895
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
896
|
-
protected _userResource: AxiosUserResourceClient;
|
|
897
886
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
887
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
898
888
|
protected _statusResource: AxiosStatusResourceClient;
|
|
889
|
+
protected _userResource: AxiosUserResourceClient;
|
|
890
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
891
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
892
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
893
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
894
|
+
protected _appResource: AxiosAppResourceClient;
|
|
895
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
896
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
897
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
899
898
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
900
|
-
protected
|
|
899
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
901
900
|
protected _assetResource: AxiosAssetResourceClient;
|
|
901
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get
|
|
904
|
-
get
|
|
905
|
-
get AppResource(): AxiosAppResourceClient;
|
|
906
|
-
get MapResource(): AxiosMapResourceClient;
|
|
903
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
904
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
907
905
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
908
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
909
906
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
910
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
911
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
912
907
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
913
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
914
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
915
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
916
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
917
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
918
|
-
get UserResource(): AxiosUserResourceClient;
|
|
919
908
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
909
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
920
910
|
get StatusResource(): AxiosStatusResourceClient;
|
|
911
|
+
get UserResource(): AxiosUserResourceClient;
|
|
912
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
913
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
914
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
915
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
916
|
+
get AppResource(): AxiosAppResourceClient;
|
|
917
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
918
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
919
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
921
920
|
get RulesResource(): AxiosRulesResourceClient;
|
|
922
|
-
get
|
|
921
|
+
get MapResource(): AxiosMapResourceClient;
|
|
923
922
|
get AssetResource(): AxiosAssetResourceClient;
|
|
923
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
932
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
|
-
}
|
|
934
|
-
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
931
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
935
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
933
|
}
|
|
937
|
-
export declare class
|
|
934
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
941
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
939
|
}
|
|
943
|
-
export declare class
|
|
940
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
|
-
export declare class
|
|
943
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
|
-
export declare class
|
|
946
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
|
-
export declare class
|
|
949
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
|
-
export declare class
|
|
952
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
956
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
954
|
}
|
|
958
|
-
export declare class
|
|
955
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
959
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
957
|
}
|
|
961
|
-
export declare class
|
|
958
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
962
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
960
|
}
|
|
964
|
-
export declare class
|
|
961
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
965
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
963
|
}
|
|
967
|
-
export declare class
|
|
964
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
|
-
export declare class
|
|
970
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
974
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
972
|
}
|
|
976
|
-
export declare class
|
|
973
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
977
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
975
|
}
|
|
979
|
-
export declare class
|
|
976
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
980
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
978
|
}
|
|
982
|
-
export declare class
|
|
979
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
983
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
981
|
}
|
|
985
982
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
986
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
984
|
}
|
|
988
|
-
export declare class
|
|
985
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
989
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
987
|
}
|
|
991
988
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
992
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
990
|
}
|
|
991
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
992
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
|
+
}
|