@openremote/rest 1.12.0-snapshot.20251209132403 → 1.12.0-snapshot.20251211105103
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +441 -441
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +1 -1
package/lib/restclient.d.ts
CHANGED
|
@@ -27,60 +27,93 @@ export declare class StatusResourceClient<O> {
|
|
|
27
27
|
[index: string]: any;
|
|
28
28
|
}>;
|
|
29
29
|
}
|
|
30
|
-
export declare class
|
|
30
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
31
31
|
protected httpClient: HttpClient<O>;
|
|
32
32
|
constructor(httpClient: HttpClient<O>);
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
34
|
+
* HTTP GET /asset/datapoint/export
|
|
35
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
37
36
|
*/
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
37
|
+
getDatapointExport(queryParams?: {
|
|
38
|
+
attributeRefs?: string;
|
|
39
|
+
fromTimestamp?: number;
|
|
40
|
+
toTimestamp?: number;
|
|
41
|
+
}, options?: O): RestResponse<any>;
|
|
41
42
|
/**
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* Response code 409 - ExternalService instance already registered
|
|
45
|
-
* HTTP POST /service
|
|
46
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
43
|
+
* HTTP GET /asset/datapoint/periods
|
|
44
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
47
45
|
*/
|
|
48
|
-
|
|
46
|
+
getDatapointPeriod(queryParams?: {
|
|
47
|
+
assetId?: string;
|
|
48
|
+
attributeName?: string;
|
|
49
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
49
50
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
51
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
52
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
53
53
|
*/
|
|
54
|
-
|
|
54
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
55
|
+
}
|
|
56
|
+
export declare class ConsoleResourceClient<O> {
|
|
57
|
+
protected httpClient: HttpClient<O>;
|
|
58
|
+
constructor(httpClient: HttpClient<O>);
|
|
55
59
|
/**
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* Response code 409 - ExternalService instance already registered
|
|
59
|
-
* HTTP POST /service/global
|
|
60
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
60
|
+
* HTTP POST /console/register
|
|
61
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
61
62
|
*/
|
|
62
|
-
|
|
63
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
64
|
+
}
|
|
65
|
+
export declare class MapResourceClient<O> {
|
|
66
|
+
protected httpClient: HttpClient<O>;
|
|
67
|
+
constructor(httpClient: HttpClient<O>);
|
|
63
68
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
67
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
69
|
+
* HTTP GET /map
|
|
70
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
68
71
|
*/
|
|
69
|
-
|
|
72
|
+
getSettings(options?: O): RestResponse<{
|
|
73
|
+
[id: string]: unknown;
|
|
74
|
+
}>;
|
|
70
75
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
74
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
76
|
+
* HTTP PUT /map
|
|
77
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
75
78
|
*/
|
|
76
|
-
|
|
79
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
80
|
+
[id: string]: unknown;
|
|
81
|
+
}>;
|
|
77
82
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
81
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
83
|
+
* HTTP DELETE /map/deleteMap
|
|
84
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
82
85
|
*/
|
|
83
|
-
|
|
86
|
+
deleteMap(options?: O): RestResponse<{
|
|
87
|
+
[id: string]: unknown;
|
|
88
|
+
}>;
|
|
89
|
+
/**
|
|
90
|
+
* HTTP GET /map/getCustomMapInfo
|
|
91
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
92
|
+
*/
|
|
93
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
94
|
+
[id: string]: unknown;
|
|
95
|
+
}>;
|
|
96
|
+
/**
|
|
97
|
+
* HTTP GET /map/js
|
|
98
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
99
|
+
*/
|
|
100
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
101
|
+
[id: string]: unknown;
|
|
102
|
+
}>;
|
|
103
|
+
/**
|
|
104
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
105
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
106
|
+
*/
|
|
107
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
108
|
+
/**
|
|
109
|
+
* HTTP POST /map/upload
|
|
110
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
111
|
+
*/
|
|
112
|
+
uploadMap(queryParams?: {
|
|
113
|
+
filename?: string;
|
|
114
|
+
}, options?: O): RestResponse<{
|
|
115
|
+
[id: string]: unknown;
|
|
116
|
+
}>;
|
|
84
117
|
}
|
|
85
118
|
export declare class NotificationResourceClient<O> {
|
|
86
119
|
protected httpClient: HttpClient<O>;
|
|
@@ -136,263 +169,243 @@ export declare class NotificationResourceClient<O> {
|
|
|
136
169
|
targetId?: string;
|
|
137
170
|
}, options?: O): RestResponse<void>;
|
|
138
171
|
}
|
|
139
|
-
export declare class
|
|
172
|
+
export declare class ConfigurationResourceClient<O> {
|
|
140
173
|
protected httpClient: HttpClient<O>;
|
|
141
174
|
constructor(httpClient: HttpClient<O>);
|
|
142
175
|
/**
|
|
143
|
-
* HTTP GET /
|
|
144
|
-
* Java method: org.openremote.model.
|
|
145
|
-
*/
|
|
146
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
147
|
-
realm?: string;
|
|
148
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
149
|
-
/**
|
|
150
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
151
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
152
|
-
*/
|
|
153
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
154
|
-
realm?: string;
|
|
155
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
156
|
-
/**
|
|
157
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
158
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
176
|
+
* HTTP GET /configuration/manager
|
|
177
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
159
178
|
*/
|
|
160
|
-
|
|
161
|
-
parentId?: string;
|
|
162
|
-
realm?: string;
|
|
163
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
164
|
-
}
|
|
165
|
-
export declare class AppResourceClient<O> {
|
|
166
|
-
protected httpClient: HttpClient<O>;
|
|
167
|
-
constructor(httpClient: HttpClient<O>);
|
|
179
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
168
180
|
/**
|
|
169
|
-
* HTTP
|
|
170
|
-
* Java method: org.openremote.model.
|
|
181
|
+
* HTTP PUT /configuration/manager
|
|
182
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
171
183
|
*/
|
|
172
|
-
|
|
184
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
173
185
|
/**
|
|
174
|
-
* HTTP
|
|
175
|
-
* Java method: org.openremote.model.
|
|
186
|
+
* HTTP POST /configuration/manager/file
|
|
187
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
176
188
|
*/
|
|
177
|
-
|
|
189
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
190
|
+
path?: string;
|
|
191
|
+
}, options?: O): RestResponse<string>;
|
|
178
192
|
/**
|
|
179
|
-
* HTTP GET /
|
|
180
|
-
* Java method: org.openremote.model.
|
|
193
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
194
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
181
195
|
*/
|
|
182
|
-
|
|
196
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
183
197
|
}
|
|
184
|
-
export declare class
|
|
198
|
+
export declare class RealmResourceClient<O> {
|
|
185
199
|
protected httpClient: HttpClient<O>;
|
|
186
200
|
constructor(httpClient: HttpClient<O>);
|
|
187
201
|
/**
|
|
188
|
-
* HTTP POST /
|
|
189
|
-
* Java method: org.openremote.model.
|
|
190
|
-
*/
|
|
191
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
192
|
-
assetIds?: string[];
|
|
193
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
194
|
-
/**
|
|
195
|
-
* HTTP GET /alarm
|
|
196
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
197
|
-
*/
|
|
198
|
-
getAlarms(queryParams?: {
|
|
199
|
-
realm?: string;
|
|
200
|
-
status?: Model.AlarmStatus;
|
|
201
|
-
assetId?: string;
|
|
202
|
-
assigneeId?: string;
|
|
203
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
204
|
-
/**
|
|
205
|
-
* HTTP DELETE /alarm
|
|
206
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
202
|
+
* HTTP POST /realm
|
|
203
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
207
204
|
*/
|
|
208
|
-
|
|
205
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
209
206
|
/**
|
|
210
|
-
* HTTP
|
|
211
|
-
* Java method: org.openremote.model.
|
|
207
|
+
* HTTP GET /realm
|
|
208
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
212
209
|
*/
|
|
213
|
-
|
|
210
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
214
211
|
/**
|
|
215
|
-
* HTTP GET /
|
|
216
|
-
* Java method: org.openremote.model.
|
|
212
|
+
* HTTP GET /realm/accessible
|
|
213
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
217
214
|
*/
|
|
218
|
-
|
|
215
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
219
216
|
/**
|
|
220
|
-
* HTTP DELETE /
|
|
221
|
-
* Java method: org.openremote.model.
|
|
217
|
+
* HTTP DELETE /realm/{name}
|
|
218
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
222
219
|
*/
|
|
223
|
-
|
|
220
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
224
221
|
/**
|
|
225
|
-
* HTTP
|
|
226
|
-
* Java method: org.openremote.model.
|
|
222
|
+
* HTTP GET /realm/{name}
|
|
223
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
227
224
|
*/
|
|
228
|
-
|
|
225
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
229
226
|
/**
|
|
230
|
-
* HTTP
|
|
231
|
-
* Java method: org.openremote.model.
|
|
227
|
+
* HTTP PUT /realm/{name}
|
|
228
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
232
229
|
*/
|
|
233
|
-
|
|
234
|
-
realm?: string;
|
|
235
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
230
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
236
231
|
}
|
|
237
|
-
export declare class
|
|
232
|
+
export declare class SyslogResourceClient<O> {
|
|
238
233
|
protected httpClient: HttpClient<O>;
|
|
239
234
|
constructor(httpClient: HttpClient<O>);
|
|
240
235
|
/**
|
|
241
|
-
* HTTP GET /
|
|
242
|
-
* Java method: org.openremote.model.
|
|
236
|
+
* HTTP GET /syslog/config
|
|
237
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
243
238
|
*/
|
|
244
|
-
|
|
245
|
-
parentId?: string;
|
|
246
|
-
parentType?: string;
|
|
247
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
239
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
248
240
|
/**
|
|
249
|
-
* HTTP
|
|
250
|
-
* Java method: org.openremote.model.
|
|
241
|
+
* HTTP PUT /syslog/config
|
|
242
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
251
243
|
*/
|
|
252
|
-
|
|
253
|
-
parentId?: string;
|
|
254
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
244
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
255
245
|
/**
|
|
256
|
-
* HTTP
|
|
257
|
-
* Java method: org.openremote.model.
|
|
246
|
+
* HTTP DELETE /syslog/event
|
|
247
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
258
248
|
*/
|
|
259
|
-
|
|
260
|
-
parentId?: string;
|
|
261
|
-
parentType?: string;
|
|
262
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
249
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
263
250
|
/**
|
|
264
|
-
* HTTP GET /
|
|
265
|
-
* Java method: org.openremote.model.
|
|
251
|
+
* HTTP GET /syslog/event
|
|
252
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
266
253
|
*/
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
254
|
+
getEvents(queryParams?: {
|
|
255
|
+
level?: Model.SyslogLevel;
|
|
256
|
+
per_page?: number;
|
|
257
|
+
page?: number;
|
|
258
|
+
from?: number;
|
|
259
|
+
to?: number;
|
|
260
|
+
category?: Model.SyslogCategory[];
|
|
261
|
+
subCategory?: string[];
|
|
270
262
|
}, options?: O): RestResponse<any>;
|
|
271
|
-
/**
|
|
272
|
-
* HTTP GET /model/metaItemDescriptors
|
|
273
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
274
|
-
*/
|
|
275
|
-
getMetaItemDescriptors(queryParams?: {
|
|
276
|
-
parentId?: string;
|
|
277
|
-
}, options?: O): RestResponse<{
|
|
278
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
279
|
-
}>;
|
|
280
|
-
/**
|
|
281
|
-
* HTTP GET /model/valueDescriptors
|
|
282
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
283
|
-
*/
|
|
284
|
-
getValueDescriptors(queryParams?: {
|
|
285
|
-
parentId?: string;
|
|
286
|
-
}, options?: O): RestResponse<{
|
|
287
|
-
[index: string]: Model.ValueDescriptor;
|
|
288
|
-
}>;
|
|
289
263
|
}
|
|
290
|
-
export declare class
|
|
264
|
+
export declare class AgentResourceClient<O> {
|
|
291
265
|
protected httpClient: HttpClient<O>;
|
|
292
266
|
constructor(httpClient: HttpClient<O>);
|
|
293
267
|
/**
|
|
294
|
-
* HTTP
|
|
295
|
-
* Java method: org.openremote.model.
|
|
268
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
269
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
296
270
|
*/
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
protected httpClient: HttpClient<O>;
|
|
301
|
-
constructor(httpClient: HttpClient<O>);
|
|
271
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
272
|
+
realm?: string;
|
|
273
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
302
274
|
/**
|
|
303
|
-
* HTTP POST /
|
|
304
|
-
* Java method: org.openremote.model.
|
|
275
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
276
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
305
277
|
*/
|
|
306
|
-
|
|
278
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
279
|
+
realm?: string;
|
|
280
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
307
281
|
/**
|
|
308
|
-
* HTTP
|
|
309
|
-
* Java method: org.openremote.model.
|
|
282
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
283
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
310
284
|
*/
|
|
311
|
-
|
|
285
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
286
|
+
parentId?: string;
|
|
287
|
+
realm?: string;
|
|
288
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
312
289
|
}
|
|
313
|
-
export declare class
|
|
290
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
314
291
|
protected httpClient: HttpClient<O>;
|
|
315
292
|
constructor(httpClient: HttpClient<O>);
|
|
316
293
|
/**
|
|
317
|
-
* HTTP POST /
|
|
318
|
-
* Java method: org.openremote.model.
|
|
319
|
-
*/
|
|
320
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
321
|
-
/**
|
|
322
|
-
* HTTP GET /realm
|
|
323
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
294
|
+
* HTTP POST /gateway/tunnel
|
|
295
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
324
296
|
*/
|
|
325
|
-
|
|
297
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
326
298
|
/**
|
|
327
|
-
* HTTP
|
|
328
|
-
* Java method: org.openremote.model.
|
|
299
|
+
* HTTP DELETE /gateway/tunnel
|
|
300
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
329
301
|
*/
|
|
330
|
-
|
|
302
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
331
303
|
/**
|
|
332
|
-
* HTTP
|
|
333
|
-
* Java method: org.openremote.model.
|
|
304
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
305
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
334
306
|
*/
|
|
335
|
-
|
|
307
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
336
308
|
/**
|
|
337
|
-
* HTTP GET /realm/{
|
|
338
|
-
* Java method: org.openremote.model.
|
|
309
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
310
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
339
311
|
*/
|
|
340
|
-
|
|
312
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
341
313
|
/**
|
|
342
|
-
* HTTP
|
|
343
|
-
* Java method: org.openremote.model.
|
|
314
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
315
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
344
316
|
*/
|
|
345
|
-
|
|
317
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
346
318
|
}
|
|
347
|
-
export declare class
|
|
319
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
348
320
|
protected httpClient: HttpClient<O>;
|
|
349
321
|
constructor(httpClient: HttpClient<O>);
|
|
350
322
|
/**
|
|
351
|
-
*
|
|
352
|
-
*
|
|
323
|
+
* Response code 200 - List of registered external services
|
|
324
|
+
* HTTP GET /service
|
|
325
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
326
|
+
*/
|
|
327
|
+
getServices(queryParams?: {
|
|
328
|
+
realm?: string;
|
|
329
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
330
|
+
/**
|
|
331
|
+
* Response code 200 - Service registered successfully
|
|
332
|
+
* Response code 400 - Invalid external service object
|
|
333
|
+
* Response code 409 - ExternalService instance already registered
|
|
334
|
+
* HTTP POST /service
|
|
335
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
336
|
+
*/
|
|
337
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
338
|
+
/**
|
|
339
|
+
* Response code 200 - List of registered external services
|
|
340
|
+
* HTTP GET /service/global
|
|
341
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
342
|
+
*/
|
|
343
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
344
|
+
/**
|
|
345
|
+
* Response code 200 - Service registered successfully
|
|
346
|
+
* Response code 400 - Invalid external service object
|
|
347
|
+
* Response code 409 - ExternalService instance already registered
|
|
348
|
+
* HTTP POST /service/global
|
|
349
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
353
350
|
*/
|
|
354
|
-
|
|
351
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
355
352
|
/**
|
|
356
|
-
*
|
|
357
|
-
*
|
|
353
|
+
* Response code 204 - Service deregistered successfully
|
|
354
|
+
* Response code 404 - Service instance not found
|
|
355
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
356
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
358
357
|
*/
|
|
359
|
-
|
|
358
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
360
359
|
/**
|
|
361
|
-
*
|
|
362
|
-
*
|
|
360
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
361
|
+
* Response code 404 - ExternalService not found
|
|
362
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
363
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
363
364
|
*/
|
|
364
|
-
|
|
365
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
365
366
|
/**
|
|
366
|
-
*
|
|
367
|
-
*
|
|
367
|
+
* Response code 204 - Heartbeat sent successfully
|
|
368
|
+
* Response code 404 - Service instance not found
|
|
369
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
370
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
368
371
|
*/
|
|
369
|
-
|
|
372
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
370
373
|
}
|
|
371
|
-
export declare class
|
|
374
|
+
export declare class GatewayClientResourceClient<O> {
|
|
372
375
|
protected httpClient: HttpClient<O>;
|
|
373
376
|
constructor(httpClient: HttpClient<O>);
|
|
374
377
|
/**
|
|
375
|
-
* HTTP
|
|
376
|
-
* Java method: org.openremote.model.
|
|
378
|
+
* HTTP DELETE /gateway/connection
|
|
379
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
377
380
|
*/
|
|
378
|
-
|
|
381
|
+
deleteConnections(queryParams?: {
|
|
382
|
+
realm?: string[];
|
|
383
|
+
}, options?: O): RestResponse<void>;
|
|
379
384
|
/**
|
|
380
|
-
* HTTP
|
|
381
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP GET /gateway/connection
|
|
386
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
382
387
|
*/
|
|
383
|
-
|
|
388
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
384
389
|
/**
|
|
385
|
-
* HTTP
|
|
386
|
-
* Java method: org.openremote.model.
|
|
390
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
391
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
387
392
|
*/
|
|
388
|
-
|
|
389
|
-
path?: string;
|
|
390
|
-
}, options?: O): RestResponse<string>;
|
|
393
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
391
394
|
/**
|
|
392
|
-
* HTTP GET /
|
|
393
|
-
* Java method: org.openremote.model.
|
|
395
|
+
* HTTP GET /gateway/connection/{realm}
|
|
396
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
394
397
|
*/
|
|
395
|
-
|
|
398
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
399
|
+
/**
|
|
400
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
401
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
402
|
+
*/
|
|
403
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
404
|
+
/**
|
|
405
|
+
* HTTP GET /gateway/status/{realm}
|
|
406
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
407
|
+
*/
|
|
408
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
396
409
|
}
|
|
397
410
|
export declare class UserResourceClient<O> {
|
|
398
411
|
protected httpClient: HttpClient<O>;
|
|
@@ -518,6 +531,78 @@ export declare class UserResourceClient<O> {
|
|
|
518
531
|
*/
|
|
519
532
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
520
533
|
}
|
|
534
|
+
export declare class FlowResourceClient<O> {
|
|
535
|
+
protected httpClient: HttpClient<O>;
|
|
536
|
+
constructor(httpClient: HttpClient<O>);
|
|
537
|
+
/**
|
|
538
|
+
* HTTP GET /flow
|
|
539
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
540
|
+
*/
|
|
541
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
542
|
+
/**
|
|
543
|
+
* HTTP GET /flow/{name}
|
|
544
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
545
|
+
*/
|
|
546
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
547
|
+
/**
|
|
548
|
+
* HTTP GET /flow/{type}
|
|
549
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
550
|
+
*/
|
|
551
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
552
|
+
}
|
|
553
|
+
export declare class AlarmResourceClient<O> {
|
|
554
|
+
protected httpClient: HttpClient<O>;
|
|
555
|
+
constructor(httpClient: HttpClient<O>);
|
|
556
|
+
/**
|
|
557
|
+
* HTTP POST /alarm
|
|
558
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
559
|
+
*/
|
|
560
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
561
|
+
assetIds?: string[];
|
|
562
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
563
|
+
/**
|
|
564
|
+
* HTTP GET /alarm
|
|
565
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
566
|
+
*/
|
|
567
|
+
getAlarms(queryParams?: {
|
|
568
|
+
realm?: string;
|
|
569
|
+
status?: Model.AlarmStatus;
|
|
570
|
+
assetId?: string;
|
|
571
|
+
assigneeId?: string;
|
|
572
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
573
|
+
/**
|
|
574
|
+
* HTTP DELETE /alarm
|
|
575
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
576
|
+
*/
|
|
577
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
578
|
+
/**
|
|
579
|
+
* HTTP PUT /alarm/assets
|
|
580
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
581
|
+
*/
|
|
582
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
583
|
+
/**
|
|
584
|
+
* HTTP GET /alarm/{alarmId}
|
|
585
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
586
|
+
*/
|
|
587
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
588
|
+
/**
|
|
589
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
590
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
591
|
+
*/
|
|
592
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
593
|
+
/**
|
|
594
|
+
* HTTP PUT /alarm/{alarmId}
|
|
595
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
596
|
+
*/
|
|
597
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
598
|
+
/**
|
|
599
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
600
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
601
|
+
*/
|
|
602
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
603
|
+
realm?: string;
|
|
604
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
605
|
+
}
|
|
521
606
|
export declare class AssetResourceClient<O> {
|
|
522
607
|
protected httpClient: HttpClient<O>;
|
|
523
608
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -627,116 +712,58 @@ export declare class AssetResourceClient<O> {
|
|
|
627
712
|
assetIds?: string[];
|
|
628
713
|
}, options?: O): RestResponse<void>;
|
|
629
714
|
}
|
|
630
|
-
export declare class
|
|
631
|
-
protected httpClient: HttpClient<O>;
|
|
632
|
-
constructor(httpClient: HttpClient<O>);
|
|
633
|
-
/**
|
|
634
|
-
* HTTP GET /asset/datapoint/export
|
|
635
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
636
|
-
*/
|
|
637
|
-
getDatapointExport(queryParams?: {
|
|
638
|
-
attributeRefs?: string;
|
|
639
|
-
fromTimestamp?: number;
|
|
640
|
-
toTimestamp?: number;
|
|
641
|
-
}, options?: O): RestResponse<any>;
|
|
642
|
-
/**
|
|
643
|
-
* HTTP GET /asset/datapoint/periods
|
|
644
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
645
|
-
*/
|
|
646
|
-
getDatapointPeriod(queryParams?: {
|
|
647
|
-
assetId?: string;
|
|
648
|
-
attributeName?: string;
|
|
649
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
650
|
-
/**
|
|
651
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
652
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
653
|
-
*/
|
|
654
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
655
|
-
}
|
|
656
|
-
export declare class SyslogResourceClient<O> {
|
|
657
|
-
protected httpClient: HttpClient<O>;
|
|
658
|
-
constructor(httpClient: HttpClient<O>);
|
|
659
|
-
/**
|
|
660
|
-
* HTTP GET /syslog/config
|
|
661
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
662
|
-
*/
|
|
663
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
664
|
-
/**
|
|
665
|
-
* HTTP PUT /syslog/config
|
|
666
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
667
|
-
*/
|
|
668
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
669
|
-
/**
|
|
670
|
-
* HTTP DELETE /syslog/event
|
|
671
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
672
|
-
*/
|
|
673
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
674
|
-
/**
|
|
675
|
-
* HTTP GET /syslog/event
|
|
676
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
677
|
-
*/
|
|
678
|
-
getEvents(queryParams?: {
|
|
679
|
-
level?: Model.SyslogLevel;
|
|
680
|
-
per_page?: number;
|
|
681
|
-
page?: number;
|
|
682
|
-
from?: number;
|
|
683
|
-
to?: number;
|
|
684
|
-
category?: Model.SyslogCategory[];
|
|
685
|
-
subCategory?: string[];
|
|
686
|
-
}, options?: O): RestResponse<any>;
|
|
687
|
-
}
|
|
688
|
-
export declare class FlowResourceClient<O> {
|
|
689
|
-
protected httpClient: HttpClient<O>;
|
|
690
|
-
constructor(httpClient: HttpClient<O>);
|
|
691
|
-
/**
|
|
692
|
-
* HTTP GET /flow
|
|
693
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
694
|
-
*/
|
|
695
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
696
|
-
/**
|
|
697
|
-
* HTTP GET /flow/{name}
|
|
698
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
699
|
-
*/
|
|
700
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
701
|
-
/**
|
|
702
|
-
* HTTP GET /flow/{type}
|
|
703
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
704
|
-
*/
|
|
705
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
706
|
-
}
|
|
707
|
-
export declare class DashboardResourceClient<O> {
|
|
715
|
+
export declare class AssetModelResourceClient<O> {
|
|
708
716
|
protected httpClient: HttpClient<O>;
|
|
709
717
|
constructor(httpClient: HttpClient<O>);
|
|
710
718
|
/**
|
|
711
|
-
* HTTP
|
|
712
|
-
* Java method: org.openremote.model.
|
|
719
|
+
* HTTP GET /model/assetDescriptors
|
|
720
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
713
721
|
*/
|
|
714
|
-
|
|
722
|
+
getAssetDescriptors(queryParams?: {
|
|
723
|
+
parentId?: string;
|
|
724
|
+
parentType?: string;
|
|
725
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
715
726
|
/**
|
|
716
|
-
* HTTP
|
|
717
|
-
* Java method: org.openremote.model.
|
|
727
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
728
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
718
729
|
*/
|
|
719
|
-
|
|
730
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
731
|
+
parentId?: string;
|
|
732
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
720
733
|
/**
|
|
721
|
-
* HTTP GET /
|
|
722
|
-
* Java method: org.openremote.model.
|
|
734
|
+
* HTTP GET /model/assetInfos
|
|
735
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
723
736
|
*/
|
|
724
|
-
|
|
737
|
+
getAssetInfos(queryParams?: {
|
|
738
|
+
parentId?: string;
|
|
739
|
+
parentType?: string;
|
|
740
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
725
741
|
/**
|
|
726
|
-
* HTTP
|
|
727
|
-
* Java method: org.openremote.model.
|
|
742
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
743
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
728
744
|
*/
|
|
729
|
-
|
|
745
|
+
getValueDescriptorSchema(queryParams?: {
|
|
746
|
+
name?: string;
|
|
747
|
+
hash?: string;
|
|
748
|
+
}, options?: O): RestResponse<any>;
|
|
730
749
|
/**
|
|
731
|
-
* HTTP
|
|
732
|
-
* Java method: org.openremote.model.
|
|
750
|
+
* HTTP GET /model/metaItemDescriptors
|
|
751
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
733
752
|
*/
|
|
734
|
-
|
|
753
|
+
getMetaItemDescriptors(queryParams?: {
|
|
754
|
+
parentId?: string;
|
|
755
|
+
}, options?: O): RestResponse<{
|
|
756
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
757
|
+
}>;
|
|
735
758
|
/**
|
|
736
|
-
* HTTP GET /
|
|
737
|
-
* Java method: org.openremote.model.
|
|
759
|
+
* HTTP GET /model/valueDescriptors
|
|
760
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
738
761
|
*/
|
|
739
|
-
|
|
762
|
+
getValueDescriptors(queryParams?: {
|
|
763
|
+
parentId?: string;
|
|
764
|
+
}, options?: O): RestResponse<{
|
|
765
|
+
[index: string]: Model.ValueDescriptor;
|
|
766
|
+
}>;
|
|
740
767
|
}
|
|
741
768
|
export declare class RulesResourceClient<O> {
|
|
742
769
|
protected httpClient: HttpClient<O>;
|
|
@@ -846,171 +873,144 @@ export declare class RulesResourceClient<O> {
|
|
|
846
873
|
*/
|
|
847
874
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
848
875
|
}
|
|
849
|
-
export declare class
|
|
876
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
850
877
|
protected httpClient: HttpClient<O>;
|
|
851
878
|
constructor(httpClient: HttpClient<O>);
|
|
852
879
|
/**
|
|
853
|
-
* HTTP POST /
|
|
854
|
-
* Java method: org.openremote.model.
|
|
855
|
-
*/
|
|
856
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP DELETE /gateway/tunnel
|
|
859
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
860
|
-
*/
|
|
861
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
862
|
-
/**
|
|
863
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
864
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
865
|
-
*/
|
|
866
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
867
|
-
/**
|
|
868
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
869
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
880
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
881
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
870
882
|
*/
|
|
871
|
-
|
|
883
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
872
884
|
/**
|
|
873
|
-
* HTTP
|
|
874
|
-
* Java method: org.openremote.model.
|
|
885
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
886
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
875
887
|
*/
|
|
876
|
-
|
|
888
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
877
889
|
}
|
|
878
|
-
export declare class
|
|
890
|
+
export declare class DashboardResourceClient<O> {
|
|
879
891
|
protected httpClient: HttpClient<O>;
|
|
880
892
|
constructor(httpClient: HttpClient<O>);
|
|
881
893
|
/**
|
|
882
|
-
* HTTP
|
|
883
|
-
* Java method: org.openremote.model.
|
|
884
|
-
*/
|
|
885
|
-
getSettings(options?: O): RestResponse<{
|
|
886
|
-
[id: string]: unknown;
|
|
887
|
-
}>;
|
|
888
|
-
/**
|
|
889
|
-
* HTTP PUT /map
|
|
890
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
894
|
+
* HTTP POST /dashboard
|
|
895
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
891
896
|
*/
|
|
892
|
-
|
|
893
|
-
[id: string]: unknown;
|
|
894
|
-
}>;
|
|
897
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
895
898
|
/**
|
|
896
|
-
* HTTP
|
|
897
|
-
* Java method: org.openremote.model.
|
|
899
|
+
* HTTP PUT /dashboard
|
|
900
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
898
901
|
*/
|
|
899
|
-
|
|
900
|
-
[id: string]: unknown;
|
|
901
|
-
}>;
|
|
902
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
902
903
|
/**
|
|
903
|
-
* HTTP GET /
|
|
904
|
-
* Java method: org.openremote.model.
|
|
904
|
+
* HTTP GET /dashboard/all/{realm}
|
|
905
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
905
906
|
*/
|
|
906
|
-
|
|
907
|
-
[id: string]: unknown;
|
|
908
|
-
}>;
|
|
907
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
909
908
|
/**
|
|
910
|
-
* HTTP
|
|
911
|
-
* Java method: org.openremote.model.
|
|
909
|
+
* HTTP POST /dashboard/query
|
|
910
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
912
911
|
*/
|
|
913
|
-
|
|
914
|
-
[id: string]: unknown;
|
|
915
|
-
}>;
|
|
912
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
916
913
|
/**
|
|
917
|
-
* HTTP
|
|
918
|
-
* Java method: org.openremote.model.
|
|
914
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
915
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
919
916
|
*/
|
|
920
|
-
|
|
917
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
921
918
|
/**
|
|
922
|
-
* HTTP
|
|
923
|
-
* Java method: org.openremote.model.
|
|
919
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
920
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
924
921
|
*/
|
|
925
|
-
|
|
926
|
-
filename?: string;
|
|
927
|
-
}, options?: O): RestResponse<{
|
|
928
|
-
[id: string]: unknown;
|
|
929
|
-
}>;
|
|
922
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
930
923
|
}
|
|
931
|
-
export declare class
|
|
924
|
+
export declare class AppResourceClient<O> {
|
|
932
925
|
protected httpClient: HttpClient<O>;
|
|
933
926
|
constructor(httpClient: HttpClient<O>);
|
|
934
927
|
/**
|
|
935
|
-
* HTTP
|
|
936
|
-
* Java method: org.openremote.model.
|
|
928
|
+
* HTTP GET /apps
|
|
929
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
937
930
|
*/
|
|
938
|
-
|
|
939
|
-
realm?: string[];
|
|
940
|
-
}, options?: O): RestResponse<void>;
|
|
931
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
941
932
|
/**
|
|
942
|
-
* HTTP GET /
|
|
943
|
-
* Java method: org.openremote.model.
|
|
933
|
+
* HTTP GET /apps/consoleConfig
|
|
934
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
944
935
|
*/
|
|
945
|
-
|
|
936
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
946
937
|
/**
|
|
947
|
-
* HTTP
|
|
948
|
-
* Java method: org.openremote.model.
|
|
938
|
+
* HTTP GET /apps/info
|
|
939
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
949
940
|
*/
|
|
950
|
-
|
|
941
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
942
|
+
}
|
|
943
|
+
export declare class ProvisioningResourceClient<O> {
|
|
944
|
+
protected httpClient: HttpClient<O>;
|
|
945
|
+
constructor(httpClient: HttpClient<O>);
|
|
951
946
|
/**
|
|
952
|
-
* HTTP
|
|
953
|
-
* Java method: org.openremote.model.
|
|
947
|
+
* HTTP POST /provisioning
|
|
948
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
954
949
|
*/
|
|
955
|
-
|
|
950
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
956
951
|
/**
|
|
957
|
-
* HTTP
|
|
958
|
-
* Java method: org.openremote.model.
|
|
952
|
+
* HTTP GET /provisioning
|
|
953
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
959
954
|
*/
|
|
960
|
-
|
|
955
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
961
956
|
/**
|
|
962
|
-
* HTTP
|
|
963
|
-
* Java method: org.openremote.model.
|
|
957
|
+
* HTTP DELETE /provisioning/{id}
|
|
958
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
964
959
|
*/
|
|
965
|
-
|
|
960
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
961
|
+
/**
|
|
962
|
+
* HTTP PUT /provisioning/{id}
|
|
963
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
964
|
+
*/
|
|
965
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
969
|
protected _statusResource: AxiosStatusResourceClient;
|
|
970
|
-
protected
|
|
970
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
971
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
972
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
971
973
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
974
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
975
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
976
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
972
977
|
protected _agentResource: AxiosAgentResourceClient;
|
|
973
|
-
protected
|
|
978
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
979
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
980
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
981
|
+
protected _userResource: AxiosUserResourceClient;
|
|
982
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
974
983
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
984
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
975
985
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
976
|
-
protected
|
|
986
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
977
987
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
978
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
979
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
980
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
981
|
-
protected _userResource: AxiosUserResourceClient;
|
|
982
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
983
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
984
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
985
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
986
988
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
987
|
-
protected
|
|
988
|
-
protected
|
|
989
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
990
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
989
|
+
protected _appResource: AxiosAppResourceClient;
|
|
990
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
get StatusResource(): AxiosStatusResourceClient;
|
|
993
|
-
get
|
|
993
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
994
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
995
|
+
get MapResource(): AxiosMapResourceClient;
|
|
994
996
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
997
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
998
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
999
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
995
1000
|
get AgentResource(): AxiosAgentResourceClient;
|
|
996
|
-
get
|
|
1001
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1002
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1003
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1004
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1005
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
997
1006
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1007
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
998
1008
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
999
|
-
get
|
|
1009
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1000
1010
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1001
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1002
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1003
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1004
|
-
get UserResource(): AxiosUserResourceClient;
|
|
1005
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
1006
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1007
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1008
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1009
1011
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1010
|
-
get
|
|
1011
|
-
get
|
|
1012
|
-
get MapResource(): AxiosMapResourceClient;
|
|
1013
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1012
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1013
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1021,66 +1021,66 @@ declare module "axios" {
|
|
|
1021
1021
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
|
-
export declare class
|
|
1027
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
|
-
export declare class
|
|
1030
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1033
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1035
|
}
|
|
1036
|
-
export declare class
|
|
1036
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1038
|
}
|
|
1039
|
-
export declare class
|
|
1039
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1041
|
}
|
|
1042
|
-
export declare class
|
|
1042
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1044
|
}
|
|
1045
|
-
export declare class
|
|
1045
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1047
|
}
|
|
1048
|
-
export declare class
|
|
1048
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1050
|
}
|
|
1051
|
-
export declare class
|
|
1051
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1053
|
}
|
|
1054
|
-
export declare class
|
|
1054
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1056
|
}
|
|
1057
1057
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1059
|
}
|
|
1060
|
-
export declare class
|
|
1060
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1062
|
}
|
|
1063
|
-
export declare class
|
|
1063
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1065
|
}
|
|
1066
|
-
export declare class
|
|
1066
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1068
|
}
|
|
1069
|
-
export declare class
|
|
1069
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1071
|
}
|
|
1072
|
-
export declare class
|
|
1072
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1074
|
}
|
|
1075
|
-
export declare class
|
|
1075
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1077
|
}
|
|
1078
|
-
export declare class
|
|
1078
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1080
|
}
|
|
1081
|
-
export declare class
|
|
1081
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1083
|
}
|
|
1084
|
-
export declare class
|
|
1084
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|