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