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