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