@openremote/rest 1.3.0-snapshot.20250117092414 → 1.3.0-snapshot.20250117163435
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 +415 -415
- 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,169 +9,182 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class SyslogResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /syslog/config
|
|
17
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /syslog/config
|
|
22
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
25
25
|
/**
|
|
26
|
-
* HTTP
|
|
27
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP DELETE /syslog/event
|
|
27
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
30
|
+
/**
|
|
31
|
+
* HTTP GET /syslog/event
|
|
32
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
33
|
+
*/
|
|
34
|
+
getEvents(queryParams?: {
|
|
35
|
+
level?: Model.SyslogLevel;
|
|
36
|
+
per_page?: any;
|
|
37
|
+
page?: any;
|
|
38
|
+
from?: any;
|
|
39
|
+
to?: any;
|
|
40
|
+
category?: Model.SyslogCategory[];
|
|
41
|
+
subCategory?: any[];
|
|
42
|
+
}, options?: O): RestResponse<any>;
|
|
30
43
|
}
|
|
31
|
-
export declare class
|
|
44
|
+
export declare class RealmResourceClient<O> {
|
|
32
45
|
protected httpClient: HttpClient<O>;
|
|
33
46
|
constructor(httpClient: HttpClient<O>);
|
|
34
47
|
/**
|
|
35
|
-
* HTTP POST /
|
|
36
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP POST /realm
|
|
49
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
37
50
|
*/
|
|
38
|
-
create(
|
|
51
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
39
52
|
/**
|
|
40
|
-
* HTTP
|
|
41
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* HTTP GET /realm
|
|
54
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
42
55
|
*/
|
|
43
|
-
|
|
56
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
44
57
|
/**
|
|
45
|
-
* HTTP GET /
|
|
46
|
-
* Java method: org.openremote.model.
|
|
58
|
+
* HTTP GET /realm/accessible
|
|
59
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
47
60
|
*/
|
|
48
|
-
|
|
61
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
49
62
|
/**
|
|
50
|
-
* HTTP
|
|
51
|
-
* Java method: org.openremote.model.
|
|
63
|
+
* HTTP DELETE /realm/{name}
|
|
64
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
52
65
|
*/
|
|
53
|
-
|
|
66
|
+
delete(name: any, options?: O): RestResponse<void>;
|
|
54
67
|
/**
|
|
55
|
-
* HTTP
|
|
56
|
-
* Java method: org.openremote.model.
|
|
68
|
+
* HTTP GET /realm/{name}
|
|
69
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
57
70
|
*/
|
|
58
|
-
|
|
71
|
+
get(name: any, options?: O): RestResponse<Model.Realm>;
|
|
59
72
|
/**
|
|
60
|
-
* HTTP
|
|
61
|
-
* Java method: org.openremote.model.
|
|
73
|
+
* HTTP PUT /realm/{name}
|
|
74
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
62
75
|
*/
|
|
63
|
-
|
|
76
|
+
update(name: any, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
64
77
|
}
|
|
65
|
-
export declare class
|
|
78
|
+
export declare class NotificationResourceClient<O> {
|
|
66
79
|
protected httpClient: HttpClient<O>;
|
|
67
80
|
constructor(httpClient: HttpClient<O>);
|
|
68
81
|
/**
|
|
69
|
-
* HTTP GET /
|
|
70
|
-
* Java method: org.openremote.model.
|
|
82
|
+
* HTTP GET /notification
|
|
83
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
71
84
|
*/
|
|
72
|
-
|
|
85
|
+
getNotifications(queryParams?: {
|
|
86
|
+
id?: any;
|
|
87
|
+
type?: any;
|
|
88
|
+
from?: any;
|
|
89
|
+
to?: any;
|
|
90
|
+
realmId?: any;
|
|
91
|
+
userId?: any;
|
|
92
|
+
assetId?: any;
|
|
93
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
73
94
|
/**
|
|
74
|
-
* HTTP
|
|
75
|
-
* Java method: org.openremote.model.
|
|
95
|
+
* HTTP DELETE /notification
|
|
96
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
76
97
|
*/
|
|
77
|
-
|
|
98
|
+
removeNotifications(queryParams?: {
|
|
99
|
+
id?: any;
|
|
100
|
+
type?: any;
|
|
101
|
+
from?: any;
|
|
102
|
+
to?: any;
|
|
103
|
+
realmId?: any;
|
|
104
|
+
userId?: any;
|
|
105
|
+
assetId?: any;
|
|
106
|
+
}, options?: O): RestResponse<void>;
|
|
78
107
|
/**
|
|
79
|
-
* HTTP
|
|
80
|
-
* Java method: org.openremote.model.
|
|
108
|
+
* HTTP POST /notification/alert
|
|
109
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
81
110
|
*/
|
|
82
|
-
|
|
83
|
-
}
|
|
84
|
-
export declare class ConsoleResourceClient<O> {
|
|
85
|
-
protected httpClient: HttpClient<O>;
|
|
86
|
-
constructor(httpClient: HttpClient<O>);
|
|
111
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
87
112
|
/**
|
|
88
|
-
* HTTP
|
|
89
|
-
* Java method: org.openremote.model.
|
|
113
|
+
* HTTP DELETE /notification/{notificationId}
|
|
114
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
90
115
|
*/
|
|
91
|
-
|
|
92
|
-
}
|
|
93
|
-
export declare class MapResourceClient<O> {
|
|
94
|
-
protected httpClient: HttpClient<O>;
|
|
95
|
-
constructor(httpClient: HttpClient<O>);
|
|
116
|
+
removeNotification(notificationId: any, options?: O): RestResponse<void>;
|
|
96
117
|
/**
|
|
97
|
-
* HTTP
|
|
98
|
-
* Java method: org.openremote.model.
|
|
118
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
119
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
99
120
|
*/
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
}>;
|
|
121
|
+
notificationAcknowledged(notificationId: any, acknowledgement: any, queryParams?: {
|
|
122
|
+
targetId?: any;
|
|
123
|
+
}, options?: O): RestResponse<void>;
|
|
103
124
|
/**
|
|
104
|
-
* HTTP PUT /
|
|
105
|
-
* Java method: org.openremote.model.
|
|
125
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
126
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
106
127
|
*/
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
}, options?: O): RestResponse<
|
|
128
|
+
notificationDelivered(notificationId: any, queryParams?: {
|
|
129
|
+
targetId?: any;
|
|
130
|
+
}, options?: O): RestResponse<void>;
|
|
131
|
+
}
|
|
132
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
133
|
+
protected httpClient: HttpClient<O>;
|
|
134
|
+
constructor(httpClient: HttpClient<O>);
|
|
110
135
|
/**
|
|
111
|
-
* HTTP
|
|
112
|
-
* Java method: org.openremote.model.
|
|
136
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
137
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
113
138
|
*/
|
|
114
|
-
|
|
115
|
-
[id: string]: any;
|
|
116
|
-
}>;
|
|
139
|
+
getPredictedDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
117
140
|
/**
|
|
118
|
-
* HTTP
|
|
119
|
-
* Java method: org.openremote.model.
|
|
141
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
142
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
120
143
|
*/
|
|
121
|
-
|
|
144
|
+
writePredictedDatapoints(assetId: any, attributeName: any, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
122
145
|
}
|
|
123
|
-
export declare class
|
|
146
|
+
export declare class DashboardResourceClient<O> {
|
|
124
147
|
protected httpClient: HttpClient<O>;
|
|
125
148
|
constructor(httpClient: HttpClient<O>);
|
|
126
149
|
/**
|
|
127
|
-
* HTTP POST /
|
|
128
|
-
* Java method: org.openremote.model.
|
|
129
|
-
*/
|
|
130
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
131
|
-
assetIds?: any[];
|
|
132
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
133
|
-
/**
|
|
134
|
-
* HTTP GET /alarm
|
|
135
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
150
|
+
* HTTP POST /dashboard
|
|
151
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
136
152
|
*/
|
|
137
|
-
|
|
138
|
-
realm?: any;
|
|
139
|
-
status?: Model.AlarmStatus;
|
|
140
|
-
assetId?: any;
|
|
141
|
-
assigneeId?: any;
|
|
142
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
153
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
143
154
|
/**
|
|
144
|
-
* HTTP
|
|
145
|
-
* Java method: org.openremote.model.
|
|
155
|
+
* HTTP PUT /dashboard
|
|
156
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
146
157
|
*/
|
|
147
|
-
|
|
158
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
148
159
|
/**
|
|
149
|
-
* HTTP
|
|
150
|
-
* Java method: org.openremote.model.
|
|
160
|
+
* HTTP GET /dashboard/all/{realm}
|
|
161
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
151
162
|
*/
|
|
152
|
-
|
|
163
|
+
getAllRealmDashboards(realm: any, options?: O): RestResponse<Model.Dashboard[]>;
|
|
153
164
|
/**
|
|
154
|
-
* HTTP
|
|
155
|
-
* Java method: org.openremote.model.
|
|
165
|
+
* HTTP POST /dashboard/query
|
|
166
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
156
167
|
*/
|
|
157
|
-
|
|
168
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
158
169
|
/**
|
|
159
|
-
* HTTP DELETE /
|
|
160
|
-
* Java method: org.openremote.model.
|
|
170
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
171
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
161
172
|
*/
|
|
162
|
-
|
|
173
|
+
delete(realm: any, dashboardId: any, options?: O): RestResponse<void>;
|
|
163
174
|
/**
|
|
164
|
-
* HTTP
|
|
165
|
-
* Java method: org.openremote.model.
|
|
175
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
176
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
166
177
|
*/
|
|
167
|
-
|
|
178
|
+
get(realm: any, dashboardId: any, options?: O): RestResponse<Model.Dashboard>;
|
|
179
|
+
}
|
|
180
|
+
export declare class ConsoleResourceClient<O> {
|
|
181
|
+
protected httpClient: HttpClient<O>;
|
|
182
|
+
constructor(httpClient: HttpClient<O>);
|
|
168
183
|
/**
|
|
169
|
-
* HTTP
|
|
170
|
-
* Java method: org.openremote.model.
|
|
184
|
+
* HTTP POST /console/register
|
|
185
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
171
186
|
*/
|
|
172
|
-
|
|
173
|
-
realm?: any;
|
|
174
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
187
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
175
188
|
}
|
|
176
189
|
export declare class RulesResourceClient<O> {
|
|
177
190
|
protected httpClient: HttpClient<O>;
|
|
@@ -281,65 +294,50 @@ export declare class RulesResourceClient<O> {
|
|
|
281
294
|
*/
|
|
282
295
|
updateGlobalRuleset(id: any, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
283
296
|
}
|
|
284
|
-
export declare class
|
|
297
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
285
298
|
protected httpClient: HttpClient<O>;
|
|
286
299
|
constructor(httpClient: HttpClient<O>);
|
|
287
300
|
/**
|
|
288
|
-
* HTTP
|
|
289
|
-
* Java method: org.openremote.model.
|
|
290
|
-
*/
|
|
291
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP GET /provisioning
|
|
294
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
301
|
+
* HTTP GET /asset/datapoint/export
|
|
302
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
295
303
|
*/
|
|
296
|
-
|
|
304
|
+
getDatapointExport(queryParams?: {
|
|
305
|
+
attributeRefs?: any;
|
|
306
|
+
fromTimestamp?: number;
|
|
307
|
+
toTimestamp?: number;
|
|
308
|
+
}, options?: O): RestResponse<any>;
|
|
297
309
|
/**
|
|
298
|
-
* HTTP
|
|
299
|
-
* Java method: org.openremote.model.
|
|
310
|
+
* HTTP GET /asset/datapoint/periods
|
|
311
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
300
312
|
*/
|
|
301
|
-
|
|
313
|
+
getDatapointPeriod(queryParams?: {
|
|
314
|
+
assetId?: any;
|
|
315
|
+
attributeName?: any;
|
|
316
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
302
317
|
/**
|
|
303
|
-
* HTTP
|
|
304
|
-
* Java method: org.openremote.model.
|
|
318
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
319
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
305
320
|
*/
|
|
306
|
-
|
|
321
|
+
getDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
307
322
|
}
|
|
308
|
-
export declare class
|
|
323
|
+
export declare class FlowResourceClient<O> {
|
|
309
324
|
protected httpClient: HttpClient<O>;
|
|
310
325
|
constructor(httpClient: HttpClient<O>);
|
|
311
326
|
/**
|
|
312
|
-
* HTTP
|
|
313
|
-
* Java method: org.openremote.model.
|
|
314
|
-
*/
|
|
315
|
-
deleteConnections(queryParams?: {
|
|
316
|
-
realm?: any[];
|
|
317
|
-
}, options?: O): RestResponse<void>;
|
|
318
|
-
/**
|
|
319
|
-
* HTTP GET /gateway/connection
|
|
320
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
321
|
-
*/
|
|
322
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
323
|
-
/**
|
|
324
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
325
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
326
|
-
*/
|
|
327
|
-
deleteConnection(realm: any, options?: O): RestResponse<void>;
|
|
328
|
-
/**
|
|
329
|
-
* HTTP GET /gateway/connection/{realm}
|
|
330
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
327
|
+
* HTTP GET /flow
|
|
328
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
331
329
|
*/
|
|
332
|
-
|
|
330
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
333
331
|
/**
|
|
334
|
-
* HTTP
|
|
335
|
-
* Java method: org.openremote.model.
|
|
332
|
+
* HTTP GET /flow/{name}
|
|
333
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
336
334
|
*/
|
|
337
|
-
|
|
335
|
+
getNodeDefinition(name: any, options?: O): RestResponse<Model.Node>;
|
|
338
336
|
/**
|
|
339
|
-
* HTTP GET /
|
|
340
|
-
* Java method: org.openremote.model.
|
|
337
|
+
* HTTP GET /flow/{type}
|
|
338
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
341
339
|
*/
|
|
342
|
-
|
|
340
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
343
341
|
}
|
|
344
342
|
export declare class AssetResourceClient<O> {
|
|
345
343
|
protected httpClient: HttpClient<O>;
|
|
@@ -445,6 +443,132 @@ export declare class AssetResourceClient<O> {
|
|
|
445
443
|
assetIds?: any[];
|
|
446
444
|
}, options?: O): RestResponse<void>;
|
|
447
445
|
}
|
|
446
|
+
export declare class GatewayClientResourceClient<O> {
|
|
447
|
+
protected httpClient: HttpClient<O>;
|
|
448
|
+
constructor(httpClient: HttpClient<O>);
|
|
449
|
+
/**
|
|
450
|
+
* HTTP DELETE /gateway/connection
|
|
451
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
452
|
+
*/
|
|
453
|
+
deleteConnections(queryParams?: {
|
|
454
|
+
realm?: any[];
|
|
455
|
+
}, options?: O): RestResponse<void>;
|
|
456
|
+
/**
|
|
457
|
+
* HTTP GET /gateway/connection
|
|
458
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
459
|
+
*/
|
|
460
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
461
|
+
/**
|
|
462
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
463
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
464
|
+
*/
|
|
465
|
+
deleteConnection(realm: any, options?: O): RestResponse<void>;
|
|
466
|
+
/**
|
|
467
|
+
* HTTP GET /gateway/connection/{realm}
|
|
468
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
469
|
+
*/
|
|
470
|
+
getConnection(realm: any, options?: O): RestResponse<Model.GatewayConnection>;
|
|
471
|
+
/**
|
|
472
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
473
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
474
|
+
*/
|
|
475
|
+
setConnection(realm: any, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
476
|
+
/**
|
|
477
|
+
* HTTP GET /gateway/status/{realm}
|
|
478
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
479
|
+
*/
|
|
480
|
+
getConnectionStatus(realm: any, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
481
|
+
}
|
|
482
|
+
export declare class AppResourceClient<O> {
|
|
483
|
+
protected httpClient: HttpClient<O>;
|
|
484
|
+
constructor(httpClient: HttpClient<O>);
|
|
485
|
+
/**
|
|
486
|
+
* HTTP GET /apps
|
|
487
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
488
|
+
*/
|
|
489
|
+
getApps(options?: O): RestResponse<any[]>;
|
|
490
|
+
/**
|
|
491
|
+
* HTTP GET /apps/consoleConfig
|
|
492
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
493
|
+
*/
|
|
494
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
495
|
+
/**
|
|
496
|
+
* HTTP GET /apps/info
|
|
497
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
498
|
+
*/
|
|
499
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
500
|
+
}
|
|
501
|
+
export declare class ConfigurationResourceClient<O> {
|
|
502
|
+
protected httpClient: HttpClient<O>;
|
|
503
|
+
constructor(httpClient: HttpClient<O>);
|
|
504
|
+
/**
|
|
505
|
+
* HTTP GET /configuration/manager
|
|
506
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
507
|
+
*/
|
|
508
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
509
|
+
/**
|
|
510
|
+
* HTTP PUT /configuration/manager
|
|
511
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
512
|
+
*/
|
|
513
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
514
|
+
/**
|
|
515
|
+
* HTTP POST /configuration/manager/file
|
|
516
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
517
|
+
*/
|
|
518
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
519
|
+
path?: any;
|
|
520
|
+
}, options?: O): RestResponse<any>;
|
|
521
|
+
/**
|
|
522
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
523
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
524
|
+
*/
|
|
525
|
+
getManagerConfigImage(filename: any, options?: O): RestResponse<any>;
|
|
526
|
+
}
|
|
527
|
+
export declare class AssetModelResourceClient<O> {
|
|
528
|
+
protected httpClient: HttpClient<O>;
|
|
529
|
+
constructor(httpClient: HttpClient<O>);
|
|
530
|
+
/**
|
|
531
|
+
* HTTP GET /model/assetDescriptors
|
|
532
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
533
|
+
*/
|
|
534
|
+
getAssetDescriptors(queryParams?: {
|
|
535
|
+
parentId?: any;
|
|
536
|
+
parentType?: any;
|
|
537
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
538
|
+
/**
|
|
539
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
540
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
541
|
+
*/
|
|
542
|
+
getAssetInfo(assetType: any, queryParams?: {
|
|
543
|
+
parentId?: any;
|
|
544
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
545
|
+
/**
|
|
546
|
+
* HTTP GET /model/assetInfos
|
|
547
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
548
|
+
*/
|
|
549
|
+
getAssetInfos(queryParams?: {
|
|
550
|
+
parentId?: any;
|
|
551
|
+
parentType?: any;
|
|
552
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
553
|
+
/**
|
|
554
|
+
* HTTP GET /model/metaItemDescriptors
|
|
555
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
556
|
+
*/
|
|
557
|
+
getMetaItemDescriptors(queryParams?: {
|
|
558
|
+
parentId?: any;
|
|
559
|
+
}, options?: O): RestResponse<{
|
|
560
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
561
|
+
}>;
|
|
562
|
+
/**
|
|
563
|
+
* HTTP GET /model/valueDescriptors
|
|
564
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
565
|
+
*/
|
|
566
|
+
getValueDescriptors(queryParams?: {
|
|
567
|
+
parentId?: any;
|
|
568
|
+
}, options?: O): RestResponse<{
|
|
569
|
+
[index: string]: Model.ValueDescriptor;
|
|
570
|
+
}>;
|
|
571
|
+
}
|
|
448
572
|
export declare class UserResourceClient<O> {
|
|
449
573
|
protected httpClient: HttpClient<O>;
|
|
450
574
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -569,188 +693,159 @@ export declare class UserResourceClient<O> {
|
|
|
569
693
|
*/
|
|
570
694
|
get(realm: any, userId: any, options?: O): RestResponse<Model.User>;
|
|
571
695
|
}
|
|
572
|
-
export declare class
|
|
696
|
+
export declare class MapResourceClient<O> {
|
|
573
697
|
protected httpClient: HttpClient<O>;
|
|
574
698
|
constructor(httpClient: HttpClient<O>);
|
|
575
699
|
/**
|
|
576
|
-
* HTTP GET /
|
|
577
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* HTTP GET /map
|
|
701
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
578
702
|
*/
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
703
|
+
getSettings(options?: O): RestResponse<{
|
|
704
|
+
[id: string]: any;
|
|
705
|
+
}>;
|
|
706
|
+
/**
|
|
707
|
+
* HTTP PUT /map
|
|
708
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
709
|
+
*/
|
|
710
|
+
saveSettings(mapConfig: {
|
|
711
|
+
[index: string]: Model.MapRealmConfig;
|
|
583
712
|
}, options?: O): RestResponse<any>;
|
|
584
713
|
/**
|
|
585
|
-
* HTTP GET /
|
|
586
|
-
* Java method: org.openremote.model.
|
|
714
|
+
* HTTP GET /map/js
|
|
715
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
587
716
|
*/
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
717
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
718
|
+
[id: string]: any;
|
|
719
|
+
}>;
|
|
592
720
|
/**
|
|
593
|
-
* HTTP
|
|
594
|
-
* Java method: org.openremote.model.
|
|
721
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
722
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
595
723
|
*/
|
|
596
|
-
|
|
724
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
597
725
|
}
|
|
598
|
-
export declare class
|
|
726
|
+
export declare class ProvisioningResourceClient<O> {
|
|
599
727
|
protected httpClient: HttpClient<O>;
|
|
600
728
|
constructor(httpClient: HttpClient<O>);
|
|
601
729
|
/**
|
|
602
|
-
* HTTP POST /
|
|
603
|
-
* Java method: org.openremote.model.
|
|
730
|
+
* HTTP POST /provisioning
|
|
731
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
604
732
|
*/
|
|
605
|
-
|
|
733
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
606
734
|
/**
|
|
607
|
-
* HTTP GET /
|
|
608
|
-
* Java method: org.openremote.model.
|
|
735
|
+
* HTTP GET /provisioning
|
|
736
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
609
737
|
*/
|
|
610
|
-
|
|
738
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
611
739
|
/**
|
|
612
|
-
* HTTP
|
|
613
|
-
* Java method: org.openremote.model.
|
|
740
|
+
* HTTP DELETE /provisioning/{id}
|
|
741
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
614
742
|
*/
|
|
615
|
-
|
|
743
|
+
deleteProvisioningConfig(id: any, options?: O): RestResponse<void>;
|
|
616
744
|
/**
|
|
617
|
-
* HTTP
|
|
618
|
-
* Java method: org.openremote.model.
|
|
745
|
+
* HTTP PUT /provisioning/{id}
|
|
746
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
619
747
|
*/
|
|
620
|
-
|
|
748
|
+
updateProvisioningConfig(id: any, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
749
|
+
}
|
|
750
|
+
export declare class StatusResourceClient<O> {
|
|
751
|
+
protected httpClient: HttpClient<O>;
|
|
752
|
+
constructor(httpClient: HttpClient<O>);
|
|
621
753
|
/**
|
|
622
|
-
* HTTP GET /
|
|
623
|
-
* Java method: org.openremote.model.
|
|
754
|
+
* HTTP GET /health
|
|
755
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
624
756
|
*/
|
|
625
|
-
|
|
757
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
758
|
+
[index: string]: any;
|
|
759
|
+
}>;
|
|
626
760
|
/**
|
|
627
|
-
* HTTP
|
|
628
|
-
* Java method: org.openremote.model.
|
|
761
|
+
* HTTP GET /info
|
|
762
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
629
763
|
*/
|
|
630
|
-
|
|
764
|
+
getInfo(options?: O): RestResponse<{
|
|
765
|
+
[index: string]: any;
|
|
766
|
+
}>;
|
|
631
767
|
}
|
|
632
|
-
export declare class
|
|
768
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
633
769
|
protected httpClient: HttpClient<O>;
|
|
634
770
|
constructor(httpClient: HttpClient<O>);
|
|
635
771
|
/**
|
|
636
|
-
* HTTP
|
|
637
|
-
* Java method: org.openremote.model.
|
|
772
|
+
* HTTP POST /gateway/tunnel
|
|
773
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
638
774
|
*/
|
|
639
|
-
|
|
775
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
640
776
|
/**
|
|
641
|
-
* HTTP
|
|
642
|
-
* Java method: org.openremote.model.
|
|
777
|
+
* HTTP DELETE /gateway/tunnel
|
|
778
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
643
779
|
*/
|
|
644
|
-
|
|
780
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
645
781
|
/**
|
|
646
|
-
* HTTP
|
|
647
|
-
* Java method: org.openremote.model.
|
|
782
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
783
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
648
784
|
*/
|
|
649
|
-
|
|
650
|
-
path?: any;
|
|
651
|
-
}, options?: O): RestResponse<any>;
|
|
785
|
+
getAllActiveTunnelInfos(realm: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
652
786
|
/**
|
|
653
|
-
* HTTP GET /
|
|
654
|
-
* Java method: org.openremote.model.
|
|
787
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
788
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
655
789
|
*/
|
|
656
|
-
|
|
790
|
+
getGatewayActiveTunnelInfos(realm: any, id: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
791
|
+
/**
|
|
792
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
793
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
794
|
+
*/
|
|
795
|
+
getActiveTunnelInfo(realm: any, id: any, target: any, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
657
796
|
}
|
|
658
|
-
export declare class
|
|
797
|
+
export declare class AlarmResourceClient<O> {
|
|
659
798
|
protected httpClient: HttpClient<O>;
|
|
660
799
|
constructor(httpClient: HttpClient<O>);
|
|
661
800
|
/**
|
|
662
|
-
* HTTP
|
|
663
|
-
* Java method: org.openremote.model.
|
|
801
|
+
* HTTP POST /alarm
|
|
802
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
664
803
|
*/
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
from?: any;
|
|
669
|
-
to?: any;
|
|
670
|
-
realmId?: any;
|
|
671
|
-
userId?: any;
|
|
672
|
-
assetId?: any;
|
|
673
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
804
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
805
|
+
assetIds?: any[];
|
|
806
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
674
807
|
/**
|
|
675
|
-
* HTTP
|
|
676
|
-
* Java method: org.openremote.model.
|
|
808
|
+
* HTTP GET /alarm
|
|
809
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
677
810
|
*/
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
from?: any;
|
|
682
|
-
to?: any;
|
|
683
|
-
realmId?: any;
|
|
684
|
-
userId?: any;
|
|
811
|
+
getAlarms(queryParams?: {
|
|
812
|
+
realm?: any;
|
|
813
|
+
status?: Model.AlarmStatus;
|
|
685
814
|
assetId?: any;
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
* HTTP POST /notification/alert
|
|
689
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
690
|
-
*/
|
|
691
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
692
|
-
/**
|
|
693
|
-
* HTTP DELETE /notification/{notificationId}
|
|
694
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
695
|
-
*/
|
|
696
|
-
removeNotification(notificationId: any, options?: O): RestResponse<void>;
|
|
697
|
-
/**
|
|
698
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
699
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
700
|
-
*/
|
|
701
|
-
notificationAcknowledged(notificationId: any, acknowledgement: any, queryParams?: {
|
|
702
|
-
targetId?: any;
|
|
703
|
-
}, options?: O): RestResponse<void>;
|
|
704
|
-
/**
|
|
705
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
706
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
707
|
-
*/
|
|
708
|
-
notificationDelivered(notificationId: any, queryParams?: {
|
|
709
|
-
targetId?: any;
|
|
710
|
-
}, options?: O): RestResponse<void>;
|
|
711
|
-
}
|
|
712
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
713
|
-
protected httpClient: HttpClient<O>;
|
|
714
|
-
constructor(httpClient: HttpClient<O>);
|
|
715
|
-
/**
|
|
716
|
-
* HTTP POST /gateway/tunnel
|
|
717
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
718
|
-
*/
|
|
719
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
815
|
+
assigneeId?: any;
|
|
816
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
720
817
|
/**
|
|
721
|
-
* HTTP DELETE /
|
|
722
|
-
* Java method: org.openremote.model.
|
|
818
|
+
* HTTP DELETE /alarm
|
|
819
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
723
820
|
*/
|
|
724
|
-
|
|
821
|
+
removeAlarms(ids: any[], options?: O): RestResponse<void>;
|
|
725
822
|
/**
|
|
726
|
-
* HTTP
|
|
727
|
-
* Java method: org.openremote.model.
|
|
823
|
+
* HTTP PUT /alarm/assets
|
|
824
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
728
825
|
*/
|
|
729
|
-
|
|
826
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
730
827
|
/**
|
|
731
|
-
* HTTP GET /
|
|
732
|
-
* Java method: org.openremote.model.
|
|
828
|
+
* HTTP GET /alarm/{alarmId}
|
|
829
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
733
830
|
*/
|
|
734
|
-
|
|
831
|
+
getAlarm(alarmId: any, options?: O): RestResponse<Model.SentAlarm>;
|
|
735
832
|
/**
|
|
736
|
-
* HTTP
|
|
737
|
-
* Java method: org.openremote.model.
|
|
833
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
834
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
738
835
|
*/
|
|
739
|
-
|
|
740
|
-
}
|
|
741
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
742
|
-
protected httpClient: HttpClient<O>;
|
|
743
|
-
constructor(httpClient: HttpClient<O>);
|
|
836
|
+
removeAlarm(alarmId: any, options?: O): RestResponse<void>;
|
|
744
837
|
/**
|
|
745
|
-
* HTTP
|
|
746
|
-
* Java method: org.openremote.model.
|
|
838
|
+
* HTTP PUT /alarm/{alarmId}
|
|
839
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
747
840
|
*/
|
|
748
|
-
|
|
841
|
+
updateAlarm(alarmId: any, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
749
842
|
/**
|
|
750
|
-
* HTTP
|
|
751
|
-
* Java method: org.openremote.model.
|
|
843
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
844
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
752
845
|
*/
|
|
753
|
-
|
|
846
|
+
getAssetLinks(alarmId: any, queryParams?: {
|
|
847
|
+
realm?: any;
|
|
848
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
754
849
|
}
|
|
755
850
|
export declare class AgentResourceClient<O> {
|
|
756
851
|
protected httpClient: HttpClient<O>;
|
|
@@ -778,146 +873,51 @@ export declare class AgentResourceClient<O> {
|
|
|
778
873
|
realm?: any;
|
|
779
874
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
780
875
|
}
|
|
781
|
-
export declare class AssetModelResourceClient<O> {
|
|
782
|
-
protected httpClient: HttpClient<O>;
|
|
783
|
-
constructor(httpClient: HttpClient<O>);
|
|
784
|
-
/**
|
|
785
|
-
* HTTP GET /model/assetDescriptors
|
|
786
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
787
|
-
*/
|
|
788
|
-
getAssetDescriptors(queryParams?: {
|
|
789
|
-
parentId?: any;
|
|
790
|
-
parentType?: any;
|
|
791
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
792
|
-
/**
|
|
793
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
794
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
795
|
-
*/
|
|
796
|
-
getAssetInfo(assetType: any, queryParams?: {
|
|
797
|
-
parentId?: any;
|
|
798
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
799
|
-
/**
|
|
800
|
-
* HTTP GET /model/assetInfos
|
|
801
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
802
|
-
*/
|
|
803
|
-
getAssetInfos(queryParams?: {
|
|
804
|
-
parentId?: any;
|
|
805
|
-
parentType?: any;
|
|
806
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
807
|
-
/**
|
|
808
|
-
* HTTP GET /model/metaItemDescriptors
|
|
809
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
810
|
-
*/
|
|
811
|
-
getMetaItemDescriptors(queryParams?: {
|
|
812
|
-
parentId?: any;
|
|
813
|
-
}, options?: O): RestResponse<{
|
|
814
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
815
|
-
}>;
|
|
816
|
-
/**
|
|
817
|
-
* HTTP GET /model/valueDescriptors
|
|
818
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
819
|
-
*/
|
|
820
|
-
getValueDescriptors(queryParams?: {
|
|
821
|
-
parentId?: any;
|
|
822
|
-
}, options?: O): RestResponse<{
|
|
823
|
-
[index: string]: Model.ValueDescriptor;
|
|
824
|
-
}>;
|
|
825
|
-
}
|
|
826
|
-
export declare class StatusResourceClient<O> {
|
|
827
|
-
protected httpClient: HttpClient<O>;
|
|
828
|
-
constructor(httpClient: HttpClient<O>);
|
|
829
|
-
/**
|
|
830
|
-
* HTTP GET /health
|
|
831
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
832
|
-
*/
|
|
833
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
834
|
-
[index: string]: any;
|
|
835
|
-
}>;
|
|
836
|
-
/**
|
|
837
|
-
* HTTP GET /info
|
|
838
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
839
|
-
*/
|
|
840
|
-
getInfo(options?: O): RestResponse<{
|
|
841
|
-
[index: string]: any;
|
|
842
|
-
}>;
|
|
843
|
-
}
|
|
844
|
-
export declare class SyslogResourceClient<O> {
|
|
845
|
-
protected httpClient: HttpClient<O>;
|
|
846
|
-
constructor(httpClient: HttpClient<O>);
|
|
847
|
-
/**
|
|
848
|
-
* HTTP GET /syslog/config
|
|
849
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
850
|
-
*/
|
|
851
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
852
|
-
/**
|
|
853
|
-
* HTTP PUT /syslog/config
|
|
854
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
855
|
-
*/
|
|
856
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP DELETE /syslog/event
|
|
859
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
860
|
-
*/
|
|
861
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
862
|
-
/**
|
|
863
|
-
* HTTP GET /syslog/event
|
|
864
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
865
|
-
*/
|
|
866
|
-
getEvents(queryParams?: {
|
|
867
|
-
level?: Model.SyslogLevel;
|
|
868
|
-
per_page?: any;
|
|
869
|
-
page?: any;
|
|
870
|
-
from?: any;
|
|
871
|
-
to?: any;
|
|
872
|
-
category?: Model.SyslogCategory[];
|
|
873
|
-
subCategory?: any[];
|
|
874
|
-
}, options?: O): RestResponse<any>;
|
|
875
|
-
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
878
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
879
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
880
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
881
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
879
882
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
880
|
-
protected _appResource: AxiosAppResourceClient;
|
|
881
883
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
882
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
883
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
884
884
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
885
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
886
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
887
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
888
|
-
protected _userResource: AxiosUserResourceClient;
|
|
889
885
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
890
|
-
protected
|
|
886
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
887
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
888
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
889
|
+
protected _appResource: AxiosAppResourceClient;
|
|
891
890
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
892
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
893
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
894
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
895
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
896
891
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
892
|
+
protected _userResource: AxiosUserResourceClient;
|
|
893
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
894
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
897
895
|
protected _statusResource: AxiosStatusResourceClient;
|
|
898
|
-
protected
|
|
896
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
897
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
898
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
900
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
901
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
902
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
903
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
901
904
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
902
|
-
get AppResource(): AxiosAppResourceClient;
|
|
903
905
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
904
|
-
get MapResource(): AxiosMapResourceClient;
|
|
905
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
906
906
|
get RulesResource(): AxiosRulesResourceClient;
|
|
907
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
908
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
909
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
910
|
-
get UserResource(): AxiosUserResourceClient;
|
|
911
907
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
912
|
-
get
|
|
908
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
909
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
910
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
911
|
+
get AppResource(): AxiosAppResourceClient;
|
|
913
912
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
914
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
915
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
916
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
917
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
918
913
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
914
|
+
get UserResource(): AxiosUserResourceClient;
|
|
915
|
+
get MapResource(): AxiosMapResourceClient;
|
|
916
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
919
917
|
get StatusResource(): AxiosStatusResourceClient;
|
|
920
|
-
get
|
|
918
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
919
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
920
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
946
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
955
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|