@openremote/rest 1.13.0-snapshot.20251218092826 → 1.13.0-snapshot.20251218141334
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 +457 -457
- package/lib/restclient.d.ts.map +1 -1
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +1 -1
package/lib/restclient.d.ts
CHANGED
|
@@ -9,72 +9,83 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class DashboardResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP POST /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP POST /dashboard
|
|
17
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
18
18
|
*/
|
|
19
|
-
create(
|
|
19
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /dashboard
|
|
22
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
25
25
|
/**
|
|
26
|
-
* HTTP GET /realm
|
|
27
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /dashboard/all/{realm}
|
|
27
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
30
30
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP POST /dashboard/query
|
|
32
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
33
33
|
*/
|
|
34
|
-
|
|
34
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
35
35
|
/**
|
|
36
|
-
* HTTP
|
|
37
|
-
* Java method: org.openremote.model.
|
|
36
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
37
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
38
38
|
*/
|
|
39
|
-
|
|
39
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
40
40
|
/**
|
|
41
|
-
* HTTP
|
|
42
|
-
* Java method: org.openremote.model.
|
|
41
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
42
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
43
43
|
*/
|
|
44
|
-
|
|
44
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
45
45
|
}
|
|
46
|
-
export declare class
|
|
46
|
+
export declare class StatusResourceClient<O> {
|
|
47
47
|
protected httpClient: HttpClient<O>;
|
|
48
48
|
constructor(httpClient: HttpClient<O>);
|
|
49
49
|
/**
|
|
50
|
-
* HTTP
|
|
51
|
-
* Java method: org.openremote.model.
|
|
50
|
+
* HTTP GET /health
|
|
51
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
54
|
+
[index: string]: any;
|
|
55
|
+
}>;
|
|
54
56
|
/**
|
|
55
|
-
* HTTP GET /
|
|
56
|
-
* Java method: org.openremote.model.
|
|
57
|
+
* HTTP GET /info
|
|
58
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
57
59
|
*/
|
|
58
|
-
|
|
60
|
+
getInfo(options?: O): RestResponse<{
|
|
61
|
+
[index: string]: any;
|
|
62
|
+
}>;
|
|
63
|
+
}
|
|
64
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
65
|
+
protected httpClient: HttpClient<O>;
|
|
66
|
+
constructor(httpClient: HttpClient<O>);
|
|
59
67
|
/**
|
|
60
|
-
* HTTP
|
|
61
|
-
* Java method: org.openremote.model.
|
|
68
|
+
* HTTP GET /asset/datapoint/export
|
|
69
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
62
70
|
*/
|
|
63
|
-
|
|
71
|
+
getDatapointExport(queryParams?: {
|
|
72
|
+
attributeRefs?: string;
|
|
73
|
+
fromTimestamp?: number;
|
|
74
|
+
toTimestamp?: number;
|
|
75
|
+
}, options?: O): RestResponse<any>;
|
|
64
76
|
/**
|
|
65
|
-
* HTTP
|
|
66
|
-
* Java method: org.openremote.model.
|
|
77
|
+
* HTTP GET /asset/datapoint/periods
|
|
78
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
67
79
|
*/
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
constructor(httpClient: HttpClient<O>);
|
|
80
|
+
getDatapointPeriod(queryParams?: {
|
|
81
|
+
assetId?: string;
|
|
82
|
+
attributeName?: string;
|
|
83
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
73
84
|
/**
|
|
74
|
-
* HTTP POST /
|
|
75
|
-
* Java method: org.openremote.model.
|
|
85
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
86
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
76
87
|
*/
|
|
77
|
-
|
|
88
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
78
89
|
}
|
|
79
90
|
export declare class AssetResourceClient<O> {
|
|
80
91
|
protected httpClient: HttpClient<O>;
|
|
@@ -185,6 +196,159 @@ export declare class AssetResourceClient<O> {
|
|
|
185
196
|
assetIds?: string[];
|
|
186
197
|
}, options?: O): RestResponse<void>;
|
|
187
198
|
}
|
|
199
|
+
export declare class AssetModelResourceClient<O> {
|
|
200
|
+
protected httpClient: HttpClient<O>;
|
|
201
|
+
constructor(httpClient: HttpClient<O>);
|
|
202
|
+
/**
|
|
203
|
+
* HTTP GET /model/assetDescriptors
|
|
204
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
205
|
+
*/
|
|
206
|
+
getAssetDescriptors(queryParams?: {
|
|
207
|
+
parentId?: string;
|
|
208
|
+
parentType?: string;
|
|
209
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
210
|
+
/**
|
|
211
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
212
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
213
|
+
*/
|
|
214
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
215
|
+
parentId?: string;
|
|
216
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
217
|
+
/**
|
|
218
|
+
* HTTP GET /model/assetInfos
|
|
219
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
220
|
+
*/
|
|
221
|
+
getAssetInfos(queryParams?: {
|
|
222
|
+
parentId?: string;
|
|
223
|
+
parentType?: string;
|
|
224
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
225
|
+
/**
|
|
226
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
227
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
228
|
+
*/
|
|
229
|
+
getValueDescriptorSchema(queryParams?: {
|
|
230
|
+
name?: string;
|
|
231
|
+
hash?: string;
|
|
232
|
+
}, options?: O): RestResponse<any>;
|
|
233
|
+
/**
|
|
234
|
+
* HTTP GET /model/metaItemDescriptors
|
|
235
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
236
|
+
*/
|
|
237
|
+
getMetaItemDescriptors(queryParams?: {
|
|
238
|
+
parentId?: string;
|
|
239
|
+
}, options?: O): RestResponse<{
|
|
240
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
241
|
+
}>;
|
|
242
|
+
/**
|
|
243
|
+
* HTTP GET /model/valueDescriptors
|
|
244
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
245
|
+
*/
|
|
246
|
+
getValueDescriptors(queryParams?: {
|
|
247
|
+
parentId?: string;
|
|
248
|
+
}, options?: O): RestResponse<{
|
|
249
|
+
[index: string]: Model.ValueDescriptor;
|
|
250
|
+
}>;
|
|
251
|
+
}
|
|
252
|
+
export declare class AppResourceClient<O> {
|
|
253
|
+
protected httpClient: HttpClient<O>;
|
|
254
|
+
constructor(httpClient: HttpClient<O>);
|
|
255
|
+
/**
|
|
256
|
+
* HTTP GET /apps
|
|
257
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
258
|
+
*/
|
|
259
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
260
|
+
/**
|
|
261
|
+
* HTTP GET /apps/consoleConfig
|
|
262
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
263
|
+
*/
|
|
264
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
265
|
+
/**
|
|
266
|
+
* HTTP GET /apps/info
|
|
267
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
268
|
+
*/
|
|
269
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
270
|
+
}
|
|
271
|
+
export declare class FlowResourceClient<O> {
|
|
272
|
+
protected httpClient: HttpClient<O>;
|
|
273
|
+
constructor(httpClient: HttpClient<O>);
|
|
274
|
+
/**
|
|
275
|
+
* HTTP GET /flow
|
|
276
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
277
|
+
*/
|
|
278
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
279
|
+
/**
|
|
280
|
+
* HTTP GET /flow/{name}
|
|
281
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
282
|
+
*/
|
|
283
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
284
|
+
/**
|
|
285
|
+
* HTTP GET /flow/{type}
|
|
286
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
287
|
+
*/
|
|
288
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
289
|
+
}
|
|
290
|
+
export declare class MapResourceClient<O> {
|
|
291
|
+
protected httpClient: HttpClient<O>;
|
|
292
|
+
constructor(httpClient: HttpClient<O>);
|
|
293
|
+
/**
|
|
294
|
+
* HTTP GET /map
|
|
295
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
296
|
+
*/
|
|
297
|
+
getSettings(options?: O): RestResponse<{
|
|
298
|
+
[id: string]: unknown;
|
|
299
|
+
}>;
|
|
300
|
+
/**
|
|
301
|
+
* HTTP PUT /map
|
|
302
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
303
|
+
*/
|
|
304
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
305
|
+
[id: string]: unknown;
|
|
306
|
+
}>;
|
|
307
|
+
/**
|
|
308
|
+
* HTTP DELETE /map/deleteMap
|
|
309
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
310
|
+
*/
|
|
311
|
+
deleteMap(options?: O): RestResponse<{
|
|
312
|
+
[id: string]: unknown;
|
|
313
|
+
}>;
|
|
314
|
+
/**
|
|
315
|
+
* HTTP GET /map/getCustomMapInfo
|
|
316
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
317
|
+
*/
|
|
318
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
319
|
+
[id: string]: unknown;
|
|
320
|
+
}>;
|
|
321
|
+
/**
|
|
322
|
+
* HTTP GET /map/js
|
|
323
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
324
|
+
*/
|
|
325
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
326
|
+
[id: string]: unknown;
|
|
327
|
+
}>;
|
|
328
|
+
/**
|
|
329
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
330
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
331
|
+
*/
|
|
332
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
333
|
+
/**
|
|
334
|
+
* HTTP POST /map/upload
|
|
335
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
336
|
+
*/
|
|
337
|
+
uploadMap(queryParams?: {
|
|
338
|
+
filename?: string;
|
|
339
|
+
}, options?: O): RestResponse<{
|
|
340
|
+
[id: string]: unknown;
|
|
341
|
+
}>;
|
|
342
|
+
}
|
|
343
|
+
export declare class ConsoleResourceClient<O> {
|
|
344
|
+
protected httpClient: HttpClient<O>;
|
|
345
|
+
constructor(httpClient: HttpClient<O>);
|
|
346
|
+
/**
|
|
347
|
+
* HTTP POST /console/register
|
|
348
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
349
|
+
*/
|
|
350
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
351
|
+
}
|
|
188
352
|
export declare class UserResourceClient<O> {
|
|
189
353
|
protected httpClient: HttpClient<O>;
|
|
190
354
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -309,77 +473,103 @@ export declare class UserResourceClient<O> {
|
|
|
309
473
|
*/
|
|
310
474
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
311
475
|
}
|
|
312
|
-
export declare class
|
|
476
|
+
export declare class ConfigurationResourceClient<O> {
|
|
313
477
|
protected httpClient: HttpClient<O>;
|
|
314
478
|
constructor(httpClient: HttpClient<O>);
|
|
315
479
|
/**
|
|
316
|
-
* HTTP GET /
|
|
317
|
-
* Java method: org.openremote.model.
|
|
480
|
+
* HTTP GET /configuration/manager
|
|
481
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
318
482
|
*/
|
|
319
|
-
|
|
483
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
320
484
|
/**
|
|
321
|
-
* HTTP
|
|
322
|
-
* Java method: org.openremote.model.
|
|
485
|
+
* HTTP PUT /configuration/manager
|
|
486
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
323
487
|
*/
|
|
324
|
-
|
|
488
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
325
489
|
/**
|
|
326
|
-
* HTTP
|
|
327
|
-
* Java method: org.openremote.model.
|
|
490
|
+
* HTTP POST /configuration/manager/file
|
|
491
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
328
492
|
*/
|
|
329
|
-
|
|
493
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
494
|
+
path?: string;
|
|
495
|
+
}, options?: O): RestResponse<string>;
|
|
496
|
+
/**
|
|
497
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
498
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
499
|
+
*/
|
|
500
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
330
501
|
}
|
|
331
|
-
export declare class
|
|
502
|
+
export declare class AgentResourceClient<O> {
|
|
332
503
|
protected httpClient: HttpClient<O>;
|
|
333
504
|
constructor(httpClient: HttpClient<O>);
|
|
334
505
|
/**
|
|
335
|
-
* HTTP
|
|
336
|
-
* Java method: org.openremote.model.
|
|
506
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
507
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
337
508
|
*/
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
}, options?: O): RestResponse<Model.
|
|
509
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
510
|
+
realm?: string;
|
|
511
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
341
512
|
/**
|
|
342
|
-
* HTTP
|
|
343
|
-
* Java method: org.openremote.model.
|
|
513
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
514
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
344
515
|
*/
|
|
345
|
-
|
|
516
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
346
517
|
realm?: string;
|
|
347
|
-
|
|
348
|
-
assetId?: string;
|
|
349
|
-
assigneeId?: string;
|
|
350
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
518
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
351
519
|
/**
|
|
352
|
-
* HTTP
|
|
353
|
-
* Java method: org.openremote.model.
|
|
520
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
521
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
354
522
|
*/
|
|
355
|
-
|
|
523
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
524
|
+
parentId?: string;
|
|
525
|
+
realm?: string;
|
|
526
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
527
|
+
}
|
|
528
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
529
|
+
protected httpClient: HttpClient<O>;
|
|
530
|
+
constructor(httpClient: HttpClient<O>);
|
|
356
531
|
/**
|
|
357
|
-
* HTTP
|
|
358
|
-
* Java method: org.openremote.model.
|
|
532
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
533
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
359
534
|
*/
|
|
360
|
-
|
|
535
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
361
536
|
/**
|
|
362
|
-
* HTTP
|
|
363
|
-
* Java method: org.openremote.model.
|
|
537
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
538
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
364
539
|
*/
|
|
365
|
-
|
|
540
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
541
|
+
}
|
|
542
|
+
export declare class SyslogResourceClient<O> {
|
|
543
|
+
protected httpClient: HttpClient<O>;
|
|
544
|
+
constructor(httpClient: HttpClient<O>);
|
|
366
545
|
/**
|
|
367
|
-
* HTTP
|
|
368
|
-
* Java method: org.openremote.model.
|
|
546
|
+
* HTTP GET /syslog/config
|
|
547
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
369
548
|
*/
|
|
370
|
-
|
|
549
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
371
550
|
/**
|
|
372
|
-
* HTTP PUT /
|
|
373
|
-
* Java method: org.openremote.model.
|
|
551
|
+
* HTTP PUT /syslog/config
|
|
552
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
374
553
|
*/
|
|
375
|
-
|
|
554
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
376
555
|
/**
|
|
377
|
-
* HTTP
|
|
378
|
-
* Java method: org.openremote.model.
|
|
556
|
+
* HTTP DELETE /syslog/event
|
|
557
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
379
558
|
*/
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
559
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
560
|
+
/**
|
|
561
|
+
* HTTP GET /syslog/event
|
|
562
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
563
|
+
*/
|
|
564
|
+
getEvents(queryParams?: {
|
|
565
|
+
level?: Model.SyslogLevel;
|
|
566
|
+
per_page?: number;
|
|
567
|
+
page?: number;
|
|
568
|
+
from?: number;
|
|
569
|
+
to?: number;
|
|
570
|
+
category?: Model.SyslogCategory[];
|
|
571
|
+
subCategory?: string[];
|
|
572
|
+
}, options?: O): RestResponse<any>;
|
|
383
573
|
}
|
|
384
574
|
export declare class ExternalServiceResourceClient<O> {
|
|
385
575
|
protected httpClient: HttpClient<O>;
|
|
@@ -436,76 +626,29 @@ export declare class ExternalServiceResourceClient<O> {
|
|
|
436
626
|
*/
|
|
437
627
|
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
438
628
|
}
|
|
439
|
-
export declare class
|
|
629
|
+
export declare class ProvisioningResourceClient<O> {
|
|
440
630
|
protected httpClient: HttpClient<O>;
|
|
441
631
|
constructor(httpClient: HttpClient<O>);
|
|
442
632
|
/**
|
|
443
|
-
* HTTP
|
|
444
|
-
* Java method: org.openremote.model.
|
|
445
|
-
*/
|
|
446
|
-
getSettings(options?: O): RestResponse<{
|
|
447
|
-
[id: string]: unknown;
|
|
448
|
-
}>;
|
|
449
|
-
/**
|
|
450
|
-
* HTTP PUT /map
|
|
451
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
452
|
-
*/
|
|
453
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
454
|
-
[id: string]: unknown;
|
|
455
|
-
}>;
|
|
456
|
-
/**
|
|
457
|
-
* HTTP DELETE /map/deleteMap
|
|
458
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
459
|
-
*/
|
|
460
|
-
deleteMap(options?: O): RestResponse<{
|
|
461
|
-
[id: string]: unknown;
|
|
462
|
-
}>;
|
|
463
|
-
/**
|
|
464
|
-
* HTTP GET /map/getCustomMapInfo
|
|
465
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
466
|
-
*/
|
|
467
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
468
|
-
[id: string]: unknown;
|
|
469
|
-
}>;
|
|
470
|
-
/**
|
|
471
|
-
* HTTP GET /map/js
|
|
472
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
473
|
-
*/
|
|
474
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
475
|
-
[id: string]: unknown;
|
|
476
|
-
}>;
|
|
477
|
-
/**
|
|
478
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
479
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
633
|
+
* HTTP POST /provisioning
|
|
634
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
480
635
|
*/
|
|
481
|
-
|
|
636
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
482
637
|
/**
|
|
483
|
-
* HTTP
|
|
484
|
-
* Java method: org.openremote.model.
|
|
638
|
+
* HTTP GET /provisioning
|
|
639
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
485
640
|
*/
|
|
486
|
-
|
|
487
|
-
filename?: string;
|
|
488
|
-
}, options?: O): RestResponse<{
|
|
489
|
-
[id: string]: unknown;
|
|
490
|
-
}>;
|
|
491
|
-
}
|
|
492
|
-
export declare class StatusResourceClient<O> {
|
|
493
|
-
protected httpClient: HttpClient<O>;
|
|
494
|
-
constructor(httpClient: HttpClient<O>);
|
|
641
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
495
642
|
/**
|
|
496
|
-
* HTTP
|
|
497
|
-
* Java method: org.openremote.model.
|
|
643
|
+
* HTTP DELETE /provisioning/{id}
|
|
644
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
498
645
|
*/
|
|
499
|
-
|
|
500
|
-
[index: string]: any;
|
|
501
|
-
}>;
|
|
646
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
502
647
|
/**
|
|
503
|
-
* HTTP
|
|
504
|
-
* Java method: org.openremote.model.
|
|
648
|
+
* HTTP PUT /provisioning/{id}
|
|
649
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
505
650
|
*/
|
|
506
|
-
|
|
507
|
-
[index: string]: any;
|
|
508
|
-
}>;
|
|
651
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
509
652
|
}
|
|
510
653
|
export declare class RulesResourceClient<O> {
|
|
511
654
|
protected httpClient: HttpClient<O>;
|
|
@@ -615,230 +758,56 @@ export declare class RulesResourceClient<O> {
|
|
|
615
758
|
*/
|
|
616
759
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
617
760
|
}
|
|
618
|
-
export declare class
|
|
619
|
-
protected httpClient: HttpClient<O>;
|
|
620
|
-
constructor(httpClient: HttpClient<O>);
|
|
621
|
-
/**
|
|
622
|
-
* HTTP GET /asset/datapoint/export
|
|
623
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
624
|
-
*/
|
|
625
|
-
getDatapointExport(queryParams?: {
|
|
626
|
-
attributeRefs?: string;
|
|
627
|
-
fromTimestamp?: number;
|
|
628
|
-
toTimestamp?: number;
|
|
629
|
-
}, options?: O): RestResponse<any>;
|
|
630
|
-
/**
|
|
631
|
-
* HTTP GET /asset/datapoint/periods
|
|
632
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
633
|
-
*/
|
|
634
|
-
getDatapointPeriod(queryParams?: {
|
|
635
|
-
assetId?: string;
|
|
636
|
-
attributeName?: string;
|
|
637
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
638
|
-
/**
|
|
639
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
640
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
641
|
-
*/
|
|
642
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
643
|
-
}
|
|
644
|
-
export declare class GatewayClientResourceClient<O> {
|
|
761
|
+
export declare class RealmResourceClient<O> {
|
|
645
762
|
protected httpClient: HttpClient<O>;
|
|
646
763
|
constructor(httpClient: HttpClient<O>);
|
|
647
764
|
/**
|
|
648
|
-
* HTTP
|
|
649
|
-
* Java method: org.openremote.model.
|
|
765
|
+
* HTTP POST /realm
|
|
766
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
650
767
|
*/
|
|
651
|
-
|
|
652
|
-
realm?: string[];
|
|
653
|
-
}, options?: O): RestResponse<void>;
|
|
768
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
654
769
|
/**
|
|
655
|
-
* HTTP GET /
|
|
656
|
-
* Java method: org.openremote.model.
|
|
770
|
+
* HTTP GET /realm
|
|
771
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
657
772
|
*/
|
|
658
|
-
|
|
773
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
659
774
|
/**
|
|
660
|
-
* HTTP
|
|
661
|
-
* Java method: org.openremote.model.
|
|
775
|
+
* HTTP GET /realm/accessible
|
|
776
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
662
777
|
*/
|
|
663
|
-
|
|
778
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
664
779
|
/**
|
|
665
|
-
* HTTP
|
|
666
|
-
* Java method: org.openremote.model.
|
|
780
|
+
* HTTP DELETE /realm/{name}
|
|
781
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
667
782
|
*/
|
|
668
|
-
|
|
783
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
669
784
|
/**
|
|
670
|
-
* HTTP
|
|
671
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* HTTP GET /realm/{name}
|
|
786
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
672
787
|
*/
|
|
673
|
-
|
|
788
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
674
789
|
/**
|
|
675
|
-
* HTTP
|
|
676
|
-
* Java method: org.openremote.model.
|
|
790
|
+
* HTTP PUT /realm/{name}
|
|
791
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
677
792
|
*/
|
|
678
|
-
|
|
793
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
679
794
|
}
|
|
680
|
-
export declare class
|
|
795
|
+
export declare class NotificationResourceClient<O> {
|
|
681
796
|
protected httpClient: HttpClient<O>;
|
|
682
797
|
constructor(httpClient: HttpClient<O>);
|
|
683
798
|
/**
|
|
684
|
-
* HTTP
|
|
685
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP GET /notification
|
|
800
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
686
801
|
*/
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
*/
|
|
697
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
698
|
-
/**
|
|
699
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
700
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
701
|
-
*/
|
|
702
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
703
|
-
/**
|
|
704
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
705
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
706
|
-
*/
|
|
707
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
708
|
-
}
|
|
709
|
-
export declare class AppResourceClient<O> {
|
|
710
|
-
protected httpClient: HttpClient<O>;
|
|
711
|
-
constructor(httpClient: HttpClient<O>);
|
|
712
|
-
/**
|
|
713
|
-
* HTTP GET /apps
|
|
714
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
715
|
-
*/
|
|
716
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
717
|
-
/**
|
|
718
|
-
* HTTP GET /apps/consoleConfig
|
|
719
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
720
|
-
*/
|
|
721
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
722
|
-
/**
|
|
723
|
-
* HTTP GET /apps/info
|
|
724
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
725
|
-
*/
|
|
726
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
727
|
-
}
|
|
728
|
-
export declare class AgentResourceClient<O> {
|
|
729
|
-
protected httpClient: HttpClient<O>;
|
|
730
|
-
constructor(httpClient: HttpClient<O>);
|
|
731
|
-
/**
|
|
732
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
733
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
734
|
-
*/
|
|
735
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
736
|
-
realm?: string;
|
|
737
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
738
|
-
/**
|
|
739
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
740
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
741
|
-
*/
|
|
742
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
743
|
-
realm?: string;
|
|
744
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
745
|
-
/**
|
|
746
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
747
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
748
|
-
*/
|
|
749
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
750
|
-
parentId?: string;
|
|
751
|
-
realm?: string;
|
|
752
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
753
|
-
}
|
|
754
|
-
export declare class SyslogResourceClient<O> {
|
|
755
|
-
protected httpClient: HttpClient<O>;
|
|
756
|
-
constructor(httpClient: HttpClient<O>);
|
|
757
|
-
/**
|
|
758
|
-
* HTTP GET /syslog/config
|
|
759
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
760
|
-
*/
|
|
761
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
762
|
-
/**
|
|
763
|
-
* HTTP PUT /syslog/config
|
|
764
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
765
|
-
*/
|
|
766
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
767
|
-
/**
|
|
768
|
-
* HTTP DELETE /syslog/event
|
|
769
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
770
|
-
*/
|
|
771
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
772
|
-
/**
|
|
773
|
-
* HTTP GET /syslog/event
|
|
774
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
775
|
-
*/
|
|
776
|
-
getEvents(queryParams?: {
|
|
777
|
-
level?: Model.SyslogLevel;
|
|
778
|
-
per_page?: number;
|
|
779
|
-
page?: number;
|
|
780
|
-
from?: number;
|
|
781
|
-
to?: number;
|
|
782
|
-
category?: Model.SyslogCategory[];
|
|
783
|
-
subCategory?: string[];
|
|
784
|
-
}, options?: O): RestResponse<any>;
|
|
785
|
-
}
|
|
786
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
787
|
-
protected httpClient: HttpClient<O>;
|
|
788
|
-
constructor(httpClient: HttpClient<O>);
|
|
789
|
-
/**
|
|
790
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
791
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
792
|
-
*/
|
|
793
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
794
|
-
/**
|
|
795
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
796
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
797
|
-
*/
|
|
798
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
799
|
-
}
|
|
800
|
-
export declare class ConfigurationResourceClient<O> {
|
|
801
|
-
protected httpClient: HttpClient<O>;
|
|
802
|
-
constructor(httpClient: HttpClient<O>);
|
|
803
|
-
/**
|
|
804
|
-
* HTTP GET /configuration/manager
|
|
805
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
806
|
-
*/
|
|
807
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
808
|
-
/**
|
|
809
|
-
* HTTP PUT /configuration/manager
|
|
810
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
811
|
-
*/
|
|
812
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
813
|
-
/**
|
|
814
|
-
* HTTP POST /configuration/manager/file
|
|
815
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
816
|
-
*/
|
|
817
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
818
|
-
path?: string;
|
|
819
|
-
}, options?: O): RestResponse<string>;
|
|
820
|
-
/**
|
|
821
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
822
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
823
|
-
*/
|
|
824
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
825
|
-
}
|
|
826
|
-
export declare class NotificationResourceClient<O> {
|
|
827
|
-
protected httpClient: HttpClient<O>;
|
|
828
|
-
constructor(httpClient: HttpClient<O>);
|
|
829
|
-
/**
|
|
830
|
-
* HTTP GET /notification
|
|
831
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
832
|
-
*/
|
|
833
|
-
getNotifications(queryParams?: {
|
|
834
|
-
id?: number;
|
|
835
|
-
type?: string;
|
|
836
|
-
from?: number;
|
|
837
|
-
to?: number;
|
|
838
|
-
realmId?: string;
|
|
839
|
-
userId?: string;
|
|
840
|
-
assetId?: string;
|
|
841
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
802
|
+
getNotifications(queryParams?: {
|
|
803
|
+
id?: number;
|
|
804
|
+
type?: string;
|
|
805
|
+
from?: number;
|
|
806
|
+
to?: number;
|
|
807
|
+
realmId?: string;
|
|
808
|
+
userId?: string;
|
|
809
|
+
assetId?: string;
|
|
810
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
842
811
|
/**
|
|
843
812
|
* HTTP DELETE /notification
|
|
844
813
|
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
@@ -877,140 +846,171 @@ export declare class NotificationResourceClient<O> {
|
|
|
877
846
|
targetId?: string;
|
|
878
847
|
}, options?: O): RestResponse<void>;
|
|
879
848
|
}
|
|
880
|
-
export declare class
|
|
849
|
+
export declare class AlarmResourceClient<O> {
|
|
881
850
|
protected httpClient: HttpClient<O>;
|
|
882
851
|
constructor(httpClient: HttpClient<O>);
|
|
883
852
|
/**
|
|
884
|
-
* HTTP POST /
|
|
885
|
-
* Java method: org.openremote.model.
|
|
853
|
+
* HTTP POST /alarm
|
|
854
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
886
855
|
*/
|
|
887
|
-
|
|
856
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
857
|
+
assetIds?: string[];
|
|
858
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
888
859
|
/**
|
|
889
|
-
* HTTP
|
|
890
|
-
* Java method: org.openremote.model.
|
|
860
|
+
* HTTP GET /alarm
|
|
861
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
891
862
|
*/
|
|
892
|
-
|
|
863
|
+
getAlarms(queryParams?: {
|
|
864
|
+
realm?: string;
|
|
865
|
+
status?: Model.AlarmStatus;
|
|
866
|
+
assetId?: string;
|
|
867
|
+
assigneeId?: string;
|
|
868
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
893
869
|
/**
|
|
894
|
-
* HTTP
|
|
895
|
-
* Java method: org.openremote.model.
|
|
870
|
+
* HTTP DELETE /alarm
|
|
871
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
896
872
|
*/
|
|
897
|
-
|
|
873
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
898
874
|
/**
|
|
899
|
-
* HTTP
|
|
900
|
-
* Java method: org.openremote.model.
|
|
875
|
+
* HTTP PUT /alarm/assets
|
|
876
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
901
877
|
*/
|
|
902
|
-
|
|
878
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
903
879
|
/**
|
|
904
|
-
* HTTP
|
|
905
|
-
* Java method: org.openremote.model.
|
|
880
|
+
* HTTP GET /alarm/{alarmId}
|
|
881
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
906
882
|
*/
|
|
907
|
-
|
|
883
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
908
884
|
/**
|
|
909
|
-
* HTTP
|
|
910
|
-
* Java method: org.openremote.model.
|
|
885
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
886
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
911
887
|
*/
|
|
912
|
-
|
|
888
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
889
|
+
/**
|
|
890
|
+
* HTTP PUT /alarm/{alarmId}
|
|
891
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
892
|
+
*/
|
|
893
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
894
|
+
/**
|
|
895
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
896
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
897
|
+
*/
|
|
898
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
899
|
+
realm?: string;
|
|
900
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
913
901
|
}
|
|
914
|
-
export declare class
|
|
902
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
915
903
|
protected httpClient: HttpClient<O>;
|
|
916
904
|
constructor(httpClient: HttpClient<O>);
|
|
917
905
|
/**
|
|
918
|
-
* HTTP
|
|
919
|
-
* Java method: org.openremote.model.
|
|
906
|
+
* HTTP POST /gateway/tunnel
|
|
907
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
920
908
|
*/
|
|
921
|
-
|
|
922
|
-
parentId?: string;
|
|
923
|
-
parentType?: string;
|
|
924
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
909
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
925
910
|
/**
|
|
926
|
-
* HTTP
|
|
927
|
-
* Java method: org.openremote.model.
|
|
911
|
+
* HTTP DELETE /gateway/tunnel
|
|
912
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
928
913
|
*/
|
|
929
|
-
|
|
930
|
-
parentId?: string;
|
|
931
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
914
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
932
915
|
/**
|
|
933
|
-
* HTTP GET /
|
|
934
|
-
* Java method: org.openremote.model.
|
|
916
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
917
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
935
918
|
*/
|
|
936
|
-
|
|
937
|
-
parentId?: string;
|
|
938
|
-
parentType?: string;
|
|
939
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
919
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
940
920
|
/**
|
|
941
|
-
* HTTP GET /
|
|
942
|
-
* Java method: org.openremote.model.
|
|
921
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
922
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
943
923
|
*/
|
|
944
|
-
|
|
945
|
-
name?: string;
|
|
946
|
-
hash?: string;
|
|
947
|
-
}, options?: O): RestResponse<any>;
|
|
924
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
948
925
|
/**
|
|
949
|
-
* HTTP GET /
|
|
950
|
-
* Java method: org.openremote.model.
|
|
926
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
927
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
951
928
|
*/
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
929
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
930
|
+
}
|
|
931
|
+
export declare class GatewayClientResourceClient<O> {
|
|
932
|
+
protected httpClient: HttpClient<O>;
|
|
933
|
+
constructor(httpClient: HttpClient<O>);
|
|
957
934
|
/**
|
|
958
|
-
* HTTP
|
|
959
|
-
* Java method: org.openremote.model.
|
|
935
|
+
* HTTP DELETE /gateway/connection
|
|
936
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
960
937
|
*/
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
}, options?: O): RestResponse<
|
|
964
|
-
|
|
965
|
-
|
|
938
|
+
deleteConnections(queryParams?: {
|
|
939
|
+
realm?: string[];
|
|
940
|
+
}, options?: O): RestResponse<void>;
|
|
941
|
+
/**
|
|
942
|
+
* HTTP GET /gateway/connection
|
|
943
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
944
|
+
*/
|
|
945
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
946
|
+
/**
|
|
947
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
948
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
949
|
+
*/
|
|
950
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
951
|
+
/**
|
|
952
|
+
* HTTP GET /gateway/connection/{realm}
|
|
953
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
954
|
+
*/
|
|
955
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
956
|
+
/**
|
|
957
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
958
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
959
|
+
*/
|
|
960
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
961
|
+
/**
|
|
962
|
+
* HTTP GET /gateway/status/{realm}
|
|
963
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
964
|
+
*/
|
|
965
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
-
protected
|
|
970
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
971
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
972
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
973
|
-
protected _userResource: AxiosUserResourceClient;
|
|
974
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
975
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
976
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
977
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
969
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
978
970
|
protected _statusResource: AxiosStatusResourceClient;
|
|
979
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
980
971
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
981
|
-
protected
|
|
982
|
-
protected
|
|
972
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
973
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
983
974
|
protected _appResource: AxiosAppResourceClient;
|
|
975
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
976
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
977
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
978
|
+
protected _userResource: AxiosUserResourceClient;
|
|
979
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
984
980
|
protected _agentResource: AxiosAgentResourceClient;
|
|
985
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
986
981
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
987
|
-
protected
|
|
982
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
983
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
984
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
985
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
986
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
988
987
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
989
|
-
protected
|
|
990
|
-
protected
|
|
988
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
989
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
990
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
get
|
|
993
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
994
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
995
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
996
|
-
get UserResource(): AxiosUserResourceClient;
|
|
997
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
998
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
999
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1000
|
-
get MapResource(): AxiosMapResourceClient;
|
|
992
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1001
993
|
get StatusResource(): AxiosStatusResourceClient;
|
|
1002
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1003
994
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1004
|
-
get
|
|
1005
|
-
get
|
|
995
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
996
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1006
997
|
get AppResource(): AxiosAppResourceClient;
|
|
998
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
999
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1000
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1001
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1002
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1007
1003
|
get AgentResource(): AxiosAgentResourceClient;
|
|
1008
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1009
1004
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1010
|
-
get
|
|
1005
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1006
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1007
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1008
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1009
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1011
1010
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1012
|
-
get
|
|
1013
|
-
get
|
|
1011
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1012
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1013
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1018,70 +1018,70 @@ declare module "axios" {
|
|
|
1018
1018
|
data: R;
|
|
1019
1019
|
}
|
|
1020
1020
|
}
|
|
1021
|
-
export declare class
|
|
1021
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
|
-
export declare class
|
|
1027
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
1030
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1034
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
|
-
}
|
|
1036
|
-
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1033
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1035
|
}
|
|
1039
|
-
export declare class
|
|
1036
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1038
|
}
|
|
1042
|
-
export declare class
|
|
1039
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1041
|
}
|
|
1045
1042
|
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1044
|
}
|
|
1048
|
-
export declare class
|
|
1045
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1047
|
}
|
|
1051
|
-
export declare class
|
|
1048
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1050
|
}
|
|
1054
|
-
export declare class
|
|
1051
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1053
|
}
|
|
1057
|
-
export declare class
|
|
1054
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1056
|
}
|
|
1060
|
-
export declare class
|
|
1057
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1059
|
}
|
|
1063
|
-
export declare class
|
|
1060
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1062
|
}
|
|
1066
|
-
export declare class
|
|
1063
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1065
|
}
|
|
1069
|
-
export declare class
|
|
1066
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1068
|
}
|
|
1072
|
-
export declare class
|
|
1069
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1071
|
}
|
|
1075
|
-
export declare class
|
|
1072
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1074
|
}
|
|
1078
1075
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1077
|
}
|
|
1081
|
-
export declare class
|
|
1078
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1080
|
}
|
|
1084
|
-
export declare class
|
|
1081
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
|
+
}
|
|
1084
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|
|
1087
1087
|
//# sourceMappingURL=restclient.d.ts.map
|