@openremote/rest 1.9.0-snapshot.20250922141329 → 1.9.0-snapshot.20250923153709
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.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +583 -583
- 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,59 +9,23 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class StatusResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
getNotifications(queryParams?: {
|
|
20
|
-
id?: number;
|
|
21
|
-
type?: string;
|
|
22
|
-
from?: number;
|
|
23
|
-
to?: number;
|
|
24
|
-
realmId?: string;
|
|
25
|
-
userId?: string;
|
|
26
|
-
assetId?: string;
|
|
27
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
28
|
-
/**
|
|
29
|
-
* HTTP DELETE /notification
|
|
30
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
31
|
-
*/
|
|
32
|
-
removeNotifications(queryParams?: {
|
|
33
|
-
id?: number;
|
|
34
|
-
type?: string;
|
|
35
|
-
from?: number;
|
|
36
|
-
to?: number;
|
|
37
|
-
realmId?: string;
|
|
38
|
-
userId?: string;
|
|
39
|
-
assetId?: string;
|
|
40
|
-
}, options?: O): RestResponse<void>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP POST /notification/alert
|
|
43
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
44
|
-
*/
|
|
45
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
46
|
-
/**
|
|
47
|
-
* HTTP DELETE /notification/{notificationId}
|
|
48
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
49
|
-
*/
|
|
50
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
51
|
-
/**
|
|
52
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
53
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
16
|
+
* HTTP GET /health
|
|
17
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
54
18
|
*/
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
}
|
|
19
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
20
|
+
[index: string]: any;
|
|
21
|
+
}>;
|
|
58
22
|
/**
|
|
59
|
-
* HTTP
|
|
60
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /info
|
|
24
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
61
25
|
*/
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
}
|
|
26
|
+
getInfo(options?: O): RestResponse<{
|
|
27
|
+
[index: string]: any;
|
|
28
|
+
}>;
|
|
65
29
|
}
|
|
66
30
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
67
31
|
protected httpClient: HttpClient<O>;
|
|
@@ -77,145 +41,63 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
77
41
|
*/
|
|
78
42
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
79
43
|
}
|
|
80
|
-
export declare class
|
|
44
|
+
export declare class SyslogResourceClient<O> {
|
|
81
45
|
protected httpClient: HttpClient<O>;
|
|
82
46
|
constructor(httpClient: HttpClient<O>);
|
|
83
47
|
/**
|
|
84
|
-
* HTTP
|
|
85
|
-
* Java method: org.openremote.model.
|
|
86
|
-
*/
|
|
87
|
-
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
88
|
-
/**
|
|
89
|
-
* HTTP DELETE /asset
|
|
90
|
-
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
91
|
-
*/
|
|
92
|
-
delete(queryParams?: {
|
|
93
|
-
assetId?: string[];
|
|
94
|
-
}, options?: O): RestResponse<void>;
|
|
95
|
-
/**
|
|
96
|
-
* HTTP PUT /asset/attributes
|
|
97
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
98
|
-
*/
|
|
99
|
-
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
100
|
-
/**
|
|
101
|
-
* HTTP PUT /asset/attributes/timestamp
|
|
102
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
103
|
-
*/
|
|
104
|
-
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
105
|
-
/**
|
|
106
|
-
* HTTP DELETE /asset/parent
|
|
107
|
-
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
108
|
-
*/
|
|
109
|
-
updateNoneParent(queryParams?: {
|
|
110
|
-
assetIds?: string[];
|
|
111
|
-
}, options?: O): RestResponse<void>;
|
|
112
|
-
/**
|
|
113
|
-
* HTTP GET /asset/partial/{assetId}
|
|
114
|
-
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
115
|
-
*/
|
|
116
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
117
|
-
/**
|
|
118
|
-
* HTTP POST /asset/query
|
|
119
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
120
|
-
*/
|
|
121
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
122
|
-
/**
|
|
123
|
-
* HTTP GET /asset/user/current
|
|
124
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
125
|
-
*/
|
|
126
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
127
|
-
/**
|
|
128
|
-
* HTTP POST /asset/user/link
|
|
129
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
130
|
-
*/
|
|
131
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
132
|
-
/**
|
|
133
|
-
* HTTP GET /asset/user/link
|
|
134
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
135
|
-
*/
|
|
136
|
-
getUserAssetLinks(queryParams?: {
|
|
137
|
-
realm?: string;
|
|
138
|
-
userId?: string;
|
|
139
|
-
assetId?: string;
|
|
140
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
141
|
-
/**
|
|
142
|
-
* HTTP POST /asset/user/link/delete
|
|
143
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
144
|
-
*/
|
|
145
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
146
|
-
/**
|
|
147
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
148
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
149
|
-
*/
|
|
150
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
151
|
-
/**
|
|
152
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
153
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
154
|
-
*/
|
|
155
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
156
|
-
/**
|
|
157
|
-
* HTTP GET /asset/{assetId}
|
|
158
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
159
|
-
*/
|
|
160
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
161
|
-
/**
|
|
162
|
-
* HTTP PUT /asset/{assetId}
|
|
163
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
48
|
+
* HTTP GET /syslog/config
|
|
49
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
164
50
|
*/
|
|
165
|
-
|
|
51
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
166
52
|
/**
|
|
167
|
-
* HTTP PUT /
|
|
168
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* HTTP PUT /syslog/config
|
|
54
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
169
55
|
*/
|
|
170
|
-
|
|
56
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
171
57
|
/**
|
|
172
|
-
* HTTP
|
|
173
|
-
* Java method: org.openremote.model.
|
|
58
|
+
* HTTP DELETE /syslog/event
|
|
59
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
174
60
|
*/
|
|
175
|
-
|
|
61
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
176
62
|
/**
|
|
177
|
-
* HTTP
|
|
178
|
-
* Java method: org.openremote.model.
|
|
63
|
+
* HTTP GET /syslog/event
|
|
64
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
179
65
|
*/
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
66
|
+
getEvents(queryParams?: {
|
|
67
|
+
level?: Model.SyslogLevel;
|
|
68
|
+
per_page?: number;
|
|
69
|
+
page?: number;
|
|
70
|
+
from?: number;
|
|
71
|
+
to?: number;
|
|
72
|
+
category?: Model.SyslogCategory[];
|
|
73
|
+
subCategory?: string[];
|
|
74
|
+
}, options?: O): RestResponse<any>;
|
|
183
75
|
}
|
|
184
|
-
export declare class
|
|
76
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
185
77
|
protected httpClient: HttpClient<O>;
|
|
186
78
|
constructor(httpClient: HttpClient<O>);
|
|
187
79
|
/**
|
|
188
|
-
* HTTP
|
|
189
|
-
* Java method: org.openremote.model.
|
|
190
|
-
*/
|
|
191
|
-
deleteConnections(queryParams?: {
|
|
192
|
-
realm?: string[];
|
|
193
|
-
}, options?: O): RestResponse<void>;
|
|
194
|
-
/**
|
|
195
|
-
* HTTP GET /gateway/connection
|
|
196
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
197
|
-
*/
|
|
198
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
199
|
-
/**
|
|
200
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
201
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
202
|
-
*/
|
|
203
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
204
|
-
/**
|
|
205
|
-
* HTTP GET /gateway/connection/{realm}
|
|
206
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
80
|
+
* HTTP GET /asset/datapoint/export
|
|
81
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
207
82
|
*/
|
|
208
|
-
|
|
83
|
+
getDatapointExport(queryParams?: {
|
|
84
|
+
attributeRefs?: string;
|
|
85
|
+
fromTimestamp?: number;
|
|
86
|
+
toTimestamp?: number;
|
|
87
|
+
}, options?: O): RestResponse<any>;
|
|
209
88
|
/**
|
|
210
|
-
* HTTP
|
|
211
|
-
* Java method: org.openremote.model.
|
|
89
|
+
* HTTP GET /asset/datapoint/periods
|
|
90
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
212
91
|
*/
|
|
213
|
-
|
|
92
|
+
getDatapointPeriod(queryParams?: {
|
|
93
|
+
assetId?: string;
|
|
94
|
+
attributeName?: string;
|
|
95
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
214
96
|
/**
|
|
215
|
-
* HTTP
|
|
216
|
-
* Java method: org.openremote.model.
|
|
97
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
98
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
217
99
|
*/
|
|
218
|
-
|
|
100
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
219
101
|
}
|
|
220
102
|
export declare class ConfigurationResourceClient<O> {
|
|
221
103
|
protected httpClient: HttpClient<O>;
|
|
@@ -243,137 +125,219 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
243
125
|
*/
|
|
244
126
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
245
127
|
}
|
|
246
|
-
export declare class
|
|
128
|
+
export declare class FlowResourceClient<O> {
|
|
247
129
|
protected httpClient: HttpClient<O>;
|
|
248
130
|
constructor(httpClient: HttpClient<O>);
|
|
249
131
|
/**
|
|
250
|
-
* HTTP
|
|
251
|
-
* Java method: org.openremote.model.
|
|
252
|
-
*/
|
|
253
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
254
|
-
/**
|
|
255
|
-
* HTTP DELETE /gateway/tunnel
|
|
256
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
257
|
-
*/
|
|
258
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
259
|
-
/**
|
|
260
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
261
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
132
|
+
* HTTP GET /flow
|
|
133
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
262
134
|
*/
|
|
263
|
-
|
|
135
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
264
136
|
/**
|
|
265
|
-
* HTTP GET /
|
|
266
|
-
* Java method: org.openremote.model.
|
|
137
|
+
* HTTP GET /flow/{name}
|
|
138
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
267
139
|
*/
|
|
268
|
-
|
|
140
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
269
141
|
/**
|
|
270
|
-
* HTTP GET /
|
|
271
|
-
* Java method: org.openremote.model.
|
|
142
|
+
* HTTP GET /flow/{type}
|
|
143
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
272
144
|
*/
|
|
273
|
-
|
|
145
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
274
146
|
}
|
|
275
|
-
export declare class
|
|
147
|
+
export declare class MapResourceClient<O> {
|
|
276
148
|
protected httpClient: HttpClient<O>;
|
|
277
149
|
constructor(httpClient: HttpClient<O>);
|
|
278
150
|
/**
|
|
279
|
-
* HTTP GET /
|
|
280
|
-
* Java method: org.openremote.model.
|
|
151
|
+
* HTTP GET /map
|
|
152
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
281
153
|
*/
|
|
282
|
-
|
|
283
|
-
[
|
|
154
|
+
getSettings(options?: O): RestResponse<{
|
|
155
|
+
[id: string]: unknown;
|
|
284
156
|
}>;
|
|
285
157
|
/**
|
|
286
|
-
* HTTP
|
|
287
|
-
* Java method: org.openremote.model.
|
|
158
|
+
* HTTP PUT /map
|
|
159
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
288
160
|
*/
|
|
289
|
-
|
|
290
|
-
[
|
|
161
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
162
|
+
[id: string]: unknown;
|
|
163
|
+
}>;
|
|
164
|
+
/**
|
|
165
|
+
* HTTP DELETE /map/deleteMap
|
|
166
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
167
|
+
*/
|
|
168
|
+
deleteMap(options?: O): RestResponse<{
|
|
169
|
+
[id: string]: unknown;
|
|
170
|
+
}>;
|
|
171
|
+
/**
|
|
172
|
+
* HTTP GET /map/getCustomMapInfo
|
|
173
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
174
|
+
*/
|
|
175
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
176
|
+
[id: string]: unknown;
|
|
177
|
+
}>;
|
|
178
|
+
/**
|
|
179
|
+
* HTTP GET /map/js
|
|
180
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
181
|
+
*/
|
|
182
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
183
|
+
[id: string]: unknown;
|
|
184
|
+
}>;
|
|
185
|
+
/**
|
|
186
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
187
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
188
|
+
*/
|
|
189
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
190
|
+
/**
|
|
191
|
+
* HTTP POST /map/upload
|
|
192
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
193
|
+
*/
|
|
194
|
+
uploadMap(queryParams?: {
|
|
195
|
+
filename?: string;
|
|
196
|
+
}, options?: O): RestResponse<{
|
|
197
|
+
[id: string]: unknown;
|
|
291
198
|
}>;
|
|
292
199
|
}
|
|
293
|
-
export declare class
|
|
200
|
+
export declare class DashboardResourceClient<O> {
|
|
294
201
|
protected httpClient: HttpClient<O>;
|
|
295
202
|
constructor(httpClient: HttpClient<O>);
|
|
296
203
|
/**
|
|
297
|
-
* HTTP
|
|
298
|
-
* Java method: org.openremote.model.
|
|
204
|
+
* HTTP POST /dashboard
|
|
205
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
299
206
|
*/
|
|
300
|
-
|
|
207
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
301
208
|
/**
|
|
302
|
-
* HTTP PUT /
|
|
303
|
-
* Java method: org.openremote.model.
|
|
209
|
+
* HTTP PUT /dashboard
|
|
210
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
304
211
|
*/
|
|
305
|
-
|
|
212
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
306
213
|
/**
|
|
307
|
-
* HTTP
|
|
308
|
-
* Java method: org.openremote.model.
|
|
214
|
+
* HTTP GET /dashboard/all/{realm}
|
|
215
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
309
216
|
*/
|
|
310
|
-
|
|
217
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
311
218
|
/**
|
|
312
|
-
* HTTP
|
|
313
|
-
* Java method: org.openremote.model.
|
|
219
|
+
* HTTP POST /dashboard/query
|
|
220
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
314
221
|
*/
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
222
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
223
|
+
/**
|
|
224
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
225
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
226
|
+
*/
|
|
227
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
228
|
+
/**
|
|
229
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
230
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
231
|
+
*/
|
|
232
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
324
233
|
}
|
|
325
|
-
export declare class
|
|
234
|
+
export declare class RulesResourceClient<O> {
|
|
326
235
|
protected httpClient: HttpClient<O>;
|
|
327
236
|
constructor(httpClient: HttpClient<O>);
|
|
328
237
|
/**
|
|
329
|
-
* HTTP POST /
|
|
330
|
-
* Java method: org.openremote.model.
|
|
238
|
+
* HTTP POST /rules
|
|
239
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
331
240
|
*/
|
|
332
|
-
|
|
333
|
-
assetIds?: string[];
|
|
334
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
241
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
335
242
|
/**
|
|
336
|
-
* HTTP GET /
|
|
337
|
-
* Java method: org.openremote.model.
|
|
243
|
+
* HTTP GET /rules
|
|
244
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
338
245
|
*/
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
assigneeId?: string;
|
|
344
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
246
|
+
getGlobalRulesets(queryParams?: {
|
|
247
|
+
language?: Model.RulesetLang[];
|
|
248
|
+
fullyPopulate?: boolean;
|
|
249
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
345
250
|
/**
|
|
346
|
-
* HTTP
|
|
347
|
-
* Java method: org.openremote.model.
|
|
251
|
+
* HTTP POST /rules/asset
|
|
252
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
348
253
|
*/
|
|
349
|
-
|
|
254
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
350
255
|
/**
|
|
351
|
-
* HTTP
|
|
352
|
-
* Java method: org.openremote.model.
|
|
256
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
257
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
353
258
|
*/
|
|
354
|
-
|
|
259
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
260
|
+
language?: Model.RulesetLang[];
|
|
261
|
+
fullyPopulate?: boolean;
|
|
262
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
355
263
|
/**
|
|
356
|
-
* HTTP
|
|
357
|
-
* Java method: org.openremote.model.
|
|
264
|
+
* HTTP DELETE /rules/asset/{id}
|
|
265
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
358
266
|
*/
|
|
359
|
-
|
|
267
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
360
268
|
/**
|
|
361
|
-
* HTTP
|
|
362
|
-
* Java method: org.openremote.model.
|
|
269
|
+
* HTTP GET /rules/asset/{id}
|
|
270
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
363
271
|
*/
|
|
364
|
-
|
|
272
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
365
273
|
/**
|
|
366
|
-
* HTTP PUT /
|
|
367
|
-
* Java method: org.openremote.model.
|
|
274
|
+
* HTTP PUT /rules/asset/{id}
|
|
275
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
368
276
|
*/
|
|
369
|
-
|
|
277
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
370
278
|
/**
|
|
371
|
-
* HTTP GET /
|
|
372
|
-
* Java method: org.openremote.model.
|
|
279
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
280
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
373
281
|
*/
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
282
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
283
|
+
/**
|
|
284
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
285
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
286
|
+
*/
|
|
287
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
288
|
+
/**
|
|
289
|
+
* HTTP GET /rules/info/global
|
|
290
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
291
|
+
*/
|
|
292
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
293
|
+
/**
|
|
294
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
295
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
296
|
+
*/
|
|
297
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
298
|
+
/**
|
|
299
|
+
* HTTP POST /rules/realm
|
|
300
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
301
|
+
*/
|
|
302
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
303
|
+
/**
|
|
304
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
305
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
306
|
+
*/
|
|
307
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
308
|
+
language?: Model.RulesetLang[];
|
|
309
|
+
fullyPopulate?: boolean;
|
|
310
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
311
|
+
/**
|
|
312
|
+
* HTTP DELETE /rules/realm/{id}
|
|
313
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
314
|
+
*/
|
|
315
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
316
|
+
/**
|
|
317
|
+
* HTTP GET /rules/realm/{id}
|
|
318
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
319
|
+
*/
|
|
320
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
321
|
+
/**
|
|
322
|
+
* HTTP PUT /rules/realm/{id}
|
|
323
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
324
|
+
*/
|
|
325
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
326
|
+
/**
|
|
327
|
+
* HTTP DELETE /rules/{id}
|
|
328
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
329
|
+
*/
|
|
330
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
331
|
+
/**
|
|
332
|
+
* HTTP GET /rules/{id}
|
|
333
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
334
|
+
*/
|
|
335
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
336
|
+
/**
|
|
337
|
+
* HTTP PUT /rules/{id}
|
|
338
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
339
|
+
*/
|
|
340
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
377
341
|
}
|
|
378
342
|
export declare class UserResourceClient<O> {
|
|
379
343
|
protected httpClient: HttpClient<O>;
|
|
@@ -499,44 +463,94 @@ export declare class UserResourceClient<O> {
|
|
|
499
463
|
*/
|
|
500
464
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
501
465
|
}
|
|
502
|
-
export declare class
|
|
466
|
+
export declare class AppResourceClient<O> {
|
|
503
467
|
protected httpClient: HttpClient<O>;
|
|
504
468
|
constructor(httpClient: HttpClient<O>);
|
|
505
469
|
/**
|
|
506
|
-
* HTTP
|
|
507
|
-
* Java method: org.openremote.model.
|
|
508
|
-
*/
|
|
509
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
510
|
-
/**
|
|
511
|
-
* HTTP GET /provisioning
|
|
512
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
470
|
+
* HTTP GET /apps
|
|
471
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
513
472
|
*/
|
|
514
|
-
|
|
473
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
515
474
|
/**
|
|
516
|
-
* HTTP
|
|
517
|
-
* Java method: org.openremote.model.
|
|
475
|
+
* HTTP GET /apps/consoleConfig
|
|
476
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
518
477
|
*/
|
|
519
|
-
|
|
478
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
520
479
|
/**
|
|
521
|
-
* HTTP
|
|
522
|
-
* Java method: org.openremote.model.
|
|
480
|
+
* HTTP GET /apps/info
|
|
481
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
523
482
|
*/
|
|
524
|
-
|
|
483
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
525
484
|
}
|
|
526
|
-
export declare class
|
|
485
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
527
486
|
protected httpClient: HttpClient<O>;
|
|
528
487
|
constructor(httpClient: HttpClient<O>);
|
|
529
488
|
/**
|
|
530
|
-
*
|
|
531
|
-
*
|
|
489
|
+
* Response code 200 - List of registered external services
|
|
490
|
+
* HTTP GET /service
|
|
491
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
532
492
|
*/
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
493
|
+
getServices(queryParams?: {
|
|
494
|
+
realm?: string;
|
|
495
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
537
496
|
/**
|
|
538
|
-
*
|
|
539
|
-
*
|
|
497
|
+
* Response code 200 - Service registered successfully
|
|
498
|
+
* Response code 400 - Invalid external service object
|
|
499
|
+
* Response code 409 - ExternalService instance already registered
|
|
500
|
+
* HTTP POST /service
|
|
501
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
502
|
+
*/
|
|
503
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
504
|
+
/**
|
|
505
|
+
* Response code 200 - List of registered external services
|
|
506
|
+
* HTTP GET /service/global
|
|
507
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
508
|
+
*/
|
|
509
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
510
|
+
/**
|
|
511
|
+
* Response code 200 - Service registered successfully
|
|
512
|
+
* Response code 400 - Invalid external service object
|
|
513
|
+
* Response code 409 - ExternalService instance already registered
|
|
514
|
+
* HTTP POST /service/global
|
|
515
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
516
|
+
*/
|
|
517
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
518
|
+
/**
|
|
519
|
+
* Response code 204 - Service deregistered successfully
|
|
520
|
+
* Response code 404 - Service instance not found
|
|
521
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
522
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
523
|
+
*/
|
|
524
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
525
|
+
/**
|
|
526
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
527
|
+
* Response code 404 - ExternalService not found
|
|
528
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
529
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
530
|
+
*/
|
|
531
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
532
|
+
/**
|
|
533
|
+
* Response code 204 - Heartbeat sent successfully
|
|
534
|
+
* Response code 404 - Service instance not found
|
|
535
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
536
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
537
|
+
*/
|
|
538
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
539
|
+
}
|
|
540
|
+
export declare class AssetModelResourceClient<O> {
|
|
541
|
+
protected httpClient: HttpClient<O>;
|
|
542
|
+
constructor(httpClient: HttpClient<O>);
|
|
543
|
+
/**
|
|
544
|
+
* HTTP GET /model/assetDescriptors
|
|
545
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
546
|
+
*/
|
|
547
|
+
getAssetDescriptors(queryParams?: {
|
|
548
|
+
parentId?: string;
|
|
549
|
+
parentType?: string;
|
|
550
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
551
|
+
/**
|
|
552
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
553
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
540
554
|
*/
|
|
541
555
|
getAssetInfo(assetType: string, queryParams?: {
|
|
542
556
|
parentId?: string;
|
|
@@ -568,436 +582,422 @@ export declare class AssetModelResourceClient<O> {
|
|
|
568
582
|
[index: string]: Model.ValueDescriptor;
|
|
569
583
|
}>;
|
|
570
584
|
}
|
|
571
|
-
export declare class
|
|
585
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
572
586
|
protected httpClient: HttpClient<O>;
|
|
573
587
|
constructor(httpClient: HttpClient<O>);
|
|
574
588
|
/**
|
|
575
|
-
* HTTP
|
|
576
|
-
* Java method: org.openremote.model.
|
|
577
|
-
*/
|
|
578
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
579
|
-
realm?: string;
|
|
580
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
581
|
-
/**
|
|
582
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
583
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
584
|
-
*/
|
|
585
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
586
|
-
realm?: string;
|
|
587
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
588
|
-
/**
|
|
589
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
590
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
589
|
+
* HTTP POST /gateway/tunnel
|
|
590
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
591
591
|
*/
|
|
592
|
-
|
|
593
|
-
parentId?: string;
|
|
594
|
-
realm?: string;
|
|
595
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
596
|
-
}
|
|
597
|
-
export declare class RulesResourceClient<O> {
|
|
598
|
-
protected httpClient: HttpClient<O>;
|
|
599
|
-
constructor(httpClient: HttpClient<O>);
|
|
592
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
600
593
|
/**
|
|
601
|
-
* HTTP
|
|
602
|
-
* Java method: org.openremote.model.
|
|
594
|
+
* HTTP DELETE /gateway/tunnel
|
|
595
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
603
596
|
*/
|
|
604
|
-
|
|
597
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
605
598
|
/**
|
|
606
|
-
* HTTP GET /
|
|
607
|
-
* Java method: org.openremote.model.
|
|
599
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
600
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
608
601
|
*/
|
|
609
|
-
|
|
610
|
-
language?: Model.RulesetLang[];
|
|
611
|
-
fullyPopulate?: boolean;
|
|
612
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
602
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
613
603
|
/**
|
|
614
|
-
* HTTP
|
|
615
|
-
* Java method: org.openremote.model.
|
|
604
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
605
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
616
606
|
*/
|
|
617
|
-
|
|
607
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
618
608
|
/**
|
|
619
|
-
* HTTP GET /
|
|
620
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
610
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
621
611
|
*/
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
612
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
613
|
+
}
|
|
614
|
+
export declare class ConsoleResourceClient<O> {
|
|
615
|
+
protected httpClient: HttpClient<O>;
|
|
616
|
+
constructor(httpClient: HttpClient<O>);
|
|
626
617
|
/**
|
|
627
|
-
* HTTP
|
|
628
|
-
* Java method: org.openremote.model.
|
|
618
|
+
* HTTP POST /console/register
|
|
619
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
629
620
|
*/
|
|
630
|
-
|
|
621
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
622
|
+
}
|
|
623
|
+
export declare class RealmResourceClient<O> {
|
|
624
|
+
protected httpClient: HttpClient<O>;
|
|
625
|
+
constructor(httpClient: HttpClient<O>);
|
|
631
626
|
/**
|
|
632
|
-
* HTTP
|
|
633
|
-
* Java method: org.openremote.model.
|
|
627
|
+
* HTTP POST /realm
|
|
628
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
634
629
|
*/
|
|
635
|
-
|
|
630
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
636
631
|
/**
|
|
637
|
-
* HTTP
|
|
638
|
-
* Java method: org.openremote.model.
|
|
632
|
+
* HTTP GET /realm
|
|
633
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
639
634
|
*/
|
|
640
|
-
|
|
635
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
641
636
|
/**
|
|
642
|
-
* HTTP GET /
|
|
643
|
-
* Java method: org.openremote.model.
|
|
637
|
+
* HTTP GET /realm/accessible
|
|
638
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
644
639
|
*/
|
|
645
|
-
|
|
640
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
646
641
|
/**
|
|
647
|
-
* HTTP
|
|
648
|
-
* Java method: org.openremote.model.
|
|
642
|
+
* HTTP DELETE /realm/{name}
|
|
643
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
649
644
|
*/
|
|
650
|
-
|
|
645
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
651
646
|
/**
|
|
652
|
-
* HTTP GET /
|
|
653
|
-
* Java method: org.openremote.model.
|
|
647
|
+
* HTTP GET /realm/{name}
|
|
648
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
654
649
|
*/
|
|
655
|
-
|
|
650
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
656
651
|
/**
|
|
657
|
-
* HTTP
|
|
658
|
-
* Java method: org.openremote.model.
|
|
652
|
+
* HTTP PUT /realm/{name}
|
|
653
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
659
654
|
*/
|
|
660
|
-
|
|
655
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
656
|
+
}
|
|
657
|
+
export declare class AlarmResourceClient<O> {
|
|
658
|
+
protected httpClient: HttpClient<O>;
|
|
659
|
+
constructor(httpClient: HttpClient<O>);
|
|
661
660
|
/**
|
|
662
|
-
* HTTP POST /
|
|
663
|
-
* Java method: org.openremote.model.
|
|
661
|
+
* HTTP POST /alarm
|
|
662
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
664
663
|
*/
|
|
665
|
-
|
|
664
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
665
|
+
assetIds?: string[];
|
|
666
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
666
667
|
/**
|
|
667
|
-
* HTTP GET /
|
|
668
|
-
* Java method: org.openremote.model.
|
|
668
|
+
* HTTP GET /alarm
|
|
669
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
669
670
|
*/
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
671
|
+
getAlarms(queryParams?: {
|
|
672
|
+
realm?: string;
|
|
673
|
+
status?: Model.AlarmStatus;
|
|
674
|
+
assetId?: string;
|
|
675
|
+
assigneeId?: string;
|
|
676
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
674
677
|
/**
|
|
675
|
-
* HTTP DELETE /
|
|
676
|
-
* Java method: org.openremote.model.
|
|
678
|
+
* HTTP DELETE /alarm
|
|
679
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
677
680
|
*/
|
|
678
|
-
|
|
681
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
679
682
|
/**
|
|
680
|
-
* HTTP
|
|
681
|
-
* Java method: org.openremote.model.
|
|
683
|
+
* HTTP PUT /alarm/assets
|
|
684
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
682
685
|
*/
|
|
683
|
-
|
|
686
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
684
687
|
/**
|
|
685
|
-
* HTTP
|
|
686
|
-
* Java method: org.openremote.model.
|
|
688
|
+
* HTTP GET /alarm/{alarmId}
|
|
689
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
687
690
|
*/
|
|
688
|
-
|
|
691
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
689
692
|
/**
|
|
690
|
-
* HTTP DELETE /
|
|
691
|
-
* Java method: org.openremote.model.
|
|
693
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
694
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
692
695
|
*/
|
|
693
|
-
|
|
696
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
694
697
|
/**
|
|
695
|
-
* HTTP
|
|
696
|
-
* Java method: org.openremote.model.
|
|
698
|
+
* HTTP PUT /alarm/{alarmId}
|
|
699
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
697
700
|
*/
|
|
698
|
-
|
|
701
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
699
702
|
/**
|
|
700
|
-
* HTTP
|
|
701
|
-
* Java method: org.openremote.model.
|
|
703
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
704
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
702
705
|
*/
|
|
703
|
-
|
|
706
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
707
|
+
realm?: string;
|
|
708
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
704
709
|
}
|
|
705
|
-
export declare class
|
|
710
|
+
export declare class NotificationResourceClient<O> {
|
|
706
711
|
protected httpClient: HttpClient<O>;
|
|
707
712
|
constructor(httpClient: HttpClient<O>);
|
|
708
713
|
/**
|
|
709
|
-
* HTTP GET /
|
|
710
|
-
* Java method: org.openremote.model.
|
|
711
|
-
*/
|
|
712
|
-
getSettings(options?: O): RestResponse<{
|
|
713
|
-
[id: string]: unknown;
|
|
714
|
-
}>;
|
|
715
|
-
/**
|
|
716
|
-
* HTTP PUT /map
|
|
717
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
714
|
+
* HTTP GET /notification
|
|
715
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
718
716
|
*/
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
717
|
+
getNotifications(queryParams?: {
|
|
718
|
+
id?: number;
|
|
719
|
+
type?: string;
|
|
720
|
+
from?: number;
|
|
721
|
+
to?: number;
|
|
722
|
+
realmId?: string;
|
|
723
|
+
userId?: string;
|
|
724
|
+
assetId?: string;
|
|
725
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
722
726
|
/**
|
|
723
|
-
* HTTP DELETE /
|
|
724
|
-
* Java method: org.openremote.model.
|
|
727
|
+
* HTTP DELETE /notification
|
|
728
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
725
729
|
*/
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
730
|
+
removeNotifications(queryParams?: {
|
|
731
|
+
id?: number;
|
|
732
|
+
type?: string;
|
|
733
|
+
from?: number;
|
|
734
|
+
to?: number;
|
|
735
|
+
realmId?: string;
|
|
736
|
+
userId?: string;
|
|
737
|
+
assetId?: string;
|
|
738
|
+
}, options?: O): RestResponse<void>;
|
|
729
739
|
/**
|
|
730
|
-
* HTTP
|
|
731
|
-
* Java method: org.openremote.model.
|
|
740
|
+
* HTTP POST /notification/alert
|
|
741
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
732
742
|
*/
|
|
733
|
-
|
|
734
|
-
[id: string]: unknown;
|
|
735
|
-
}>;
|
|
743
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
736
744
|
/**
|
|
737
|
-
* HTTP
|
|
738
|
-
* Java method: org.openremote.model.
|
|
745
|
+
* HTTP DELETE /notification/{notificationId}
|
|
746
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
739
747
|
*/
|
|
740
|
-
|
|
741
|
-
[id: string]: unknown;
|
|
742
|
-
}>;
|
|
748
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
743
749
|
/**
|
|
744
|
-
* HTTP
|
|
745
|
-
* Java method: org.openremote.model.
|
|
750
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
751
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
746
752
|
*/
|
|
747
|
-
|
|
753
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
754
|
+
targetId?: string;
|
|
755
|
+
}, options?: O): RestResponse<void>;
|
|
748
756
|
/**
|
|
749
|
-
* HTTP
|
|
750
|
-
* Java method: org.openremote.model.
|
|
757
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
758
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
751
759
|
*/
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
}, options?: O): RestResponse<
|
|
755
|
-
[id: string]: unknown;
|
|
756
|
-
}>;
|
|
760
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
761
|
+
targetId?: string;
|
|
762
|
+
}, options?: O): RestResponse<void>;
|
|
757
763
|
}
|
|
758
|
-
export declare class
|
|
764
|
+
export declare class GatewayClientResourceClient<O> {
|
|
759
765
|
protected httpClient: HttpClient<O>;
|
|
760
766
|
constructor(httpClient: HttpClient<O>);
|
|
761
767
|
/**
|
|
762
|
-
*
|
|
763
|
-
*
|
|
764
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
765
|
-
*/
|
|
766
|
-
getServices(queryParams?: {
|
|
767
|
-
realm?: string;
|
|
768
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
769
|
-
/**
|
|
770
|
-
* Response code 200 - Service registered successfully
|
|
771
|
-
* Response code 400 - Invalid external service object
|
|
772
|
-
* Response code 409 - ExternalService instance already registered
|
|
773
|
-
* HTTP POST /service
|
|
774
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
768
|
+
* HTTP DELETE /gateway/connection
|
|
769
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
775
770
|
*/
|
|
776
|
-
|
|
771
|
+
deleteConnections(queryParams?: {
|
|
772
|
+
realm?: string[];
|
|
773
|
+
}, options?: O): RestResponse<void>;
|
|
777
774
|
/**
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
775
|
+
* HTTP GET /gateway/connection
|
|
776
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
781
777
|
*/
|
|
782
|
-
|
|
778
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
783
779
|
/**
|
|
784
|
-
*
|
|
785
|
-
*
|
|
786
|
-
* Response code 409 - ExternalService instance already registered
|
|
787
|
-
* HTTP POST /service/global
|
|
788
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
780
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
781
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
789
782
|
*/
|
|
790
|
-
|
|
783
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
791
784
|
/**
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
795
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
785
|
+
* HTTP GET /gateway/connection/{realm}
|
|
786
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
796
787
|
*/
|
|
797
|
-
|
|
788
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
798
789
|
/**
|
|
799
|
-
*
|
|
800
|
-
*
|
|
801
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
802
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
790
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
791
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
803
792
|
*/
|
|
804
|
-
|
|
793
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
805
794
|
/**
|
|
806
|
-
*
|
|
807
|
-
*
|
|
808
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
809
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
795
|
+
* HTTP GET /gateway/status/{realm}
|
|
796
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
810
797
|
*/
|
|
811
|
-
|
|
798
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
812
799
|
}
|
|
813
|
-
export declare class
|
|
800
|
+
export declare class ProvisioningResourceClient<O> {
|
|
814
801
|
protected httpClient: HttpClient<O>;
|
|
815
802
|
constructor(httpClient: HttpClient<O>);
|
|
816
803
|
/**
|
|
817
|
-
* HTTP
|
|
818
|
-
* Java method: org.openremote.model.
|
|
804
|
+
* HTTP POST /provisioning
|
|
805
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
819
806
|
*/
|
|
820
|
-
|
|
807
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
821
808
|
/**
|
|
822
|
-
* HTTP GET /
|
|
823
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP GET /provisioning
|
|
810
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
824
811
|
*/
|
|
825
|
-
|
|
812
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
826
813
|
/**
|
|
827
|
-
* HTTP
|
|
828
|
-
* Java method: org.openremote.model.
|
|
814
|
+
* HTTP DELETE /provisioning/{id}
|
|
815
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
829
816
|
*/
|
|
830
|
-
|
|
817
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP PUT /provisioning/{id}
|
|
820
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
821
|
+
*/
|
|
822
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
831
823
|
}
|
|
832
|
-
export declare class
|
|
824
|
+
export declare class AgentResourceClient<O> {
|
|
833
825
|
protected httpClient: HttpClient<O>;
|
|
834
826
|
constructor(httpClient: HttpClient<O>);
|
|
835
827
|
/**
|
|
836
|
-
* HTTP
|
|
837
|
-
* Java method: org.openremote.model.
|
|
828
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
829
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
830
|
+
*/
|
|
831
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
832
|
+
realm?: string;
|
|
833
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
834
|
+
/**
|
|
835
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
836
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
837
|
+
*/
|
|
838
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
839
|
+
realm?: string;
|
|
840
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
841
|
+
/**
|
|
842
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
843
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
838
844
|
*/
|
|
839
|
-
|
|
845
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
846
|
+
parentId?: string;
|
|
847
|
+
realm?: string;
|
|
848
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
840
849
|
}
|
|
841
|
-
export declare class
|
|
850
|
+
export declare class AssetResourceClient<O> {
|
|
842
851
|
protected httpClient: HttpClient<O>;
|
|
843
852
|
constructor(httpClient: HttpClient<O>);
|
|
844
853
|
/**
|
|
845
|
-
* HTTP
|
|
846
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP POST /asset
|
|
855
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
847
856
|
*/
|
|
848
|
-
|
|
849
|
-
attributeRefs?: string;
|
|
850
|
-
fromTimestamp?: number;
|
|
851
|
-
toTimestamp?: number;
|
|
852
|
-
}, options?: O): RestResponse<any>;
|
|
857
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
853
858
|
/**
|
|
854
|
-
* HTTP
|
|
855
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP DELETE /asset
|
|
860
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
856
861
|
*/
|
|
857
|
-
|
|
858
|
-
assetId?: string;
|
|
859
|
-
|
|
860
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
862
|
+
delete(queryParams?: {
|
|
863
|
+
assetId?: string[];
|
|
864
|
+
}, options?: O): RestResponse<void>;
|
|
861
865
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
866
|
+
* HTTP PUT /asset/attributes
|
|
867
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
864
868
|
*/
|
|
865
|
-
|
|
866
|
-
}
|
|
867
|
-
export declare class AppResourceClient<O> {
|
|
868
|
-
protected httpClient: HttpClient<O>;
|
|
869
|
-
constructor(httpClient: HttpClient<O>);
|
|
869
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
870
870
|
/**
|
|
871
|
-
* HTTP
|
|
872
|
-
* Java method: org.openremote.model.
|
|
871
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
872
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
873
873
|
*/
|
|
874
|
-
|
|
874
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
875
875
|
/**
|
|
876
|
-
* HTTP
|
|
877
|
-
* Java method: org.openremote.model.
|
|
876
|
+
* HTTP DELETE /asset/parent
|
|
877
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
878
878
|
*/
|
|
879
|
-
|
|
879
|
+
updateNoneParent(queryParams?: {
|
|
880
|
+
assetIds?: string[];
|
|
881
|
+
}, options?: O): RestResponse<void>;
|
|
880
882
|
/**
|
|
881
|
-
* HTTP GET /
|
|
882
|
-
* Java method: org.openremote.model.
|
|
883
|
+
* HTTP GET /asset/partial/{assetId}
|
|
884
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
883
885
|
*/
|
|
884
|
-
|
|
885
|
-
}
|
|
886
|
-
export declare class RealmResourceClient<O> {
|
|
887
|
-
protected httpClient: HttpClient<O>;
|
|
888
|
-
constructor(httpClient: HttpClient<O>);
|
|
886
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
889
887
|
/**
|
|
890
|
-
* HTTP POST /
|
|
891
|
-
* Java method: org.openremote.model.
|
|
888
|
+
* HTTP POST /asset/query
|
|
889
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
892
890
|
*/
|
|
893
|
-
|
|
891
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
894
892
|
/**
|
|
895
|
-
* HTTP GET /
|
|
896
|
-
* Java method: org.openremote.model.
|
|
893
|
+
* HTTP GET /asset/user/current
|
|
894
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
897
895
|
*/
|
|
898
|
-
|
|
896
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
899
897
|
/**
|
|
900
|
-
* HTTP
|
|
901
|
-
* Java method: org.openremote.model.
|
|
898
|
+
* HTTP POST /asset/user/link
|
|
899
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
902
900
|
*/
|
|
903
|
-
|
|
901
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
904
902
|
/**
|
|
905
|
-
* HTTP
|
|
906
|
-
* Java method: org.openremote.model.
|
|
903
|
+
* HTTP GET /asset/user/link
|
|
904
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
907
905
|
*/
|
|
908
|
-
|
|
906
|
+
getUserAssetLinks(queryParams?: {
|
|
907
|
+
realm?: string;
|
|
908
|
+
userId?: string;
|
|
909
|
+
assetId?: string;
|
|
910
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
909
911
|
/**
|
|
910
|
-
* HTTP
|
|
911
|
-
* Java method: org.openremote.model.
|
|
912
|
+
* HTTP POST /asset/user/link/delete
|
|
913
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
912
914
|
*/
|
|
913
|
-
|
|
915
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
914
916
|
/**
|
|
915
|
-
* HTTP
|
|
916
|
-
* Java method: org.openremote.model.
|
|
917
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
918
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
917
919
|
*/
|
|
918
|
-
|
|
919
|
-
}
|
|
920
|
-
export declare class DashboardResourceClient<O> {
|
|
921
|
-
protected httpClient: HttpClient<O>;
|
|
922
|
-
constructor(httpClient: HttpClient<O>);
|
|
920
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
923
921
|
/**
|
|
924
|
-
* HTTP
|
|
925
|
-
* Java method: org.openremote.model.
|
|
922
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
923
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
926
924
|
*/
|
|
927
|
-
|
|
925
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
928
926
|
/**
|
|
929
|
-
* HTTP
|
|
930
|
-
* Java method: org.openremote.model.
|
|
927
|
+
* HTTP GET /asset/{assetId}
|
|
928
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
931
929
|
*/
|
|
932
|
-
|
|
930
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
933
931
|
/**
|
|
934
|
-
* HTTP
|
|
935
|
-
* Java method: org.openremote.model.
|
|
932
|
+
* HTTP PUT /asset/{assetId}
|
|
933
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
936
934
|
*/
|
|
937
|
-
|
|
935
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
938
936
|
/**
|
|
939
|
-
* HTTP
|
|
940
|
-
* Java method: org.openremote.model.
|
|
937
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
938
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
941
939
|
*/
|
|
942
|
-
|
|
940
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
943
941
|
/**
|
|
944
|
-
* HTTP
|
|
945
|
-
* Java method: org.openremote.model.
|
|
942
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
943
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
946
944
|
*/
|
|
947
|
-
|
|
945
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
948
946
|
/**
|
|
949
|
-
* HTTP
|
|
950
|
-
* Java method: org.openremote.model.
|
|
947
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
948
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
951
949
|
*/
|
|
952
|
-
|
|
950
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
951
|
+
assetIds?: string[];
|
|
952
|
+
}, options?: O): RestResponse<void>;
|
|
953
953
|
}
|
|
954
954
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
955
955
|
export declare class ApiClient {
|
|
956
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
957
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
958
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
959
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
960
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
961
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
962
956
|
protected _statusResource: AxiosStatusResourceClient;
|
|
957
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
963
958
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
964
|
-
protected
|
|
965
|
-
protected
|
|
966
|
-
protected
|
|
967
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
968
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
969
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
959
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
960
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
961
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
970
962
|
protected _mapResource: AxiosMapResourceClient;
|
|
963
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
964
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
965
|
+
protected _userResource: AxiosUserResourceClient;
|
|
966
|
+
protected _appResource: AxiosAppResourceClient;
|
|
971
967
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
972
|
-
protected
|
|
968
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
969
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
973
970
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
974
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
975
|
-
protected _appResource: AxiosAppResourceClient;
|
|
976
971
|
protected _realmResource: AxiosRealmResourceClient;
|
|
977
|
-
protected
|
|
972
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
973
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
974
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
975
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
976
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
977
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
978
978
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
979
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
980
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
981
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
982
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
983
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
984
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
985
979
|
get StatusResource(): AxiosStatusResourceClient;
|
|
980
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
986
981
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
987
|
-
get
|
|
988
|
-
get
|
|
989
|
-
get
|
|
990
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
991
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
992
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
982
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
983
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
984
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
993
985
|
get MapResource(): AxiosMapResourceClient;
|
|
986
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
987
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
988
|
+
get UserResource(): AxiosUserResourceClient;
|
|
989
|
+
get AppResource(): AxiosAppResourceClient;
|
|
994
990
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
995
|
-
get
|
|
991
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
992
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
996
993
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
997
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
998
|
-
get AppResource(): AxiosAppResourceClient;
|
|
999
994
|
get RealmResource(): AxiosRealmResourceClient;
|
|
1000
|
-
get
|
|
995
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
996
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
997
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
998
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
999
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1000
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1001
1001
|
}
|
|
1002
1002
|
import * as Axios from "axios";
|
|
1003
1003
|
declare module "axios" {
|
|
@@ -1005,69 +1005,69 @@ declare module "axios" {
|
|
|
1005
1005
|
data: R;
|
|
1006
1006
|
}
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
1011
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|
|
1014
|
-
export declare class
|
|
1014
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1015
1015
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1016
1016
|
}
|
|
1017
|
-
export declare class
|
|
1017
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1018
1018
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1019
1019
|
}
|
|
1020
1020
|
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1021
1021
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1022
1022
|
}
|
|
1023
|
-
export declare class
|
|
1023
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1024
1024
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1025
1025
|
}
|
|
1026
|
-
export declare class
|
|
1026
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1027
1027
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1028
1028
|
}
|
|
1029
|
-
export declare class
|
|
1029
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1030
1030
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1031
1031
|
}
|
|
1032
|
-
export declare class
|
|
1032
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1033
1033
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1034
1034
|
}
|
|
1035
1035
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1036
1036
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1037
1037
|
}
|
|
1038
|
-
export declare class
|
|
1038
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1039
1039
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1040
1040
|
}
|
|
1041
|
-
export declare class
|
|
1041
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1042
1042
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1043
1043
|
}
|
|
1044
|
-
export declare class
|
|
1044
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1045
1045
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1046
1046
|
}
|
|
1047
|
-
export declare class
|
|
1047
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1048
1048
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1049
1049
|
}
|
|
1050
|
-
export declare class
|
|
1050
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1051
1051
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1052
1052
|
}
|
|
1053
|
-
export declare class
|
|
1053
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1054
1054
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1055
1055
|
}
|
|
1056
|
-
export declare class
|
|
1056
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1057
1057
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1058
1058
|
}
|
|
1059
|
-
export declare class
|
|
1059
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1060
1060
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1061
1061
|
}
|
|
1062
|
-
export declare class
|
|
1062
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1063
1063
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1064
1064
|
}
|
|
1065
|
-
export declare class
|
|
1065
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1066
1066
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1067
1067
|
}
|
|
1068
|
-
export declare class
|
|
1068
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1069
1069
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1070
1070
|
}
|
|
1071
|
-
export declare class
|
|
1071
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1072
1072
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1073
1073
|
}
|