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