@openremote/rest 1.7.0-snapshot.20250630105956 → 1.7.0-snapshot.20250703135847
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 +428 -428
- 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,56 +9,58 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AlarmResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP POST /alarm
|
|
17
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
20
|
+
assetIds?: string[];
|
|
21
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
20
22
|
/**
|
|
21
|
-
* HTTP
|
|
22
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /alarm
|
|
24
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
23
25
|
*/
|
|
24
|
-
|
|
26
|
+
getAlarms(queryParams?: {
|
|
27
|
+
realm?: string;
|
|
28
|
+
status?: Model.AlarmStatus;
|
|
29
|
+
assetId?: string;
|
|
30
|
+
assigneeId?: string;
|
|
31
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
25
32
|
/**
|
|
26
|
-
* HTTP DELETE /
|
|
27
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP DELETE /alarm
|
|
34
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
28
35
|
*/
|
|
29
|
-
|
|
36
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
30
37
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
38
|
+
* HTTP PUT /alarm/assets
|
|
39
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
33
40
|
*/
|
|
34
|
-
|
|
35
|
-
level?: Model.SyslogLevel;
|
|
36
|
-
per_page?: number;
|
|
37
|
-
page?: number;
|
|
38
|
-
from?: number;
|
|
39
|
-
to?: number;
|
|
40
|
-
category?: Model.SyslogCategory[];
|
|
41
|
-
subCategory?: string[];
|
|
42
|
-
}, options?: O): RestResponse<any>;
|
|
43
|
-
}
|
|
44
|
-
export declare class FlowResourceClient<O> {
|
|
45
|
-
protected httpClient: HttpClient<O>;
|
|
46
|
-
constructor(httpClient: HttpClient<O>);
|
|
41
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
47
42
|
/**
|
|
48
|
-
* HTTP GET /
|
|
49
|
-
* Java method: org.openremote.model.
|
|
43
|
+
* HTTP GET /alarm/{alarmId}
|
|
44
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
50
45
|
*/
|
|
51
|
-
|
|
46
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
52
47
|
/**
|
|
53
|
-
* HTTP
|
|
54
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
49
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
55
50
|
*/
|
|
56
|
-
|
|
51
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
57
52
|
/**
|
|
58
|
-
* HTTP
|
|
59
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* HTTP PUT /alarm/{alarmId}
|
|
54
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
60
55
|
*/
|
|
61
|
-
|
|
56
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
57
|
+
/**
|
|
58
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
59
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
60
|
+
*/
|
|
61
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
62
|
+
realm?: string;
|
|
63
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
62
64
|
}
|
|
63
65
|
export declare class NotificationResourceClient<O> {
|
|
64
66
|
protected httpClient: HttpClient<O>;
|
|
@@ -114,181 +116,37 @@ export declare class NotificationResourceClient<O> {
|
|
|
114
116
|
targetId?: string;
|
|
115
117
|
}, options?: O): RestResponse<void>;
|
|
116
118
|
}
|
|
117
|
-
export declare class
|
|
118
|
-
protected httpClient: HttpClient<O>;
|
|
119
|
-
constructor(httpClient: HttpClient<O>);
|
|
120
|
-
/**
|
|
121
|
-
* HTTP POST /rules
|
|
122
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
123
|
-
*/
|
|
124
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
125
|
-
/**
|
|
126
|
-
* HTTP GET /rules
|
|
127
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
128
|
-
*/
|
|
129
|
-
getGlobalRulesets(queryParams?: {
|
|
130
|
-
language?: Model.RulesetLang[];
|
|
131
|
-
fullyPopulate?: boolean;
|
|
132
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
133
|
-
/**
|
|
134
|
-
* HTTP POST /rules/asset
|
|
135
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
136
|
-
*/
|
|
137
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
138
|
-
/**
|
|
139
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
140
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
141
|
-
*/
|
|
142
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
143
|
-
language?: Model.RulesetLang[];
|
|
144
|
-
fullyPopulate?: boolean;
|
|
145
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
146
|
-
/**
|
|
147
|
-
* HTTP DELETE /rules/asset/{id}
|
|
148
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
149
|
-
*/
|
|
150
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
151
|
-
/**
|
|
152
|
-
* HTTP GET /rules/asset/{id}
|
|
153
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
154
|
-
*/
|
|
155
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
156
|
-
/**
|
|
157
|
-
* HTTP PUT /rules/asset/{id}
|
|
158
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
159
|
-
*/
|
|
160
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
161
|
-
/**
|
|
162
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
163
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
164
|
-
*/
|
|
165
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
166
|
-
/**
|
|
167
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
168
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
169
|
-
*/
|
|
170
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
171
|
-
/**
|
|
172
|
-
* HTTP GET /rules/info/global
|
|
173
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
174
|
-
*/
|
|
175
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
176
|
-
/**
|
|
177
|
-
* HTTP GET /rules/info/realm/{realm}
|
|
178
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
179
|
-
*/
|
|
180
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
181
|
-
/**
|
|
182
|
-
* HTTP POST /rules/realm
|
|
183
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
184
|
-
*/
|
|
185
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
186
|
-
/**
|
|
187
|
-
* HTTP GET /rules/realm/for/{realm}
|
|
188
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
189
|
-
*/
|
|
190
|
-
getRealmRulesets(realm: string, queryParams?: {
|
|
191
|
-
language?: Model.RulesetLang[];
|
|
192
|
-
fullyPopulate?: boolean;
|
|
193
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
194
|
-
/**
|
|
195
|
-
* HTTP DELETE /rules/realm/{id}
|
|
196
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
197
|
-
*/
|
|
198
|
-
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
199
|
-
/**
|
|
200
|
-
* HTTP GET /rules/realm/{id}
|
|
201
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
202
|
-
*/
|
|
203
|
-
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
204
|
-
/**
|
|
205
|
-
* HTTP PUT /rules/realm/{id}
|
|
206
|
-
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
207
|
-
*/
|
|
208
|
-
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
209
|
-
/**
|
|
210
|
-
* HTTP DELETE /rules/{id}
|
|
211
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
212
|
-
*/
|
|
213
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
214
|
-
/**
|
|
215
|
-
* HTTP GET /rules/{id}
|
|
216
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
217
|
-
*/
|
|
218
|
-
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
219
|
-
/**
|
|
220
|
-
* HTTP PUT /rules/{id}
|
|
221
|
-
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
222
|
-
*/
|
|
223
|
-
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
224
|
-
}
|
|
225
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
226
|
-
protected httpClient: HttpClient<O>;
|
|
227
|
-
constructor(httpClient: HttpClient<O>);
|
|
228
|
-
/**
|
|
229
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
230
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
231
|
-
*/
|
|
232
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
233
|
-
/**
|
|
234
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
235
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
236
|
-
*/
|
|
237
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
238
|
-
}
|
|
239
|
-
export declare class ConsoleResourceClient<O> {
|
|
240
|
-
protected httpClient: HttpClient<O>;
|
|
241
|
-
constructor(httpClient: HttpClient<O>);
|
|
242
|
-
/**
|
|
243
|
-
* HTTP POST /console/register
|
|
244
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
245
|
-
*/
|
|
246
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
247
|
-
}
|
|
248
|
-
export declare class ConfigurationResourceClient<O> {
|
|
119
|
+
export declare class SyslogResourceClient<O> {
|
|
249
120
|
protected httpClient: HttpClient<O>;
|
|
250
121
|
constructor(httpClient: HttpClient<O>);
|
|
251
122
|
/**
|
|
252
|
-
* HTTP GET /
|
|
253
|
-
* Java method: org.openremote.model.
|
|
254
|
-
*/
|
|
255
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
256
|
-
/**
|
|
257
|
-
* HTTP PUT /configuration/manager
|
|
258
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
259
|
-
*/
|
|
260
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
261
|
-
/**
|
|
262
|
-
* HTTP POST /configuration/manager/file
|
|
263
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
264
|
-
*/
|
|
265
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
266
|
-
path?: string;
|
|
267
|
-
}, options?: O): RestResponse<string>;
|
|
268
|
-
/**
|
|
269
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
270
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
123
|
+
* HTTP GET /syslog/config
|
|
124
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
271
125
|
*/
|
|
272
|
-
|
|
273
|
-
}
|
|
274
|
-
export declare class AppResourceClient<O> {
|
|
275
|
-
protected httpClient: HttpClient<O>;
|
|
276
|
-
constructor(httpClient: HttpClient<O>);
|
|
126
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
277
127
|
/**
|
|
278
|
-
* HTTP
|
|
279
|
-
* Java method: org.openremote.model.
|
|
128
|
+
* HTTP PUT /syslog/config
|
|
129
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
280
130
|
*/
|
|
281
|
-
|
|
131
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
282
132
|
/**
|
|
283
|
-
* HTTP
|
|
284
|
-
* Java method: org.openremote.model.
|
|
133
|
+
* HTTP DELETE /syslog/event
|
|
134
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
285
135
|
*/
|
|
286
|
-
|
|
136
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
287
137
|
/**
|
|
288
|
-
* HTTP GET /
|
|
289
|
-
* Java method: org.openremote.model.
|
|
138
|
+
* HTTP GET /syslog/event
|
|
139
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
290
140
|
*/
|
|
291
|
-
|
|
141
|
+
getEvents(queryParams?: {
|
|
142
|
+
level?: Model.SyslogLevel;
|
|
143
|
+
per_page?: number;
|
|
144
|
+
page?: number;
|
|
145
|
+
from?: number;
|
|
146
|
+
to?: number;
|
|
147
|
+
category?: Model.SyslogCategory[];
|
|
148
|
+
subCategory?: string[];
|
|
149
|
+
}, options?: O): RestResponse<any>;
|
|
292
150
|
}
|
|
293
151
|
export declare class ProvisioningResourceClient<O> {
|
|
294
152
|
protected httpClient: HttpClient<O>;
|
|
@@ -348,6 +206,61 @@ export declare class RealmResourceClient<O> {
|
|
|
348
206
|
*/
|
|
349
207
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
350
208
|
}
|
|
209
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
210
|
+
protected httpClient: HttpClient<O>;
|
|
211
|
+
constructor(httpClient: HttpClient<O>);
|
|
212
|
+
/**
|
|
213
|
+
* HTTP POST /gateway/tunnel
|
|
214
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
215
|
+
*/
|
|
216
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
217
|
+
/**
|
|
218
|
+
* HTTP DELETE /gateway/tunnel
|
|
219
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
220
|
+
*/
|
|
221
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
222
|
+
/**
|
|
223
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
224
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
225
|
+
*/
|
|
226
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
227
|
+
/**
|
|
228
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
229
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
230
|
+
*/
|
|
231
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
232
|
+
/**
|
|
233
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
234
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
235
|
+
*/
|
|
236
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
237
|
+
}
|
|
238
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
239
|
+
protected httpClient: HttpClient<O>;
|
|
240
|
+
constructor(httpClient: HttpClient<O>);
|
|
241
|
+
/**
|
|
242
|
+
* HTTP GET /asset/datapoint/export
|
|
243
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
244
|
+
*/
|
|
245
|
+
getDatapointExport(queryParams?: {
|
|
246
|
+
attributeRefs?: string;
|
|
247
|
+
fromTimestamp?: number;
|
|
248
|
+
toTimestamp?: number;
|
|
249
|
+
}, options?: O): RestResponse<any>;
|
|
250
|
+
/**
|
|
251
|
+
* HTTP GET /asset/datapoint/periods
|
|
252
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
253
|
+
*/
|
|
254
|
+
getDatapointPeriod(queryParams?: {
|
|
255
|
+
assetId?: string;
|
|
256
|
+
attributeName?: string;
|
|
257
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
258
|
+
/**
|
|
259
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
260
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
261
|
+
*/
|
|
262
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
263
|
+
}
|
|
351
264
|
export declare class AssetResourceClient<O> {
|
|
352
265
|
protected httpClient: HttpClient<O>;
|
|
353
266
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -452,50 +365,31 @@ export declare class AssetResourceClient<O> {
|
|
|
452
365
|
assetIds?: string[];
|
|
453
366
|
}, options?: O): RestResponse<void>;
|
|
454
367
|
}
|
|
455
|
-
export declare class
|
|
368
|
+
export declare class AgentResourceClient<O> {
|
|
456
369
|
protected httpClient: HttpClient<O>;
|
|
457
370
|
constructor(httpClient: HttpClient<O>);
|
|
458
371
|
/**
|
|
459
|
-
* HTTP GET /
|
|
460
|
-
* Java method: org.openremote.model.asset.
|
|
461
|
-
*/
|
|
462
|
-
getAssetDescriptors(queryParams?: {
|
|
463
|
-
parentId?: string;
|
|
464
|
-
parentType?: string;
|
|
465
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
466
|
-
/**
|
|
467
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
468
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
469
|
-
*/
|
|
470
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
471
|
-
parentId?: string;
|
|
472
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
473
|
-
/**
|
|
474
|
-
* HTTP GET /model/assetInfos
|
|
475
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
372
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
373
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
476
374
|
*/
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
375
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
376
|
+
realm?: string;
|
|
377
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
481
378
|
/**
|
|
482
|
-
* HTTP
|
|
483
|
-
* Java method: org.openremote.model.asset.
|
|
379
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
380
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
484
381
|
*/
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
}, options?: O): RestResponse<
|
|
488
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
489
|
-
}>;
|
|
382
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
383
|
+
realm?: string;
|
|
384
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
490
385
|
/**
|
|
491
|
-
* HTTP GET /
|
|
492
|
-
* Java method: org.openremote.model.asset.
|
|
386
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
387
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
493
388
|
*/
|
|
494
|
-
|
|
389
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
495
390
|
parentId?: string;
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
}>;
|
|
391
|
+
realm?: string;
|
|
392
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
499
393
|
}
|
|
500
394
|
export declare class MapResourceClient<O> {
|
|
501
395
|
protected httpClient: HttpClient<O>;
|
|
@@ -550,112 +444,90 @@ export declare class MapResourceClient<O> {
|
|
|
550
444
|
[id: string]: unknown;
|
|
551
445
|
}>;
|
|
552
446
|
}
|
|
553
|
-
export declare class
|
|
554
|
-
protected httpClient: HttpClient<O>;
|
|
555
|
-
constructor(httpClient: HttpClient<O>);
|
|
556
|
-
/**
|
|
557
|
-
* HTTP POST /gateway/tunnel
|
|
558
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
559
|
-
*/
|
|
560
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
561
|
-
/**
|
|
562
|
-
* HTTP DELETE /gateway/tunnel
|
|
563
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
564
|
-
*/
|
|
565
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
566
|
-
/**
|
|
567
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
568
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
569
|
-
*/
|
|
570
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
571
|
-
/**
|
|
572
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
573
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
574
|
-
*/
|
|
575
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
576
|
-
/**
|
|
577
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
578
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
579
|
-
*/
|
|
580
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
581
|
-
}
|
|
582
|
-
export declare class AgentResourceClient<O> {
|
|
447
|
+
export declare class AssetModelResourceClient<O> {
|
|
583
448
|
protected httpClient: HttpClient<O>;
|
|
584
449
|
constructor(httpClient: HttpClient<O>);
|
|
585
450
|
/**
|
|
586
|
-
* HTTP GET /
|
|
587
|
-
* Java method: org.openremote.model.asset.
|
|
451
|
+
* HTTP GET /model/assetDescriptors
|
|
452
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
588
453
|
*/
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
454
|
+
getAssetDescriptors(queryParams?: {
|
|
455
|
+
parentId?: string;
|
|
456
|
+
parentType?: string;
|
|
457
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
592
458
|
/**
|
|
593
|
-
* HTTP
|
|
594
|
-
* Java method: org.openremote.model.asset.
|
|
459
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
460
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
595
461
|
*/
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
}, options?: O): RestResponse<Model.
|
|
462
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
463
|
+
parentId?: string;
|
|
464
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
599
465
|
/**
|
|
600
|
-
* HTTP GET /
|
|
601
|
-
* Java method: org.openremote.model.asset.
|
|
466
|
+
* HTTP GET /model/assetInfos
|
|
467
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
602
468
|
*/
|
|
603
|
-
|
|
469
|
+
getAssetInfos(queryParams?: {
|
|
604
470
|
parentId?: string;
|
|
605
|
-
|
|
606
|
-
}, options?: O): RestResponse<Model.
|
|
607
|
-
}
|
|
608
|
-
export declare class StatusResourceClient<O> {
|
|
609
|
-
protected httpClient: HttpClient<O>;
|
|
610
|
-
constructor(httpClient: HttpClient<O>);
|
|
471
|
+
parentType?: string;
|
|
472
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
611
473
|
/**
|
|
612
|
-
* HTTP GET /
|
|
613
|
-
* Java method: org.openremote.model.
|
|
474
|
+
* HTTP GET /model/metaItemDescriptors
|
|
475
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
614
476
|
*/
|
|
615
|
-
|
|
616
|
-
|
|
477
|
+
getMetaItemDescriptors(queryParams?: {
|
|
478
|
+
parentId?: string;
|
|
479
|
+
}, options?: O): RestResponse<{
|
|
480
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
617
481
|
}>;
|
|
618
482
|
/**
|
|
619
|
-
* HTTP GET /
|
|
620
|
-
* Java method: org.openremote.model.
|
|
483
|
+
* HTTP GET /model/valueDescriptors
|
|
484
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
621
485
|
*/
|
|
622
|
-
|
|
623
|
-
|
|
486
|
+
getValueDescriptors(queryParams?: {
|
|
487
|
+
parentId?: string;
|
|
488
|
+
}, options?: O): RestResponse<{
|
|
489
|
+
[index: string]: Model.ValueDescriptor;
|
|
624
490
|
}>;
|
|
625
491
|
}
|
|
626
|
-
export declare class
|
|
492
|
+
export declare class ConfigurationResourceClient<O> {
|
|
627
493
|
protected httpClient: HttpClient<O>;
|
|
628
494
|
constructor(httpClient: HttpClient<O>);
|
|
629
495
|
/**
|
|
630
|
-
* HTTP
|
|
631
|
-
* Java method: org.openremote.model.
|
|
496
|
+
* HTTP GET /configuration/manager
|
|
497
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
632
498
|
*/
|
|
633
|
-
|
|
499
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
634
500
|
/**
|
|
635
|
-
* HTTP PUT /
|
|
636
|
-
* Java method: org.openremote.model.
|
|
501
|
+
* HTTP PUT /configuration/manager
|
|
502
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
637
503
|
*/
|
|
638
|
-
update(
|
|
504
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
639
505
|
/**
|
|
640
|
-
* HTTP
|
|
641
|
-
* Java method: org.openremote.model.
|
|
506
|
+
* HTTP POST /configuration/manager/file
|
|
507
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
642
508
|
*/
|
|
643
|
-
|
|
509
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
510
|
+
path?: string;
|
|
511
|
+
}, options?: O): RestResponse<string>;
|
|
644
512
|
/**
|
|
645
|
-
* HTTP
|
|
646
|
-
* Java method: org.openremote.model.
|
|
513
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
514
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
647
515
|
*/
|
|
648
|
-
|
|
516
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
517
|
+
}
|
|
518
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
519
|
+
protected httpClient: HttpClient<O>;
|
|
520
|
+
constructor(httpClient: HttpClient<O>);
|
|
649
521
|
/**
|
|
650
|
-
* HTTP
|
|
651
|
-
* Java method: org.openremote.model.
|
|
522
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
523
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
652
524
|
*/
|
|
653
|
-
|
|
525
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
654
526
|
/**
|
|
655
|
-
* HTTP
|
|
656
|
-
* Java method: org.openremote.model.
|
|
527
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
528
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
657
529
|
*/
|
|
658
|
-
|
|
530
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
659
531
|
}
|
|
660
532
|
export declare class UserResourceClient<O> {
|
|
661
533
|
protected httpClient: HttpClient<O>;
|
|
@@ -761,166 +633,294 @@ export declare class UserResourceClient<O> {
|
|
|
761
633
|
*/
|
|
762
634
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
763
635
|
}
|
|
764
|
-
export declare class
|
|
636
|
+
export declare class RulesResourceClient<O> {
|
|
765
637
|
protected httpClient: HttpClient<O>;
|
|
766
638
|
constructor(httpClient: HttpClient<O>);
|
|
767
639
|
/**
|
|
768
|
-
* HTTP
|
|
769
|
-
* Java method: org.openremote.model.
|
|
640
|
+
* HTTP POST /rules
|
|
641
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
770
642
|
*/
|
|
771
|
-
|
|
772
|
-
realm?: string[];
|
|
773
|
-
}, options?: O): RestResponse<void>;
|
|
643
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
774
644
|
/**
|
|
775
|
-
* HTTP GET /
|
|
776
|
-
* Java method: org.openremote.model.
|
|
645
|
+
* HTTP GET /rules
|
|
646
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
777
647
|
*/
|
|
778
|
-
|
|
648
|
+
getGlobalRulesets(queryParams?: {
|
|
649
|
+
language?: Model.RulesetLang[];
|
|
650
|
+
fullyPopulate?: boolean;
|
|
651
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
779
652
|
/**
|
|
780
|
-
* HTTP
|
|
781
|
-
* Java method: org.openremote.model.
|
|
653
|
+
* HTTP POST /rules/asset
|
|
654
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
782
655
|
*/
|
|
783
|
-
|
|
656
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
784
657
|
/**
|
|
785
|
-
* HTTP GET /
|
|
786
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
659
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
787
660
|
*/
|
|
788
|
-
|
|
661
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
662
|
+
language?: Model.RulesetLang[];
|
|
663
|
+
fullyPopulate?: boolean;
|
|
664
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
789
665
|
/**
|
|
790
|
-
* HTTP
|
|
791
|
-
* Java method: org.openremote.model.
|
|
666
|
+
* HTTP DELETE /rules/asset/{id}
|
|
667
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
792
668
|
*/
|
|
793
|
-
|
|
669
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
794
670
|
/**
|
|
795
|
-
* HTTP GET /
|
|
796
|
-
* Java method: org.openremote.model.
|
|
671
|
+
* HTTP GET /rules/asset/{id}
|
|
672
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
797
673
|
*/
|
|
798
|
-
|
|
674
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
675
|
+
/**
|
|
676
|
+
* HTTP PUT /rules/asset/{id}
|
|
677
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
678
|
+
*/
|
|
679
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
680
|
+
/**
|
|
681
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
682
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
683
|
+
*/
|
|
684
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
685
|
+
/**
|
|
686
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
687
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
688
|
+
*/
|
|
689
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
690
|
+
/**
|
|
691
|
+
* HTTP GET /rules/info/global
|
|
692
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
693
|
+
*/
|
|
694
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
695
|
+
/**
|
|
696
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
697
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
698
|
+
*/
|
|
699
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
700
|
+
/**
|
|
701
|
+
* HTTP POST /rules/realm
|
|
702
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
703
|
+
*/
|
|
704
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
705
|
+
/**
|
|
706
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
707
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
708
|
+
*/
|
|
709
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
710
|
+
language?: Model.RulesetLang[];
|
|
711
|
+
fullyPopulate?: boolean;
|
|
712
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
713
|
+
/**
|
|
714
|
+
* HTTP DELETE /rules/realm/{id}
|
|
715
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
716
|
+
*/
|
|
717
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
718
|
+
/**
|
|
719
|
+
* HTTP GET /rules/realm/{id}
|
|
720
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
721
|
+
*/
|
|
722
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
723
|
+
/**
|
|
724
|
+
* HTTP PUT /rules/realm/{id}
|
|
725
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
726
|
+
*/
|
|
727
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
728
|
+
/**
|
|
729
|
+
* HTTP DELETE /rules/{id}
|
|
730
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
731
|
+
*/
|
|
732
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
733
|
+
/**
|
|
734
|
+
* HTTP GET /rules/{id}
|
|
735
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
736
|
+
*/
|
|
737
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
738
|
+
/**
|
|
739
|
+
* HTTP PUT /rules/{id}
|
|
740
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
741
|
+
*/
|
|
742
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
799
743
|
}
|
|
800
|
-
export declare class
|
|
744
|
+
export declare class StatusResourceClient<O> {
|
|
801
745
|
protected httpClient: HttpClient<O>;
|
|
802
746
|
constructor(httpClient: HttpClient<O>);
|
|
803
747
|
/**
|
|
804
|
-
* HTTP GET /
|
|
805
|
-
* Java method: org.openremote.model.
|
|
748
|
+
* HTTP GET /health
|
|
749
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
806
750
|
*/
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
toTimestamp?: number;
|
|
811
|
-
}, options?: O): RestResponse<any>;
|
|
751
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
752
|
+
[index: string]: any;
|
|
753
|
+
}>;
|
|
812
754
|
/**
|
|
813
|
-
* HTTP GET /
|
|
814
|
-
* Java method: org.openremote.model.
|
|
755
|
+
* HTTP GET /info
|
|
756
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
815
757
|
*/
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
758
|
+
getInfo(options?: O): RestResponse<{
|
|
759
|
+
[index: string]: any;
|
|
760
|
+
}>;
|
|
761
|
+
}
|
|
762
|
+
export declare class ConsoleResourceClient<O> {
|
|
763
|
+
protected httpClient: HttpClient<O>;
|
|
764
|
+
constructor(httpClient: HttpClient<O>);
|
|
820
765
|
/**
|
|
821
|
-
* HTTP POST /
|
|
822
|
-
* Java method: org.openremote.model.
|
|
766
|
+
* HTTP POST /console/register
|
|
767
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
823
768
|
*/
|
|
824
|
-
|
|
769
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
825
770
|
}
|
|
826
|
-
export declare class
|
|
771
|
+
export declare class FlowResourceClient<O> {
|
|
827
772
|
protected httpClient: HttpClient<O>;
|
|
828
773
|
constructor(httpClient: HttpClient<O>);
|
|
829
774
|
/**
|
|
830
|
-
* HTTP
|
|
831
|
-
* Java method: org.openremote.model.
|
|
775
|
+
* HTTP GET /flow
|
|
776
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
832
777
|
*/
|
|
833
|
-
|
|
834
|
-
assetIds?: string[];
|
|
835
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
778
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
836
779
|
/**
|
|
837
|
-
* HTTP GET /
|
|
838
|
-
* Java method: org.openremote.model.
|
|
780
|
+
* HTTP GET /flow/{name}
|
|
781
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
839
782
|
*/
|
|
840
|
-
|
|
841
|
-
realm?: string;
|
|
842
|
-
status?: Model.AlarmStatus;
|
|
843
|
-
assetId?: string;
|
|
844
|
-
assigneeId?: string;
|
|
845
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
783
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
846
784
|
/**
|
|
847
|
-
* HTTP
|
|
848
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* HTTP GET /flow/{type}
|
|
786
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
849
787
|
*/
|
|
850
|
-
|
|
788
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
789
|
+
}
|
|
790
|
+
export declare class DashboardResourceClient<O> {
|
|
791
|
+
protected httpClient: HttpClient<O>;
|
|
792
|
+
constructor(httpClient: HttpClient<O>);
|
|
851
793
|
/**
|
|
852
|
-
* HTTP
|
|
853
|
-
* Java method: org.openremote.model.
|
|
794
|
+
* HTTP POST /dashboard
|
|
795
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
854
796
|
*/
|
|
855
|
-
|
|
797
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
856
798
|
/**
|
|
857
|
-
* HTTP
|
|
858
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP PUT /dashboard
|
|
800
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
859
801
|
*/
|
|
860
|
-
|
|
802
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
861
803
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
804
|
+
* HTTP GET /dashboard/all/{realm}
|
|
805
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
864
806
|
*/
|
|
865
|
-
|
|
807
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
866
808
|
/**
|
|
867
|
-
* HTTP
|
|
868
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP POST /dashboard/query
|
|
810
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
869
811
|
*/
|
|
870
|
-
|
|
812
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
871
813
|
/**
|
|
872
|
-
* HTTP
|
|
873
|
-
* Java method: org.openremote.model.
|
|
814
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
815
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
874
816
|
*/
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
817
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
820
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
821
|
+
*/
|
|
822
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
823
|
+
}
|
|
824
|
+
export declare class AppResourceClient<O> {
|
|
825
|
+
protected httpClient: HttpClient<O>;
|
|
826
|
+
constructor(httpClient: HttpClient<O>);
|
|
827
|
+
/**
|
|
828
|
+
* HTTP GET /apps
|
|
829
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
830
|
+
*/
|
|
831
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
832
|
+
/**
|
|
833
|
+
* HTTP GET /apps/consoleConfig
|
|
834
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
835
|
+
*/
|
|
836
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
837
|
+
/**
|
|
838
|
+
* HTTP GET /apps/info
|
|
839
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
840
|
+
*/
|
|
841
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
842
|
+
}
|
|
843
|
+
export declare class GatewayClientResourceClient<O> {
|
|
844
|
+
protected httpClient: HttpClient<O>;
|
|
845
|
+
constructor(httpClient: HttpClient<O>);
|
|
846
|
+
/**
|
|
847
|
+
* HTTP DELETE /gateway/connection
|
|
848
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
849
|
+
*/
|
|
850
|
+
deleteConnections(queryParams?: {
|
|
851
|
+
realm?: string[];
|
|
852
|
+
}, options?: O): RestResponse<void>;
|
|
853
|
+
/**
|
|
854
|
+
* HTTP GET /gateway/connection
|
|
855
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
856
|
+
*/
|
|
857
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
858
|
+
/**
|
|
859
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
860
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
861
|
+
*/
|
|
862
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
863
|
+
/**
|
|
864
|
+
* HTTP GET /gateway/connection/{realm}
|
|
865
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
866
|
+
*/
|
|
867
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
868
|
+
/**
|
|
869
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
870
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
871
|
+
*/
|
|
872
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
873
|
+
/**
|
|
874
|
+
* HTTP GET /gateway/status/{realm}
|
|
875
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
876
|
+
*/
|
|
877
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
878
878
|
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected
|
|
882
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
881
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
883
882
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
884
|
-
protected
|
|
885
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
886
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
887
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
888
|
-
protected _appResource: AxiosAppResourceClient;
|
|
883
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
889
884
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
890
885
|
protected _realmResource: AxiosRealmResourceClient;
|
|
891
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
892
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
893
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
894
886
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
887
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
888
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
895
889
|
protected _agentResource: AxiosAgentResourceClient;
|
|
890
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
891
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
892
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
893
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
894
|
+
protected _userResource: AxiosUserResourceClient;
|
|
895
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
896
896
|
protected _statusResource: AxiosStatusResourceClient;
|
|
897
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
898
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
897
899
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
898
|
-
protected
|
|
900
|
+
protected _appResource: AxiosAppResourceClient;
|
|
899
901
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
900
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
901
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get
|
|
904
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
903
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
905
904
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
906
|
-
get
|
|
907
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
908
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
909
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
910
|
-
get AppResource(): AxiosAppResourceClient;
|
|
905
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
911
906
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
912
907
|
get RealmResource(): AxiosRealmResourceClient;
|
|
913
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
914
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
915
|
-
get MapResource(): AxiosMapResourceClient;
|
|
916
908
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
909
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
910
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
917
911
|
get AgentResource(): AxiosAgentResourceClient;
|
|
912
|
+
get MapResource(): AxiosMapResourceClient;
|
|
913
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
914
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
915
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
916
|
+
get UserResource(): AxiosUserResourceClient;
|
|
917
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
918
918
|
get StatusResource(): AxiosStatusResourceClient;
|
|
919
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
920
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
919
921
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
920
|
-
get
|
|
922
|
+
get AppResource(): AxiosAppResourceClient;
|
|
921
923
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
922
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
923
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
932
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
|
-
}
|
|
934
|
-
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
931
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
935
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
933
|
}
|
|
937
934
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
941
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
939
|
}
|
|
943
|
-
export declare class
|
|
940
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
|
-
export declare class
|
|
943
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
|
-
export declare class
|
|
946
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
|
-
export declare class
|
|
949
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
|
-
export declare class
|
|
952
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
956
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
954
|
}
|
|
958
|
-
export declare class
|
|
955
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
959
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
957
|
}
|
|
961
|
-
export declare class
|
|
958
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
962
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
960
|
}
|
|
964
961
|
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
965
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
963
|
}
|
|
967
|
-
export declare class
|
|
964
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
|
-
export declare class
|
|
970
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
971
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
|
+
}
|
|
973
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
976
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<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 AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|
|
991
|
-
export declare class
|
|
991
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|