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