@openremote/rest 1.4.0-snapshot.20250325085710 → 1.4.0-snapshot.20250326102055
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 +293 -293
- 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,29 +9,31 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP GET /provisioning
|
|
22
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
16
|
+
* HTTP GET /asset/datapoint/export
|
|
17
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
23
18
|
*/
|
|
24
|
-
|
|
19
|
+
getDatapointExport(queryParams?: {
|
|
20
|
+
attributeRefs?: string;
|
|
21
|
+
fromTimestamp?: number;
|
|
22
|
+
toTimestamp?: number;
|
|
23
|
+
}, options?: O): RestResponse<any>;
|
|
25
24
|
/**
|
|
26
|
-
* HTTP
|
|
27
|
-
* Java method: org.openremote.model.
|
|
25
|
+
* HTTP GET /asset/datapoint/periods
|
|
26
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
28
27
|
*/
|
|
29
|
-
|
|
28
|
+
getDatapointPeriod(queryParams?: {
|
|
29
|
+
assetId?: string;
|
|
30
|
+
attributeName?: string;
|
|
31
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
30
32
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
34
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
33
35
|
*/
|
|
34
|
-
|
|
36
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
35
37
|
}
|
|
36
38
|
export declare class ConsoleResourceClient<O> {
|
|
37
39
|
protected httpClient: HttpClient<O>;
|
|
@@ -42,77 +44,24 @@ export declare class ConsoleResourceClient<O> {
|
|
|
42
44
|
*/
|
|
43
45
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
44
46
|
}
|
|
45
|
-
export declare class
|
|
46
|
-
protected httpClient: HttpClient<O>;
|
|
47
|
-
constructor(httpClient: HttpClient<O>);
|
|
48
|
-
/**
|
|
49
|
-
* HTTP GET /health
|
|
50
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
51
|
-
*/
|
|
52
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
53
|
-
[index: string]: any;
|
|
54
|
-
}>;
|
|
55
|
-
/**
|
|
56
|
-
* HTTP GET /info
|
|
57
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
58
|
-
*/
|
|
59
|
-
getInfo(options?: O): RestResponse<{
|
|
60
|
-
[index: string]: any;
|
|
61
|
-
}>;
|
|
62
|
-
}
|
|
63
|
-
export declare class NotificationResourceClient<O> {
|
|
47
|
+
export declare class FlowResourceClient<O> {
|
|
64
48
|
protected httpClient: HttpClient<O>;
|
|
65
49
|
constructor(httpClient: HttpClient<O>);
|
|
66
50
|
/**
|
|
67
|
-
* HTTP GET /
|
|
68
|
-
* Java method: org.openremote.model.
|
|
69
|
-
*/
|
|
70
|
-
getNotifications(queryParams?: {
|
|
71
|
-
id?: number;
|
|
72
|
-
type?: string;
|
|
73
|
-
from?: number;
|
|
74
|
-
to?: number;
|
|
75
|
-
realmId?: string;
|
|
76
|
-
userId?: string;
|
|
77
|
-
assetId?: string;
|
|
78
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
79
|
-
/**
|
|
80
|
-
* HTTP DELETE /notification
|
|
81
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
82
|
-
*/
|
|
83
|
-
removeNotifications(queryParams?: {
|
|
84
|
-
id?: number;
|
|
85
|
-
type?: string;
|
|
86
|
-
from?: number;
|
|
87
|
-
to?: number;
|
|
88
|
-
realmId?: string;
|
|
89
|
-
userId?: string;
|
|
90
|
-
assetId?: string;
|
|
91
|
-
}, options?: O): RestResponse<void>;
|
|
92
|
-
/**
|
|
93
|
-
* HTTP POST /notification/alert
|
|
94
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
95
|
-
*/
|
|
96
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
97
|
-
/**
|
|
98
|
-
* HTTP DELETE /notification/{notificationId}
|
|
99
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
51
|
+
* HTTP GET /flow
|
|
52
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
100
53
|
*/
|
|
101
|
-
|
|
54
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
102
55
|
/**
|
|
103
|
-
* HTTP
|
|
104
|
-
* Java method: org.openremote.model.
|
|
56
|
+
* HTTP GET /flow/{name}
|
|
57
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
105
58
|
*/
|
|
106
|
-
|
|
107
|
-
targetId?: string;
|
|
108
|
-
}, options?: O): RestResponse<void>;
|
|
59
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
109
60
|
/**
|
|
110
|
-
* HTTP
|
|
111
|
-
* Java method: org.openremote.model.
|
|
61
|
+
* HTTP GET /flow/{type}
|
|
62
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
112
63
|
*/
|
|
113
|
-
|
|
114
|
-
targetId?: string;
|
|
115
|
-
}, options?: O): RestResponse<void>;
|
|
64
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
116
65
|
}
|
|
117
66
|
export declare class GatewayServiceResourceClient<O> {
|
|
118
67
|
protected httpClient: HttpClient<O>;
|
|
@@ -247,31 +196,19 @@ export declare class AssetResourceClient<O> {
|
|
|
247
196
|
assetIds?: string[];
|
|
248
197
|
}, options?: O): RestResponse<void>;
|
|
249
198
|
}
|
|
250
|
-
export declare class
|
|
199
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
251
200
|
protected httpClient: HttpClient<O>;
|
|
252
201
|
constructor(httpClient: HttpClient<O>);
|
|
253
202
|
/**
|
|
254
|
-
* HTTP
|
|
255
|
-
* Java method: org.openremote.model.datapoint.
|
|
256
|
-
*/
|
|
257
|
-
getDatapointExport(queryParams?: {
|
|
258
|
-
attributeRefs?: string;
|
|
259
|
-
fromTimestamp?: number;
|
|
260
|
-
toTimestamp?: number;
|
|
261
|
-
}, options?: O): RestResponse<any>;
|
|
262
|
-
/**
|
|
263
|
-
* HTTP GET /asset/datapoint/periods
|
|
264
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
203
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
204
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
265
205
|
*/
|
|
266
|
-
|
|
267
|
-
assetId?: string;
|
|
268
|
-
attributeName?: string;
|
|
269
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
206
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
270
207
|
/**
|
|
271
|
-
* HTTP
|
|
272
|
-
* Java method: org.openremote.model.datapoint.
|
|
208
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
209
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
273
210
|
*/
|
|
274
|
-
|
|
211
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
275
212
|
}
|
|
276
213
|
export declare class RealmResourceClient<O> {
|
|
277
214
|
protected httpClient: HttpClient<O>;
|
|
@@ -307,38 +244,127 @@ export declare class RealmResourceClient<O> {
|
|
|
307
244
|
*/
|
|
308
245
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
309
246
|
}
|
|
310
|
-
export declare class
|
|
247
|
+
export declare class AgentResourceClient<O> {
|
|
311
248
|
protected httpClient: HttpClient<O>;
|
|
312
249
|
constructor(httpClient: HttpClient<O>);
|
|
313
250
|
/**
|
|
314
|
-
* HTTP
|
|
315
|
-
* Java method: org.openremote.model.
|
|
251
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
252
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
316
253
|
*/
|
|
317
|
-
|
|
254
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
255
|
+
realm?: string;
|
|
256
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
318
257
|
/**
|
|
319
|
-
* HTTP
|
|
320
|
-
* Java method: org.openremote.model.
|
|
258
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
259
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
321
260
|
*/
|
|
322
|
-
|
|
261
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
262
|
+
realm?: string;
|
|
263
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
264
|
+
/**
|
|
265
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
266
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
267
|
+
*/
|
|
268
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
269
|
+
parentId?: string;
|
|
270
|
+
realm?: string;
|
|
271
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
323
272
|
}
|
|
324
|
-
export declare class
|
|
273
|
+
export declare class MapResourceClient<O> {
|
|
325
274
|
protected httpClient: HttpClient<O>;
|
|
326
275
|
constructor(httpClient: HttpClient<O>);
|
|
327
276
|
/**
|
|
328
|
-
* HTTP GET /
|
|
329
|
-
* Java method: org.openremote.model.
|
|
277
|
+
* HTTP GET /map
|
|
278
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
330
279
|
*/
|
|
331
|
-
|
|
280
|
+
getSettings(options?: O): RestResponse<{
|
|
281
|
+
[id: string]: unknown;
|
|
282
|
+
}>;
|
|
332
283
|
/**
|
|
333
|
-
* HTTP
|
|
334
|
-
* Java method: org.openremote.model.
|
|
284
|
+
* HTTP PUT /map
|
|
285
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
335
286
|
*/
|
|
336
|
-
|
|
287
|
+
saveSettings(mapConfig: {
|
|
288
|
+
[index: string]: Model.MapRealmConfig;
|
|
289
|
+
}, options?: O): RestResponse<any>;
|
|
337
290
|
/**
|
|
338
|
-
* HTTP GET /
|
|
339
|
-
* Java method: org.openremote.model.
|
|
291
|
+
* HTTP GET /map/js
|
|
292
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
340
293
|
*/
|
|
341
|
-
|
|
294
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
295
|
+
[id: string]: unknown;
|
|
296
|
+
}>;
|
|
297
|
+
/**
|
|
298
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
299
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
300
|
+
*/
|
|
301
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
302
|
+
}
|
|
303
|
+
export declare class SyslogResourceClient<O> {
|
|
304
|
+
protected httpClient: HttpClient<O>;
|
|
305
|
+
constructor(httpClient: HttpClient<O>);
|
|
306
|
+
/**
|
|
307
|
+
* HTTP GET /syslog/config
|
|
308
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
309
|
+
*/
|
|
310
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
311
|
+
/**
|
|
312
|
+
* HTTP PUT /syslog/config
|
|
313
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
314
|
+
*/
|
|
315
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
316
|
+
/**
|
|
317
|
+
* HTTP DELETE /syslog/event
|
|
318
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
319
|
+
*/
|
|
320
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
321
|
+
/**
|
|
322
|
+
* HTTP GET /syslog/event
|
|
323
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
324
|
+
*/
|
|
325
|
+
getEvents(queryParams?: {
|
|
326
|
+
level?: Model.SyslogLevel;
|
|
327
|
+
per_page?: number;
|
|
328
|
+
page?: number;
|
|
329
|
+
from?: number;
|
|
330
|
+
to?: number;
|
|
331
|
+
category?: Model.SyslogCategory[];
|
|
332
|
+
subCategory?: string[];
|
|
333
|
+
}, options?: O): RestResponse<any>;
|
|
334
|
+
}
|
|
335
|
+
export declare class DashboardResourceClient<O> {
|
|
336
|
+
protected httpClient: HttpClient<O>;
|
|
337
|
+
constructor(httpClient: HttpClient<O>);
|
|
338
|
+
/**
|
|
339
|
+
* HTTP POST /dashboard
|
|
340
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
341
|
+
*/
|
|
342
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
343
|
+
/**
|
|
344
|
+
* HTTP PUT /dashboard
|
|
345
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
346
|
+
*/
|
|
347
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
348
|
+
/**
|
|
349
|
+
* HTTP GET /dashboard/all/{realm}
|
|
350
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
351
|
+
*/
|
|
352
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
353
|
+
/**
|
|
354
|
+
* HTTP POST /dashboard/query
|
|
355
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
356
|
+
*/
|
|
357
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
358
|
+
/**
|
|
359
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
360
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
361
|
+
*/
|
|
362
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
363
|
+
/**
|
|
364
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
365
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
366
|
+
*/
|
|
367
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
342
368
|
}
|
|
343
369
|
export declare class AlarmResourceClient<O> {
|
|
344
370
|
protected httpClient: HttpClient<O>;
|
|
@@ -517,163 +543,146 @@ export declare class UserResourceClient<O> {
|
|
|
517
543
|
*/
|
|
518
544
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
519
545
|
}
|
|
520
|
-
export declare class
|
|
546
|
+
export declare class NotificationResourceClient<O> {
|
|
521
547
|
protected httpClient: HttpClient<O>;
|
|
522
548
|
constructor(httpClient: HttpClient<O>);
|
|
523
549
|
/**
|
|
524
|
-
* HTTP GET /
|
|
525
|
-
* Java method: org.openremote.model.
|
|
526
|
-
*/
|
|
527
|
-
getSettings(options?: O): RestResponse<{
|
|
528
|
-
[id: string]: unknown;
|
|
529
|
-
}>;
|
|
530
|
-
/**
|
|
531
|
-
* HTTP PUT /map
|
|
532
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
550
|
+
* HTTP GET /notification
|
|
551
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
533
552
|
*/
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
553
|
+
getNotifications(queryParams?: {
|
|
554
|
+
id?: number;
|
|
555
|
+
type?: string;
|
|
556
|
+
from?: number;
|
|
557
|
+
to?: number;
|
|
558
|
+
realmId?: string;
|
|
559
|
+
userId?: string;
|
|
560
|
+
assetId?: string;
|
|
561
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
537
562
|
/**
|
|
538
|
-
* HTTP
|
|
539
|
-
* Java method: org.openremote.model.
|
|
563
|
+
* HTTP DELETE /notification
|
|
564
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
540
565
|
*/
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
566
|
+
removeNotifications(queryParams?: {
|
|
567
|
+
id?: number;
|
|
568
|
+
type?: string;
|
|
569
|
+
from?: number;
|
|
570
|
+
to?: number;
|
|
571
|
+
realmId?: string;
|
|
572
|
+
userId?: string;
|
|
573
|
+
assetId?: string;
|
|
574
|
+
}, options?: O): RestResponse<void>;
|
|
544
575
|
/**
|
|
545
|
-
* HTTP
|
|
546
|
-
* Java method: org.openremote.model.
|
|
576
|
+
* HTTP POST /notification/alert
|
|
577
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
547
578
|
*/
|
|
548
|
-
|
|
549
|
-
}
|
|
550
|
-
export declare class AgentResourceClient<O> {
|
|
551
|
-
protected httpClient: HttpClient<O>;
|
|
552
|
-
constructor(httpClient: HttpClient<O>);
|
|
579
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
553
580
|
/**
|
|
554
|
-
* HTTP
|
|
555
|
-
* Java method: org.openremote.model.
|
|
581
|
+
* HTTP DELETE /notification/{notificationId}
|
|
582
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
556
583
|
*/
|
|
557
|
-
|
|
558
|
-
realm?: string;
|
|
559
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
584
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
560
585
|
/**
|
|
561
|
-
* HTTP
|
|
562
|
-
* Java method: org.openremote.model.
|
|
586
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
587
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
563
588
|
*/
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
}, options?: O): RestResponse<
|
|
589
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
590
|
+
targetId?: string;
|
|
591
|
+
}, options?: O): RestResponse<void>;
|
|
567
592
|
/**
|
|
568
|
-
* HTTP
|
|
569
|
-
* Java method: org.openremote.model.
|
|
593
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
594
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
570
595
|
*/
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
596
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
597
|
+
targetId?: string;
|
|
598
|
+
}, options?: O): RestResponse<void>;
|
|
575
599
|
}
|
|
576
|
-
export declare class
|
|
600
|
+
export declare class ConfigurationResourceClient<O> {
|
|
577
601
|
protected httpClient: HttpClient<O>;
|
|
578
602
|
constructor(httpClient: HttpClient<O>);
|
|
579
603
|
/**
|
|
580
|
-
* HTTP
|
|
581
|
-
* Java method: org.openremote.model.
|
|
604
|
+
* HTTP GET /configuration/manager
|
|
605
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
582
606
|
*/
|
|
583
|
-
|
|
607
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
584
608
|
/**
|
|
585
|
-
* HTTP PUT /
|
|
586
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* HTTP PUT /configuration/manager
|
|
610
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
587
611
|
*/
|
|
588
|
-
update(
|
|
612
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
589
613
|
/**
|
|
590
|
-
* HTTP
|
|
591
|
-
* Java method: org.openremote.model.
|
|
614
|
+
* HTTP POST /configuration/manager/file
|
|
615
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
592
616
|
*/
|
|
593
|
-
|
|
617
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
618
|
+
path?: string;
|
|
619
|
+
}, options?: O): RestResponse<string>;
|
|
594
620
|
/**
|
|
595
|
-
* HTTP
|
|
596
|
-
* Java method: org.openremote.model.
|
|
621
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
622
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
597
623
|
*/
|
|
598
|
-
|
|
624
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
625
|
+
}
|
|
626
|
+
export declare class StatusResourceClient<O> {
|
|
627
|
+
protected httpClient: HttpClient<O>;
|
|
628
|
+
constructor(httpClient: HttpClient<O>);
|
|
599
629
|
/**
|
|
600
|
-
* HTTP
|
|
601
|
-
* Java method: org.openremote.model.
|
|
630
|
+
* HTTP GET /health
|
|
631
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
602
632
|
*/
|
|
603
|
-
|
|
633
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
634
|
+
[index: string]: any;
|
|
635
|
+
}>;
|
|
604
636
|
/**
|
|
605
|
-
* HTTP GET /
|
|
606
|
-
* Java method: org.openremote.model.
|
|
637
|
+
* HTTP GET /info
|
|
638
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
607
639
|
*/
|
|
608
|
-
|
|
640
|
+
getInfo(options?: O): RestResponse<{
|
|
641
|
+
[index: string]: any;
|
|
642
|
+
}>;
|
|
609
643
|
}
|
|
610
|
-
export declare class
|
|
644
|
+
export declare class AppResourceClient<O> {
|
|
611
645
|
protected httpClient: HttpClient<O>;
|
|
612
646
|
constructor(httpClient: HttpClient<O>);
|
|
613
647
|
/**
|
|
614
|
-
* HTTP GET /
|
|
615
|
-
* Java method: org.openremote.model.
|
|
616
|
-
*/
|
|
617
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
618
|
-
/**
|
|
619
|
-
* HTTP PUT /syslog/config
|
|
620
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
648
|
+
* HTTP GET /apps
|
|
649
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
621
650
|
*/
|
|
622
|
-
|
|
651
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
623
652
|
/**
|
|
624
|
-
* HTTP
|
|
625
|
-
* Java method: org.openremote.model.
|
|
653
|
+
* HTTP GET /apps/consoleConfig
|
|
654
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
626
655
|
*/
|
|
627
|
-
|
|
656
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
628
657
|
/**
|
|
629
|
-
* HTTP GET /
|
|
630
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP GET /apps/info
|
|
659
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
631
660
|
*/
|
|
632
|
-
|
|
633
|
-
level?: Model.SyslogLevel;
|
|
634
|
-
per_page?: number;
|
|
635
|
-
page?: number;
|
|
636
|
-
from?: number;
|
|
637
|
-
to?: number;
|
|
638
|
-
category?: Model.SyslogCategory[];
|
|
639
|
-
subCategory?: string[];
|
|
640
|
-
}, options?: O): RestResponse<any>;
|
|
661
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
641
662
|
}
|
|
642
|
-
export declare class
|
|
663
|
+
export declare class ProvisioningResourceClient<O> {
|
|
643
664
|
protected httpClient: HttpClient<O>;
|
|
644
665
|
constructor(httpClient: HttpClient<O>);
|
|
645
666
|
/**
|
|
646
|
-
* HTTP
|
|
647
|
-
* Java method: org.openremote.model.
|
|
648
|
-
*/
|
|
649
|
-
deleteConnections(queryParams?: {
|
|
650
|
-
realm?: string[];
|
|
651
|
-
}, options?: O): RestResponse<void>;
|
|
652
|
-
/**
|
|
653
|
-
* HTTP GET /gateway/connection
|
|
654
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
655
|
-
*/
|
|
656
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
657
|
-
/**
|
|
658
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
659
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
667
|
+
* HTTP POST /provisioning
|
|
668
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
660
669
|
*/
|
|
661
|
-
|
|
670
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
662
671
|
/**
|
|
663
|
-
* HTTP GET /
|
|
664
|
-
* Java method: org.openremote.model.
|
|
672
|
+
* HTTP GET /provisioning
|
|
673
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
665
674
|
*/
|
|
666
|
-
|
|
675
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
667
676
|
/**
|
|
668
|
-
* HTTP
|
|
669
|
-
* Java method: org.openremote.model.
|
|
677
|
+
* HTTP DELETE /provisioning/{id}
|
|
678
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
670
679
|
*/
|
|
671
|
-
|
|
680
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
672
681
|
/**
|
|
673
|
-
* HTTP
|
|
674
|
-
* Java method: org.openremote.model.
|
|
682
|
+
* HTTP PUT /provisioning/{id}
|
|
683
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
675
684
|
*/
|
|
676
|
-
|
|
685
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
677
686
|
}
|
|
678
687
|
export declare class RulesResourceClient<O> {
|
|
679
688
|
protected httpClient: HttpClient<O>;
|
|
@@ -783,50 +792,41 @@ export declare class RulesResourceClient<O> {
|
|
|
783
792
|
*/
|
|
784
793
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
785
794
|
}
|
|
786
|
-
export declare class
|
|
795
|
+
export declare class GatewayClientResourceClient<O> {
|
|
787
796
|
protected httpClient: HttpClient<O>;
|
|
788
797
|
constructor(httpClient: HttpClient<O>);
|
|
789
798
|
/**
|
|
790
|
-
* HTTP
|
|
791
|
-
* Java method: org.openremote.model.
|
|
792
|
-
*/
|
|
793
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
794
|
-
/**
|
|
795
|
-
* HTTP PUT /configuration/manager
|
|
796
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
799
|
+
* HTTP DELETE /gateway/connection
|
|
800
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
797
801
|
*/
|
|
798
|
-
|
|
802
|
+
deleteConnections(queryParams?: {
|
|
803
|
+
realm?: string[];
|
|
804
|
+
}, options?: O): RestResponse<void>;
|
|
799
805
|
/**
|
|
800
|
-
* HTTP
|
|
801
|
-
* Java method: org.openremote.model.
|
|
806
|
+
* HTTP GET /gateway/connection
|
|
807
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
802
808
|
*/
|
|
803
|
-
|
|
804
|
-
path?: string;
|
|
805
|
-
}, options?: O): RestResponse<string>;
|
|
809
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
806
810
|
/**
|
|
807
|
-
* HTTP
|
|
808
|
-
* Java method: org.openremote.model.
|
|
811
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
812
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
809
813
|
*/
|
|
810
|
-
|
|
811
|
-
}
|
|
812
|
-
export declare class AppResourceClient<O> {
|
|
813
|
-
protected httpClient: HttpClient<O>;
|
|
814
|
-
constructor(httpClient: HttpClient<O>);
|
|
814
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
815
815
|
/**
|
|
816
|
-
* HTTP GET /
|
|
817
|
-
* Java method: org.openremote.model.
|
|
816
|
+
* HTTP GET /gateway/connection/{realm}
|
|
817
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
818
818
|
*/
|
|
819
|
-
|
|
819
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
820
820
|
/**
|
|
821
|
-
* HTTP
|
|
822
|
-
* Java method: org.openremote.model.
|
|
821
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
822
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
823
823
|
*/
|
|
824
|
-
|
|
824
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
825
825
|
/**
|
|
826
|
-
* HTTP GET /
|
|
827
|
-
* Java method: org.openremote.model.
|
|
826
|
+
* HTTP GET /gateway/status/{realm}
|
|
827
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
828
828
|
*/
|
|
829
|
-
|
|
829
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
830
830
|
}
|
|
831
831
|
export declare class AssetModelResourceClient<O> {
|
|
832
832
|
protected httpClient: HttpClient<O>;
|
|
@@ -875,48 +875,48 @@ export declare class AssetModelResourceClient<O> {
|
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
878
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
879
879
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
880
|
-
protected
|
|
881
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
880
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
882
881
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
883
882
|
protected _assetResource: AxiosAssetResourceClient;
|
|
884
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
885
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
886
883
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
887
|
-
protected
|
|
888
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
889
|
-
protected _userResource: AxiosUserResourceClient;
|
|
890
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
884
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
891
885
|
protected _agentResource: AxiosAgentResourceClient;
|
|
892
|
-
protected
|
|
886
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
893
887
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
894
|
-
protected
|
|
895
|
-
protected
|
|
888
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
889
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
890
|
+
protected _userResource: AxiosUserResourceClient;
|
|
891
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
896
892
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
893
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
897
894
|
protected _appResource: AxiosAppResourceClient;
|
|
895
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
896
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
897
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
898
898
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
900
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
901
901
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
902
|
-
get
|
|
903
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
902
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
904
903
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
905
904
|
get AssetResource(): AxiosAssetResourceClient;
|
|
906
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
907
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
908
905
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
909
|
-
get
|
|
910
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
911
|
-
get UserResource(): AxiosUserResourceClient;
|
|
912
|
-
get MapResource(): AxiosMapResourceClient;
|
|
906
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
913
907
|
get AgentResource(): AxiosAgentResourceClient;
|
|
914
|
-
get
|
|
908
|
+
get MapResource(): AxiosMapResourceClient;
|
|
915
909
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
916
|
-
get
|
|
917
|
-
get
|
|
910
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
911
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
912
|
+
get UserResource(): AxiosUserResourceClient;
|
|
913
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
918
914
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
915
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
919
916
|
get AppResource(): AxiosAppResourceClient;
|
|
917
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
918
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
919
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
920
920
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
@@ -925,16 +925,13 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
931
|
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
935
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
|
-
}
|
|
937
|
-
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
934
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
937
|
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -943,16 +940,22 @@ export declare class AxiosGatewayServiceResourceClient extends GatewayServiceRes
|
|
|
943
940
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
|
-
export declare class
|
|
943
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
946
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
|
-
export declare class
|
|
949
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
|
-
export declare class
|
|
952
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
953
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
|
+
}
|
|
955
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
956
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
|
+
}
|
|
958
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
956
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
960
|
}
|
|
958
961
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -961,28 +964,25 @@ export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.
|
|
|
961
964
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
962
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
966
|
}
|
|
964
|
-
export declare class
|
|
967
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
965
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
969
|
}
|
|
967
|
-
export declare class
|
|
970
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
968
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
972
|
}
|
|
970
|
-
export declare class
|
|
973
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
971
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
975
|
}
|
|
973
|
-
export declare class
|
|
976
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
974
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
978
|
}
|
|
976
|
-
export declare class
|
|
979
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
977
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
981
|
}
|
|
979
982
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
980
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
984
|
}
|
|
982
|
-
export declare class
|
|
983
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
|
-
}
|
|
985
|
-
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
985
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
988
|
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|