@openremote/rest 1.4.0-snapshot.20250401092307 → 1.4.0-snapshot.20250402120116
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 +428 -428
- 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,139 +9,42 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP DELETE /gateway/connection
|
|
17
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
18
|
-
*/
|
|
19
|
-
deleteConnections(queryParams?: {
|
|
20
|
-
realm?: string[];
|
|
21
|
-
}, options?: O): RestResponse<void>;
|
|
22
|
-
/**
|
|
23
|
-
* HTTP GET /gateway/connection
|
|
24
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
25
|
-
*/
|
|
26
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
27
|
-
/**
|
|
28
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
30
|
-
*/
|
|
31
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
32
|
-
/**
|
|
33
|
-
* HTTP GET /gateway/connection/{realm}
|
|
34
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
35
|
-
*/
|
|
36
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
37
|
-
/**
|
|
38
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
39
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
40
|
-
*/
|
|
41
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
42
|
-
/**
|
|
43
|
-
* HTTP GET /gateway/status/{realm}
|
|
44
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
45
|
-
*/
|
|
46
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
47
|
-
}
|
|
48
|
-
export declare class ConfigurationResourceClient<O> {
|
|
49
|
-
protected httpClient: HttpClient<O>;
|
|
50
|
-
constructor(httpClient: HttpClient<O>);
|
|
51
|
-
/**
|
|
52
|
-
* HTTP GET /configuration/manager
|
|
53
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
54
|
-
*/
|
|
55
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
56
|
-
/**
|
|
57
|
-
* HTTP PUT /configuration/manager
|
|
58
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
59
|
-
*/
|
|
60
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
61
|
-
/**
|
|
62
|
-
* HTTP POST /configuration/manager/file
|
|
63
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
64
|
-
*/
|
|
65
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
66
|
-
path?: string;
|
|
67
|
-
}, options?: O): RestResponse<string>;
|
|
68
|
-
/**
|
|
69
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
70
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
71
|
-
*/
|
|
72
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
73
|
-
}
|
|
74
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
12
|
+
export declare class FlowResourceClient<O> {
|
|
75
13
|
protected httpClient: HttpClient<O>;
|
|
76
14
|
constructor(httpClient: HttpClient<O>);
|
|
77
15
|
/**
|
|
78
|
-
* HTTP
|
|
79
|
-
* Java method: org.openremote.model.
|
|
80
|
-
*/
|
|
81
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
82
|
-
/**
|
|
83
|
-
* HTTP DELETE /gateway/tunnel
|
|
84
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
85
|
-
*/
|
|
86
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
87
|
-
/**
|
|
88
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
89
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
90
|
-
*/
|
|
91
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
92
|
-
/**
|
|
93
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
94
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
16
|
+
* HTTP GET /flow
|
|
17
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
95
18
|
*/
|
|
96
|
-
|
|
19
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
97
20
|
/**
|
|
98
|
-
* HTTP GET /
|
|
99
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /flow/{name}
|
|
22
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
100
23
|
*/
|
|
101
|
-
|
|
102
|
-
}
|
|
103
|
-
export declare class ConsoleResourceClient<O> {
|
|
104
|
-
protected httpClient: HttpClient<O>;
|
|
105
|
-
constructor(httpClient: HttpClient<O>);
|
|
24
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
106
25
|
/**
|
|
107
|
-
* HTTP
|
|
108
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /flow/{type}
|
|
27
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
109
28
|
*/
|
|
110
|
-
|
|
29
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
111
30
|
}
|
|
112
|
-
export declare class
|
|
31
|
+
export declare class StatusResourceClient<O> {
|
|
113
32
|
protected httpClient: HttpClient<O>;
|
|
114
33
|
constructor(httpClient: HttpClient<O>);
|
|
115
34
|
/**
|
|
116
|
-
* HTTP
|
|
117
|
-
* Java method: org.openremote.model.
|
|
118
|
-
*/
|
|
119
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
120
|
-
/**
|
|
121
|
-
* HTTP GET /realm
|
|
122
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
123
|
-
*/
|
|
124
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
125
|
-
/**
|
|
126
|
-
* HTTP GET /realm/accessible
|
|
127
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
128
|
-
*/
|
|
129
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
130
|
-
/**
|
|
131
|
-
* HTTP DELETE /realm/{name}
|
|
132
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
133
|
-
*/
|
|
134
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
135
|
-
/**
|
|
136
|
-
* HTTP GET /realm/{name}
|
|
137
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
35
|
+
* HTTP GET /health
|
|
36
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
138
37
|
*/
|
|
139
|
-
|
|
38
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
39
|
+
[index: string]: any;
|
|
40
|
+
}>;
|
|
140
41
|
/**
|
|
141
|
-
* HTTP
|
|
142
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP GET /info
|
|
43
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
143
44
|
*/
|
|
144
|
-
|
|
45
|
+
getInfo(options?: O): RestResponse<{
|
|
46
|
+
[index: string]: any;
|
|
47
|
+
}>;
|
|
145
48
|
}
|
|
146
49
|
export declare class AgentResourceClient<O> {
|
|
147
50
|
protected httpClient: HttpClient<O>;
|
|
@@ -169,136 +72,37 @@ export declare class AgentResourceClient<O> {
|
|
|
169
72
|
realm?: string;
|
|
170
73
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
171
74
|
}
|
|
172
|
-
export declare class
|
|
173
|
-
protected httpClient: HttpClient<O>;
|
|
174
|
-
constructor(httpClient: HttpClient<O>);
|
|
175
|
-
/**
|
|
176
|
-
* HTTP POST /dashboard
|
|
177
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
178
|
-
*/
|
|
179
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
180
|
-
/**
|
|
181
|
-
* HTTP PUT /dashboard
|
|
182
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
183
|
-
*/
|
|
184
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
185
|
-
/**
|
|
186
|
-
* HTTP GET /dashboard/all/{realm}
|
|
187
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
188
|
-
*/
|
|
189
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
190
|
-
/**
|
|
191
|
-
* HTTP POST /dashboard/query
|
|
192
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
193
|
-
*/
|
|
194
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
195
|
-
/**
|
|
196
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
197
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
198
|
-
*/
|
|
199
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
200
|
-
/**
|
|
201
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
202
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
203
|
-
*/
|
|
204
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
205
|
-
}
|
|
206
|
-
export declare class ProvisioningResourceClient<O> {
|
|
75
|
+
export declare class SyslogResourceClient<O> {
|
|
207
76
|
protected httpClient: HttpClient<O>;
|
|
208
77
|
constructor(httpClient: HttpClient<O>);
|
|
209
78
|
/**
|
|
210
|
-
* HTTP
|
|
211
|
-
* Java method: org.openremote.model.
|
|
212
|
-
*/
|
|
213
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
214
|
-
/**
|
|
215
|
-
* HTTP GET /provisioning
|
|
216
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
217
|
-
*/
|
|
218
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
219
|
-
/**
|
|
220
|
-
* HTTP DELETE /provisioning/{id}
|
|
221
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
79
|
+
* HTTP GET /syslog/config
|
|
80
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
222
81
|
*/
|
|
223
|
-
|
|
82
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
224
83
|
/**
|
|
225
|
-
* HTTP PUT /
|
|
226
|
-
* Java method: org.openremote.model.
|
|
84
|
+
* HTTP PUT /syslog/config
|
|
85
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
227
86
|
*/
|
|
228
|
-
|
|
229
|
-
}
|
|
230
|
-
export declare class NotificationResourceClient<O> {
|
|
231
|
-
protected httpClient: HttpClient<O>;
|
|
232
|
-
constructor(httpClient: HttpClient<O>);
|
|
87
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
233
88
|
/**
|
|
234
|
-
* HTTP
|
|
235
|
-
* Java method: org.openremote.model.
|
|
89
|
+
* HTTP DELETE /syslog/event
|
|
90
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
236
91
|
*/
|
|
237
|
-
|
|
238
|
-
id?: number;
|
|
239
|
-
type?: string;
|
|
240
|
-
from?: number;
|
|
241
|
-
to?: number;
|
|
242
|
-
realmId?: string;
|
|
243
|
-
userId?: string;
|
|
244
|
-
assetId?: string;
|
|
245
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
92
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
246
93
|
/**
|
|
247
|
-
* HTTP
|
|
248
|
-
* Java method: org.openremote.model.
|
|
94
|
+
* HTTP GET /syslog/event
|
|
95
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
249
96
|
*/
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
97
|
+
getEvents(queryParams?: {
|
|
98
|
+
level?: Model.SyslogLevel;
|
|
99
|
+
per_page?: number;
|
|
100
|
+
page?: number;
|
|
253
101
|
from?: number;
|
|
254
102
|
to?: number;
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
}, options?: O): RestResponse<void>;
|
|
259
|
-
/**
|
|
260
|
-
* HTTP POST /notification/alert
|
|
261
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
262
|
-
*/
|
|
263
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
264
|
-
/**
|
|
265
|
-
* HTTP DELETE /notification/{notificationId}
|
|
266
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
267
|
-
*/
|
|
268
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
269
|
-
/**
|
|
270
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
271
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
272
|
-
*/
|
|
273
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
274
|
-
targetId?: string;
|
|
275
|
-
}, options?: O): RestResponse<void>;
|
|
276
|
-
/**
|
|
277
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
278
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
279
|
-
*/
|
|
280
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
281
|
-
targetId?: string;
|
|
282
|
-
}, options?: O): RestResponse<void>;
|
|
283
|
-
}
|
|
284
|
-
export declare class FlowResourceClient<O> {
|
|
285
|
-
protected httpClient: HttpClient<O>;
|
|
286
|
-
constructor(httpClient: HttpClient<O>);
|
|
287
|
-
/**
|
|
288
|
-
* HTTP GET /flow
|
|
289
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
290
|
-
*/
|
|
291
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP GET /flow/{name}
|
|
294
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
295
|
-
*/
|
|
296
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
297
|
-
/**
|
|
298
|
-
* HTTP GET /flow/{type}
|
|
299
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
300
|
-
*/
|
|
301
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
103
|
+
category?: Model.SyslogCategory[];
|
|
104
|
+
subCategory?: string[];
|
|
105
|
+
}, options?: O): RestResponse<any>;
|
|
302
106
|
}
|
|
303
107
|
export declare class UserResourceClient<O> {
|
|
304
108
|
protected httpClient: HttpClient<O>;
|
|
@@ -417,88 +221,173 @@ export declare class UserResourceClient<O> {
|
|
|
417
221
|
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
418
222
|
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
419
223
|
*/
|
|
420
|
-
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
224
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
225
|
+
/**
|
|
226
|
+
* HTTP GET /user/{realm}/{userId}
|
|
227
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
228
|
+
*/
|
|
229
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
230
|
+
}
|
|
231
|
+
export declare class RealmResourceClient<O> {
|
|
232
|
+
protected httpClient: HttpClient<O>;
|
|
233
|
+
constructor(httpClient: HttpClient<O>);
|
|
234
|
+
/**
|
|
235
|
+
* HTTP POST /realm
|
|
236
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
237
|
+
*/
|
|
238
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
239
|
+
/**
|
|
240
|
+
* HTTP GET /realm
|
|
241
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
242
|
+
*/
|
|
243
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
244
|
+
/**
|
|
245
|
+
* HTTP GET /realm/accessible
|
|
246
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
247
|
+
*/
|
|
248
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
249
|
+
/**
|
|
250
|
+
* HTTP DELETE /realm/{name}
|
|
251
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
252
|
+
*/
|
|
253
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
254
|
+
/**
|
|
255
|
+
* HTTP GET /realm/{name}
|
|
256
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
257
|
+
*/
|
|
258
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
259
|
+
/**
|
|
260
|
+
* HTTP PUT /realm/{name}
|
|
261
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
262
|
+
*/
|
|
263
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
264
|
+
}
|
|
265
|
+
export declare class AssetModelResourceClient<O> {
|
|
266
|
+
protected httpClient: HttpClient<O>;
|
|
267
|
+
constructor(httpClient: HttpClient<O>);
|
|
268
|
+
/**
|
|
269
|
+
* HTTP GET /model/assetDescriptors
|
|
270
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
271
|
+
*/
|
|
272
|
+
getAssetDescriptors(queryParams?: {
|
|
273
|
+
parentId?: string;
|
|
274
|
+
parentType?: string;
|
|
275
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
276
|
+
/**
|
|
277
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
278
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
279
|
+
*/
|
|
280
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
281
|
+
parentId?: string;
|
|
282
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
283
|
+
/**
|
|
284
|
+
* HTTP GET /model/assetInfos
|
|
285
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
286
|
+
*/
|
|
287
|
+
getAssetInfos(queryParams?: {
|
|
288
|
+
parentId?: string;
|
|
289
|
+
parentType?: string;
|
|
290
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
291
|
+
/**
|
|
292
|
+
* HTTP GET /model/metaItemDescriptors
|
|
293
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
294
|
+
*/
|
|
295
|
+
getMetaItemDescriptors(queryParams?: {
|
|
296
|
+
parentId?: string;
|
|
297
|
+
}, options?: O): RestResponse<{
|
|
298
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
299
|
+
}>;
|
|
421
300
|
/**
|
|
422
|
-
* HTTP GET /
|
|
423
|
-
* Java method: org.openremote.model.
|
|
301
|
+
* HTTP GET /model/valueDescriptors
|
|
302
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
424
303
|
*/
|
|
425
|
-
|
|
304
|
+
getValueDescriptors(queryParams?: {
|
|
305
|
+
parentId?: string;
|
|
306
|
+
}, options?: O): RestResponse<{
|
|
307
|
+
[index: string]: Model.ValueDescriptor;
|
|
308
|
+
}>;
|
|
426
309
|
}
|
|
427
|
-
export declare class
|
|
310
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
428
311
|
protected httpClient: HttpClient<O>;
|
|
429
312
|
constructor(httpClient: HttpClient<O>);
|
|
430
313
|
/**
|
|
431
|
-
* HTTP
|
|
432
|
-
* Java method: org.openremote.model.
|
|
314
|
+
* HTTP POST /gateway/tunnel
|
|
315
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
433
316
|
*/
|
|
434
|
-
|
|
435
|
-
[id: string]: unknown;
|
|
436
|
-
}>;
|
|
317
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
437
318
|
/**
|
|
438
|
-
* HTTP
|
|
439
|
-
* Java method: org.openremote.model.
|
|
319
|
+
* HTTP DELETE /gateway/tunnel
|
|
320
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
440
321
|
*/
|
|
441
|
-
|
|
442
|
-
[index: string]: Model.MapRealmConfig;
|
|
443
|
-
}, options?: O): RestResponse<any>;
|
|
322
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
444
323
|
/**
|
|
445
|
-
* HTTP GET /
|
|
446
|
-
* Java method: org.openremote.model.
|
|
324
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
325
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
447
326
|
*/
|
|
448
|
-
|
|
449
|
-
[id: string]: unknown;
|
|
450
|
-
}>;
|
|
327
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
451
328
|
/**
|
|
452
|
-
* HTTP GET /
|
|
453
|
-
* Java method: org.openremote.model.
|
|
329
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
330
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
454
331
|
*/
|
|
455
|
-
|
|
332
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
333
|
+
/**
|
|
334
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
335
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
336
|
+
*/
|
|
337
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
456
338
|
}
|
|
457
|
-
export declare class
|
|
339
|
+
export declare class AlarmResourceClient<O> {
|
|
458
340
|
protected httpClient: HttpClient<O>;
|
|
459
341
|
constructor(httpClient: HttpClient<O>);
|
|
460
342
|
/**
|
|
461
|
-
* HTTP
|
|
462
|
-
* Java method: org.openremote.model.
|
|
343
|
+
* HTTP POST /alarm
|
|
344
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
463
345
|
*/
|
|
464
|
-
|
|
346
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
347
|
+
assetIds?: string[];
|
|
348
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
465
349
|
/**
|
|
466
|
-
* HTTP
|
|
467
|
-
* Java method: org.openremote.model.
|
|
350
|
+
* HTTP GET /alarm
|
|
351
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
468
352
|
*/
|
|
469
|
-
|
|
353
|
+
getAlarms(queryParams?: {
|
|
354
|
+
realm?: string;
|
|
355
|
+
status?: Model.AlarmStatus;
|
|
356
|
+
assetId?: string;
|
|
357
|
+
assigneeId?: string;
|
|
358
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
470
359
|
/**
|
|
471
|
-
* HTTP DELETE /
|
|
472
|
-
* Java method: org.openremote.model.
|
|
360
|
+
* HTTP DELETE /alarm
|
|
361
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
473
362
|
*/
|
|
474
|
-
|
|
363
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
475
364
|
/**
|
|
476
|
-
* HTTP
|
|
477
|
-
* Java method: org.openremote.model.
|
|
365
|
+
* HTTP PUT /alarm/assets
|
|
366
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
478
367
|
*/
|
|
479
|
-
|
|
480
|
-
level?: Model.SyslogLevel;
|
|
481
|
-
per_page?: number;
|
|
482
|
-
page?: number;
|
|
483
|
-
from?: number;
|
|
484
|
-
to?: number;
|
|
485
|
-
category?: Model.SyslogCategory[];
|
|
486
|
-
subCategory?: string[];
|
|
487
|
-
}, options?: O): RestResponse<any>;
|
|
488
|
-
}
|
|
489
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
490
|
-
protected httpClient: HttpClient<O>;
|
|
491
|
-
constructor(httpClient: HttpClient<O>);
|
|
368
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
492
369
|
/**
|
|
493
|
-
* HTTP
|
|
494
|
-
* Java method: org.openremote.model.
|
|
370
|
+
* HTTP GET /alarm/{alarmId}
|
|
371
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
495
372
|
*/
|
|
496
|
-
|
|
373
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
497
374
|
/**
|
|
498
|
-
* HTTP
|
|
499
|
-
* Java method: org.openremote.model.
|
|
375
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
376
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
500
377
|
*/
|
|
501
|
-
|
|
378
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
379
|
+
/**
|
|
380
|
+
* HTTP PUT /alarm/{alarmId}
|
|
381
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
382
|
+
*/
|
|
383
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
384
|
+
/**
|
|
385
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
386
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
387
|
+
*/
|
|
388
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
389
|
+
realm?: string;
|
|
390
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
502
391
|
}
|
|
503
392
|
export declare class AssetResourceClient<O> {
|
|
504
393
|
protected httpClient: HttpClient<O>;
|
|
@@ -604,122 +493,217 @@ export declare class AssetResourceClient<O> {
|
|
|
604
493
|
assetIds?: string[];
|
|
605
494
|
}, options?: O): RestResponse<void>;
|
|
606
495
|
}
|
|
607
|
-
export declare class
|
|
496
|
+
export declare class AppResourceClient<O> {
|
|
608
497
|
protected httpClient: HttpClient<O>;
|
|
609
498
|
constructor(httpClient: HttpClient<O>);
|
|
610
499
|
/**
|
|
611
|
-
* HTTP
|
|
612
|
-
* Java method: org.openremote.model.
|
|
500
|
+
* HTTP GET /apps
|
|
501
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
613
502
|
*/
|
|
614
|
-
|
|
615
|
-
assetIds?: string[];
|
|
616
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
503
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
617
504
|
/**
|
|
618
|
-
* HTTP GET /
|
|
619
|
-
* Java method: org.openremote.model.
|
|
505
|
+
* HTTP GET /apps/consoleConfig
|
|
506
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
620
507
|
*/
|
|
621
|
-
|
|
622
|
-
realm?: string;
|
|
623
|
-
status?: Model.AlarmStatus;
|
|
624
|
-
assetId?: string;
|
|
625
|
-
assigneeId?: string;
|
|
626
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
508
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
627
509
|
/**
|
|
628
|
-
* HTTP
|
|
629
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP GET /apps/info
|
|
511
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
630
512
|
*/
|
|
631
|
-
|
|
513
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
514
|
+
}
|
|
515
|
+
export declare class ConsoleResourceClient<O> {
|
|
516
|
+
protected httpClient: HttpClient<O>;
|
|
517
|
+
constructor(httpClient: HttpClient<O>);
|
|
632
518
|
/**
|
|
633
|
-
* HTTP
|
|
634
|
-
* Java method: org.openremote.model.
|
|
519
|
+
* HTTP POST /console/register
|
|
520
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
635
521
|
*/
|
|
636
|
-
|
|
522
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
523
|
+
}
|
|
524
|
+
export declare class ConfigurationResourceClient<O> {
|
|
525
|
+
protected httpClient: HttpClient<O>;
|
|
526
|
+
constructor(httpClient: HttpClient<O>);
|
|
527
|
+
/**
|
|
528
|
+
* HTTP GET /configuration/manager
|
|
529
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
530
|
+
*/
|
|
531
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
532
|
+
/**
|
|
533
|
+
* HTTP PUT /configuration/manager
|
|
534
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
535
|
+
*/
|
|
536
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
537
|
+
/**
|
|
538
|
+
* HTTP POST /configuration/manager/file
|
|
539
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
540
|
+
*/
|
|
541
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
542
|
+
path?: string;
|
|
543
|
+
}, options?: O): RestResponse<string>;
|
|
544
|
+
/**
|
|
545
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
546
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
547
|
+
*/
|
|
548
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
549
|
+
}
|
|
550
|
+
export declare class ProvisioningResourceClient<O> {
|
|
551
|
+
protected httpClient: HttpClient<O>;
|
|
552
|
+
constructor(httpClient: HttpClient<O>);
|
|
553
|
+
/**
|
|
554
|
+
* HTTP POST /provisioning
|
|
555
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
556
|
+
*/
|
|
557
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
558
|
+
/**
|
|
559
|
+
* HTTP GET /provisioning
|
|
560
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
561
|
+
*/
|
|
562
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
563
|
+
/**
|
|
564
|
+
* HTTP DELETE /provisioning/{id}
|
|
565
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
566
|
+
*/
|
|
567
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
568
|
+
/**
|
|
569
|
+
* HTTP PUT /provisioning/{id}
|
|
570
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
571
|
+
*/
|
|
572
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
573
|
+
}
|
|
574
|
+
export declare class GatewayClientResourceClient<O> {
|
|
575
|
+
protected httpClient: HttpClient<O>;
|
|
576
|
+
constructor(httpClient: HttpClient<O>);
|
|
577
|
+
/**
|
|
578
|
+
* HTTP DELETE /gateway/connection
|
|
579
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
580
|
+
*/
|
|
581
|
+
deleteConnections(queryParams?: {
|
|
582
|
+
realm?: string[];
|
|
583
|
+
}, options?: O): RestResponse<void>;
|
|
584
|
+
/**
|
|
585
|
+
* HTTP GET /gateway/connection
|
|
586
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
587
|
+
*/
|
|
588
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
589
|
+
/**
|
|
590
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
591
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
592
|
+
*/
|
|
593
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
594
|
+
/**
|
|
595
|
+
* HTTP GET /gateway/connection/{realm}
|
|
596
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
597
|
+
*/
|
|
598
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
599
|
+
/**
|
|
600
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
601
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
602
|
+
*/
|
|
603
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
604
|
+
/**
|
|
605
|
+
* HTTP GET /gateway/status/{realm}
|
|
606
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
607
|
+
*/
|
|
608
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
609
|
+
}
|
|
610
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
611
|
+
protected httpClient: HttpClient<O>;
|
|
612
|
+
constructor(httpClient: HttpClient<O>);
|
|
613
|
+
/**
|
|
614
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
615
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
616
|
+
*/
|
|
617
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
637
618
|
/**
|
|
638
|
-
* HTTP
|
|
639
|
-
* Java method: org.openremote.model.
|
|
619
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
620
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
640
621
|
*/
|
|
641
|
-
|
|
622
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
623
|
+
}
|
|
624
|
+
export declare class NotificationResourceClient<O> {
|
|
625
|
+
protected httpClient: HttpClient<O>;
|
|
626
|
+
constructor(httpClient: HttpClient<O>);
|
|
642
627
|
/**
|
|
643
|
-
* HTTP
|
|
644
|
-
* Java method: org.openremote.model.
|
|
628
|
+
* HTTP GET /notification
|
|
629
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
645
630
|
*/
|
|
646
|
-
|
|
631
|
+
getNotifications(queryParams?: {
|
|
632
|
+
id?: number;
|
|
633
|
+
type?: string;
|
|
634
|
+
from?: number;
|
|
635
|
+
to?: number;
|
|
636
|
+
realmId?: string;
|
|
637
|
+
userId?: string;
|
|
638
|
+
assetId?: string;
|
|
639
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
647
640
|
/**
|
|
648
|
-
* HTTP
|
|
649
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP DELETE /notification
|
|
642
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
650
643
|
*/
|
|
651
|
-
|
|
644
|
+
removeNotifications(queryParams?: {
|
|
645
|
+
id?: number;
|
|
646
|
+
type?: string;
|
|
647
|
+
from?: number;
|
|
648
|
+
to?: number;
|
|
649
|
+
realmId?: string;
|
|
650
|
+
userId?: string;
|
|
651
|
+
assetId?: string;
|
|
652
|
+
}, options?: O): RestResponse<void>;
|
|
652
653
|
/**
|
|
653
|
-
* HTTP
|
|
654
|
-
* Java method: org.openremote.model.
|
|
654
|
+
* HTTP POST /notification/alert
|
|
655
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
655
656
|
*/
|
|
656
|
-
|
|
657
|
-
realm?: string;
|
|
658
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
659
|
-
}
|
|
660
|
-
export declare class AppResourceClient<O> {
|
|
661
|
-
protected httpClient: HttpClient<O>;
|
|
662
|
-
constructor(httpClient: HttpClient<O>);
|
|
657
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
663
658
|
/**
|
|
664
|
-
* HTTP
|
|
665
|
-
* Java method: org.openremote.model.
|
|
659
|
+
* HTTP DELETE /notification/{notificationId}
|
|
660
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
666
661
|
*/
|
|
667
|
-
|
|
662
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
668
663
|
/**
|
|
669
|
-
* HTTP
|
|
670
|
-
* Java method: org.openremote.model.
|
|
664
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
665
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
671
666
|
*/
|
|
672
|
-
|
|
667
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
668
|
+
targetId?: string;
|
|
669
|
+
}, options?: O): RestResponse<void>;
|
|
673
670
|
/**
|
|
674
|
-
* HTTP
|
|
675
|
-
* Java method: org.openremote.model.
|
|
671
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
672
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
676
673
|
*/
|
|
677
|
-
|
|
674
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
675
|
+
targetId?: string;
|
|
676
|
+
}, options?: O): RestResponse<void>;
|
|
678
677
|
}
|
|
679
|
-
export declare class
|
|
678
|
+
export declare class MapResourceClient<O> {
|
|
680
679
|
protected httpClient: HttpClient<O>;
|
|
681
680
|
constructor(httpClient: HttpClient<O>);
|
|
682
681
|
/**
|
|
683
|
-
* HTTP GET /
|
|
684
|
-
* Java method: org.openremote.model.
|
|
685
|
-
*/
|
|
686
|
-
getAssetDescriptors(queryParams?: {
|
|
687
|
-
parentId?: string;
|
|
688
|
-
parentType?: string;
|
|
689
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
690
|
-
/**
|
|
691
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
692
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
682
|
+
* HTTP GET /map
|
|
683
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
693
684
|
*/
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
}
|
|
685
|
+
getSettings(options?: O): RestResponse<{
|
|
686
|
+
[id: string]: unknown;
|
|
687
|
+
}>;
|
|
697
688
|
/**
|
|
698
|
-
* HTTP
|
|
699
|
-
* Java method: org.openremote.model.
|
|
689
|
+
* HTTP PUT /map
|
|
690
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
700
691
|
*/
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
692
|
+
saveSettings(mapConfig: {
|
|
693
|
+
[index: string]: Model.MapRealmConfig;
|
|
694
|
+
}, options?: O): RestResponse<any>;
|
|
705
695
|
/**
|
|
706
|
-
* HTTP GET /
|
|
707
|
-
* Java method: org.openremote.model.
|
|
696
|
+
* HTTP GET /map/js
|
|
697
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
708
698
|
*/
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
}, options?: O): RestResponse<{
|
|
712
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
699
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
700
|
+
[id: string]: unknown;
|
|
713
701
|
}>;
|
|
714
702
|
/**
|
|
715
|
-
* HTTP GET /
|
|
716
|
-
* Java method: org.openremote.model.
|
|
703
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
704
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
717
705
|
*/
|
|
718
|
-
|
|
719
|
-
parentId?: string;
|
|
720
|
-
}, options?: O): RestResponse<{
|
|
721
|
-
[index: string]: Model.ValueDescriptor;
|
|
722
|
-
}>;
|
|
706
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
723
707
|
}
|
|
724
708
|
export declare class RulesResourceClient<O> {
|
|
725
709
|
protected httpClient: HttpClient<O>;
|
|
@@ -855,69 +839,85 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
855
839
|
*/
|
|
856
840
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
857
841
|
}
|
|
858
|
-
export declare class
|
|
842
|
+
export declare class DashboardResourceClient<O> {
|
|
859
843
|
protected httpClient: HttpClient<O>;
|
|
860
844
|
constructor(httpClient: HttpClient<O>);
|
|
861
845
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
846
|
+
* HTTP POST /dashboard
|
|
847
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
864
848
|
*/
|
|
865
|
-
|
|
866
|
-
[index: string]: any;
|
|
867
|
-
}>;
|
|
849
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
868
850
|
/**
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
851
|
+
* HTTP PUT /dashboard
|
|
852
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
871
853
|
*/
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
854
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
855
|
+
/**
|
|
856
|
+
* HTTP GET /dashboard/all/{realm}
|
|
857
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
858
|
+
*/
|
|
859
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
860
|
+
/**
|
|
861
|
+
* HTTP POST /dashboard/query
|
|
862
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
863
|
+
*/
|
|
864
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
865
|
+
/**
|
|
866
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
867
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
868
|
+
*/
|
|
869
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
870
|
+
/**
|
|
871
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
872
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
873
|
+
*/
|
|
874
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
879
|
-
protected
|
|
878
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
879
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
880
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
881
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
882
|
+
protected _userResource: AxiosUserResourceClient;
|
|
883
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
884
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
880
885
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
886
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
887
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
888
|
+
protected _appResource: AxiosAppResourceClient;
|
|
881
889
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
882
|
-
protected
|
|
883
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
884
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
890
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
885
891
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
892
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
893
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
886
894
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
887
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
888
|
-
protected _userResource: AxiosUserResourceClient;
|
|
889
895
|
protected _mapResource: AxiosMapResourceClient;
|
|
890
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
891
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
892
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
893
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
894
|
-
protected _appResource: AxiosAppResourceClient;
|
|
895
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
896
896
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
897
897
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
898
|
-
protected
|
|
898
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
901
|
-
get
|
|
900
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
901
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
902
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
903
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
904
|
+
get UserResource(): AxiosUserResourceClient;
|
|
905
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
906
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
902
907
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
908
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
909
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
910
|
+
get AppResource(): AxiosAppResourceClient;
|
|
903
911
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
904
|
-
get
|
|
905
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
906
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
912
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
907
913
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
914
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
915
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
908
916
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
909
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
910
|
-
get UserResource(): AxiosUserResourceClient;
|
|
911
917
|
get MapResource(): AxiosMapResourceClient;
|
|
912
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
913
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
914
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
915
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
916
|
-
get AppResource(): AxiosAppResourceClient;
|
|
917
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
918
918
|
get RulesResource(): AxiosRulesResourceClient;
|
|
919
919
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
920
|
-
get
|
|
920
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,58 +925,58 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<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 AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
982
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -985,6 +985,6 @@ export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.
|
|
|
985
985
|
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|