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