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