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