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