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