@openremote/rest 1.17.0-snapshot.20260206124337 → 1.17.0
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 +440 -440
- package/lib/restclient.d.ts.map +1 -1
- 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,151 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class RulesResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP POST /rules
|
|
17
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
parentId?: string;
|
|
21
|
-
parentType?: string;
|
|
22
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
19
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
23
20
|
/**
|
|
24
|
-
* HTTP GET /
|
|
25
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /rules
|
|
22
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
26
23
|
*/
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
24
|
+
getGlobalRulesets(queryParams?: {
|
|
25
|
+
language?: Model.RulesetLang[];
|
|
26
|
+
fullyPopulate?: boolean;
|
|
27
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
30
28
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
29
|
+
* HTTP POST /rules/asset
|
|
30
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
33
31
|
*/
|
|
34
|
-
|
|
35
|
-
parentId?: string;
|
|
36
|
-
parentType?: string;
|
|
37
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
32
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
38
33
|
/**
|
|
39
|
-
* HTTP GET /
|
|
40
|
-
* Java method: org.openremote.model.
|
|
34
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
35
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
41
36
|
*/
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
}, options?: O): RestResponse<
|
|
37
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
38
|
+
language?: Model.RulesetLang[];
|
|
39
|
+
fullyPopulate?: boolean;
|
|
40
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
46
41
|
/**
|
|
47
|
-
* HTTP
|
|
48
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP DELETE /rules/asset/{id}
|
|
43
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
49
44
|
*/
|
|
50
|
-
|
|
51
|
-
parentId?: string;
|
|
52
|
-
}, options?: O): RestResponse<{
|
|
53
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
54
|
-
}>;
|
|
45
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
55
46
|
/**
|
|
56
|
-
* HTTP GET /
|
|
57
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP GET /rules/asset/{id}
|
|
48
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
58
49
|
*/
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
50
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
51
|
+
/**
|
|
52
|
+
* HTTP PUT /rules/asset/{id}
|
|
53
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
54
|
+
*/
|
|
55
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
56
|
+
/**
|
|
57
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
58
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
59
|
+
*/
|
|
60
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
61
|
+
/**
|
|
62
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
63
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
64
|
+
*/
|
|
65
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
66
|
+
/**
|
|
67
|
+
* HTTP GET /rules/info/global
|
|
68
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
69
|
+
*/
|
|
70
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
71
|
+
/**
|
|
72
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
73
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
74
|
+
*/
|
|
75
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
76
|
+
/**
|
|
77
|
+
* HTTP POST /rules/realm
|
|
78
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
79
|
+
*/
|
|
80
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
81
|
+
/**
|
|
82
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
83
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
84
|
+
*/
|
|
85
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
86
|
+
language?: Model.RulesetLang[];
|
|
87
|
+
fullyPopulate?: boolean;
|
|
88
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
89
|
+
/**
|
|
90
|
+
* HTTP DELETE /rules/realm/{id}
|
|
91
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
92
|
+
*/
|
|
93
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
94
|
+
/**
|
|
95
|
+
* HTTP GET /rules/realm/{id}
|
|
96
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
97
|
+
*/
|
|
98
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
99
|
+
/**
|
|
100
|
+
* HTTP PUT /rules/realm/{id}
|
|
101
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
102
|
+
*/
|
|
103
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
104
|
+
/**
|
|
105
|
+
* HTTP DELETE /rules/{id}
|
|
106
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
107
|
+
*/
|
|
108
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
109
|
+
/**
|
|
110
|
+
* HTTP GET /rules/{id}
|
|
111
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
112
|
+
*/
|
|
113
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
114
|
+
/**
|
|
115
|
+
* HTTP PUT /rules/{id}
|
|
116
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
117
|
+
*/
|
|
118
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
64
119
|
}
|
|
65
|
-
export declare class
|
|
120
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
66
121
|
protected httpClient: HttpClient<O>;
|
|
67
122
|
constructor(httpClient: HttpClient<O>);
|
|
68
123
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
124
|
+
* HTTP POST /gateway/tunnel
|
|
125
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
71
126
|
*/
|
|
72
|
-
|
|
127
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
73
128
|
/**
|
|
74
|
-
* HTTP
|
|
75
|
-
* Java method: org.openremote.model.
|
|
129
|
+
* HTTP DELETE /gateway/tunnel
|
|
130
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
76
131
|
*/
|
|
77
|
-
|
|
132
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
78
133
|
/**
|
|
79
|
-
* HTTP GET /
|
|
80
|
-
* Java method: org.openremote.model.
|
|
134
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
135
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
81
136
|
*/
|
|
82
|
-
|
|
137
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
138
|
+
/**
|
|
139
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
140
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
141
|
+
*/
|
|
142
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
143
|
+
/**
|
|
144
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
145
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
146
|
+
*/
|
|
147
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
148
|
+
}
|
|
149
|
+
export declare class ConsoleResourceClient<O> {
|
|
150
|
+
protected httpClient: HttpClient<O>;
|
|
151
|
+
constructor(httpClient: HttpClient<O>);
|
|
152
|
+
/**
|
|
153
|
+
* HTTP POST /console/register
|
|
154
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
155
|
+
*/
|
|
156
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
83
157
|
}
|
|
84
158
|
export declare class ExternalServiceResourceClient<O> {
|
|
85
159
|
protected httpClient: HttpClient<O>;
|
|
@@ -260,189 +334,196 @@ export declare class UserResourceClient<O> {
|
|
|
260
334
|
*/
|
|
261
335
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
262
336
|
}
|
|
263
|
-
export declare class
|
|
337
|
+
export declare class DashboardResourceClient<O> {
|
|
264
338
|
protected httpClient: HttpClient<O>;
|
|
265
339
|
constructor(httpClient: HttpClient<O>);
|
|
266
340
|
/**
|
|
267
|
-
* HTTP
|
|
268
|
-
* Java method: org.openremote.model.
|
|
341
|
+
* HTTP POST /dashboard
|
|
342
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
269
343
|
*/
|
|
270
|
-
|
|
344
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
271
345
|
/**
|
|
272
|
-
* HTTP PUT /
|
|
273
|
-
* Java method: org.openremote.model.
|
|
346
|
+
* HTTP PUT /dashboard
|
|
347
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
274
348
|
*/
|
|
275
|
-
|
|
349
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
276
350
|
/**
|
|
277
|
-
* HTTP
|
|
278
|
-
* Java method: org.openremote.model.
|
|
351
|
+
* HTTP GET /dashboard/all/{realm}
|
|
352
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
279
353
|
*/
|
|
280
|
-
|
|
354
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
281
355
|
/**
|
|
282
|
-
* HTTP
|
|
283
|
-
* Java method: org.openremote.model.
|
|
356
|
+
* HTTP POST /dashboard/query
|
|
357
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
284
358
|
*/
|
|
285
|
-
|
|
286
|
-
level?: Model.SyslogLevel;
|
|
287
|
-
per_page?: number;
|
|
288
|
-
page?: number;
|
|
289
|
-
from?: number;
|
|
290
|
-
to?: number;
|
|
291
|
-
category?: Model.SyslogCategory[];
|
|
292
|
-
subCategory?: string[];
|
|
293
|
-
}, options?: O): RestResponse<any>;
|
|
294
|
-
}
|
|
295
|
-
export declare class ConfigurationResourceClient<O> {
|
|
296
|
-
protected httpClient: HttpClient<O>;
|
|
297
|
-
constructor(httpClient: HttpClient<O>);
|
|
359
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
298
360
|
/**
|
|
299
|
-
* HTTP
|
|
300
|
-
* Java method: org.openremote.model.
|
|
361
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
362
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
301
363
|
*/
|
|
302
|
-
|
|
364
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
303
365
|
/**
|
|
304
|
-
* HTTP
|
|
305
|
-
* Java method: org.openremote.model.
|
|
366
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
367
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
306
368
|
*/
|
|
307
|
-
|
|
369
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
370
|
+
}
|
|
371
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
372
|
+
protected httpClient: HttpClient<O>;
|
|
373
|
+
constructor(httpClient: HttpClient<O>);
|
|
308
374
|
/**
|
|
309
|
-
* HTTP POST /
|
|
310
|
-
* Java method: org.openremote.model.
|
|
375
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
376
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
311
377
|
*/
|
|
312
|
-
|
|
313
|
-
path?: string;
|
|
314
|
-
}, options?: O): RestResponse<string>;
|
|
378
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
315
379
|
/**
|
|
316
|
-
* HTTP
|
|
317
|
-
* Java method: org.openremote.model.
|
|
380
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
381
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
318
382
|
*/
|
|
319
|
-
|
|
383
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
320
384
|
}
|
|
321
|
-
export declare class
|
|
385
|
+
export declare class AgentResourceClient<O> {
|
|
322
386
|
protected httpClient: HttpClient<O>;
|
|
323
387
|
constructor(httpClient: HttpClient<O>);
|
|
324
388
|
/**
|
|
325
|
-
* HTTP GET /
|
|
326
|
-
* Java method: org.openremote.model.
|
|
389
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
390
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
327
391
|
*/
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
from?: number;
|
|
332
|
-
to?: number;
|
|
333
|
-
realmId?: string;
|
|
334
|
-
userId?: string;
|
|
335
|
-
assetId?: string;
|
|
336
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
392
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
393
|
+
realm?: string;
|
|
394
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
337
395
|
/**
|
|
338
|
-
* HTTP
|
|
339
|
-
* Java method: org.openremote.model.
|
|
340
|
-
*/
|
|
341
|
-
removeNotifications(queryParams?: {
|
|
342
|
-
id?: number;
|
|
343
|
-
type?: string;
|
|
344
|
-
from?: number;
|
|
345
|
-
to?: number;
|
|
346
|
-
realmId?: string;
|
|
347
|
-
userId?: string;
|
|
348
|
-
assetId?: string;
|
|
349
|
-
}, options?: O): RestResponse<void>;
|
|
350
|
-
/**
|
|
351
|
-
* HTTP POST /notification/alert
|
|
352
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
353
|
-
*/
|
|
354
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
355
|
-
/**
|
|
356
|
-
* HTTP DELETE /notification/{notificationId}
|
|
357
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
358
|
-
*/
|
|
359
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
360
|
-
/**
|
|
361
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
362
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
396
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
397
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
363
398
|
*/
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
}, options?: O): RestResponse<
|
|
399
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
400
|
+
realm?: string;
|
|
401
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
367
402
|
/**
|
|
368
|
-
* HTTP
|
|
369
|
-
* Java method: org.openremote.model.
|
|
403
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
404
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
370
405
|
*/
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
406
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
407
|
+
parentId?: string;
|
|
408
|
+
realm?: string;
|
|
409
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
374
410
|
}
|
|
375
|
-
export declare class
|
|
411
|
+
export declare class MapResourceClient<O> {
|
|
376
412
|
protected httpClient: HttpClient<O>;
|
|
377
413
|
constructor(httpClient: HttpClient<O>);
|
|
378
414
|
/**
|
|
379
|
-
* HTTP
|
|
380
|
-
* Java method: org.openremote.model.
|
|
415
|
+
* HTTP GET /map
|
|
416
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
381
417
|
*/
|
|
382
|
-
|
|
418
|
+
getSettings(options?: O): RestResponse<{
|
|
419
|
+
[id: string]: unknown;
|
|
420
|
+
}>;
|
|
383
421
|
/**
|
|
384
|
-
* HTTP PUT /
|
|
385
|
-
* Java method: org.openremote.model.
|
|
422
|
+
* HTTP PUT /map
|
|
423
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
386
424
|
*/
|
|
387
|
-
|
|
425
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
426
|
+
[id: string]: unknown;
|
|
427
|
+
}>;
|
|
388
428
|
/**
|
|
389
|
-
* HTTP
|
|
390
|
-
* Java method: org.openremote.model.
|
|
429
|
+
* HTTP DELETE /map/deleteMap
|
|
430
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
391
431
|
*/
|
|
392
|
-
|
|
432
|
+
deleteMap(options?: O): RestResponse<{
|
|
433
|
+
[id: string]: unknown;
|
|
434
|
+
}>;
|
|
393
435
|
/**
|
|
394
|
-
* HTTP
|
|
395
|
-
* Java method: org.openremote.model.
|
|
436
|
+
* HTTP GET /map/getCustomMapInfo
|
|
437
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
396
438
|
*/
|
|
397
|
-
|
|
439
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
440
|
+
[id: string]: unknown;
|
|
441
|
+
}>;
|
|
398
442
|
/**
|
|
399
|
-
* HTTP
|
|
400
|
-
* Java method: org.openremote.model.
|
|
443
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
444
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
401
445
|
*/
|
|
402
|
-
|
|
446
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
403
447
|
/**
|
|
404
|
-
* HTTP
|
|
405
|
-
* Java method: org.openremote.model.
|
|
448
|
+
* HTTP POST /map/upload
|
|
449
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
406
450
|
*/
|
|
407
|
-
|
|
451
|
+
uploadMap(queryParams?: {
|
|
452
|
+
filename?: string;
|
|
453
|
+
}, options?: O): RestResponse<{
|
|
454
|
+
[id: string]: unknown;
|
|
455
|
+
}>;
|
|
408
456
|
}
|
|
409
|
-
export declare class
|
|
457
|
+
export declare class StatusResourceClient<O> {
|
|
410
458
|
protected httpClient: HttpClient<O>;
|
|
411
459
|
constructor(httpClient: HttpClient<O>);
|
|
412
460
|
/**
|
|
413
|
-
* HTTP
|
|
414
|
-
* Java method: org.openremote.model.
|
|
461
|
+
* HTTP GET /health
|
|
462
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
415
463
|
*/
|
|
416
|
-
|
|
464
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
465
|
+
[index: string]: any;
|
|
466
|
+
}>;
|
|
417
467
|
/**
|
|
418
|
-
* HTTP
|
|
419
|
-
* Java method: org.openremote.model.
|
|
468
|
+
* HTTP GET /info
|
|
469
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
420
470
|
*/
|
|
421
|
-
|
|
471
|
+
getInfo(options?: O): RestResponse<{
|
|
472
|
+
[index: string]: any;
|
|
473
|
+
}>;
|
|
422
474
|
}
|
|
423
|
-
export declare class
|
|
475
|
+
export declare class AssetModelResourceClient<O> {
|
|
424
476
|
protected httpClient: HttpClient<O>;
|
|
425
477
|
constructor(httpClient: HttpClient<O>);
|
|
426
478
|
/**
|
|
427
|
-
* HTTP
|
|
428
|
-
* Java method: org.openremote.model.
|
|
479
|
+
* HTTP GET /model/assetDescriptors
|
|
480
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
429
481
|
*/
|
|
430
|
-
|
|
482
|
+
getAssetDescriptors(queryParams?: {
|
|
483
|
+
parentId?: string;
|
|
484
|
+
parentType?: string;
|
|
485
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
431
486
|
/**
|
|
432
|
-
* HTTP GET /
|
|
433
|
-
* Java method: org.openremote.model.
|
|
487
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
488
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
434
489
|
*/
|
|
435
|
-
|
|
490
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
491
|
+
parentId?: string;
|
|
492
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
436
493
|
/**
|
|
437
|
-
* HTTP
|
|
438
|
-
* Java method: org.openremote.model.
|
|
494
|
+
* HTTP GET /model/assetInfos
|
|
495
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
439
496
|
*/
|
|
440
|
-
|
|
497
|
+
getAssetInfos(queryParams?: {
|
|
498
|
+
parentId?: string;
|
|
499
|
+
parentType?: string;
|
|
500
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
441
501
|
/**
|
|
442
|
-
* HTTP
|
|
443
|
-
* Java method: org.openremote.model.
|
|
502
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
503
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
444
504
|
*/
|
|
445
|
-
|
|
505
|
+
getValueDescriptorSchema(queryParams?: {
|
|
506
|
+
name?: string;
|
|
507
|
+
hash?: string;
|
|
508
|
+
}, options?: O): RestResponse<any>;
|
|
509
|
+
/**
|
|
510
|
+
* HTTP GET /model/metaItemDescriptors
|
|
511
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
512
|
+
*/
|
|
513
|
+
getMetaItemDescriptors(queryParams?: {
|
|
514
|
+
parentId?: string;
|
|
515
|
+
}, options?: O): RestResponse<{
|
|
516
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
517
|
+
}>;
|
|
518
|
+
/**
|
|
519
|
+
* HTTP GET /model/valueDescriptors
|
|
520
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
521
|
+
*/
|
|
522
|
+
getValueDescriptors(queryParams?: {
|
|
523
|
+
parentId?: string;
|
|
524
|
+
}, options?: O): RestResponse<{
|
|
525
|
+
[index: string]: Model.ValueDescriptor;
|
|
526
|
+
}>;
|
|
446
527
|
}
|
|
447
528
|
export declare class GatewayClientResourceClient<O> {
|
|
448
529
|
protected httpClient: HttpClient<O>;
|
|
@@ -514,62 +595,6 @@ export declare class RealmResourceClient<O> {
|
|
|
514
595
|
*/
|
|
515
596
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
516
597
|
}
|
|
517
|
-
export declare class ConsoleResourceClient<O> {
|
|
518
|
-
protected httpClient: HttpClient<O>;
|
|
519
|
-
constructor(httpClient: HttpClient<O>);
|
|
520
|
-
/**
|
|
521
|
-
* HTTP POST /console/register
|
|
522
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
523
|
-
*/
|
|
524
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
525
|
-
}
|
|
526
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
527
|
-
protected httpClient: HttpClient<O>;
|
|
528
|
-
constructor(httpClient: HttpClient<O>);
|
|
529
|
-
/**
|
|
530
|
-
* HTTP POST /gateway/tunnel
|
|
531
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
532
|
-
*/
|
|
533
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
534
|
-
/**
|
|
535
|
-
* HTTP DELETE /gateway/tunnel
|
|
536
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
537
|
-
*/
|
|
538
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
539
|
-
/**
|
|
540
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
541
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
542
|
-
*/
|
|
543
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
544
|
-
/**
|
|
545
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
546
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
547
|
-
*/
|
|
548
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
549
|
-
/**
|
|
550
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
551
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
552
|
-
*/
|
|
553
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
554
|
-
}
|
|
555
|
-
export declare class StatusResourceClient<O> {
|
|
556
|
-
protected httpClient: HttpClient<O>;
|
|
557
|
-
constructor(httpClient: HttpClient<O>);
|
|
558
|
-
/**
|
|
559
|
-
* HTTP GET /health
|
|
560
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
561
|
-
*/
|
|
562
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
563
|
-
[index: string]: any;
|
|
564
|
-
}>;
|
|
565
|
-
/**
|
|
566
|
-
* HTTP GET /info
|
|
567
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
568
|
-
*/
|
|
569
|
-
getInfo(options?: O): RestResponse<{
|
|
570
|
-
[index: string]: any;
|
|
571
|
-
}>;
|
|
572
|
-
}
|
|
573
598
|
export declare class FlowResourceClient<O> {
|
|
574
599
|
protected httpClient: HttpClient<O>;
|
|
575
600
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -589,51 +614,58 @@ export declare class FlowResourceClient<O> {
|
|
|
589
614
|
*/
|
|
590
615
|
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
591
616
|
}
|
|
592
|
-
export declare class
|
|
617
|
+
export declare class AlarmResourceClient<O> {
|
|
593
618
|
protected httpClient: HttpClient<O>;
|
|
594
619
|
constructor(httpClient: HttpClient<O>);
|
|
595
620
|
/**
|
|
596
|
-
* HTTP
|
|
597
|
-
* Java method: org.openremote.model.
|
|
621
|
+
* HTTP POST /alarm
|
|
622
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
598
623
|
*/
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
}>;
|
|
624
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
625
|
+
assetIds?: string[];
|
|
626
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
602
627
|
/**
|
|
603
|
-
* HTTP
|
|
604
|
-
* Java method: org.openremote.model.
|
|
628
|
+
* HTTP GET /alarm
|
|
629
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
605
630
|
*/
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
631
|
+
getAlarms(queryParams?: {
|
|
632
|
+
realm?: string;
|
|
633
|
+
status?: Model.AlarmStatus;
|
|
634
|
+
assetId?: string;
|
|
635
|
+
assigneeId?: string;
|
|
636
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
609
637
|
/**
|
|
610
|
-
* HTTP DELETE /
|
|
611
|
-
* Java method: org.openremote.model.
|
|
638
|
+
* HTTP DELETE /alarm
|
|
639
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
612
640
|
*/
|
|
613
|
-
|
|
614
|
-
[id: string]: unknown;
|
|
615
|
-
}>;
|
|
641
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
616
642
|
/**
|
|
617
|
-
* HTTP
|
|
618
|
-
* Java method: org.openremote.model.
|
|
643
|
+
* HTTP PUT /alarm/assets
|
|
644
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
619
645
|
*/
|
|
620
|
-
|
|
621
|
-
[id: string]: unknown;
|
|
622
|
-
}>;
|
|
646
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
623
647
|
/**
|
|
624
|
-
* HTTP GET /
|
|
625
|
-
* Java method: org.openremote.model.
|
|
648
|
+
* HTTP GET /alarm/{alarmId}
|
|
649
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
626
650
|
*/
|
|
627
|
-
|
|
651
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
628
652
|
/**
|
|
629
|
-
* HTTP
|
|
630
|
-
* Java method: org.openremote.model.
|
|
653
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
654
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
631
655
|
*/
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
656
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
657
|
+
/**
|
|
658
|
+
* HTTP PUT /alarm/{alarmId}
|
|
659
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
660
|
+
*/
|
|
661
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
662
|
+
/**
|
|
663
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
664
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
665
|
+
*/
|
|
666
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
667
|
+
realm?: string;
|
|
668
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
637
669
|
}
|
|
638
670
|
export declare class AssetResourceClient<O> {
|
|
639
671
|
protected httpClient: HttpClient<O>;
|
|
@@ -749,58 +781,55 @@ export declare class AssetResourceClient<O> {
|
|
|
749
781
|
assetIds?: string[];
|
|
750
782
|
}, options?: O): RestResponse<void>;
|
|
751
783
|
}
|
|
752
|
-
export declare class
|
|
784
|
+
export declare class ProvisioningResourceClient<O> {
|
|
753
785
|
protected httpClient: HttpClient<O>;
|
|
754
786
|
constructor(httpClient: HttpClient<O>);
|
|
755
787
|
/**
|
|
756
|
-
* HTTP POST /
|
|
757
|
-
* Java method: org.openremote.model.
|
|
788
|
+
* HTTP POST /provisioning
|
|
789
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
758
790
|
*/
|
|
759
|
-
|
|
760
|
-
assetIds?: string[];
|
|
761
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
791
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
762
792
|
/**
|
|
763
|
-
* HTTP GET /
|
|
764
|
-
* Java method: org.openremote.model.
|
|
793
|
+
* HTTP GET /provisioning
|
|
794
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
765
795
|
*/
|
|
766
|
-
|
|
767
|
-
realm?: string;
|
|
768
|
-
status?: Model.AlarmStatus;
|
|
769
|
-
assetId?: string;
|
|
770
|
-
assigneeId?: string;
|
|
771
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
796
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
772
797
|
/**
|
|
773
|
-
* HTTP DELETE /
|
|
774
|
-
* Java method: org.openremote.model.
|
|
798
|
+
* HTTP DELETE /provisioning/{id}
|
|
799
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
775
800
|
*/
|
|
776
|
-
|
|
801
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
777
802
|
/**
|
|
778
|
-
* HTTP PUT /
|
|
779
|
-
* Java method: org.openremote.model.
|
|
803
|
+
* HTTP PUT /provisioning/{id}
|
|
804
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
780
805
|
*/
|
|
781
|
-
|
|
806
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
807
|
+
}
|
|
808
|
+
export declare class ConfigurationResourceClient<O> {
|
|
809
|
+
protected httpClient: HttpClient<O>;
|
|
810
|
+
constructor(httpClient: HttpClient<O>);
|
|
782
811
|
/**
|
|
783
|
-
* HTTP GET /
|
|
784
|
-
* Java method: org.openremote.model.
|
|
812
|
+
* HTTP GET /configuration/manager
|
|
813
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
785
814
|
*/
|
|
786
|
-
|
|
815
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
787
816
|
/**
|
|
788
|
-
* HTTP
|
|
789
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP PUT /configuration/manager
|
|
818
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
790
819
|
*/
|
|
791
|
-
|
|
820
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
792
821
|
/**
|
|
793
|
-
* HTTP
|
|
794
|
-
* Java method: org.openremote.model.
|
|
822
|
+
* HTTP POST /configuration/manager/file
|
|
823
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
795
824
|
*/
|
|
796
|
-
|
|
825
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
826
|
+
path?: string;
|
|
827
|
+
}, options?: O): RestResponse<string>;
|
|
797
828
|
/**
|
|
798
|
-
* HTTP GET /
|
|
799
|
-
* Java method: org.openremote.model.
|
|
829
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
830
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
800
831
|
*/
|
|
801
|
-
|
|
802
|
-
realm?: string;
|
|
803
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
832
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
804
833
|
}
|
|
805
834
|
export declare class AssetDatapointResourceClient<O> {
|
|
806
835
|
protected httpClient: HttpClient<O>;
|
|
@@ -828,187 +857,158 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
828
857
|
*/
|
|
829
858
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
830
859
|
}
|
|
831
|
-
export declare class
|
|
860
|
+
export declare class AppResourceClient<O> {
|
|
832
861
|
protected httpClient: HttpClient<O>;
|
|
833
862
|
constructor(httpClient: HttpClient<O>);
|
|
834
863
|
/**
|
|
835
|
-
* HTTP GET /
|
|
836
|
-
* Java method: org.openremote.model.
|
|
864
|
+
* HTTP GET /apps
|
|
865
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
837
866
|
*/
|
|
838
|
-
|
|
839
|
-
realm?: string;
|
|
840
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
867
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
841
868
|
/**
|
|
842
|
-
* HTTP
|
|
843
|
-
* Java method: org.openremote.model.
|
|
869
|
+
* HTTP GET /apps/consoleConfig
|
|
870
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
844
871
|
*/
|
|
845
|
-
|
|
846
|
-
realm?: string;
|
|
847
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
872
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
848
873
|
/**
|
|
849
|
-
* HTTP GET /
|
|
850
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP GET /apps/info
|
|
875
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
851
876
|
*/
|
|
852
|
-
|
|
853
|
-
parentId?: string;
|
|
854
|
-
realm?: string;
|
|
855
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
877
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
856
878
|
}
|
|
857
|
-
export declare class
|
|
879
|
+
export declare class SyslogResourceClient<O> {
|
|
858
880
|
protected httpClient: HttpClient<O>;
|
|
859
881
|
constructor(httpClient: HttpClient<O>);
|
|
860
882
|
/**
|
|
861
|
-
* HTTP
|
|
862
|
-
* Java method: org.openremote.model.
|
|
863
|
-
*/
|
|
864
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
865
|
-
/**
|
|
866
|
-
* HTTP GET /rules
|
|
867
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
868
|
-
*/
|
|
869
|
-
getGlobalRulesets(queryParams?: {
|
|
870
|
-
language?: Model.RulesetLang[];
|
|
871
|
-
fullyPopulate?: boolean;
|
|
872
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
873
|
-
/**
|
|
874
|
-
* HTTP POST /rules/asset
|
|
875
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
876
|
-
*/
|
|
877
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
878
|
-
/**
|
|
879
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
880
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
881
|
-
*/
|
|
882
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
883
|
-
language?: Model.RulesetLang[];
|
|
884
|
-
fullyPopulate?: boolean;
|
|
885
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
886
|
-
/**
|
|
887
|
-
* HTTP DELETE /rules/asset/{id}
|
|
888
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
889
|
-
*/
|
|
890
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
891
|
-
/**
|
|
892
|
-
* HTTP GET /rules/asset/{id}
|
|
893
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
894
|
-
*/
|
|
895
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
896
|
-
/**
|
|
897
|
-
* HTTP PUT /rules/asset/{id}
|
|
898
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
899
|
-
*/
|
|
900
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
901
|
-
/**
|
|
902
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
903
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
904
|
-
*/
|
|
905
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
906
|
-
/**
|
|
907
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
908
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
909
|
-
*/
|
|
910
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
911
|
-
/**
|
|
912
|
-
* HTTP GET /rules/info/global
|
|
913
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
883
|
+
* HTTP GET /syslog/config
|
|
884
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
914
885
|
*/
|
|
915
|
-
|
|
886
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
916
887
|
/**
|
|
917
|
-
* HTTP
|
|
918
|
-
* Java method: org.openremote.model.
|
|
888
|
+
* HTTP PUT /syslog/config
|
|
889
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
919
890
|
*/
|
|
920
|
-
|
|
891
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
921
892
|
/**
|
|
922
|
-
* HTTP
|
|
923
|
-
* Java method: org.openremote.model.
|
|
893
|
+
* HTTP DELETE /syslog/event
|
|
894
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
924
895
|
*/
|
|
925
|
-
|
|
896
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
926
897
|
/**
|
|
927
|
-
* HTTP GET /
|
|
928
|
-
* Java method: org.openremote.model.
|
|
898
|
+
* HTTP GET /syslog/event
|
|
899
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
929
900
|
*/
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
901
|
+
getEvents(queryParams?: {
|
|
902
|
+
level?: Model.SyslogLevel;
|
|
903
|
+
per_page?: number;
|
|
904
|
+
page?: number;
|
|
905
|
+
from?: number;
|
|
906
|
+
to?: number;
|
|
907
|
+
category?: Model.SyslogCategory[];
|
|
908
|
+
subCategory?: string[];
|
|
909
|
+
}, options?: O): RestResponse<any>;
|
|
910
|
+
}
|
|
911
|
+
export declare class NotificationResourceClient<O> {
|
|
912
|
+
protected httpClient: HttpClient<O>;
|
|
913
|
+
constructor(httpClient: HttpClient<O>);
|
|
934
914
|
/**
|
|
935
|
-
* HTTP
|
|
936
|
-
* Java method: org.openremote.model.
|
|
915
|
+
* HTTP GET /notification
|
|
916
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
937
917
|
*/
|
|
938
|
-
|
|
918
|
+
getNotifications(queryParams?: {
|
|
919
|
+
id?: number;
|
|
920
|
+
type?: string;
|
|
921
|
+
from?: number;
|
|
922
|
+
to?: number;
|
|
923
|
+
realmId?: string;
|
|
924
|
+
userId?: string;
|
|
925
|
+
assetId?: string;
|
|
926
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
939
927
|
/**
|
|
940
|
-
* HTTP
|
|
941
|
-
* Java method: org.openremote.model.
|
|
928
|
+
* HTTP DELETE /notification
|
|
929
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
942
930
|
*/
|
|
943
|
-
|
|
931
|
+
removeNotifications(queryParams?: {
|
|
932
|
+
id?: number;
|
|
933
|
+
type?: string;
|
|
934
|
+
from?: number;
|
|
935
|
+
to?: number;
|
|
936
|
+
realmId?: string;
|
|
937
|
+
userId?: string;
|
|
938
|
+
assetId?: string;
|
|
939
|
+
}, options?: O): RestResponse<void>;
|
|
944
940
|
/**
|
|
945
|
-
* HTTP
|
|
946
|
-
* Java method: org.openremote.model.
|
|
941
|
+
* HTTP POST /notification/alert
|
|
942
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
947
943
|
*/
|
|
948
|
-
|
|
944
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
949
945
|
/**
|
|
950
|
-
* HTTP DELETE /
|
|
951
|
-
* Java method: org.openremote.model.
|
|
946
|
+
* HTTP DELETE /notification/{notificationId}
|
|
947
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
952
948
|
*/
|
|
953
|
-
|
|
949
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
954
950
|
/**
|
|
955
|
-
* HTTP
|
|
956
|
-
* Java method: org.openremote.model.
|
|
951
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
952
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
957
953
|
*/
|
|
958
|
-
|
|
954
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
955
|
+
targetId?: string;
|
|
956
|
+
}, options?: O): RestResponse<void>;
|
|
959
957
|
/**
|
|
960
|
-
* HTTP PUT /
|
|
961
|
-
* Java method: org.openremote.model.
|
|
958
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
959
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
962
960
|
*/
|
|
963
|
-
|
|
961
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
962
|
+
targetId?: string;
|
|
963
|
+
}, options?: O): RestResponse<void>;
|
|
964
964
|
}
|
|
965
965
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
966
966
|
export declare class ApiClient {
|
|
967
|
-
protected
|
|
968
|
-
protected
|
|
967
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
968
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
969
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
969
970
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
970
971
|
protected _userResource: AxiosUserResourceClient;
|
|
971
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
972
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
973
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
974
972
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
975
973
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
976
|
-
protected
|
|
974
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
975
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
976
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
977
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
977
978
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
978
979
|
protected _realmResource: AxiosRealmResourceClient;
|
|
979
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
980
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
981
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
982
980
|
protected _flowResource: AxiosFlowResourceClient;
|
|
983
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
984
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
985
981
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
982
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
983
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
984
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
986
985
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
987
|
-
protected
|
|
988
|
-
protected
|
|
986
|
+
protected _appResource: AxiosAppResourceClient;
|
|
987
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
988
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
-
get
|
|
991
|
-
get
|
|
990
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
991
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
992
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
992
993
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
993
994
|
get UserResource(): AxiosUserResourceClient;
|
|
994
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
995
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
996
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
997
995
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
998
996
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
999
|
-
get
|
|
997
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
998
|
+
get MapResource(): AxiosMapResourceClient;
|
|
999
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1000
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1000
1001
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1001
1002
|
get RealmResource(): AxiosRealmResourceClient;
|
|
1002
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1003
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1004
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1005
1003
|
get FlowResource(): AxiosFlowResourceClient;
|
|
1006
|
-
get MapResource(): AxiosMapResourceClient;
|
|
1007
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
1008
1004
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1005
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1006
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1007
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1009
1008
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1010
|
-
get
|
|
1011
|
-
get
|
|
1009
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1010
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1011
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1012
1012
|
}
|
|
1013
1013
|
import * as Axios from "axios";
|
|
1014
1014
|
declare module "axios" {
|
|
@@ -1016,10 +1016,13 @@ declare module "axios" {
|
|
|
1016
1016
|
data: R;
|
|
1017
1017
|
}
|
|
1018
1018
|
}
|
|
1019
|
-
export declare class
|
|
1019
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1020
1020
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1021
1021
|
}
|
|
1022
|
-
export declare class
|
|
1022
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1023
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1024
|
+
}
|
|
1025
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1023
1026
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1024
1027
|
}
|
|
1025
1028
|
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1028,22 +1031,22 @@ export declare class AxiosExternalServiceResourceClient extends ExternalServiceR
|
|
|
1028
1031
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1029
1032
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1030
1033
|
}
|
|
1031
|
-
export declare class
|
|
1034
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1032
1035
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1033
1036
|
}
|
|
1034
|
-
export declare class
|
|
1037
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1035
1038
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1036
1039
|
}
|
|
1037
|
-
export declare class
|
|
1040
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1038
1041
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1039
1042
|
}
|
|
1040
|
-
export declare class
|
|
1043
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1041
1044
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1042
1045
|
}
|
|
1043
|
-
export declare class
|
|
1046
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1044
1047
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1045
1048
|
}
|
|
1046
|
-
export declare class
|
|
1049
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1047
1050
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1048
1051
|
}
|
|
1049
1052
|
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1052,34 +1055,31 @@ export declare class AxiosGatewayClientResourceClient extends GatewayClientResou
|
|
|
1052
1055
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1053
1056
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1054
1057
|
}
|
|
1055
|
-
export declare class
|
|
1056
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1057
|
-
}
|
|
1058
|
-
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1059
1059
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1060
1060
|
}
|
|
1061
|
-
export declare class
|
|
1061
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1062
1062
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1063
1063
|
}
|
|
1064
|
-
export declare class
|
|
1064
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1065
1065
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1066
1066
|
}
|
|
1067
|
-
export declare class
|
|
1067
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1068
1068
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1069
1069
|
}
|
|
1070
|
-
export declare class
|
|
1070
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1071
1071
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1072
1072
|
}
|
|
1073
|
-
export declare class
|
|
1073
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1074
1074
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1075
1075
|
}
|
|
1076
|
-
export declare class
|
|
1076
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1077
1077
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1078
1078
|
}
|
|
1079
|
-
export declare class
|
|
1079
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1080
1080
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1081
1081
|
}
|
|
1082
|
-
export declare class
|
|
1082
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1083
1083
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1084
1084
|
}
|
|
1085
1085
|
//# sourceMappingURL=restclient.d.ts.map
|