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