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