@openremote/rest 1.13.1 → 1.14.0-snapshot
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/index.d.ts +3 -3
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -1
- package/lib/index.js.map +1 -1
- package/lib/restclient.d.ts +615 -620
- package/lib/restclient.d.ts.map +1 -1
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -2
package/lib/restclient.d.ts
CHANGED
|
@@ -9,162 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class SyslogResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /syslog/config
|
|
17
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
18
|
-
*/
|
|
19
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP PUT /syslog/config
|
|
22
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
23
|
-
*/
|
|
24
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP DELETE /syslog/event
|
|
27
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
28
|
-
*/
|
|
29
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
30
|
-
/**
|
|
31
|
-
* HTTP GET /syslog/event
|
|
32
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
33
|
-
*/
|
|
34
|
-
getEvents(queryParams?: {
|
|
35
|
-
level?: Model.SyslogLevel;
|
|
36
|
-
per_page?: number;
|
|
37
|
-
page?: number;
|
|
38
|
-
from?: number;
|
|
39
|
-
to?: number;
|
|
40
|
-
category?: Model.SyslogCategory[];
|
|
41
|
-
subCategory?: string[];
|
|
42
|
-
}, options?: O): RestResponse<any>;
|
|
43
|
-
}
|
|
44
|
-
export declare class FlowResourceClient<O> {
|
|
45
|
-
protected httpClient: HttpClient<O>;
|
|
46
|
-
constructor(httpClient: HttpClient<O>);
|
|
47
|
-
/**
|
|
48
|
-
* HTTP GET /flow
|
|
49
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
50
|
-
*/
|
|
51
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
52
|
-
/**
|
|
53
|
-
* HTTP GET /flow/{name}
|
|
54
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
55
|
-
*/
|
|
56
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
57
|
-
/**
|
|
58
|
-
* HTTP GET /flow/{type}
|
|
59
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
60
|
-
*/
|
|
61
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
62
|
-
}
|
|
63
|
-
export declare class AgentResourceClient<O> {
|
|
64
|
-
protected httpClient: HttpClient<O>;
|
|
65
|
-
constructor(httpClient: HttpClient<O>);
|
|
66
|
-
/**
|
|
67
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
68
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
69
|
-
*/
|
|
70
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
71
|
-
realm?: string;
|
|
72
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
73
|
-
/**
|
|
74
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
75
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
76
|
-
*/
|
|
77
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
78
|
-
realm?: string;
|
|
79
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
80
|
-
/**
|
|
81
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
82
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
83
|
-
*/
|
|
84
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
85
|
-
parentId?: string;
|
|
86
|
-
realm?: string;
|
|
87
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
88
|
-
}
|
|
89
|
-
export declare class MapResourceClient<O> {
|
|
90
|
-
protected httpClient: HttpClient<O>;
|
|
91
|
-
constructor(httpClient: HttpClient<O>);
|
|
92
|
-
/**
|
|
93
|
-
* HTTP GET /map
|
|
94
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
95
|
-
*/
|
|
96
|
-
getSettings(options?: O): RestResponse<{
|
|
97
|
-
[id: string]: unknown;
|
|
98
|
-
}>;
|
|
99
|
-
/**
|
|
100
|
-
* HTTP PUT /map
|
|
101
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
102
|
-
*/
|
|
103
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
104
|
-
[id: string]: unknown;
|
|
105
|
-
}>;
|
|
106
|
-
/**
|
|
107
|
-
* HTTP DELETE /map/deleteMap
|
|
108
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
109
|
-
*/
|
|
110
|
-
deleteMap(options?: O): RestResponse<{
|
|
111
|
-
[id: string]: unknown;
|
|
112
|
-
}>;
|
|
113
|
-
/**
|
|
114
|
-
* HTTP GET /map/getCustomMapInfo
|
|
115
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
116
|
-
*/
|
|
117
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
118
|
-
[id: string]: unknown;
|
|
119
|
-
}>;
|
|
120
|
-
/**
|
|
121
|
-
* HTTP GET /map/js
|
|
122
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
123
|
-
*/
|
|
124
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
125
|
-
[id: string]: unknown;
|
|
126
|
-
}>;
|
|
127
|
-
/**
|
|
128
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
129
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
130
|
-
*/
|
|
131
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
132
|
-
/**
|
|
133
|
-
* HTTP POST /map/upload
|
|
134
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
135
|
-
*/
|
|
136
|
-
uploadMap(queryParams?: {
|
|
137
|
-
filename?: string;
|
|
138
|
-
}, options?: O): RestResponse<{
|
|
139
|
-
[id: string]: unknown;
|
|
140
|
-
}>;
|
|
141
|
-
}
|
|
142
|
-
export declare class ConfigurationResourceClient<O> {
|
|
143
|
-
protected httpClient: HttpClient<O>;
|
|
144
|
-
constructor(httpClient: HttpClient<O>);
|
|
145
|
-
/**
|
|
146
|
-
* HTTP GET /configuration/manager
|
|
147
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
148
|
-
*/
|
|
149
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
150
|
-
/**
|
|
151
|
-
* HTTP PUT /configuration/manager
|
|
152
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
153
|
-
*/
|
|
154
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
155
|
-
/**
|
|
156
|
-
* HTTP POST /configuration/manager/file
|
|
157
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
158
|
-
*/
|
|
159
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
160
|
-
path?: string;
|
|
161
|
-
}, options?: O): RestResponse<string>;
|
|
162
|
-
/**
|
|
163
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
164
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
165
|
-
*/
|
|
166
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
167
|
-
}
|
|
168
12
|
export declare class RulesResourceClient<O> {
|
|
169
13
|
protected httpClient: HttpClient<O>;
|
|
170
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -273,288 +117,388 @@ export declare class RulesResourceClient<O> {
|
|
|
273
117
|
*/
|
|
274
118
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
275
119
|
}
|
|
276
|
-
export declare class
|
|
120
|
+
export declare class StatusResourceClient<O> {
|
|
277
121
|
protected httpClient: HttpClient<O>;
|
|
278
122
|
constructor(httpClient: HttpClient<O>);
|
|
279
123
|
/**
|
|
280
|
-
* HTTP GET /
|
|
281
|
-
* Java method: org.openremote.model.
|
|
282
|
-
*/
|
|
283
|
-
getNotifications(queryParams?: {
|
|
284
|
-
id?: number;
|
|
285
|
-
type?: string;
|
|
286
|
-
from?: number;
|
|
287
|
-
to?: number;
|
|
288
|
-
realmId?: string;
|
|
289
|
-
userId?: string;
|
|
290
|
-
assetId?: string;
|
|
291
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP DELETE /notification
|
|
294
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
124
|
+
* HTTP GET /health
|
|
125
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
295
126
|
*/
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
from?: number;
|
|
300
|
-
to?: number;
|
|
301
|
-
realmId?: string;
|
|
302
|
-
userId?: string;
|
|
303
|
-
assetId?: string;
|
|
304
|
-
}, options?: O): RestResponse<void>;
|
|
127
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
128
|
+
[index: string]: any;
|
|
129
|
+
}>;
|
|
305
130
|
/**
|
|
306
|
-
* HTTP
|
|
307
|
-
* Java method: org.openremote.model.
|
|
131
|
+
* HTTP GET /info
|
|
132
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
308
133
|
*/
|
|
309
|
-
|
|
134
|
+
getInfo(options?: O): RestResponse<{
|
|
135
|
+
[index: string]: any;
|
|
136
|
+
}>;
|
|
137
|
+
}
|
|
138
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
139
|
+
protected httpClient: HttpClient<O>;
|
|
140
|
+
constructor(httpClient: HttpClient<O>);
|
|
310
141
|
/**
|
|
311
|
-
* HTTP
|
|
312
|
-
* Java method: org.openremote.model.
|
|
142
|
+
* HTTP GET /asset/datapoint/export
|
|
143
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
313
144
|
*/
|
|
314
|
-
|
|
145
|
+
getDatapointExport(queryParams?: {
|
|
146
|
+
attributeRefs?: string;
|
|
147
|
+
fromTimestamp?: number;
|
|
148
|
+
toTimestamp?: number;
|
|
149
|
+
format?: Model.DatapointExportFormat;
|
|
150
|
+
}, options?: O): RestResponse<any>;
|
|
315
151
|
/**
|
|
316
|
-
* HTTP
|
|
317
|
-
* Java method: org.openremote.model.
|
|
152
|
+
* HTTP GET /asset/datapoint/periods
|
|
153
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
318
154
|
*/
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
155
|
+
getDatapointPeriod(queryParams?: {
|
|
156
|
+
assetId?: string;
|
|
157
|
+
attributeName?: string;
|
|
158
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
322
159
|
/**
|
|
323
|
-
* HTTP
|
|
324
|
-
* Java method: org.openremote.model.
|
|
160
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
161
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
325
162
|
*/
|
|
326
|
-
|
|
327
|
-
targetId?: string;
|
|
328
|
-
}, options?: O): RestResponse<void>;
|
|
163
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
329
164
|
}
|
|
330
|
-
export declare class
|
|
165
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
331
166
|
protected httpClient: HttpClient<O>;
|
|
332
167
|
constructor(httpClient: HttpClient<O>);
|
|
333
168
|
/**
|
|
334
|
-
*
|
|
335
|
-
*
|
|
169
|
+
* Response code 200 - List of registered external services
|
|
170
|
+
* HTTP GET /service
|
|
171
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
336
172
|
*/
|
|
337
|
-
|
|
173
|
+
getServices(queryParams?: {
|
|
174
|
+
realm?: string;
|
|
175
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
338
176
|
/**
|
|
339
|
-
*
|
|
340
|
-
*
|
|
177
|
+
* Response code 200 - Service registered successfully
|
|
178
|
+
* Response code 400 - Invalid external service object
|
|
179
|
+
* Response code 409 - ExternalService instance already registered
|
|
180
|
+
* HTTP POST /service
|
|
181
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
341
182
|
*/
|
|
342
|
-
|
|
183
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
343
184
|
/**
|
|
344
|
-
*
|
|
345
|
-
*
|
|
185
|
+
* Response code 200 - List of registered external services
|
|
186
|
+
* HTTP GET /service/global
|
|
187
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
346
188
|
*/
|
|
347
|
-
|
|
189
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
348
190
|
/**
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
|
|
352
|
-
|
|
191
|
+
* Response code 200 - Service registered successfully
|
|
192
|
+
* Response code 400 - Invalid external service object
|
|
193
|
+
* Response code 409 - ExternalService instance already registered
|
|
194
|
+
* HTTP POST /service/global
|
|
195
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
196
|
+
*/
|
|
197
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
353
198
|
/**
|
|
354
|
-
*
|
|
355
|
-
*
|
|
199
|
+
* Response code 204 - Service deregistered successfully
|
|
200
|
+
* Response code 404 - Service instance not found
|
|
201
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
202
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
356
203
|
*/
|
|
357
|
-
|
|
204
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
205
|
+
/**
|
|
206
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
207
|
+
* Response code 404 - ExternalService not found
|
|
208
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
209
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
210
|
+
*/
|
|
211
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
212
|
+
/**
|
|
213
|
+
* Response code 204 - Heartbeat sent successfully
|
|
214
|
+
* Response code 404 - Service instance not found
|
|
215
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
216
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
217
|
+
*/
|
|
218
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
358
219
|
}
|
|
359
|
-
export declare class
|
|
220
|
+
export declare class RealmResourceClient<O> {
|
|
360
221
|
protected httpClient: HttpClient<O>;
|
|
361
222
|
constructor(httpClient: HttpClient<O>);
|
|
362
223
|
/**
|
|
363
|
-
* HTTP POST /
|
|
364
|
-
* Java method: org.openremote.model.
|
|
224
|
+
* HTTP POST /realm
|
|
225
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
365
226
|
*/
|
|
366
|
-
create(
|
|
227
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
367
228
|
/**
|
|
368
|
-
* HTTP
|
|
369
|
-
* Java method: org.openremote.model.
|
|
229
|
+
* HTTP GET /realm
|
|
230
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
370
231
|
*/
|
|
371
|
-
|
|
372
|
-
assetId?: string[];
|
|
373
|
-
}, options?: O): RestResponse<void>;
|
|
232
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
374
233
|
/**
|
|
375
|
-
* HTTP
|
|
376
|
-
* Java method: org.openremote.model.
|
|
234
|
+
* HTTP GET /realm/accessible
|
|
235
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
377
236
|
*/
|
|
378
|
-
|
|
237
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
379
238
|
/**
|
|
380
|
-
* HTTP
|
|
381
|
-
* Java method: org.openremote.model.
|
|
239
|
+
* HTTP DELETE /realm/{name}
|
|
240
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
382
241
|
*/
|
|
383
|
-
|
|
242
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
384
243
|
/**
|
|
385
|
-
* HTTP
|
|
386
|
-
* Java method: org.openremote.model.
|
|
244
|
+
* HTTP GET /realm/{name}
|
|
245
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
387
246
|
*/
|
|
388
|
-
|
|
247
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
389
248
|
/**
|
|
390
|
-
* HTTP
|
|
391
|
-
* Java method: org.openremote.model.
|
|
249
|
+
* HTTP PUT /realm/{name}
|
|
250
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
392
251
|
*/
|
|
393
|
-
|
|
394
|
-
|
|
252
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
253
|
+
}
|
|
254
|
+
export declare class GatewayClientResourceClient<O> {
|
|
255
|
+
protected httpClient: HttpClient<O>;
|
|
256
|
+
constructor(httpClient: HttpClient<O>);
|
|
257
|
+
/**
|
|
258
|
+
* HTTP DELETE /gateway/connection
|
|
259
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
260
|
+
*/
|
|
261
|
+
deleteConnections(queryParams?: {
|
|
262
|
+
realm?: string[];
|
|
395
263
|
}, options?: O): RestResponse<void>;
|
|
396
264
|
/**
|
|
397
|
-
* HTTP GET /
|
|
398
|
-
* Java method: org.openremote.model.
|
|
265
|
+
* HTTP GET /gateway/connection
|
|
266
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
399
267
|
*/
|
|
400
|
-
|
|
268
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
401
269
|
/**
|
|
402
|
-
* HTTP
|
|
403
|
-
* Java method: org.openremote.model.
|
|
270
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
271
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
404
272
|
*/
|
|
405
|
-
|
|
273
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
406
274
|
/**
|
|
407
|
-
* HTTP
|
|
408
|
-
* Java method: org.openremote.model.
|
|
275
|
+
* HTTP GET /gateway/connection/{realm}
|
|
276
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
409
277
|
*/
|
|
410
|
-
|
|
278
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
411
279
|
/**
|
|
412
|
-
* HTTP
|
|
413
|
-
* Java method: org.openremote.model.
|
|
280
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
281
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
414
282
|
*/
|
|
415
|
-
|
|
283
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
416
284
|
/**
|
|
417
|
-
* HTTP
|
|
418
|
-
* Java method: org.openremote.model.
|
|
285
|
+
* HTTP GET /gateway/status/{realm}
|
|
286
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
419
287
|
*/
|
|
420
|
-
|
|
288
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
289
|
+
}
|
|
290
|
+
export declare class NotificationResourceClient<O> {
|
|
291
|
+
protected httpClient: HttpClient<O>;
|
|
292
|
+
constructor(httpClient: HttpClient<O>);
|
|
421
293
|
/**
|
|
422
|
-
* HTTP GET /
|
|
423
|
-
* Java method: org.openremote.model.
|
|
294
|
+
* HTTP GET /notification
|
|
295
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
424
296
|
*/
|
|
425
|
-
|
|
426
|
-
|
|
297
|
+
getNotifications(queryParams?: {
|
|
298
|
+
id?: number;
|
|
299
|
+
type?: string;
|
|
300
|
+
from?: number;
|
|
301
|
+
to?: number;
|
|
302
|
+
realmId?: string;
|
|
427
303
|
userId?: string;
|
|
428
304
|
assetId?: string;
|
|
429
|
-
}, options?: O): RestResponse<Model.
|
|
305
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
430
306
|
/**
|
|
431
|
-
* HTTP
|
|
432
|
-
* Java method: org.openremote.model.
|
|
307
|
+
* HTTP DELETE /notification
|
|
308
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
433
309
|
*/
|
|
434
|
-
|
|
310
|
+
removeNotifications(queryParams?: {
|
|
311
|
+
id?: number;
|
|
312
|
+
type?: string;
|
|
313
|
+
from?: number;
|
|
314
|
+
to?: number;
|
|
315
|
+
realmId?: string;
|
|
316
|
+
userId?: string;
|
|
317
|
+
assetId?: string;
|
|
318
|
+
}, options?: O): RestResponse<void>;
|
|
435
319
|
/**
|
|
436
|
-
* HTTP
|
|
437
|
-
* Java method: org.openremote.model.
|
|
320
|
+
* HTTP POST /notification/alert
|
|
321
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
438
322
|
*/
|
|
439
|
-
|
|
323
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
440
324
|
/**
|
|
441
|
-
* HTTP DELETE /
|
|
442
|
-
* Java method: org.openremote.model.
|
|
325
|
+
* HTTP DELETE /notification/{notificationId}
|
|
326
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
443
327
|
*/
|
|
444
|
-
|
|
328
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
445
329
|
/**
|
|
446
|
-
* HTTP
|
|
447
|
-
* Java method: org.openremote.model.
|
|
330
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
331
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
448
332
|
*/
|
|
449
|
-
|
|
333
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
334
|
+
targetId?: string;
|
|
335
|
+
}, options?: O): RestResponse<void>;
|
|
450
336
|
/**
|
|
451
|
-
* HTTP PUT /
|
|
452
|
-
* Java method: org.openremote.model.
|
|
337
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
338
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
453
339
|
*/
|
|
454
|
-
|
|
340
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
341
|
+
targetId?: string;
|
|
342
|
+
}, options?: O): RestResponse<void>;
|
|
343
|
+
}
|
|
344
|
+
export declare class AppResourceClient<O> {
|
|
345
|
+
protected httpClient: HttpClient<O>;
|
|
346
|
+
constructor(httpClient: HttpClient<O>);
|
|
455
347
|
/**
|
|
456
|
-
* HTTP
|
|
457
|
-
* Java method: org.openremote.model.
|
|
348
|
+
* HTTP GET /apps
|
|
349
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
458
350
|
*/
|
|
459
|
-
|
|
351
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
460
352
|
/**
|
|
461
|
-
* HTTP
|
|
462
|
-
* Java method: org.openremote.model.
|
|
353
|
+
* HTTP GET /apps/consoleConfig
|
|
354
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
463
355
|
*/
|
|
464
|
-
|
|
356
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
465
357
|
/**
|
|
466
|
-
* HTTP
|
|
467
|
-
* Java method: org.openremote.model.
|
|
358
|
+
* HTTP GET /apps/info
|
|
359
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
468
360
|
*/
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
}
|
|
361
|
+
getAppInfos(options?: O): RestResponse<{
|
|
362
|
+
[index: string]: any;
|
|
363
|
+
}>;
|
|
472
364
|
}
|
|
473
|
-
export declare class
|
|
365
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
474
366
|
protected httpClient: HttpClient<O>;
|
|
475
367
|
constructor(httpClient: HttpClient<O>);
|
|
476
368
|
/**
|
|
477
|
-
* HTTP POST /
|
|
478
|
-
* Java method: org.openremote.model.
|
|
369
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
370
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
479
371
|
*/
|
|
480
|
-
|
|
372
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
481
373
|
/**
|
|
482
|
-
* HTTP
|
|
483
|
-
* Java method: org.openremote.model.
|
|
374
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
375
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
484
376
|
*/
|
|
485
|
-
|
|
377
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
378
|
+
}
|
|
379
|
+
export declare class UserResourceClient<O> {
|
|
380
|
+
protected httpClient: HttpClient<O>;
|
|
381
|
+
constructor(httpClient: HttpClient<O>);
|
|
486
382
|
/**
|
|
487
|
-
* HTTP
|
|
488
|
-
* Java method: org.openremote.model.
|
|
383
|
+
* HTTP PUT /user/locale
|
|
384
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
489
385
|
*/
|
|
490
|
-
|
|
386
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
491
387
|
/**
|
|
492
|
-
* HTTP
|
|
493
|
-
* Java method: org.openremote.model.
|
|
388
|
+
* HTTP POST /user/query
|
|
389
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
494
390
|
*/
|
|
495
|
-
|
|
496
|
-
}
|
|
497
|
-
export declare class GatewayClientResourceClient<O> {
|
|
498
|
-
protected httpClient: HttpClient<O>;
|
|
499
|
-
constructor(httpClient: HttpClient<O>);
|
|
391
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
500
392
|
/**
|
|
501
|
-
* HTTP
|
|
502
|
-
* Java method: org.openremote.model.
|
|
393
|
+
* HTTP PUT /user/request-password-reset
|
|
394
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
503
395
|
*/
|
|
504
|
-
|
|
505
|
-
realm?: string[];
|
|
506
|
-
}, options?: O): RestResponse<void>;
|
|
396
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
507
397
|
/**
|
|
508
|
-
* HTTP
|
|
509
|
-
* Java method: org.openremote.model.
|
|
398
|
+
* HTTP PUT /user/reset-password
|
|
399
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
510
400
|
*/
|
|
511
|
-
|
|
401
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
512
402
|
/**
|
|
513
|
-
* HTTP
|
|
514
|
-
* Java method: org.openremote.model.
|
|
403
|
+
* HTTP PUT /user/update
|
|
404
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
515
405
|
*/
|
|
516
|
-
|
|
406
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
517
407
|
/**
|
|
518
|
-
* HTTP GET /
|
|
519
|
-
* Java method: org.openremote.model.
|
|
408
|
+
* HTTP GET /user/user
|
|
409
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
520
410
|
*/
|
|
521
|
-
|
|
411
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
522
412
|
/**
|
|
523
|
-
* HTTP
|
|
524
|
-
* Java method: org.openremote.model.
|
|
413
|
+
* HTTP GET /user/userRealmRoles
|
|
414
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
525
415
|
*/
|
|
526
|
-
|
|
416
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
527
417
|
/**
|
|
528
|
-
* HTTP GET /
|
|
529
|
-
* Java method: org.openremote.model.
|
|
418
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
419
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
530
420
|
*/
|
|
531
|
-
|
|
532
|
-
}
|
|
533
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
534
|
-
protected httpClient: HttpClient<O>;
|
|
535
|
-
constructor(httpClient: HttpClient<O>);
|
|
421
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
536
422
|
/**
|
|
537
|
-
* HTTP GET /
|
|
538
|
-
* Java method: org.openremote.model.
|
|
423
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
424
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
539
425
|
*/
|
|
540
|
-
|
|
541
|
-
attributeRefs?: string;
|
|
542
|
-
fromTimestamp?: number;
|
|
543
|
-
toTimestamp?: number;
|
|
544
|
-
}, options?: O): RestResponse<any>;
|
|
426
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
545
427
|
/**
|
|
546
|
-
* HTTP
|
|
547
|
-
* Java method: org.openremote.model.
|
|
428
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
429
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
548
430
|
*/
|
|
549
|
-
|
|
550
|
-
assetId?: string;
|
|
551
|
-
attributeName?: string;
|
|
552
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
431
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
553
432
|
/**
|
|
554
|
-
* HTTP
|
|
555
|
-
* Java method: org.openremote.model.
|
|
433
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
434
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
556
435
|
*/
|
|
557
|
-
|
|
436
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
437
|
+
/**
|
|
438
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
439
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
440
|
+
*/
|
|
441
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
442
|
+
/**
|
|
443
|
+
* HTTP PUT /user/{realm}/roles
|
|
444
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
445
|
+
*/
|
|
446
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
447
|
+
/**
|
|
448
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
449
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
450
|
+
*/
|
|
451
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
452
|
+
/**
|
|
453
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
454
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
455
|
+
*/
|
|
456
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
457
|
+
/**
|
|
458
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
459
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
460
|
+
*/
|
|
461
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
462
|
+
/**
|
|
463
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
464
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
465
|
+
*/
|
|
466
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
467
|
+
/**
|
|
468
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
469
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
470
|
+
*/
|
|
471
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
472
|
+
/**
|
|
473
|
+
* HTTP POST /user/{realm}/users
|
|
474
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
475
|
+
*/
|
|
476
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
477
|
+
/**
|
|
478
|
+
* HTTP PUT /user/{realm}/users
|
|
479
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
480
|
+
*/
|
|
481
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
482
|
+
/**
|
|
483
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
484
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
485
|
+
*/
|
|
486
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
487
|
+
/**
|
|
488
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
489
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
490
|
+
*/
|
|
491
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
492
|
+
/**
|
|
493
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
494
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
495
|
+
*/
|
|
496
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
497
|
+
/**
|
|
498
|
+
* HTTP GET /user/{realm}/{userId}
|
|
499
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
500
|
+
*/
|
|
501
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
558
502
|
}
|
|
559
503
|
export declare class DashboardResourceClient<O> {
|
|
560
504
|
protected httpClient: HttpClient<O>;
|
|
@@ -590,132 +534,56 @@ export declare class DashboardResourceClient<O> {
|
|
|
590
534
|
*/
|
|
591
535
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
592
536
|
}
|
|
593
|
-
export declare class
|
|
594
|
-
protected httpClient: HttpClient<O>;
|
|
595
|
-
constructor(httpClient: HttpClient<O>);
|
|
596
|
-
/**
|
|
597
|
-
* HTTP GET /model/assetDescriptors
|
|
598
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
599
|
-
*/
|
|
600
|
-
getAssetDescriptors(queryParams?: {
|
|
601
|
-
parentId?: string;
|
|
602
|
-
parentType?: string;
|
|
603
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
604
|
-
/**
|
|
605
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
606
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
607
|
-
*/
|
|
608
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
609
|
-
parentId?: string;
|
|
610
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
611
|
-
/**
|
|
612
|
-
* HTTP GET /model/assetInfos
|
|
613
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
614
|
-
*/
|
|
615
|
-
getAssetInfos(queryParams?: {
|
|
616
|
-
parentId?: string;
|
|
617
|
-
parentType?: string;
|
|
618
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
619
|
-
/**
|
|
620
|
-
* HTTP GET /model/getValueDescriptorSchema
|
|
621
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
622
|
-
*/
|
|
623
|
-
getValueDescriptorSchema(queryParams?: {
|
|
624
|
-
name?: string;
|
|
625
|
-
hash?: string;
|
|
626
|
-
}, options?: O): RestResponse<any>;
|
|
627
|
-
/**
|
|
628
|
-
* HTTP GET /model/metaItemDescriptors
|
|
629
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
630
|
-
*/
|
|
631
|
-
getMetaItemDescriptors(queryParams?: {
|
|
632
|
-
parentId?: string;
|
|
633
|
-
}, options?: O): RestResponse<{
|
|
634
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
635
|
-
}>;
|
|
636
|
-
/**
|
|
637
|
-
* HTTP GET /model/valueDescriptors
|
|
638
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
639
|
-
*/
|
|
640
|
-
getValueDescriptors(queryParams?: {
|
|
641
|
-
parentId?: string;
|
|
642
|
-
}, options?: O): RestResponse<{
|
|
643
|
-
[index: string]: Model.ValueDescriptor;
|
|
644
|
-
}>;
|
|
645
|
-
}
|
|
646
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
537
|
+
export declare class FlowResourceClient<O> {
|
|
647
538
|
protected httpClient: HttpClient<O>;
|
|
648
539
|
constructor(httpClient: HttpClient<O>);
|
|
649
540
|
/**
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
653
|
-
*/
|
|
654
|
-
getServices(queryParams?: {
|
|
655
|
-
realm?: string;
|
|
656
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
657
|
-
/**
|
|
658
|
-
* Response code 200 - Service registered successfully
|
|
659
|
-
* Response code 400 - Invalid external service object
|
|
660
|
-
* Response code 409 - ExternalService instance already registered
|
|
661
|
-
* HTTP POST /service
|
|
662
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
663
|
-
*/
|
|
664
|
-
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
665
|
-
/**
|
|
666
|
-
* Response code 200 - List of registered external services
|
|
667
|
-
* HTTP GET /service/global
|
|
668
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
669
|
-
*/
|
|
670
|
-
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
671
|
-
/**
|
|
672
|
-
* Response code 200 - Service registered successfully
|
|
673
|
-
* Response code 400 - Invalid external service object
|
|
674
|
-
* Response code 409 - ExternalService instance already registered
|
|
675
|
-
* HTTP POST /service/global
|
|
676
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
677
|
-
*/
|
|
678
|
-
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
679
|
-
/**
|
|
680
|
-
* Response code 204 - Service deregistered successfully
|
|
681
|
-
* Response code 404 - Service instance not found
|
|
682
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
683
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
541
|
+
* HTTP GET /flow
|
|
542
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
684
543
|
*/
|
|
685
|
-
|
|
544
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
686
545
|
/**
|
|
687
|
-
*
|
|
688
|
-
*
|
|
689
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
690
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
546
|
+
* HTTP GET /flow/{name}
|
|
547
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
691
548
|
*/
|
|
692
|
-
|
|
549
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
693
550
|
/**
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
697
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
551
|
+
* HTTP GET /flow/{type}
|
|
552
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
698
553
|
*/
|
|
699
|
-
|
|
554
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
700
555
|
}
|
|
701
|
-
export declare class
|
|
556
|
+
export declare class SyslogResourceClient<O> {
|
|
702
557
|
protected httpClient: HttpClient<O>;
|
|
703
558
|
constructor(httpClient: HttpClient<O>);
|
|
704
559
|
/**
|
|
705
|
-
* HTTP GET /
|
|
706
|
-
* Java method: org.openremote.model.
|
|
560
|
+
* HTTP GET /syslog/config
|
|
561
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
707
562
|
*/
|
|
708
|
-
|
|
563
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
709
564
|
/**
|
|
710
|
-
* HTTP
|
|
711
|
-
* Java method: org.openremote.model.
|
|
565
|
+
* HTTP PUT /syslog/config
|
|
566
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
712
567
|
*/
|
|
713
|
-
|
|
568
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
714
569
|
/**
|
|
715
|
-
* HTTP
|
|
716
|
-
* Java method: org.openremote.model.
|
|
570
|
+
* HTTP DELETE /syslog/event
|
|
571
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
572
|
+
*/
|
|
573
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
574
|
+
/**
|
|
575
|
+
* HTTP GET /syslog/event
|
|
576
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
717
577
|
*/
|
|
718
|
-
|
|
578
|
+
getEvents(queryParams?: {
|
|
579
|
+
level?: Model.SyslogLevel;
|
|
580
|
+
per_page?: number;
|
|
581
|
+
page?: number;
|
|
582
|
+
from?: number;
|
|
583
|
+
to?: number;
|
|
584
|
+
category?: Model.SyslogCategory[];
|
|
585
|
+
subCategory?: string[];
|
|
586
|
+
}, options?: O): RestResponse<any>;
|
|
719
587
|
}
|
|
720
588
|
export declare class AlarmResourceClient<O> {
|
|
721
589
|
protected httpClient: HttpClient<O>;
|
|
@@ -770,252 +638,379 @@ export declare class AlarmResourceClient<O> {
|
|
|
770
638
|
realm?: string;
|
|
771
639
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
772
640
|
}
|
|
773
|
-
export declare class
|
|
641
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
774
642
|
protected httpClient: HttpClient<O>;
|
|
775
643
|
constructor(httpClient: HttpClient<O>);
|
|
776
644
|
/**
|
|
777
|
-
* HTTP
|
|
778
|
-
* Java method: org.openremote.model.
|
|
645
|
+
* HTTP POST /gateway/tunnel
|
|
646
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
779
647
|
*/
|
|
780
|
-
|
|
781
|
-
[index: string]: any;
|
|
782
|
-
}>;
|
|
648
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
783
649
|
/**
|
|
784
|
-
* HTTP
|
|
785
|
-
* Java method: org.openremote.model.
|
|
650
|
+
* HTTP DELETE /gateway/tunnel
|
|
651
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
786
652
|
*/
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
653
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
654
|
+
/**
|
|
655
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
656
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
657
|
+
*/
|
|
658
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
659
|
+
/**
|
|
660
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
661
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
662
|
+
*/
|
|
663
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
664
|
+
/**
|
|
665
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
666
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
667
|
+
*/
|
|
668
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
790
669
|
}
|
|
791
|
-
export declare class
|
|
670
|
+
export declare class AgentResourceClient<O> {
|
|
792
671
|
protected httpClient: HttpClient<O>;
|
|
793
672
|
constructor(httpClient: HttpClient<O>);
|
|
794
673
|
/**
|
|
795
|
-
* HTTP
|
|
796
|
-
* Java method: org.openremote.model.
|
|
674
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
675
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
797
676
|
*/
|
|
798
|
-
|
|
677
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
678
|
+
realm?: string;
|
|
679
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
799
680
|
/**
|
|
800
|
-
* HTTP POST /
|
|
801
|
-
* Java method: org.openremote.model.
|
|
681
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
682
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
802
683
|
*/
|
|
803
|
-
|
|
684
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
685
|
+
realm?: string;
|
|
686
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
804
687
|
/**
|
|
805
|
-
* HTTP
|
|
806
|
-
* Java method: org.openremote.model.
|
|
688
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
689
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
807
690
|
*/
|
|
808
|
-
|
|
691
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
692
|
+
parentId?: string;
|
|
693
|
+
realm?: string;
|
|
694
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
695
|
+
}
|
|
696
|
+
export declare class ConfigurationResourceClient<O> {
|
|
697
|
+
protected httpClient: HttpClient<O>;
|
|
698
|
+
constructor(httpClient: HttpClient<O>);
|
|
809
699
|
/**
|
|
810
|
-
* HTTP
|
|
811
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* HTTP GET /configuration/manager
|
|
701
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
812
702
|
*/
|
|
813
|
-
|
|
703
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
814
704
|
/**
|
|
815
|
-
* HTTP PUT /
|
|
816
|
-
* Java method: org.openremote.model.
|
|
705
|
+
* HTTP PUT /configuration/manager
|
|
706
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
817
707
|
*/
|
|
818
|
-
|
|
708
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
819
709
|
/**
|
|
820
|
-
* HTTP
|
|
821
|
-
* Java method: org.openremote.model.
|
|
710
|
+
* HTTP POST /configuration/manager/file
|
|
711
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
822
712
|
*/
|
|
823
|
-
|
|
713
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
714
|
+
path?: string;
|
|
715
|
+
}, options?: O): RestResponse<string>;
|
|
824
716
|
/**
|
|
825
|
-
* HTTP GET /
|
|
826
|
-
* Java method: org.openremote.model.
|
|
717
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
718
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
827
719
|
*/
|
|
828
|
-
|
|
720
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
721
|
+
}
|
|
722
|
+
export declare class ConsoleResourceClient<O> {
|
|
723
|
+
protected httpClient: HttpClient<O>;
|
|
724
|
+
constructor(httpClient: HttpClient<O>);
|
|
829
725
|
/**
|
|
830
|
-
* HTTP
|
|
831
|
-
* Java method: org.openremote.model.
|
|
726
|
+
* HTTP POST /console/register
|
|
727
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
832
728
|
*/
|
|
833
|
-
|
|
729
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
730
|
+
}
|
|
731
|
+
export declare class AssetResourceClient<O> {
|
|
732
|
+
protected httpClient: HttpClient<O>;
|
|
733
|
+
constructor(httpClient: HttpClient<O>);
|
|
834
734
|
/**
|
|
835
|
-
* HTTP
|
|
836
|
-
* Java method: org.openremote.model.
|
|
735
|
+
* HTTP POST /asset
|
|
736
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
837
737
|
*/
|
|
838
|
-
|
|
738
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
839
739
|
/**
|
|
840
|
-
* HTTP
|
|
841
|
-
* Java method: org.openremote.model.
|
|
740
|
+
* HTTP DELETE /asset
|
|
741
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
842
742
|
*/
|
|
843
|
-
|
|
743
|
+
delete(queryParams?: {
|
|
744
|
+
assetId?: string[];
|
|
745
|
+
}, options?: O): RestResponse<void>;
|
|
844
746
|
/**
|
|
845
|
-
* HTTP PUT /
|
|
846
|
-
* Java method: org.openremote.model.
|
|
747
|
+
* HTTP PUT /asset/attributes
|
|
748
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
847
749
|
*/
|
|
848
|
-
|
|
750
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
849
751
|
/**
|
|
850
|
-
* HTTP
|
|
851
|
-
* Java method: org.openremote.model.
|
|
752
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
753
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
852
754
|
*/
|
|
853
|
-
|
|
755
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
854
756
|
/**
|
|
855
|
-
* HTTP
|
|
856
|
-
* Java method: org.openremote.model.
|
|
757
|
+
* HTTP POST /asset/count
|
|
758
|
+
* Java method: org.openremote.model.asset.AssetResource.queryCount
|
|
857
759
|
*/
|
|
858
|
-
|
|
760
|
+
queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
|
|
859
761
|
/**
|
|
860
|
-
* HTTP
|
|
861
|
-
* Java method: org.openremote.model.
|
|
762
|
+
* HTTP DELETE /asset/parent
|
|
763
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
862
764
|
*/
|
|
863
|
-
|
|
765
|
+
updateNoneParent(queryParams?: {
|
|
766
|
+
assetIds?: string[];
|
|
767
|
+
}, options?: O): RestResponse<void>;
|
|
864
768
|
/**
|
|
865
|
-
* HTTP
|
|
866
|
-
* Java method: org.openremote.model.
|
|
769
|
+
* HTTP GET /asset/partial/{assetId}
|
|
770
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
867
771
|
*/
|
|
868
|
-
|
|
772
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
869
773
|
/**
|
|
870
|
-
* HTTP
|
|
871
|
-
* Java method: org.openremote.model.
|
|
774
|
+
* HTTP POST /asset/query
|
|
775
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
872
776
|
*/
|
|
873
|
-
|
|
777
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
874
778
|
/**
|
|
875
|
-
* HTTP
|
|
876
|
-
* Java method: org.openremote.model.
|
|
779
|
+
* HTTP POST /asset/tree
|
|
780
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
877
781
|
*/
|
|
878
|
-
|
|
782
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
783
|
+
/**
|
|
784
|
+
* HTTP GET /asset/user/current
|
|
785
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
786
|
+
*/
|
|
787
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
788
|
+
/**
|
|
789
|
+
* HTTP POST /asset/user/link
|
|
790
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
791
|
+
*/
|
|
792
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
793
|
+
/**
|
|
794
|
+
* HTTP GET /asset/user/link
|
|
795
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
796
|
+
*/
|
|
797
|
+
getUserAssetLinks(queryParams?: {
|
|
798
|
+
realm?: string;
|
|
799
|
+
userId?: string;
|
|
800
|
+
assetId?: string;
|
|
801
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
802
|
+
/**
|
|
803
|
+
* HTTP POST /asset/user/link/delete
|
|
804
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
805
|
+
*/
|
|
806
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
807
|
+
/**
|
|
808
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
809
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
810
|
+
*/
|
|
811
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
812
|
+
/**
|
|
813
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
814
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
815
|
+
*/
|
|
816
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
817
|
+
/**
|
|
818
|
+
* HTTP GET /asset/{assetId}
|
|
819
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
820
|
+
*/
|
|
821
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
822
|
+
/**
|
|
823
|
+
* HTTP PUT /asset/{assetId}
|
|
824
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
825
|
+
*/
|
|
826
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
827
|
+
/**
|
|
828
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
829
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
830
|
+
*/
|
|
831
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
832
|
+
/**
|
|
833
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
834
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
835
|
+
*/
|
|
836
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
879
837
|
/**
|
|
880
|
-
* HTTP
|
|
881
|
-
* Java method: org.openremote.model.
|
|
838
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
839
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
882
840
|
*/
|
|
883
|
-
|
|
841
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
842
|
+
assetIds?: string[];
|
|
843
|
+
}, options?: O): RestResponse<void>;
|
|
844
|
+
}
|
|
845
|
+
export declare class MapResourceClient<O> {
|
|
846
|
+
protected httpClient: HttpClient<O>;
|
|
847
|
+
constructor(httpClient: HttpClient<O>);
|
|
884
848
|
/**
|
|
885
|
-
* HTTP
|
|
886
|
-
* Java method: org.openremote.model.
|
|
849
|
+
* HTTP GET /map
|
|
850
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
887
851
|
*/
|
|
888
|
-
|
|
852
|
+
getSettings(options?: O): RestResponse<{
|
|
853
|
+
[id: string]: unknown;
|
|
854
|
+
}>;
|
|
889
855
|
/**
|
|
890
|
-
* HTTP PUT /
|
|
891
|
-
* Java method: org.openremote.model.
|
|
856
|
+
* HTTP PUT /map
|
|
857
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
892
858
|
*/
|
|
893
|
-
|
|
859
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
860
|
+
[id: string]: unknown;
|
|
861
|
+
}>;
|
|
894
862
|
/**
|
|
895
|
-
* HTTP DELETE /
|
|
896
|
-
* Java method: org.openremote.model.
|
|
863
|
+
* HTTP DELETE /map/deleteMap
|
|
864
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
897
865
|
*/
|
|
898
|
-
|
|
866
|
+
deleteMap(options?: O): RestResponse<{
|
|
867
|
+
[id: string]: unknown;
|
|
868
|
+
}>;
|
|
899
869
|
/**
|
|
900
|
-
* HTTP GET /
|
|
901
|
-
* Java method: org.openremote.model.
|
|
870
|
+
* HTTP GET /map/getCustomMapInfo
|
|
871
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
902
872
|
*/
|
|
903
|
-
|
|
873
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
874
|
+
[id: string]: unknown;
|
|
875
|
+
}>;
|
|
904
876
|
/**
|
|
905
|
-
* HTTP
|
|
906
|
-
* Java method: org.openremote.model.
|
|
877
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
878
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
907
879
|
*/
|
|
908
|
-
|
|
880
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
909
881
|
/**
|
|
910
|
-
* HTTP
|
|
911
|
-
* Java method: org.openremote.model.
|
|
882
|
+
* HTTP POST /map/upload
|
|
883
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
912
884
|
*/
|
|
913
|
-
|
|
885
|
+
uploadMap(queryParams?: {
|
|
886
|
+
filename?: string;
|
|
887
|
+
}, options?: O): RestResponse<{
|
|
888
|
+
[id: string]: unknown;
|
|
889
|
+
}>;
|
|
914
890
|
}
|
|
915
|
-
export declare class
|
|
891
|
+
export declare class ProvisioningResourceClient<O> {
|
|
916
892
|
protected httpClient: HttpClient<O>;
|
|
917
893
|
constructor(httpClient: HttpClient<O>);
|
|
918
894
|
/**
|
|
919
|
-
* HTTP POST /
|
|
920
|
-
* Java method: org.openremote.model.
|
|
895
|
+
* HTTP POST /provisioning
|
|
896
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
921
897
|
*/
|
|
922
|
-
|
|
898
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
923
899
|
/**
|
|
924
|
-
* HTTP
|
|
925
|
-
* Java method: org.openremote.model.
|
|
900
|
+
* HTTP GET /provisioning
|
|
901
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
926
902
|
*/
|
|
927
|
-
|
|
903
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
904
|
+
/**
|
|
905
|
+
* HTTP DELETE /provisioning/{id}
|
|
906
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
907
|
+
*/
|
|
908
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
909
|
+
/**
|
|
910
|
+
* HTTP PUT /provisioning/{id}
|
|
911
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
912
|
+
*/
|
|
913
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
928
914
|
}
|
|
929
|
-
export declare class
|
|
915
|
+
export declare class AssetModelResourceClient<O> {
|
|
930
916
|
protected httpClient: HttpClient<O>;
|
|
931
917
|
constructor(httpClient: HttpClient<O>);
|
|
932
918
|
/**
|
|
933
|
-
* HTTP
|
|
934
|
-
* Java method: org.openremote.model.
|
|
935
|
-
*/
|
|
936
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
937
|
-
/**
|
|
938
|
-
* HTTP GET /realm
|
|
939
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
919
|
+
* HTTP GET /model/assetDescriptors
|
|
920
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
940
921
|
*/
|
|
941
|
-
|
|
922
|
+
getAssetDescriptors(queryParams?: {
|
|
923
|
+
parentId?: string;
|
|
924
|
+
parentType?: string;
|
|
925
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
942
926
|
/**
|
|
943
|
-
* HTTP GET /
|
|
944
|
-
* Java method: org.openremote.model.
|
|
927
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
928
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
945
929
|
*/
|
|
946
|
-
|
|
930
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
931
|
+
parentId?: string;
|
|
932
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
947
933
|
/**
|
|
948
|
-
* HTTP
|
|
949
|
-
* Java method: org.openremote.model.
|
|
934
|
+
* HTTP GET /model/assetInfos
|
|
935
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
950
936
|
*/
|
|
951
|
-
|
|
937
|
+
getAssetInfos(queryParams?: {
|
|
938
|
+
parentId?: string;
|
|
939
|
+
parentType?: string;
|
|
940
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
952
941
|
/**
|
|
953
|
-
* HTTP GET /
|
|
954
|
-
* Java method: org.openremote.model.
|
|
942
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
943
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
955
944
|
*/
|
|
956
|
-
|
|
945
|
+
getValueDescriptorSchema(queryParams?: {
|
|
946
|
+
name?: string;
|
|
947
|
+
}, options?: O): RestResponse<any>;
|
|
957
948
|
/**
|
|
958
|
-
* HTTP
|
|
959
|
-
* Java method: org.openremote.model.
|
|
949
|
+
* HTTP GET /model/metaItemDescriptors
|
|
950
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
960
951
|
*/
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
952
|
+
getMetaItemDescriptors(queryParams?: {
|
|
953
|
+
parentId?: string;
|
|
954
|
+
}, options?: O): RestResponse<{
|
|
955
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
956
|
+
}>;
|
|
966
957
|
/**
|
|
967
|
-
* HTTP
|
|
968
|
-
* Java method: org.openremote.model.
|
|
958
|
+
* HTTP GET /model/valueDescriptors
|
|
959
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
969
960
|
*/
|
|
970
|
-
|
|
961
|
+
getValueDescriptors(queryParams?: {
|
|
962
|
+
parentId?: string;
|
|
963
|
+
}, options?: O): RestResponse<{
|
|
964
|
+
[index: string]: Model.ValueDescriptor;
|
|
965
|
+
}>;
|
|
971
966
|
}
|
|
972
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
973
968
|
export declare class ApiClient {
|
|
974
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
975
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
976
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
977
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
978
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
979
969
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
980
|
-
protected
|
|
981
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
982
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
983
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
984
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
970
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
985
971
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
986
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
987
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
988
972
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
973
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
974
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
975
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
989
976
|
protected _appResource: AxiosAppResourceClient;
|
|
990
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
991
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
992
|
-
protected _userResource: AxiosUserResourceClient;
|
|
993
977
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
994
|
-
protected
|
|
978
|
+
protected _userResource: AxiosUserResourceClient;
|
|
979
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
980
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
981
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
982
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
983
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
984
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
985
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
995
986
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
987
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
988
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
989
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
990
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
996
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
997
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
998
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
999
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1000
|
-
get MapResource(): AxiosMapResourceClient;
|
|
1001
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1002
992
|
get RulesResource(): AxiosRulesResourceClient;
|
|
1003
|
-
get
|
|
1004
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1005
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
1006
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1007
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
993
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1008
994
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1009
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1010
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1011
995
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
996
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
997
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
998
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1012
999
|
get AppResource(): AxiosAppResourceClient;
|
|
1013
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1014
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1015
|
-
get UserResource(): AxiosUserResourceClient;
|
|
1016
1000
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1017
|
-
get
|
|
1001
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1002
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1003
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1004
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1005
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1006
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1007
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1008
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1018
1009
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1010
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1011
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1012
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1013
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1019
1014
|
}
|
|
1020
1015
|
import * as Axios from "axios";
|
|
1021
1016
|
declare module "axios" {
|
|
@@ -1023,70 +1018,70 @@ declare module "axios" {
|
|
|
1023
1018
|
data: R;
|
|
1024
1019
|
}
|
|
1025
1020
|
}
|
|
1026
|
-
export declare class
|
|
1021
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1027
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1028
1023
|
}
|
|
1029
|
-
export declare class
|
|
1024
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1030
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1031
1026
|
}
|
|
1032
|
-
export declare class
|
|
1027
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1033
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1034
1029
|
}
|
|
1035
|
-
export declare class
|
|
1030
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1036
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1037
1032
|
}
|
|
1038
|
-
export declare class
|
|
1033
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1039
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1040
1035
|
}
|
|
1041
|
-
export declare class
|
|
1036
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1042
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1043
1038
|
}
|
|
1044
1039
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1045
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1046
1041
|
}
|
|
1047
|
-
export declare class
|
|
1042
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1048
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1049
1044
|
}
|
|
1050
|
-
export declare class
|
|
1045
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1051
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1052
1047
|
}
|
|
1053
|
-
export declare class
|
|
1048
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1054
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1055
1050
|
}
|
|
1056
|
-
export declare class
|
|
1051
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1057
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1058
1053
|
}
|
|
1059
|
-
export declare class
|
|
1054
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1060
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1061
1056
|
}
|
|
1062
|
-
export declare class
|
|
1057
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1063
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1064
1059
|
}
|
|
1065
|
-
export declare class
|
|
1060
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1066
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1067
1062
|
}
|
|
1068
|
-
export declare class
|
|
1063
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1069
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1070
1065
|
}
|
|
1071
|
-
export declare class
|
|
1066
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1072
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1073
1068
|
}
|
|
1074
|
-
export declare class
|
|
1069
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1075
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1076
1071
|
}
|
|
1077
|
-
export declare class
|
|
1072
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1078
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1079
1074
|
}
|
|
1080
|
-
export declare class
|
|
1075
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1081
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1082
1077
|
}
|
|
1083
|
-
export declare class
|
|
1078
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1084
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1085
1080
|
}
|
|
1086
|
-
export declare class
|
|
1081
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1087
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1088
1083
|
}
|
|
1089
|
-
export declare class
|
|
1084
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1090
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1091
1086
|
}
|
|
1092
1087
|
//# sourceMappingURL=restclient.d.ts.map
|