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