@openremote/rest 1.13.0-snapshot.20260112092956 → 1.13.0
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 +408 -408
- 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,84 +9,90 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class SyslogResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /syslog/config
|
|
17
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
parentId?: string;
|
|
21
|
-
parentType?: string;
|
|
22
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
19
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
23
20
|
/**
|
|
24
|
-
* HTTP
|
|
25
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /syslog/config
|
|
22
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
26
23
|
*/
|
|
27
|
-
|
|
28
|
-
parentId?: string;
|
|
29
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
24
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
30
25
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP DELETE /syslog/event
|
|
27
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
33
28
|
*/
|
|
34
|
-
|
|
35
|
-
parentId?: string;
|
|
36
|
-
parentType?: string;
|
|
37
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
29
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
38
30
|
/**
|
|
39
|
-
* HTTP GET /
|
|
40
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP GET /syslog/event
|
|
32
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
41
33
|
*/
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
34
|
+
getEvents(queryParams?: {
|
|
35
|
+
level?: Model.SyslogLevel;
|
|
36
|
+
per_page?: number;
|
|
37
|
+
page?: number;
|
|
38
|
+
from?: number;
|
|
39
|
+
to?: number;
|
|
40
|
+
category?: Model.SyslogCategory[];
|
|
41
|
+
subCategory?: string[];
|
|
45
42
|
}, options?: O): RestResponse<any>;
|
|
43
|
+
}
|
|
44
|
+
export declare class MapResourceClient<O> {
|
|
45
|
+
protected httpClient: HttpClient<O>;
|
|
46
|
+
constructor(httpClient: HttpClient<O>);
|
|
46
47
|
/**
|
|
47
|
-
* HTTP GET /
|
|
48
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP GET /map
|
|
49
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
49
50
|
*/
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
}, options?: O): RestResponse<{
|
|
53
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
51
|
+
getSettings(options?: O): RestResponse<{
|
|
52
|
+
[id: string]: unknown;
|
|
54
53
|
}>;
|
|
55
54
|
/**
|
|
56
|
-
* HTTP
|
|
57
|
-
* Java method: org.openremote.model.
|
|
55
|
+
* HTTP PUT /map
|
|
56
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
58
57
|
*/
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
}, options?: O): RestResponse<{
|
|
62
|
-
[index: string]: Model.ValueDescriptor;
|
|
58
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
59
|
+
[id: string]: unknown;
|
|
63
60
|
}>;
|
|
64
|
-
}
|
|
65
|
-
export declare class ConfigurationResourceClient<O> {
|
|
66
|
-
protected httpClient: HttpClient<O>;
|
|
67
|
-
constructor(httpClient: HttpClient<O>);
|
|
68
61
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
62
|
+
* HTTP DELETE /map/deleteMap
|
|
63
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
71
64
|
*/
|
|
72
|
-
|
|
65
|
+
deleteMap(options?: O): RestResponse<{
|
|
66
|
+
[id: string]: unknown;
|
|
67
|
+
}>;
|
|
73
68
|
/**
|
|
74
|
-
* HTTP
|
|
75
|
-
* Java method: org.openremote.model.
|
|
69
|
+
* HTTP GET /map/getCustomMapInfo
|
|
70
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
76
71
|
*/
|
|
77
|
-
|
|
72
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
73
|
+
[id: string]: unknown;
|
|
74
|
+
}>;
|
|
78
75
|
/**
|
|
79
|
-
* HTTP
|
|
80
|
-
* Java method: org.openremote.model.
|
|
76
|
+
* HTTP GET /map/js
|
|
77
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
81
78
|
*/
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
}
|
|
79
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
80
|
+
[id: string]: unknown;
|
|
81
|
+
}>;
|
|
85
82
|
/**
|
|
86
|
-
* HTTP GET /
|
|
87
|
-
* Java method: org.openremote.model.
|
|
83
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
84
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
88
85
|
*/
|
|
89
|
-
|
|
86
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
87
|
+
/**
|
|
88
|
+
* HTTP POST /map/upload
|
|
89
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
90
|
+
*/
|
|
91
|
+
uploadMap(queryParams?: {
|
|
92
|
+
filename?: string;
|
|
93
|
+
}, options?: O): RestResponse<{
|
|
94
|
+
[id: string]: unknown;
|
|
95
|
+
}>;
|
|
90
96
|
}
|
|
91
97
|
export declare class StatusResourceClient<O> {
|
|
92
98
|
protected httpClient: HttpClient<O>;
|
|
@@ -106,60 +112,67 @@ export declare class StatusResourceClient<O> {
|
|
|
106
112
|
[index: string]: any;
|
|
107
113
|
}>;
|
|
108
114
|
}
|
|
109
|
-
export declare class
|
|
115
|
+
export declare class ConfigurationResourceClient<O> {
|
|
110
116
|
protected httpClient: HttpClient<O>;
|
|
111
117
|
constructor(httpClient: HttpClient<O>);
|
|
112
118
|
/**
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
119
|
+
* HTTP GET /configuration/manager
|
|
120
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
116
121
|
*/
|
|
117
|
-
|
|
118
|
-
realm?: string;
|
|
119
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
122
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
120
123
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* Response code 409 - ExternalService instance already registered
|
|
124
|
-
* HTTP POST /service
|
|
125
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
124
|
+
* HTTP PUT /configuration/manager
|
|
125
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
126
126
|
*/
|
|
127
|
-
|
|
127
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
129
|
+
* HTTP POST /configuration/manager/file
|
|
130
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
132
131
|
*/
|
|
133
|
-
|
|
132
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
133
|
+
path?: string;
|
|
134
|
+
}, options?: O): RestResponse<string>;
|
|
134
135
|
/**
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
* Response code 409 - ExternalService instance already registered
|
|
138
|
-
* HTTP POST /service/global
|
|
139
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
136
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
137
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
140
138
|
*/
|
|
141
|
-
|
|
139
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
140
|
+
}
|
|
141
|
+
export declare class GatewayClientResourceClient<O> {
|
|
142
|
+
protected httpClient: HttpClient<O>;
|
|
143
|
+
constructor(httpClient: HttpClient<O>);
|
|
142
144
|
/**
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
146
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
145
|
+
* HTTP DELETE /gateway/connection
|
|
146
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
147
147
|
*/
|
|
148
|
-
|
|
148
|
+
deleteConnections(queryParams?: {
|
|
149
|
+
realm?: string[];
|
|
150
|
+
}, options?: O): RestResponse<void>;
|
|
149
151
|
/**
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
153
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
152
|
+
* HTTP GET /gateway/connection
|
|
153
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
154
154
|
*/
|
|
155
|
-
|
|
155
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
156
156
|
/**
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
160
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
157
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
158
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
161
159
|
*/
|
|
162
|
-
|
|
160
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
161
|
+
/**
|
|
162
|
+
* HTTP GET /gateway/connection/{realm}
|
|
163
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
164
|
+
*/
|
|
165
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
166
|
+
/**
|
|
167
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
168
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
169
|
+
*/
|
|
170
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
171
|
+
/**
|
|
172
|
+
* HTTP GET /gateway/status/{realm}
|
|
173
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
174
|
+
*/
|
|
175
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
163
176
|
}
|
|
164
177
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
165
178
|
protected httpClient: HttpClient<O>;
|
|
@@ -175,25 +188,6 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
175
188
|
*/
|
|
176
189
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
177
190
|
}
|
|
178
|
-
export declare class AppResourceClient<O> {
|
|
179
|
-
protected httpClient: HttpClient<O>;
|
|
180
|
-
constructor(httpClient: HttpClient<O>);
|
|
181
|
-
/**
|
|
182
|
-
* HTTP GET /apps
|
|
183
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
184
|
-
*/
|
|
185
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
186
|
-
/**
|
|
187
|
-
* HTTP GET /apps/consoleConfig
|
|
188
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
189
|
-
*/
|
|
190
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
191
|
-
/**
|
|
192
|
-
* HTTP GET /apps/info
|
|
193
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
194
|
-
*/
|
|
195
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
196
|
-
}
|
|
197
191
|
export declare class AlarmResourceClient<O> {
|
|
198
192
|
protected httpClient: HttpClient<O>;
|
|
199
193
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -355,93 +349,59 @@ export declare class RulesResourceClient<O> {
|
|
|
355
349
|
*/
|
|
356
350
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
357
351
|
}
|
|
358
|
-
export declare class
|
|
352
|
+
export declare class NotificationResourceClient<O> {
|
|
359
353
|
protected httpClient: HttpClient<O>;
|
|
360
354
|
constructor(httpClient: HttpClient<O>);
|
|
361
355
|
/**
|
|
362
|
-
* HTTP
|
|
363
|
-
* Java method: org.openremote.model.
|
|
356
|
+
* HTTP GET /notification
|
|
357
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
364
358
|
*/
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
359
|
+
getNotifications(queryParams?: {
|
|
360
|
+
id?: number;
|
|
361
|
+
type?: string;
|
|
362
|
+
from?: number;
|
|
363
|
+
to?: number;
|
|
364
|
+
realmId?: string;
|
|
365
|
+
userId?: string;
|
|
366
|
+
assetId?: string;
|
|
367
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
370
368
|
/**
|
|
371
|
-
* HTTP
|
|
372
|
-
* Java method: org.openremote.model.
|
|
369
|
+
* HTTP DELETE /notification
|
|
370
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
373
371
|
*/
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
372
|
+
removeNotifications(queryParams?: {
|
|
373
|
+
id?: number;
|
|
374
|
+
type?: string;
|
|
375
|
+
from?: number;
|
|
376
|
+
to?: number;
|
|
377
|
+
realmId?: string;
|
|
378
|
+
userId?: string;
|
|
379
|
+
assetId?: string;
|
|
380
|
+
}, options?: O): RestResponse<void>;
|
|
377
381
|
/**
|
|
378
|
-
* HTTP
|
|
379
|
-
* Java method: org.openremote.model.
|
|
382
|
+
* HTTP POST /notification/alert
|
|
383
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
380
384
|
*/
|
|
381
|
-
|
|
382
|
-
[id: string]: unknown;
|
|
383
|
-
}>;
|
|
384
|
-
/**
|
|
385
|
-
* HTTP DELETE /map/deleteMap
|
|
386
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
387
|
-
*/
|
|
388
|
-
deleteMap(options?: O): RestResponse<{
|
|
389
|
-
[id: string]: unknown;
|
|
390
|
-
}>;
|
|
391
|
-
/**
|
|
392
|
-
* HTTP GET /map/getCustomMapInfo
|
|
393
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
394
|
-
*/
|
|
395
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
396
|
-
[id: string]: unknown;
|
|
397
|
-
}>;
|
|
398
|
-
/**
|
|
399
|
-
* HTTP GET /map/js
|
|
400
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
401
|
-
*/
|
|
402
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
403
|
-
[id: string]: unknown;
|
|
404
|
-
}>;
|
|
405
|
-
/**
|
|
406
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
407
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
408
|
-
*/
|
|
409
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
410
|
-
/**
|
|
411
|
-
* HTTP POST /map/upload
|
|
412
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
413
|
-
*/
|
|
414
|
-
uploadMap(queryParams?: {
|
|
415
|
-
filename?: string;
|
|
416
|
-
}, options?: O): RestResponse<{
|
|
417
|
-
[id: string]: unknown;
|
|
418
|
-
}>;
|
|
419
|
-
}
|
|
420
|
-
export declare class AgentResourceClient<O> {
|
|
421
|
-
protected httpClient: HttpClient<O>;
|
|
422
|
-
constructor(httpClient: HttpClient<O>);
|
|
385
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
423
386
|
/**
|
|
424
|
-
* HTTP
|
|
425
|
-
* Java method: org.openremote.model.
|
|
387
|
+
* HTTP DELETE /notification/{notificationId}
|
|
388
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
426
389
|
*/
|
|
427
|
-
|
|
428
|
-
realm?: string;
|
|
429
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
390
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
430
391
|
/**
|
|
431
|
-
* HTTP
|
|
432
|
-
* Java method: org.openremote.model.
|
|
392
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
393
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
433
394
|
*/
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
}, options?: O): RestResponse<
|
|
395
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
396
|
+
targetId?: string;
|
|
397
|
+
}, options?: O): RestResponse<void>;
|
|
437
398
|
/**
|
|
438
|
-
* HTTP
|
|
439
|
-
* Java method: org.openremote.model.
|
|
399
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
400
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
440
401
|
*/
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
402
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
403
|
+
targetId?: string;
|
|
404
|
+
}, options?: O): RestResponse<void>;
|
|
445
405
|
}
|
|
446
406
|
export declare class AssetResourceClient<O> {
|
|
447
407
|
protected httpClient: HttpClient<O>;
|
|
@@ -557,65 +517,53 @@ export declare class AssetResourceClient<O> {
|
|
|
557
517
|
assetIds?: string[];
|
|
558
518
|
}, options?: O): RestResponse<void>;
|
|
559
519
|
}
|
|
560
|
-
export declare class
|
|
520
|
+
export declare class FlowResourceClient<O> {
|
|
561
521
|
protected httpClient: HttpClient<O>;
|
|
562
522
|
constructor(httpClient: HttpClient<O>);
|
|
563
523
|
/**
|
|
564
|
-
* HTTP GET /
|
|
565
|
-
* Java method: org.openremote.model.
|
|
524
|
+
* HTTP GET /flow
|
|
525
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
566
526
|
*/
|
|
567
|
-
|
|
568
|
-
attributeRefs?: string;
|
|
569
|
-
fromTimestamp?: number;
|
|
570
|
-
toTimestamp?: number;
|
|
571
|
-
}, options?: O): RestResponse<any>;
|
|
527
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
572
528
|
/**
|
|
573
|
-
* HTTP GET /
|
|
574
|
-
* Java method: org.openremote.model.
|
|
529
|
+
* HTTP GET /flow/{name}
|
|
530
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
575
531
|
*/
|
|
576
|
-
|
|
577
|
-
assetId?: string;
|
|
578
|
-
attributeName?: string;
|
|
579
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
532
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
580
533
|
/**
|
|
581
|
-
* HTTP
|
|
582
|
-
* Java method: org.openremote.model.
|
|
534
|
+
* HTTP GET /flow/{type}
|
|
535
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
583
536
|
*/
|
|
584
|
-
|
|
537
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
585
538
|
}
|
|
586
|
-
export declare class
|
|
539
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
587
540
|
protected httpClient: HttpClient<O>;
|
|
588
541
|
constructor(httpClient: HttpClient<O>);
|
|
589
542
|
/**
|
|
590
|
-
* HTTP POST /
|
|
591
|
-
* Java method: org.openremote.model.
|
|
592
|
-
*/
|
|
593
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
594
|
-
/**
|
|
595
|
-
* HTTP PUT /dashboard
|
|
596
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
543
|
+
* HTTP POST /gateway/tunnel
|
|
544
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
597
545
|
*/
|
|
598
|
-
|
|
546
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
599
547
|
/**
|
|
600
|
-
* HTTP
|
|
601
|
-
* Java method: org.openremote.model.
|
|
548
|
+
* HTTP DELETE /gateway/tunnel
|
|
549
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
602
550
|
*/
|
|
603
|
-
|
|
551
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
604
552
|
/**
|
|
605
|
-
* HTTP
|
|
606
|
-
* Java method: org.openremote.model.
|
|
553
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
554
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
607
555
|
*/
|
|
608
|
-
|
|
556
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
609
557
|
/**
|
|
610
|
-
* HTTP
|
|
611
|
-
* Java method: org.openremote.model.
|
|
558
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
559
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
612
560
|
*/
|
|
613
|
-
|
|
561
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
614
562
|
/**
|
|
615
|
-
* HTTP GET /
|
|
616
|
-
* Java method: org.openremote.model.
|
|
563
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
564
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
617
565
|
*/
|
|
618
|
-
|
|
566
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
619
567
|
}
|
|
620
568
|
export declare class UserResourceClient<O> {
|
|
621
569
|
protected httpClient: HttpClient<O>;
|
|
@@ -741,281 +689,333 @@ export declare class UserResourceClient<O> {
|
|
|
741
689
|
*/
|
|
742
690
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
743
691
|
}
|
|
744
|
-
export declare class
|
|
692
|
+
export declare class ProvisioningResourceClient<O> {
|
|
745
693
|
protected httpClient: HttpClient<O>;
|
|
746
694
|
constructor(httpClient: HttpClient<O>);
|
|
747
695
|
/**
|
|
748
|
-
* HTTP POST /
|
|
749
|
-
* Java method: org.openremote.model.
|
|
696
|
+
* HTTP POST /provisioning
|
|
697
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
750
698
|
*/
|
|
751
|
-
|
|
699
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
752
700
|
/**
|
|
753
|
-
* HTTP GET /
|
|
754
|
-
* Java method: org.openremote.model.
|
|
701
|
+
* HTTP GET /provisioning
|
|
702
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
755
703
|
*/
|
|
756
|
-
|
|
704
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
757
705
|
/**
|
|
758
|
-
* HTTP
|
|
759
|
-
* Java method: org.openremote.model.
|
|
706
|
+
* HTTP DELETE /provisioning/{id}
|
|
707
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
760
708
|
*/
|
|
761
|
-
|
|
709
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
762
710
|
/**
|
|
763
|
-
* HTTP
|
|
764
|
-
* Java method: org.openremote.model.
|
|
711
|
+
* HTTP PUT /provisioning/{id}
|
|
712
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
765
713
|
*/
|
|
766
|
-
|
|
714
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
715
|
+
}
|
|
716
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
717
|
+
protected httpClient: HttpClient<O>;
|
|
718
|
+
constructor(httpClient: HttpClient<O>);
|
|
767
719
|
/**
|
|
768
|
-
* HTTP GET /
|
|
769
|
-
* Java method: org.openremote.model.
|
|
720
|
+
* HTTP GET /asset/datapoint/export
|
|
721
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
770
722
|
*/
|
|
771
|
-
|
|
723
|
+
getDatapointExport(queryParams?: {
|
|
724
|
+
attributeRefs?: string;
|
|
725
|
+
fromTimestamp?: number;
|
|
726
|
+
toTimestamp?: number;
|
|
727
|
+
}, options?: O): RestResponse<any>;
|
|
772
728
|
/**
|
|
773
|
-
* HTTP
|
|
774
|
-
* Java method: org.openremote.model.
|
|
729
|
+
* HTTP GET /asset/datapoint/periods
|
|
730
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
775
731
|
*/
|
|
776
|
-
|
|
732
|
+
getDatapointPeriod(queryParams?: {
|
|
733
|
+
assetId?: string;
|
|
734
|
+
attributeName?: string;
|
|
735
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
736
|
+
/**
|
|
737
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
738
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
739
|
+
*/
|
|
740
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
777
741
|
}
|
|
778
|
-
export declare class
|
|
742
|
+
export declare class AppResourceClient<O> {
|
|
779
743
|
protected httpClient: HttpClient<O>;
|
|
780
744
|
constructor(httpClient: HttpClient<O>);
|
|
781
745
|
/**
|
|
782
|
-
* HTTP GET /
|
|
783
|
-
* Java method: org.openremote.model.
|
|
746
|
+
* HTTP GET /apps
|
|
747
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
784
748
|
*/
|
|
785
|
-
|
|
749
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
786
750
|
/**
|
|
787
|
-
* HTTP GET /
|
|
788
|
-
* Java method: org.openremote.model.
|
|
751
|
+
* HTTP GET /apps/consoleConfig
|
|
752
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
789
753
|
*/
|
|
790
|
-
|
|
754
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
791
755
|
/**
|
|
792
|
-
* HTTP GET /
|
|
793
|
-
* Java method: org.openremote.model.
|
|
756
|
+
* HTTP GET /apps/info
|
|
757
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
794
758
|
*/
|
|
795
|
-
|
|
759
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
796
760
|
}
|
|
797
|
-
export declare class
|
|
761
|
+
export declare class DashboardResourceClient<O> {
|
|
798
762
|
protected httpClient: HttpClient<O>;
|
|
799
763
|
constructor(httpClient: HttpClient<O>);
|
|
800
764
|
/**
|
|
801
|
-
* HTTP POST /
|
|
802
|
-
* Java method: org.openremote.model.
|
|
765
|
+
* HTTP POST /dashboard
|
|
766
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
803
767
|
*/
|
|
804
|
-
|
|
768
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
805
769
|
/**
|
|
806
|
-
* HTTP
|
|
807
|
-
* Java method: org.openremote.model.
|
|
770
|
+
* HTTP PUT /dashboard
|
|
771
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
808
772
|
*/
|
|
809
|
-
|
|
773
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
810
774
|
/**
|
|
811
|
-
* HTTP GET /
|
|
812
|
-
* Java method: org.openremote.model.
|
|
775
|
+
* HTTP GET /dashboard/all/{realm}
|
|
776
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
813
777
|
*/
|
|
814
|
-
|
|
778
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
815
779
|
/**
|
|
816
|
-
* HTTP
|
|
817
|
-
* Java method: org.openremote.model.
|
|
780
|
+
* HTTP POST /dashboard/query
|
|
781
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
818
782
|
*/
|
|
819
|
-
|
|
783
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
820
784
|
/**
|
|
821
|
-
* HTTP
|
|
822
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
786
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
823
787
|
*/
|
|
824
|
-
|
|
788
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
789
|
+
/**
|
|
790
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
791
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
792
|
+
*/
|
|
793
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
825
794
|
}
|
|
826
|
-
export declare class
|
|
795
|
+
export declare class AssetModelResourceClient<O> {
|
|
827
796
|
protected httpClient: HttpClient<O>;
|
|
828
797
|
constructor(httpClient: HttpClient<O>);
|
|
829
798
|
/**
|
|
830
|
-
* HTTP
|
|
831
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP GET /model/assetDescriptors
|
|
800
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
832
801
|
*/
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
*
|
|
802
|
+
getAssetDescriptors(queryParams?: {
|
|
803
|
+
parentId?: string;
|
|
804
|
+
parentType?: string;
|
|
805
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
806
|
+
/**
|
|
807
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
808
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
839
809
|
*/
|
|
840
|
-
|
|
810
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
811
|
+
parentId?: string;
|
|
812
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
841
813
|
/**
|
|
842
|
-
* HTTP
|
|
843
|
-
* Java method: org.openremote.model.
|
|
814
|
+
* HTTP GET /model/assetInfos
|
|
815
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
844
816
|
*/
|
|
845
|
-
|
|
817
|
+
getAssetInfos(queryParams?: {
|
|
818
|
+
parentId?: string;
|
|
819
|
+
parentType?: string;
|
|
820
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
846
821
|
/**
|
|
847
|
-
* HTTP GET /
|
|
848
|
-
* Java method: org.openremote.model.
|
|
822
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
823
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
849
824
|
*/
|
|
850
|
-
|
|
825
|
+
getValueDescriptorSchema(queryParams?: {
|
|
826
|
+
name?: string;
|
|
827
|
+
hash?: string;
|
|
828
|
+
}, options?: O): RestResponse<any>;
|
|
851
829
|
/**
|
|
852
|
-
* HTTP
|
|
853
|
-
* Java method: org.openremote.model.
|
|
830
|
+
* HTTP GET /model/metaItemDescriptors
|
|
831
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
854
832
|
*/
|
|
855
|
-
|
|
833
|
+
getMetaItemDescriptors(queryParams?: {
|
|
834
|
+
parentId?: string;
|
|
835
|
+
}, options?: O): RestResponse<{
|
|
836
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
837
|
+
}>;
|
|
856
838
|
/**
|
|
857
|
-
* HTTP GET /
|
|
858
|
-
* Java method: org.openremote.model.
|
|
839
|
+
* HTTP GET /model/valueDescriptors
|
|
840
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
859
841
|
*/
|
|
860
|
-
|
|
842
|
+
getValueDescriptors(queryParams?: {
|
|
843
|
+
parentId?: string;
|
|
844
|
+
}, options?: O): RestResponse<{
|
|
845
|
+
[index: string]: Model.ValueDescriptor;
|
|
846
|
+
}>;
|
|
861
847
|
}
|
|
862
|
-
export declare class
|
|
848
|
+
export declare class RealmResourceClient<O> {
|
|
863
849
|
protected httpClient: HttpClient<O>;
|
|
864
850
|
constructor(httpClient: HttpClient<O>);
|
|
865
851
|
/**
|
|
866
|
-
* HTTP POST /
|
|
867
|
-
* Java method: org.openremote.model.
|
|
852
|
+
* HTTP POST /realm
|
|
853
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
868
854
|
*/
|
|
869
|
-
|
|
855
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
870
856
|
/**
|
|
871
|
-
* HTTP GET /
|
|
872
|
-
* Java method: org.openremote.model.
|
|
857
|
+
* HTTP GET /realm
|
|
858
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
873
859
|
*/
|
|
874
|
-
|
|
860
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
875
861
|
/**
|
|
876
|
-
* HTTP
|
|
877
|
-
* Java method: org.openremote.model.
|
|
862
|
+
* HTTP GET /realm/accessible
|
|
863
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
878
864
|
*/
|
|
879
|
-
|
|
865
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
880
866
|
/**
|
|
881
|
-
* HTTP
|
|
882
|
-
* Java method: org.openremote.model.
|
|
867
|
+
* HTTP DELETE /realm/{name}
|
|
868
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
883
869
|
*/
|
|
884
|
-
|
|
870
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
871
|
+
/**
|
|
872
|
+
* HTTP GET /realm/{name}
|
|
873
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
874
|
+
*/
|
|
875
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
876
|
+
/**
|
|
877
|
+
* HTTP PUT /realm/{name}
|
|
878
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
879
|
+
*/
|
|
880
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
885
881
|
}
|
|
886
|
-
export declare class
|
|
882
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
887
883
|
protected httpClient: HttpClient<O>;
|
|
888
884
|
constructor(httpClient: HttpClient<O>);
|
|
889
885
|
/**
|
|
890
|
-
*
|
|
891
|
-
*
|
|
886
|
+
* Response code 200 - List of registered external services
|
|
887
|
+
* HTTP GET /service
|
|
888
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
892
889
|
*/
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
from?: number;
|
|
897
|
-
to?: number;
|
|
898
|
-
realmId?: string;
|
|
899
|
-
userId?: string;
|
|
900
|
-
assetId?: string;
|
|
901
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
890
|
+
getServices(queryParams?: {
|
|
891
|
+
realm?: string;
|
|
892
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
902
893
|
/**
|
|
903
|
-
*
|
|
904
|
-
*
|
|
894
|
+
* Response code 200 - Service registered successfully
|
|
895
|
+
* Response code 400 - Invalid external service object
|
|
896
|
+
* Response code 409 - ExternalService instance already registered
|
|
897
|
+
* HTTP POST /service
|
|
898
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
905
899
|
*/
|
|
906
|
-
|
|
907
|
-
id?: number;
|
|
908
|
-
type?: string;
|
|
909
|
-
from?: number;
|
|
910
|
-
to?: number;
|
|
911
|
-
realmId?: string;
|
|
912
|
-
userId?: string;
|
|
913
|
-
assetId?: string;
|
|
914
|
-
}, options?: O): RestResponse<void>;
|
|
900
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
915
901
|
/**
|
|
916
|
-
*
|
|
917
|
-
*
|
|
902
|
+
* Response code 200 - List of registered external services
|
|
903
|
+
* HTTP GET /service/global
|
|
904
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
918
905
|
*/
|
|
919
|
-
|
|
906
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
920
907
|
/**
|
|
921
|
-
*
|
|
922
|
-
*
|
|
908
|
+
* Response code 200 - Service registered successfully
|
|
909
|
+
* Response code 400 - Invalid external service object
|
|
910
|
+
* Response code 409 - ExternalService instance already registered
|
|
911
|
+
* HTTP POST /service/global
|
|
912
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
923
913
|
*/
|
|
924
|
-
|
|
914
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
925
915
|
/**
|
|
926
|
-
*
|
|
927
|
-
*
|
|
916
|
+
* Response code 204 - Service deregistered successfully
|
|
917
|
+
* Response code 404 - Service instance not found
|
|
918
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
919
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
928
920
|
*/
|
|
929
|
-
|
|
930
|
-
targetId?: string;
|
|
931
|
-
}, options?: O): RestResponse<void>;
|
|
921
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
932
922
|
/**
|
|
933
|
-
*
|
|
934
|
-
*
|
|
923
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
924
|
+
* Response code 404 - ExternalService not found
|
|
925
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
926
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
935
927
|
*/
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
928
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
929
|
+
/**
|
|
930
|
+
* Response code 204 - Heartbeat sent successfully
|
|
931
|
+
* Response code 404 - Service instance not found
|
|
932
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
933
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
934
|
+
*/
|
|
935
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AgentResourceClient<O> {
|
|
941
938
|
protected httpClient: HttpClient<O>;
|
|
942
939
|
constructor(httpClient: HttpClient<O>);
|
|
943
940
|
/**
|
|
944
|
-
* HTTP GET /
|
|
945
|
-
* Java method: org.openremote.model.
|
|
941
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
942
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
946
943
|
*/
|
|
947
|
-
|
|
944
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
945
|
+
realm?: string;
|
|
946
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
948
947
|
/**
|
|
949
|
-
* HTTP
|
|
950
|
-
* Java method: org.openremote.model.
|
|
948
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
949
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
951
950
|
*/
|
|
952
|
-
|
|
951
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
952
|
+
realm?: string;
|
|
953
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
953
954
|
/**
|
|
954
|
-
* HTTP
|
|
955
|
-
* Java method: org.openremote.model.
|
|
955
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
956
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
956
957
|
*/
|
|
957
|
-
|
|
958
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
959
|
+
parentId?: string;
|
|
960
|
+
realm?: string;
|
|
961
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
962
|
+
}
|
|
963
|
+
export declare class ConsoleResourceClient<O> {
|
|
964
|
+
protected httpClient: HttpClient<O>;
|
|
965
|
+
constructor(httpClient: HttpClient<O>);
|
|
958
966
|
/**
|
|
959
|
-
* HTTP
|
|
960
|
-
* Java method: org.openremote.model.
|
|
967
|
+
* HTTP POST /console/register
|
|
968
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
961
969
|
*/
|
|
962
|
-
|
|
963
|
-
level?: Model.SyslogLevel;
|
|
964
|
-
per_page?: number;
|
|
965
|
-
page?: number;
|
|
966
|
-
from?: number;
|
|
967
|
-
to?: number;
|
|
968
|
-
category?: Model.SyslogCategory[];
|
|
969
|
-
subCategory?: string[];
|
|
970
|
-
}, options?: O): RestResponse<any>;
|
|
970
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
971
971
|
}
|
|
972
972
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
973
973
|
export declare class ApiClient {
|
|
974
|
-
protected
|
|
975
|
-
protected
|
|
974
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
975
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
976
976
|
protected _statusResource: AxiosStatusResourceClient;
|
|
977
|
-
protected
|
|
977
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
978
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
978
979
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
979
|
-
protected _appResource: AxiosAppResourceClient;
|
|
980
980
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
981
981
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
982
|
-
protected
|
|
983
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
984
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
982
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
985
983
|
protected _assetResource: AxiosAssetResourceClient;
|
|
986
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
987
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
988
|
-
protected _userResource: AxiosUserResourceClient;
|
|
989
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
990
984
|
protected _flowResource: AxiosFlowResourceClient;
|
|
991
985
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
992
|
-
protected
|
|
986
|
+
protected _userResource: AxiosUserResourceClient;
|
|
993
987
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
994
|
-
protected
|
|
995
|
-
protected
|
|
988
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
989
|
+
protected _appResource: AxiosAppResourceClient;
|
|
990
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
991
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
992
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
993
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
994
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
995
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
996
996
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
997
|
-
get
|
|
998
|
-
get
|
|
997
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
998
|
+
get MapResource(): AxiosMapResourceClient;
|
|
999
999
|
get StatusResource(): AxiosStatusResourceClient;
|
|
1000
|
-
get
|
|
1000
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1001
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1001
1002
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1002
|
-
get AppResource(): AxiosAppResourceClient;
|
|
1003
1003
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1004
1004
|
get RulesResource(): AxiosRulesResourceClient;
|
|
1005
|
-
get
|
|
1006
|
-
get MapResource(): AxiosMapResourceClient;
|
|
1007
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1005
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1008
1006
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1009
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1010
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1011
|
-
get UserResource(): AxiosUserResourceClient;
|
|
1012
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1013
1007
|
get FlowResource(): AxiosFlowResourceClient;
|
|
1014
1008
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1015
|
-
get
|
|
1009
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1016
1010
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1017
|
-
get
|
|
1018
|
-
get
|
|
1011
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1012
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1013
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1014
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1015
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1016
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1017
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1018
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1019
1019
|
}
|
|
1020
1020
|
import * as Axios from "axios";
|
|
1021
1021
|
declare module "axios" {
|
|
@@ -1023,22 +1023,22 @@ declare module "axios" {
|
|
|
1023
1023
|
data: R;
|
|
1024
1024
|
}
|
|
1025
1025
|
}
|
|
1026
|
-
export declare class
|
|
1026
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1027
1027
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1028
1028
|
}
|
|
1029
|
-
export declare class
|
|
1029
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1030
1030
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1031
1031
|
}
|
|
1032
1032
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1033
1033
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1034
1034
|
}
|
|
1035
|
-
export declare class
|
|
1035
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1036
1036
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1037
1037
|
}
|
|
1038
|
-
export declare class
|
|
1038
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1039
1039
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1040
1040
|
}
|
|
1041
|
-
export declare class
|
|
1041
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1042
1042
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1043
1043
|
}
|
|
1044
1044
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1047,46 +1047,46 @@ export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.
|
|
|
1047
1047
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1048
1048
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1049
1049
|
}
|
|
1050
|
-
export declare class
|
|
1050
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1051
1051
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1052
1052
|
}
|
|
1053
|
-
export declare class
|
|
1053
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1054
1054
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1055
1055
|
}
|
|
1056
|
-
export declare class
|
|
1056
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1057
1057
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1058
1058
|
}
|
|
1059
|
-
export declare class
|
|
1059
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1060
1060
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1061
1061
|
}
|
|
1062
|
-
export declare class
|
|
1062
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1063
1063
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1064
1064
|
}
|
|
1065
|
-
export declare class
|
|
1065
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1066
1066
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1067
1067
|
}
|
|
1068
|
-
export declare class
|
|
1068
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1069
1069
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1070
1070
|
}
|
|
1071
|
-
export declare class
|
|
1071
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1072
1072
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1073
1073
|
}
|
|
1074
|
-
export declare class
|
|
1074
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1075
1075
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1076
1076
|
}
|
|
1077
|
-
export declare class
|
|
1077
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1078
1078
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1079
1079
|
}
|
|
1080
|
-
export declare class
|
|
1080
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1081
1081
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1082
1082
|
}
|
|
1083
|
-
export declare class
|
|
1083
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1084
1084
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1085
1085
|
}
|
|
1086
|
-
export declare class
|
|
1086
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1087
1087
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1088
1088
|
}
|
|
1089
|
-
export declare class
|
|
1089
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1090
1090
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1091
1091
|
}
|
|
1092
1092
|
//# sourceMappingURL=restclient.d.ts.map
|