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