@openremote/rest 1.6.0-snapshot.20250516214447 → 1.6.0-snapshot.20250519123755
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +467 -467
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,158 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class AssetModelResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /model/assetDescriptors
|
|
17
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
18
|
-
*/
|
|
19
|
-
getAssetDescriptors(queryParams?: {
|
|
20
|
-
parentId?: string;
|
|
21
|
-
parentType?: string;
|
|
22
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
23
|
-
/**
|
|
24
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
25
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
26
|
-
*/
|
|
27
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
28
|
-
parentId?: string;
|
|
29
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
30
|
-
/**
|
|
31
|
-
* HTTP GET /model/assetInfos
|
|
32
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
33
|
-
*/
|
|
34
|
-
getAssetInfos(queryParams?: {
|
|
35
|
-
parentId?: string;
|
|
36
|
-
parentType?: string;
|
|
37
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
38
|
-
/**
|
|
39
|
-
* HTTP GET /model/metaItemDescriptors
|
|
40
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
41
|
-
*/
|
|
42
|
-
getMetaItemDescriptors(queryParams?: {
|
|
43
|
-
parentId?: string;
|
|
44
|
-
}, options?: O): RestResponse<{
|
|
45
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
46
|
-
}>;
|
|
47
|
-
/**
|
|
48
|
-
* HTTP GET /model/valueDescriptors
|
|
49
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
50
|
-
*/
|
|
51
|
-
getValueDescriptors(queryParams?: {
|
|
52
|
-
parentId?: string;
|
|
53
|
-
}, options?: O): RestResponse<{
|
|
54
|
-
[index: string]: Model.ValueDescriptor;
|
|
55
|
-
}>;
|
|
56
|
-
}
|
|
57
|
-
export declare class StatusResourceClient<O> {
|
|
58
|
-
protected httpClient: HttpClient<O>;
|
|
59
|
-
constructor(httpClient: HttpClient<O>);
|
|
60
|
-
/**
|
|
61
|
-
* HTTP GET /health
|
|
62
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
63
|
-
*/
|
|
64
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
65
|
-
[index: string]: any;
|
|
66
|
-
}>;
|
|
67
|
-
/**
|
|
68
|
-
* HTTP GET /info
|
|
69
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
70
|
-
*/
|
|
71
|
-
getInfo(options?: O): RestResponse<{
|
|
72
|
-
[index: string]: any;
|
|
73
|
-
}>;
|
|
74
|
-
}
|
|
75
|
-
export declare class MapResourceClient<O> {
|
|
76
|
-
protected httpClient: HttpClient<O>;
|
|
77
|
-
constructor(httpClient: HttpClient<O>);
|
|
78
|
-
/**
|
|
79
|
-
* HTTP GET /map
|
|
80
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
81
|
-
*/
|
|
82
|
-
getSettings(options?: O): RestResponse<{
|
|
83
|
-
[id: string]: unknown;
|
|
84
|
-
}>;
|
|
85
|
-
/**
|
|
86
|
-
* HTTP PUT /map
|
|
87
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
88
|
-
*/
|
|
89
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
90
|
-
[id: string]: unknown;
|
|
91
|
-
}>;
|
|
92
|
-
/**
|
|
93
|
-
* HTTP DELETE /map/deleteMap
|
|
94
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
95
|
-
*/
|
|
96
|
-
deleteMap(options?: O): RestResponse<{
|
|
97
|
-
[id: string]: unknown;
|
|
98
|
-
}>;
|
|
99
|
-
/**
|
|
100
|
-
* HTTP GET /map/getCustomMapInfo
|
|
101
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
102
|
-
*/
|
|
103
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
104
|
-
[id: string]: unknown;
|
|
105
|
-
}>;
|
|
106
|
-
/**
|
|
107
|
-
* HTTP GET /map/js
|
|
108
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
109
|
-
*/
|
|
110
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
111
|
-
[id: string]: unknown;
|
|
112
|
-
}>;
|
|
113
|
-
/**
|
|
114
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
115
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
116
|
-
*/
|
|
117
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
118
|
-
/**
|
|
119
|
-
* HTTP POST /map/upload
|
|
120
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
121
|
-
*/
|
|
122
|
-
uploadMap(queryParams?: {
|
|
123
|
-
filename?: string;
|
|
124
|
-
}, options?: O): RestResponse<{
|
|
125
|
-
[id: string]: unknown;
|
|
126
|
-
}>;
|
|
127
|
-
}
|
|
128
|
-
export declare class GatewayClientResourceClient<O> {
|
|
129
|
-
protected httpClient: HttpClient<O>;
|
|
130
|
-
constructor(httpClient: HttpClient<O>);
|
|
131
|
-
/**
|
|
132
|
-
* HTTP DELETE /gateway/connection
|
|
133
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
134
|
-
*/
|
|
135
|
-
deleteConnections(queryParams?: {
|
|
136
|
-
realm?: string[];
|
|
137
|
-
}, options?: O): RestResponse<void>;
|
|
138
|
-
/**
|
|
139
|
-
* HTTP GET /gateway/connection
|
|
140
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
141
|
-
*/
|
|
142
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
143
|
-
/**
|
|
144
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
145
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
146
|
-
*/
|
|
147
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
148
|
-
/**
|
|
149
|
-
* HTTP GET /gateway/connection/{realm}
|
|
150
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
151
|
-
*/
|
|
152
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
153
|
-
/**
|
|
154
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
155
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
156
|
-
*/
|
|
157
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
158
|
-
/**
|
|
159
|
-
* HTTP GET /gateway/status/{realm}
|
|
160
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
161
|
-
*/
|
|
162
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
163
|
-
}
|
|
164
12
|
export declare class UserResourceClient<O> {
|
|
165
13
|
protected httpClient: HttpClient<O>;
|
|
166
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -265,110 +113,6 @@ export declare class UserResourceClient<O> {
|
|
|
265
113
|
*/
|
|
266
114
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
267
115
|
}
|
|
268
|
-
export declare class NotificationResourceClient<O> {
|
|
269
|
-
protected httpClient: HttpClient<O>;
|
|
270
|
-
constructor(httpClient: HttpClient<O>);
|
|
271
|
-
/**
|
|
272
|
-
* HTTP GET /notification
|
|
273
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
274
|
-
*/
|
|
275
|
-
getNotifications(queryParams?: {
|
|
276
|
-
id?: number;
|
|
277
|
-
type?: string;
|
|
278
|
-
from?: number;
|
|
279
|
-
to?: number;
|
|
280
|
-
realmId?: string;
|
|
281
|
-
userId?: string;
|
|
282
|
-
assetId?: string;
|
|
283
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
284
|
-
/**
|
|
285
|
-
* HTTP DELETE /notification
|
|
286
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
287
|
-
*/
|
|
288
|
-
removeNotifications(queryParams?: {
|
|
289
|
-
id?: number;
|
|
290
|
-
type?: string;
|
|
291
|
-
from?: number;
|
|
292
|
-
to?: number;
|
|
293
|
-
realmId?: string;
|
|
294
|
-
userId?: string;
|
|
295
|
-
assetId?: string;
|
|
296
|
-
}, options?: O): RestResponse<void>;
|
|
297
|
-
/**
|
|
298
|
-
* HTTP POST /notification/alert
|
|
299
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
300
|
-
*/
|
|
301
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
302
|
-
/**
|
|
303
|
-
* HTTP DELETE /notification/{notificationId}
|
|
304
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
305
|
-
*/
|
|
306
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
307
|
-
/**
|
|
308
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
309
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
310
|
-
*/
|
|
311
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
312
|
-
targetId?: string;
|
|
313
|
-
}, options?: O): RestResponse<void>;
|
|
314
|
-
/**
|
|
315
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
316
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
317
|
-
*/
|
|
318
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
319
|
-
targetId?: string;
|
|
320
|
-
}, options?: O): RestResponse<void>;
|
|
321
|
-
}
|
|
322
|
-
export declare class ConfigurationResourceClient<O> {
|
|
323
|
-
protected httpClient: HttpClient<O>;
|
|
324
|
-
constructor(httpClient: HttpClient<O>);
|
|
325
|
-
/**
|
|
326
|
-
* HTTP GET /configuration/manager
|
|
327
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
328
|
-
*/
|
|
329
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
330
|
-
/**
|
|
331
|
-
* HTTP PUT /configuration/manager
|
|
332
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
333
|
-
*/
|
|
334
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
335
|
-
/**
|
|
336
|
-
* HTTP POST /configuration/manager/file
|
|
337
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
338
|
-
*/
|
|
339
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
340
|
-
path?: string;
|
|
341
|
-
}, options?: O): RestResponse<string>;
|
|
342
|
-
/**
|
|
343
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
344
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
345
|
-
*/
|
|
346
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
347
|
-
}
|
|
348
|
-
export declare class ProvisioningResourceClient<O> {
|
|
349
|
-
protected httpClient: HttpClient<O>;
|
|
350
|
-
constructor(httpClient: HttpClient<O>);
|
|
351
|
-
/**
|
|
352
|
-
* HTTP POST /provisioning
|
|
353
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
354
|
-
*/
|
|
355
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
356
|
-
/**
|
|
357
|
-
* HTTP GET /provisioning
|
|
358
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
359
|
-
*/
|
|
360
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
361
|
-
/**
|
|
362
|
-
* HTTP DELETE /provisioning/{id}
|
|
363
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
364
|
-
*/
|
|
365
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
366
|
-
/**
|
|
367
|
-
* HTTP PUT /provisioning/{id}
|
|
368
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
369
|
-
*/
|
|
370
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
371
|
-
}
|
|
372
116
|
export declare class AssetDatapointResourceClient<O> {
|
|
373
117
|
protected httpClient: HttpClient<O>;
|
|
374
118
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -429,57 +173,6 @@ export declare class DashboardResourceClient<O> {
|
|
|
429
173
|
*/
|
|
430
174
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
431
175
|
}
|
|
432
|
-
export declare class SyslogResourceClient<O> {
|
|
433
|
-
protected httpClient: HttpClient<O>;
|
|
434
|
-
constructor(httpClient: HttpClient<O>);
|
|
435
|
-
/**
|
|
436
|
-
* HTTP GET /syslog/config
|
|
437
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
438
|
-
*/
|
|
439
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
440
|
-
/**
|
|
441
|
-
* HTTP PUT /syslog/config
|
|
442
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
443
|
-
*/
|
|
444
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
445
|
-
/**
|
|
446
|
-
* HTTP DELETE /syslog/event
|
|
447
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
448
|
-
*/
|
|
449
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
450
|
-
/**
|
|
451
|
-
* HTTP GET /syslog/event
|
|
452
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
453
|
-
*/
|
|
454
|
-
getEvents(queryParams?: {
|
|
455
|
-
level?: Model.SyslogLevel;
|
|
456
|
-
per_page?: number;
|
|
457
|
-
page?: number;
|
|
458
|
-
from?: number;
|
|
459
|
-
to?: number;
|
|
460
|
-
category?: Model.SyslogCategory[];
|
|
461
|
-
subCategory?: string[];
|
|
462
|
-
}, options?: O): RestResponse<any>;
|
|
463
|
-
}
|
|
464
|
-
export declare class FlowResourceClient<O> {
|
|
465
|
-
protected httpClient: HttpClient<O>;
|
|
466
|
-
constructor(httpClient: HttpClient<O>);
|
|
467
|
-
/**
|
|
468
|
-
* HTTP GET /flow
|
|
469
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
470
|
-
*/
|
|
471
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
472
|
-
/**
|
|
473
|
-
* HTTP GET /flow/{name}
|
|
474
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
475
|
-
*/
|
|
476
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
477
|
-
/**
|
|
478
|
-
* HTTP GET /flow/{type}
|
|
479
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
480
|
-
*/
|
|
481
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
482
|
-
}
|
|
483
176
|
export declare class GatewayServiceResourceClient<O> {
|
|
484
177
|
protected httpClient: HttpClient<O>;
|
|
485
178
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -509,68 +202,6 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
509
202
|
*/
|
|
510
203
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
511
204
|
}
|
|
512
|
-
export declare class ConsoleResourceClient<O> {
|
|
513
|
-
protected httpClient: HttpClient<O>;
|
|
514
|
-
constructor(httpClient: HttpClient<O>);
|
|
515
|
-
/**
|
|
516
|
-
* HTTP POST /console/register
|
|
517
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
518
|
-
*/
|
|
519
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
520
|
-
}
|
|
521
|
-
export declare class AlarmResourceClient<O> {
|
|
522
|
-
protected httpClient: HttpClient<O>;
|
|
523
|
-
constructor(httpClient: HttpClient<O>);
|
|
524
|
-
/**
|
|
525
|
-
* HTTP POST /alarm
|
|
526
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
527
|
-
*/
|
|
528
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
529
|
-
assetIds?: string[];
|
|
530
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
531
|
-
/**
|
|
532
|
-
* HTTP GET /alarm
|
|
533
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
534
|
-
*/
|
|
535
|
-
getAlarms(queryParams?: {
|
|
536
|
-
realm?: string;
|
|
537
|
-
status?: Model.AlarmStatus;
|
|
538
|
-
assetId?: string;
|
|
539
|
-
assigneeId?: string;
|
|
540
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
541
|
-
/**
|
|
542
|
-
* HTTP DELETE /alarm
|
|
543
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
544
|
-
*/
|
|
545
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
546
|
-
/**
|
|
547
|
-
* HTTP PUT /alarm/assets
|
|
548
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
549
|
-
*/
|
|
550
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
551
|
-
/**
|
|
552
|
-
* HTTP GET /alarm/{alarmId}
|
|
553
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
554
|
-
*/
|
|
555
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
556
|
-
/**
|
|
557
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
558
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
559
|
-
*/
|
|
560
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
561
|
-
/**
|
|
562
|
-
* HTTP PUT /alarm/{alarmId}
|
|
563
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
564
|
-
*/
|
|
565
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
566
|
-
/**
|
|
567
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
568
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
569
|
-
*/
|
|
570
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
571
|
-
realm?: string;
|
|
572
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
573
|
-
}
|
|
574
205
|
export declare class AppResourceClient<O> {
|
|
575
206
|
protected httpClient: HttpClient<O>;
|
|
576
207
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -590,6 +221,32 @@ export declare class AppResourceClient<O> {
|
|
|
590
221
|
*/
|
|
591
222
|
getAppInfos(options?: O): RestResponse<any>;
|
|
592
223
|
}
|
|
224
|
+
export declare class ConfigurationResourceClient<O> {
|
|
225
|
+
protected httpClient: HttpClient<O>;
|
|
226
|
+
constructor(httpClient: HttpClient<O>);
|
|
227
|
+
/**
|
|
228
|
+
* HTTP GET /configuration/manager
|
|
229
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
230
|
+
*/
|
|
231
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
232
|
+
/**
|
|
233
|
+
* HTTP PUT /configuration/manager
|
|
234
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
235
|
+
*/
|
|
236
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
237
|
+
/**
|
|
238
|
+
* HTTP POST /configuration/manager/file
|
|
239
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
240
|
+
*/
|
|
241
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
242
|
+
path?: string;
|
|
243
|
+
}, options?: O): RestResponse<string>;
|
|
244
|
+
/**
|
|
245
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
246
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
247
|
+
*/
|
|
248
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
249
|
+
}
|
|
593
250
|
export declare class RulesResourceClient<O> {
|
|
594
251
|
protected httpClient: HttpClient<O>;
|
|
595
252
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -698,65 +355,82 @@ export declare class RulesResourceClient<O> {
|
|
|
698
355
|
*/
|
|
699
356
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
700
357
|
}
|
|
701
|
-
export declare class
|
|
358
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
702
359
|
protected httpClient: HttpClient<O>;
|
|
703
360
|
constructor(httpClient: HttpClient<O>);
|
|
704
361
|
/**
|
|
705
|
-
* HTTP POST /
|
|
706
|
-
* Java method: org.openremote.model.
|
|
362
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
363
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
707
364
|
*/
|
|
708
|
-
|
|
365
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
709
366
|
/**
|
|
710
|
-
* HTTP
|
|
711
|
-
* Java method: org.openremote.model.
|
|
367
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
368
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
712
369
|
*/
|
|
713
|
-
|
|
370
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
371
|
+
}
|
|
372
|
+
export declare class StatusResourceClient<O> {
|
|
373
|
+
protected httpClient: HttpClient<O>;
|
|
374
|
+
constructor(httpClient: HttpClient<O>);
|
|
714
375
|
/**
|
|
715
|
-
* HTTP GET /
|
|
716
|
-
* Java method: org.openremote.model.
|
|
376
|
+
* HTTP GET /health
|
|
377
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
717
378
|
*/
|
|
718
|
-
|
|
379
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
380
|
+
[index: string]: any;
|
|
381
|
+
}>;
|
|
719
382
|
/**
|
|
720
|
-
* HTTP
|
|
721
|
-
* Java method: org.openremote.model.
|
|
383
|
+
* HTTP GET /info
|
|
384
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
722
385
|
*/
|
|
723
|
-
|
|
386
|
+
getInfo(options?: O): RestResponse<{
|
|
387
|
+
[index: string]: any;
|
|
388
|
+
}>;
|
|
389
|
+
}
|
|
390
|
+
export declare class GatewayClientResourceClient<O> {
|
|
391
|
+
protected httpClient: HttpClient<O>;
|
|
392
|
+
constructor(httpClient: HttpClient<O>);
|
|
724
393
|
/**
|
|
725
|
-
* HTTP
|
|
726
|
-
* Java method: org.openremote.model.
|
|
394
|
+
* HTTP DELETE /gateway/connection
|
|
395
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
727
396
|
*/
|
|
728
|
-
|
|
397
|
+
deleteConnections(queryParams?: {
|
|
398
|
+
realm?: string[];
|
|
399
|
+
}, options?: O): RestResponse<void>;
|
|
729
400
|
/**
|
|
730
|
-
* HTTP
|
|
731
|
-
* Java method: org.openremote.model.
|
|
401
|
+
* HTTP GET /gateway/connection
|
|
402
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
732
403
|
*/
|
|
733
|
-
|
|
734
|
-
}
|
|
735
|
-
export declare class AgentResourceClient<O> {
|
|
736
|
-
protected httpClient: HttpClient<O>;
|
|
737
|
-
constructor(httpClient: HttpClient<O>);
|
|
404
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
738
405
|
/**
|
|
739
|
-
* HTTP
|
|
740
|
-
* Java method: org.openremote.model.
|
|
406
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
407
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
741
408
|
*/
|
|
742
|
-
|
|
743
|
-
realm?: string;
|
|
744
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
409
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
745
410
|
/**
|
|
746
|
-
* HTTP
|
|
747
|
-
* Java method: org.openremote.model.
|
|
411
|
+
* HTTP GET /gateway/connection/{realm}
|
|
412
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
748
413
|
*/
|
|
749
|
-
|
|
750
|
-
realm?: string;
|
|
751
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
414
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
752
415
|
/**
|
|
753
|
-
* HTTP
|
|
754
|
-
* Java method: org.openremote.model.
|
|
416
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
417
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
755
418
|
*/
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
419
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
420
|
+
/**
|
|
421
|
+
* HTTP GET /gateway/status/{realm}
|
|
422
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
423
|
+
*/
|
|
424
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
425
|
+
}
|
|
426
|
+
export declare class ConsoleResourceClient<O> {
|
|
427
|
+
protected httpClient: HttpClient<O>;
|
|
428
|
+
constructor(httpClient: HttpClient<O>);
|
|
429
|
+
/**
|
|
430
|
+
* HTTP POST /console/register
|
|
431
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
432
|
+
*/
|
|
433
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
760
434
|
}
|
|
761
435
|
export declare class AssetResourceClient<O> {
|
|
762
436
|
protected httpClient: HttpClient<O>;
|
|
@@ -862,65 +536,391 @@ export declare class AssetResourceClient<O> {
|
|
|
862
536
|
assetIds?: string[];
|
|
863
537
|
}, options?: O): RestResponse<void>;
|
|
864
538
|
}
|
|
865
|
-
export declare class
|
|
539
|
+
export declare class AgentResourceClient<O> {
|
|
866
540
|
protected httpClient: HttpClient<O>;
|
|
867
541
|
constructor(httpClient: HttpClient<O>);
|
|
868
542
|
/**
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
543
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
544
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
871
545
|
*/
|
|
872
|
-
|
|
546
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
547
|
+
realm?: string;
|
|
548
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
873
549
|
/**
|
|
874
|
-
* HTTP
|
|
875
|
-
* Java method: org.openremote.model.
|
|
550
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
551
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
876
552
|
*/
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
553
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
554
|
+
realm?: string;
|
|
555
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
556
|
+
/**
|
|
557
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
558
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
559
|
+
*/
|
|
560
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
561
|
+
parentId?: string;
|
|
562
|
+
realm?: string;
|
|
563
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
564
|
+
}
|
|
565
|
+
export declare class AssetModelResourceClient<O> {
|
|
566
|
+
protected httpClient: HttpClient<O>;
|
|
567
|
+
constructor(httpClient: HttpClient<O>);
|
|
568
|
+
/**
|
|
569
|
+
* HTTP GET /model/assetDescriptors
|
|
570
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
571
|
+
*/
|
|
572
|
+
getAssetDescriptors(queryParams?: {
|
|
573
|
+
parentId?: string;
|
|
574
|
+
parentType?: string;
|
|
575
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
576
|
+
/**
|
|
577
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
578
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
579
|
+
*/
|
|
580
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
581
|
+
parentId?: string;
|
|
582
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
583
|
+
/**
|
|
584
|
+
* HTTP GET /model/assetInfos
|
|
585
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
586
|
+
*/
|
|
587
|
+
getAssetInfos(queryParams?: {
|
|
588
|
+
parentId?: string;
|
|
589
|
+
parentType?: string;
|
|
590
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
591
|
+
/**
|
|
592
|
+
* HTTP GET /model/metaItemDescriptors
|
|
593
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
594
|
+
*/
|
|
595
|
+
getMetaItemDescriptors(queryParams?: {
|
|
596
|
+
parentId?: string;
|
|
597
|
+
}, options?: O): RestResponse<{
|
|
598
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
599
|
+
}>;
|
|
600
|
+
/**
|
|
601
|
+
* HTTP GET /model/valueDescriptors
|
|
602
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
603
|
+
*/
|
|
604
|
+
getValueDescriptors(queryParams?: {
|
|
605
|
+
parentId?: string;
|
|
606
|
+
}, options?: O): RestResponse<{
|
|
607
|
+
[index: string]: Model.ValueDescriptor;
|
|
608
|
+
}>;
|
|
609
|
+
}
|
|
610
|
+
export declare class ProvisioningResourceClient<O> {
|
|
611
|
+
protected httpClient: HttpClient<O>;
|
|
612
|
+
constructor(httpClient: HttpClient<O>);
|
|
613
|
+
/**
|
|
614
|
+
* HTTP POST /provisioning
|
|
615
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
616
|
+
*/
|
|
617
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
618
|
+
/**
|
|
619
|
+
* HTTP GET /provisioning
|
|
620
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
621
|
+
*/
|
|
622
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
623
|
+
/**
|
|
624
|
+
* HTTP DELETE /provisioning/{id}
|
|
625
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
626
|
+
*/
|
|
627
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
628
|
+
/**
|
|
629
|
+
* HTTP PUT /provisioning/{id}
|
|
630
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
631
|
+
*/
|
|
632
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
633
|
+
}
|
|
634
|
+
export declare class SyslogResourceClient<O> {
|
|
635
|
+
protected httpClient: HttpClient<O>;
|
|
636
|
+
constructor(httpClient: HttpClient<O>);
|
|
637
|
+
/**
|
|
638
|
+
* HTTP GET /syslog/config
|
|
639
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
640
|
+
*/
|
|
641
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
642
|
+
/**
|
|
643
|
+
* HTTP PUT /syslog/config
|
|
644
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
645
|
+
*/
|
|
646
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
647
|
+
/**
|
|
648
|
+
* HTTP DELETE /syslog/event
|
|
649
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
650
|
+
*/
|
|
651
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
652
|
+
/**
|
|
653
|
+
* HTTP GET /syslog/event
|
|
654
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
655
|
+
*/
|
|
656
|
+
getEvents(queryParams?: {
|
|
657
|
+
level?: Model.SyslogLevel;
|
|
658
|
+
per_page?: number;
|
|
659
|
+
page?: number;
|
|
660
|
+
from?: number;
|
|
661
|
+
to?: number;
|
|
662
|
+
category?: Model.SyslogCategory[];
|
|
663
|
+
subCategory?: string[];
|
|
664
|
+
}, options?: O): RestResponse<any>;
|
|
665
|
+
}
|
|
666
|
+
export declare class FlowResourceClient<O> {
|
|
667
|
+
protected httpClient: HttpClient<O>;
|
|
668
|
+
constructor(httpClient: HttpClient<O>);
|
|
669
|
+
/**
|
|
670
|
+
* HTTP GET /flow
|
|
671
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
672
|
+
*/
|
|
673
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
674
|
+
/**
|
|
675
|
+
* HTTP GET /flow/{name}
|
|
676
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
677
|
+
*/
|
|
678
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
679
|
+
/**
|
|
680
|
+
* HTTP GET /flow/{type}
|
|
681
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
682
|
+
*/
|
|
683
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
684
|
+
}
|
|
685
|
+
export declare class MapResourceClient<O> {
|
|
686
|
+
protected httpClient: HttpClient<O>;
|
|
687
|
+
constructor(httpClient: HttpClient<O>);
|
|
688
|
+
/**
|
|
689
|
+
* HTTP GET /map
|
|
690
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
691
|
+
*/
|
|
692
|
+
getSettings(options?: O): RestResponse<{
|
|
693
|
+
[id: string]: unknown;
|
|
694
|
+
}>;
|
|
695
|
+
/**
|
|
696
|
+
* HTTP PUT /map
|
|
697
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
698
|
+
*/
|
|
699
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
700
|
+
[id: string]: unknown;
|
|
701
|
+
}>;
|
|
702
|
+
/**
|
|
703
|
+
* HTTP DELETE /map/deleteMap
|
|
704
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
705
|
+
*/
|
|
706
|
+
deleteMap(options?: O): RestResponse<{
|
|
707
|
+
[id: string]: unknown;
|
|
708
|
+
}>;
|
|
709
|
+
/**
|
|
710
|
+
* HTTP GET /map/getCustomMapInfo
|
|
711
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
712
|
+
*/
|
|
713
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
714
|
+
[id: string]: unknown;
|
|
715
|
+
}>;
|
|
716
|
+
/**
|
|
717
|
+
* HTTP GET /map/js
|
|
718
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
719
|
+
*/
|
|
720
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
721
|
+
[id: string]: unknown;
|
|
722
|
+
}>;
|
|
723
|
+
/**
|
|
724
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
725
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
726
|
+
*/
|
|
727
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
728
|
+
/**
|
|
729
|
+
* HTTP POST /map/upload
|
|
730
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
731
|
+
*/
|
|
732
|
+
uploadMap(queryParams?: {
|
|
733
|
+
filename?: string;
|
|
734
|
+
}, options?: O): RestResponse<{
|
|
735
|
+
[id: string]: unknown;
|
|
736
|
+
}>;
|
|
737
|
+
}
|
|
738
|
+
export declare class RealmResourceClient<O> {
|
|
739
|
+
protected httpClient: HttpClient<O>;
|
|
740
|
+
constructor(httpClient: HttpClient<O>);
|
|
741
|
+
/**
|
|
742
|
+
* HTTP POST /realm
|
|
743
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
744
|
+
*/
|
|
745
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
746
|
+
/**
|
|
747
|
+
* HTTP GET /realm
|
|
748
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
749
|
+
*/
|
|
750
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
751
|
+
/**
|
|
752
|
+
* HTTP GET /realm/accessible
|
|
753
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
754
|
+
*/
|
|
755
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
756
|
+
/**
|
|
757
|
+
* HTTP DELETE /realm/{name}
|
|
758
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
759
|
+
*/
|
|
760
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
761
|
+
/**
|
|
762
|
+
* HTTP GET /realm/{name}
|
|
763
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
764
|
+
*/
|
|
765
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
766
|
+
/**
|
|
767
|
+
* HTTP PUT /realm/{name}
|
|
768
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
769
|
+
*/
|
|
770
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
771
|
+
}
|
|
772
|
+
export declare class NotificationResourceClient<O> {
|
|
773
|
+
protected httpClient: HttpClient<O>;
|
|
774
|
+
constructor(httpClient: HttpClient<O>);
|
|
775
|
+
/**
|
|
776
|
+
* HTTP GET /notification
|
|
777
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
778
|
+
*/
|
|
779
|
+
getNotifications(queryParams?: {
|
|
780
|
+
id?: number;
|
|
781
|
+
type?: string;
|
|
782
|
+
from?: number;
|
|
783
|
+
to?: number;
|
|
784
|
+
realmId?: string;
|
|
785
|
+
userId?: string;
|
|
786
|
+
assetId?: string;
|
|
787
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
788
|
+
/**
|
|
789
|
+
* HTTP DELETE /notification
|
|
790
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
791
|
+
*/
|
|
792
|
+
removeNotifications(queryParams?: {
|
|
793
|
+
id?: number;
|
|
794
|
+
type?: string;
|
|
795
|
+
from?: number;
|
|
796
|
+
to?: number;
|
|
797
|
+
realmId?: string;
|
|
798
|
+
userId?: string;
|
|
799
|
+
assetId?: string;
|
|
800
|
+
}, options?: O): RestResponse<void>;
|
|
801
|
+
/**
|
|
802
|
+
* HTTP POST /notification/alert
|
|
803
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
804
|
+
*/
|
|
805
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
806
|
+
/**
|
|
807
|
+
* HTTP DELETE /notification/{notificationId}
|
|
808
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
809
|
+
*/
|
|
810
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
811
|
+
/**
|
|
812
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
813
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
814
|
+
*/
|
|
815
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
816
|
+
targetId?: string;
|
|
817
|
+
}, options?: O): RestResponse<void>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
820
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
821
|
+
*/
|
|
822
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
823
|
+
targetId?: string;
|
|
824
|
+
}, options?: O): RestResponse<void>;
|
|
825
|
+
}
|
|
826
|
+
export declare class AlarmResourceClient<O> {
|
|
827
|
+
protected httpClient: HttpClient<O>;
|
|
828
|
+
constructor(httpClient: HttpClient<O>);
|
|
829
|
+
/**
|
|
830
|
+
* HTTP POST /alarm
|
|
831
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
832
|
+
*/
|
|
833
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
834
|
+
assetIds?: string[];
|
|
835
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
836
|
+
/**
|
|
837
|
+
* HTTP GET /alarm
|
|
838
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
839
|
+
*/
|
|
840
|
+
getAlarms(queryParams?: {
|
|
841
|
+
realm?: string;
|
|
842
|
+
status?: Model.AlarmStatus;
|
|
843
|
+
assetId?: string;
|
|
844
|
+
assigneeId?: string;
|
|
845
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
846
|
+
/**
|
|
847
|
+
* HTTP DELETE /alarm
|
|
848
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
849
|
+
*/
|
|
850
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
851
|
+
/**
|
|
852
|
+
* HTTP PUT /alarm/assets
|
|
853
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
854
|
+
*/
|
|
855
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
856
|
+
/**
|
|
857
|
+
* HTTP GET /alarm/{alarmId}
|
|
858
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
859
|
+
*/
|
|
860
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
861
|
+
/**
|
|
862
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
863
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
864
|
+
*/
|
|
865
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
866
|
+
/**
|
|
867
|
+
* HTTP PUT /alarm/{alarmId}
|
|
868
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
869
|
+
*/
|
|
870
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
871
|
+
/**
|
|
872
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
873
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
874
|
+
*/
|
|
875
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
876
|
+
realm?: string;
|
|
877
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
878
|
+
}
|
|
879
|
+
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
|
+
export declare class ApiClient {
|
|
885
881
|
protected _userResource: AxiosUserResourceClient;
|
|
886
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
887
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
888
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
889
882
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
890
883
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
891
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
892
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
893
884
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
894
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
895
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
896
885
|
protected _appResource: AxiosAppResourceClient;
|
|
886
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
897
887
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
898
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
899
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
900
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
901
888
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
889
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
890
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
891
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
892
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
893
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
894
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
895
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
896
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
897
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
898
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
899
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
900
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
901
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
904
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
905
|
-
get MapResource(): AxiosMapResourceClient;
|
|
906
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
907
903
|
get UserResource(): AxiosUserResourceClient;
|
|
908
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
909
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
910
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
911
904
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
912
905
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
913
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
914
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
915
906
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
916
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
917
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
918
907
|
get AppResource(): AxiosAppResourceClient;
|
|
908
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
919
909
|
get RulesResource(): AxiosRulesResourceClient;
|
|
920
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
921
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
922
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
923
910
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
911
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
912
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
913
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
914
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
915
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
916
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
917
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
918
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
919
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
920
|
+
get MapResource(): AxiosMapResourceClient;
|
|
921
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
922
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
923
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|
|
991
|
-
export declare class
|
|
991
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|