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