@openremote/rest 1.8.0-snapshot.20250820125434 → 1.9.0-snapshot.20250825142142
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 +471 -471
- 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,24 +9,166 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class RulesResourceClient<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 /rules
|
|
17
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP GET /
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /rules
|
|
22
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
getGlobalRulesets(queryParams?: {
|
|
25
|
+
language?: Model.RulesetLang[];
|
|
26
|
+
fullyPopulate?: boolean;
|
|
27
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
25
28
|
/**
|
|
26
|
-
* HTTP
|
|
27
|
-
* Java method: org.openremote.model.
|
|
29
|
+
* HTTP POST /rules/asset
|
|
30
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
28
31
|
*/
|
|
29
|
-
|
|
32
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
33
|
+
/**
|
|
34
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
35
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
36
|
+
*/
|
|
37
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
38
|
+
language?: Model.RulesetLang[];
|
|
39
|
+
fullyPopulate?: boolean;
|
|
40
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
41
|
+
/**
|
|
42
|
+
* HTTP DELETE /rules/asset/{id}
|
|
43
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
44
|
+
*/
|
|
45
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
46
|
+
/**
|
|
47
|
+
* HTTP GET /rules/asset/{id}
|
|
48
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
49
|
+
*/
|
|
50
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
51
|
+
/**
|
|
52
|
+
* HTTP PUT /rules/asset/{id}
|
|
53
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
54
|
+
*/
|
|
55
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
56
|
+
/**
|
|
57
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
58
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
59
|
+
*/
|
|
60
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
61
|
+
/**
|
|
62
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
63
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
64
|
+
*/
|
|
65
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
66
|
+
/**
|
|
67
|
+
* HTTP GET /rules/info/global
|
|
68
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
69
|
+
*/
|
|
70
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
71
|
+
/**
|
|
72
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
73
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
74
|
+
*/
|
|
75
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
76
|
+
/**
|
|
77
|
+
* HTTP POST /rules/realm
|
|
78
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
79
|
+
*/
|
|
80
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
81
|
+
/**
|
|
82
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
83
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
84
|
+
*/
|
|
85
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
86
|
+
language?: Model.RulesetLang[];
|
|
87
|
+
fullyPopulate?: boolean;
|
|
88
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
89
|
+
/**
|
|
90
|
+
* HTTP DELETE /rules/realm/{id}
|
|
91
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
92
|
+
*/
|
|
93
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
94
|
+
/**
|
|
95
|
+
* HTTP GET /rules/realm/{id}
|
|
96
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
97
|
+
*/
|
|
98
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
99
|
+
/**
|
|
100
|
+
* HTTP PUT /rules/realm/{id}
|
|
101
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
102
|
+
*/
|
|
103
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
104
|
+
/**
|
|
105
|
+
* HTTP DELETE /rules/{id}
|
|
106
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
107
|
+
*/
|
|
108
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
109
|
+
/**
|
|
110
|
+
* HTTP GET /rules/{id}
|
|
111
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
112
|
+
*/
|
|
113
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
114
|
+
/**
|
|
115
|
+
* HTTP PUT /rules/{id}
|
|
116
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
117
|
+
*/
|
|
118
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
119
|
+
}
|
|
120
|
+
export declare class AlarmResourceClient<O> {
|
|
121
|
+
protected httpClient: HttpClient<O>;
|
|
122
|
+
constructor(httpClient: HttpClient<O>);
|
|
123
|
+
/**
|
|
124
|
+
* HTTP POST /alarm
|
|
125
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
126
|
+
*/
|
|
127
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
128
|
+
assetIds?: string[];
|
|
129
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
130
|
+
/**
|
|
131
|
+
* HTTP GET /alarm
|
|
132
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
133
|
+
*/
|
|
134
|
+
getAlarms(queryParams?: {
|
|
135
|
+
realm?: string;
|
|
136
|
+
status?: Model.AlarmStatus;
|
|
137
|
+
assetId?: string;
|
|
138
|
+
assigneeId?: string;
|
|
139
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
140
|
+
/**
|
|
141
|
+
* HTTP DELETE /alarm
|
|
142
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
143
|
+
*/
|
|
144
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
145
|
+
/**
|
|
146
|
+
* HTTP PUT /alarm/assets
|
|
147
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
148
|
+
*/
|
|
149
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
150
|
+
/**
|
|
151
|
+
* HTTP GET /alarm/{alarmId}
|
|
152
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
153
|
+
*/
|
|
154
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
155
|
+
/**
|
|
156
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
157
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
158
|
+
*/
|
|
159
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
160
|
+
/**
|
|
161
|
+
* HTTP PUT /alarm/{alarmId}
|
|
162
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
163
|
+
*/
|
|
164
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
165
|
+
/**
|
|
166
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
167
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
168
|
+
*/
|
|
169
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
170
|
+
realm?: string;
|
|
171
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
30
172
|
}
|
|
31
173
|
export declare class UserResourceClient<O> {
|
|
32
174
|
protected httpClient: HttpClient<O>;
|
|
@@ -152,68 +294,58 @@ export declare class UserResourceClient<O> {
|
|
|
152
294
|
*/
|
|
153
295
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
154
296
|
}
|
|
155
|
-
export declare class
|
|
297
|
+
export declare class DashboardResourceClient<O> {
|
|
156
298
|
protected httpClient: HttpClient<O>;
|
|
157
299
|
constructor(httpClient: HttpClient<O>);
|
|
158
300
|
/**
|
|
159
|
-
* HTTP POST /
|
|
160
|
-
* Java method: org.openremote.model.
|
|
301
|
+
* HTTP POST /dashboard
|
|
302
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
161
303
|
*/
|
|
162
|
-
|
|
304
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
163
305
|
/**
|
|
164
|
-
* HTTP
|
|
165
|
-
* Java method: org.openremote.model.
|
|
306
|
+
* HTTP PUT /dashboard
|
|
307
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
166
308
|
*/
|
|
167
|
-
|
|
309
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
168
310
|
/**
|
|
169
|
-
* HTTP GET /
|
|
170
|
-
* Java method: org.openremote.model.
|
|
311
|
+
* HTTP GET /dashboard/all/{realm}
|
|
312
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
171
313
|
*/
|
|
172
|
-
|
|
314
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
173
315
|
/**
|
|
174
|
-
* HTTP
|
|
175
|
-
* Java method: org.openremote.model.
|
|
316
|
+
* HTTP POST /dashboard/query
|
|
317
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
176
318
|
*/
|
|
177
|
-
|
|
319
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
178
320
|
/**
|
|
179
|
-
* HTTP
|
|
180
|
-
* Java method: org.openremote.model.
|
|
321
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
322
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
181
323
|
*/
|
|
182
|
-
|
|
324
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
325
|
+
/**
|
|
326
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
327
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
328
|
+
*/
|
|
329
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
183
330
|
}
|
|
184
|
-
export declare class
|
|
331
|
+
export declare class FlowResourceClient<O> {
|
|
185
332
|
protected httpClient: HttpClient<O>;
|
|
186
333
|
constructor(httpClient: HttpClient<O>);
|
|
187
334
|
/**
|
|
188
|
-
* HTTP
|
|
189
|
-
* Java method: org.openremote.model.
|
|
190
|
-
*/
|
|
191
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
192
|
-
/**
|
|
193
|
-
* HTTP GET /realm
|
|
194
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
195
|
-
*/
|
|
196
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
197
|
-
/**
|
|
198
|
-
* HTTP GET /realm/accessible
|
|
199
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
200
|
-
*/
|
|
201
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
202
|
-
/**
|
|
203
|
-
* HTTP DELETE /realm/{name}
|
|
204
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
335
|
+
* HTTP GET /flow
|
|
336
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
205
337
|
*/
|
|
206
|
-
|
|
338
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
207
339
|
/**
|
|
208
|
-
* HTTP GET /
|
|
209
|
-
* Java method: org.openremote.model.
|
|
340
|
+
* HTTP GET /flow/{name}
|
|
341
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
210
342
|
*/
|
|
211
|
-
|
|
343
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
212
344
|
/**
|
|
213
|
-
* HTTP
|
|
214
|
-
* Java method: org.openremote.model.
|
|
345
|
+
* HTTP GET /flow/{type}
|
|
346
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
215
347
|
*/
|
|
216
|
-
|
|
348
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
217
349
|
}
|
|
218
350
|
export declare class NotificationResourceClient<O> {
|
|
219
351
|
protected httpClient: HttpClient<O>;
|
|
@@ -269,31 +401,55 @@ export declare class NotificationResourceClient<O> {
|
|
|
269
401
|
targetId?: string;
|
|
270
402
|
}, options?: O): RestResponse<void>;
|
|
271
403
|
}
|
|
272
|
-
export declare class
|
|
404
|
+
export declare class ConfigurationResourceClient<O> {
|
|
273
405
|
protected httpClient: HttpClient<O>;
|
|
274
406
|
constructor(httpClient: HttpClient<O>);
|
|
275
407
|
/**
|
|
276
|
-
* HTTP GET /
|
|
277
|
-
* Java method: org.openremote.model.
|
|
408
|
+
* HTTP GET /configuration/manager
|
|
409
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
278
410
|
*/
|
|
279
|
-
|
|
280
|
-
attributeRefs?: string;
|
|
281
|
-
fromTimestamp?: number;
|
|
282
|
-
toTimestamp?: number;
|
|
283
|
-
}, options?: O): RestResponse<any>;
|
|
411
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
284
412
|
/**
|
|
285
|
-
* HTTP
|
|
286
|
-
* Java method: org.openremote.model.
|
|
413
|
+
* HTTP PUT /configuration/manager
|
|
414
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
287
415
|
*/
|
|
288
|
-
|
|
289
|
-
assetId?: string;
|
|
290
|
-
attributeName?: string;
|
|
291
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
416
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
292
417
|
/**
|
|
293
|
-
* HTTP POST /
|
|
294
|
-
* Java method: org.openremote.model.
|
|
418
|
+
* HTTP POST /configuration/manager/file
|
|
419
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
295
420
|
*/
|
|
296
|
-
|
|
421
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
422
|
+
path?: string;
|
|
423
|
+
}, options?: O): RestResponse<string>;
|
|
424
|
+
/**
|
|
425
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
426
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
427
|
+
*/
|
|
428
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
429
|
+
}
|
|
430
|
+
export declare class ProvisioningResourceClient<O> {
|
|
431
|
+
protected httpClient: HttpClient<O>;
|
|
432
|
+
constructor(httpClient: HttpClient<O>);
|
|
433
|
+
/**
|
|
434
|
+
* HTTP POST /provisioning
|
|
435
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
436
|
+
*/
|
|
437
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
438
|
+
/**
|
|
439
|
+
* HTTP GET /provisioning
|
|
440
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
441
|
+
*/
|
|
442
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
443
|
+
/**
|
|
444
|
+
* HTTP DELETE /provisioning/{id}
|
|
445
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
446
|
+
*/
|
|
447
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
448
|
+
/**
|
|
449
|
+
* HTTP PUT /provisioning/{id}
|
|
450
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
451
|
+
*/
|
|
452
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
297
453
|
}
|
|
298
454
|
export declare class MapResourceClient<O> {
|
|
299
455
|
protected httpClient: HttpClient<O>;
|
|
@@ -348,6 +504,116 @@ export declare class MapResourceClient<O> {
|
|
|
348
504
|
[id: string]: unknown;
|
|
349
505
|
}>;
|
|
350
506
|
}
|
|
507
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
508
|
+
protected httpClient: HttpClient<O>;
|
|
509
|
+
constructor(httpClient: HttpClient<O>);
|
|
510
|
+
/**
|
|
511
|
+
* HTTP POST /gateway/tunnel
|
|
512
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
513
|
+
*/
|
|
514
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
515
|
+
/**
|
|
516
|
+
* HTTP DELETE /gateway/tunnel
|
|
517
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
518
|
+
*/
|
|
519
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
520
|
+
/**
|
|
521
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
522
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
523
|
+
*/
|
|
524
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
525
|
+
/**
|
|
526
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
527
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
528
|
+
*/
|
|
529
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
530
|
+
/**
|
|
531
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
532
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
533
|
+
*/
|
|
534
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
535
|
+
}
|
|
536
|
+
export declare class AssetModelResourceClient<O> {
|
|
537
|
+
protected httpClient: HttpClient<O>;
|
|
538
|
+
constructor(httpClient: HttpClient<O>);
|
|
539
|
+
/**
|
|
540
|
+
* HTTP GET /model/assetDescriptors
|
|
541
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
542
|
+
*/
|
|
543
|
+
getAssetDescriptors(queryParams?: {
|
|
544
|
+
parentId?: string;
|
|
545
|
+
parentType?: string;
|
|
546
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
547
|
+
/**
|
|
548
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
549
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
550
|
+
*/
|
|
551
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
552
|
+
parentId?: string;
|
|
553
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
554
|
+
/**
|
|
555
|
+
* HTTP GET /model/assetInfos
|
|
556
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
557
|
+
*/
|
|
558
|
+
getAssetInfos(queryParams?: {
|
|
559
|
+
parentId?: string;
|
|
560
|
+
parentType?: string;
|
|
561
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
562
|
+
/**
|
|
563
|
+
* HTTP GET /model/metaItemDescriptors
|
|
564
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
565
|
+
*/
|
|
566
|
+
getMetaItemDescriptors(queryParams?: {
|
|
567
|
+
parentId?: string;
|
|
568
|
+
}, options?: O): RestResponse<{
|
|
569
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
570
|
+
}>;
|
|
571
|
+
/**
|
|
572
|
+
* HTTP GET /model/valueDescriptors
|
|
573
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
574
|
+
*/
|
|
575
|
+
getValueDescriptors(queryParams?: {
|
|
576
|
+
parentId?: string;
|
|
577
|
+
}, options?: O): RestResponse<{
|
|
578
|
+
[index: string]: Model.ValueDescriptor;
|
|
579
|
+
}>;
|
|
580
|
+
}
|
|
581
|
+
export declare class GatewayClientResourceClient<O> {
|
|
582
|
+
protected httpClient: HttpClient<O>;
|
|
583
|
+
constructor(httpClient: HttpClient<O>);
|
|
584
|
+
/**
|
|
585
|
+
* HTTP DELETE /gateway/connection
|
|
586
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
587
|
+
*/
|
|
588
|
+
deleteConnections(queryParams?: {
|
|
589
|
+
realm?: string[];
|
|
590
|
+
}, options?: O): RestResponse<void>;
|
|
591
|
+
/**
|
|
592
|
+
* HTTP GET /gateway/connection
|
|
593
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
594
|
+
*/
|
|
595
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
596
|
+
/**
|
|
597
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
598
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
599
|
+
*/
|
|
600
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
601
|
+
/**
|
|
602
|
+
* HTTP GET /gateway/connection/{realm}
|
|
603
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
604
|
+
*/
|
|
605
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
606
|
+
/**
|
|
607
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
608
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
609
|
+
*/
|
|
610
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
611
|
+
/**
|
|
612
|
+
* HTTP GET /gateway/status/{realm}
|
|
613
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
614
|
+
*/
|
|
615
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
616
|
+
}
|
|
351
617
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
352
618
|
protected httpClient: HttpClient<O>;
|
|
353
619
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -388,24 +654,85 @@ export declare class AgentResourceClient<O> {
|
|
|
388
654
|
realm?: string;
|
|
389
655
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
390
656
|
}
|
|
391
|
-
export declare class
|
|
657
|
+
export declare class ConsoleResourceClient<O> {
|
|
392
658
|
protected httpClient: HttpClient<O>;
|
|
393
659
|
constructor(httpClient: HttpClient<O>);
|
|
394
660
|
/**
|
|
395
|
-
* HTTP
|
|
396
|
-
* Java method: org.openremote.model.
|
|
661
|
+
* HTTP POST /console/register
|
|
662
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
397
663
|
*/
|
|
398
|
-
|
|
664
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
665
|
+
}
|
|
666
|
+
export declare class AppResourceClient<O> {
|
|
667
|
+
protected httpClient: HttpClient<O>;
|
|
668
|
+
constructor(httpClient: HttpClient<O>);
|
|
399
669
|
/**
|
|
400
|
-
* HTTP GET /
|
|
401
|
-
* Java method: org.openremote.model.
|
|
670
|
+
* HTTP GET /apps
|
|
671
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
402
672
|
*/
|
|
403
|
-
|
|
673
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
404
674
|
/**
|
|
405
|
-
* HTTP GET /
|
|
406
|
-
* Java method: org.openremote.model.
|
|
675
|
+
* HTTP GET /apps/consoleConfig
|
|
676
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
407
677
|
*/
|
|
408
|
-
|
|
678
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
679
|
+
/**
|
|
680
|
+
* HTTP GET /apps/info
|
|
681
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
682
|
+
*/
|
|
683
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
684
|
+
}
|
|
685
|
+
export declare class RealmResourceClient<O> {
|
|
686
|
+
protected httpClient: HttpClient<O>;
|
|
687
|
+
constructor(httpClient: HttpClient<O>);
|
|
688
|
+
/**
|
|
689
|
+
* HTTP POST /realm
|
|
690
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
691
|
+
*/
|
|
692
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
693
|
+
/**
|
|
694
|
+
* HTTP GET /realm
|
|
695
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
696
|
+
*/
|
|
697
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
698
|
+
/**
|
|
699
|
+
* HTTP GET /realm/accessible
|
|
700
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
701
|
+
*/
|
|
702
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
703
|
+
/**
|
|
704
|
+
* HTTP DELETE /realm/{name}
|
|
705
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
706
|
+
*/
|
|
707
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
708
|
+
/**
|
|
709
|
+
* HTTP GET /realm/{name}
|
|
710
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
711
|
+
*/
|
|
712
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
713
|
+
/**
|
|
714
|
+
* HTTP PUT /realm/{name}
|
|
715
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
716
|
+
*/
|
|
717
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
718
|
+
}
|
|
719
|
+
export declare class StatusResourceClient<O> {
|
|
720
|
+
protected httpClient: HttpClient<O>;
|
|
721
|
+
constructor(httpClient: HttpClient<O>);
|
|
722
|
+
/**
|
|
723
|
+
* HTTP GET /health
|
|
724
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
725
|
+
*/
|
|
726
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
727
|
+
[index: string]: any;
|
|
728
|
+
}>;
|
|
729
|
+
/**
|
|
730
|
+
* HTTP GET /info
|
|
731
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
732
|
+
*/
|
|
733
|
+
getInfo(options?: O): RestResponse<{
|
|
734
|
+
[index: string]: any;
|
|
735
|
+
}>;
|
|
409
736
|
}
|
|
410
737
|
export declare class AssetResourceClient<O> {
|
|
411
738
|
protected httpClient: HttpClient<O>;
|
|
@@ -543,404 +870,77 @@ export declare class SyslogResourceClient<O> {
|
|
|
543
870
|
subCategory?: string[];
|
|
544
871
|
}, options?: O): RestResponse<any>;
|
|
545
872
|
}
|
|
546
|
-
export declare class
|
|
873
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
547
874
|
protected httpClient: HttpClient<O>;
|
|
548
875
|
constructor(httpClient: HttpClient<O>);
|
|
549
876
|
/**
|
|
550
|
-
* HTTP
|
|
551
|
-
* Java method: org.openremote.model.
|
|
877
|
+
* HTTP GET /asset/datapoint/export
|
|
878
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
552
879
|
*/
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
880
|
+
getDatapointExport(queryParams?: {
|
|
881
|
+
attributeRefs?: string;
|
|
882
|
+
fromTimestamp?: number;
|
|
883
|
+
toTimestamp?: number;
|
|
884
|
+
}, options?: O): RestResponse<any>;
|
|
556
885
|
/**
|
|
557
|
-
* HTTP GET /
|
|
558
|
-
* Java method: org.openremote.model.
|
|
886
|
+
* HTTP GET /asset/datapoint/periods
|
|
887
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
559
888
|
*/
|
|
560
|
-
|
|
889
|
+
getDatapointPeriod(queryParams?: {
|
|
890
|
+
assetId?: string;
|
|
891
|
+
attributeName?: string;
|
|
892
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
561
893
|
/**
|
|
562
|
-
* HTTP
|
|
563
|
-
* Java method: org.openremote.model.
|
|
894
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
895
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
564
896
|
*/
|
|
565
|
-
|
|
566
|
-
/**
|
|
567
|
-
* HTTP GET /gateway/connection/{realm}
|
|
568
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
569
|
-
*/
|
|
570
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
571
|
-
/**
|
|
572
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
573
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
574
|
-
*/
|
|
575
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
576
|
-
/**
|
|
577
|
-
* HTTP GET /gateway/status/{realm}
|
|
578
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
579
|
-
*/
|
|
580
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
581
|
-
}
|
|
582
|
-
export declare class StatusResourceClient<O> {
|
|
583
|
-
protected httpClient: HttpClient<O>;
|
|
584
|
-
constructor(httpClient: HttpClient<O>);
|
|
585
|
-
/**
|
|
586
|
-
* HTTP GET /health
|
|
587
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
588
|
-
*/
|
|
589
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
590
|
-
[index: string]: any;
|
|
591
|
-
}>;
|
|
592
|
-
/**
|
|
593
|
-
* HTTP GET /info
|
|
594
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
595
|
-
*/
|
|
596
|
-
getInfo(options?: O): RestResponse<{
|
|
597
|
-
[index: string]: any;
|
|
598
|
-
}>;
|
|
599
|
-
}
|
|
600
|
-
export declare class ProvisioningResourceClient<O> {
|
|
601
|
-
protected httpClient: HttpClient<O>;
|
|
602
|
-
constructor(httpClient: HttpClient<O>);
|
|
603
|
-
/**
|
|
604
|
-
* HTTP POST /provisioning
|
|
605
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
606
|
-
*/
|
|
607
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
608
|
-
/**
|
|
609
|
-
* HTTP GET /provisioning
|
|
610
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
611
|
-
*/
|
|
612
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
613
|
-
/**
|
|
614
|
-
* HTTP DELETE /provisioning/{id}
|
|
615
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
616
|
-
*/
|
|
617
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
618
|
-
/**
|
|
619
|
-
* HTTP PUT /provisioning/{id}
|
|
620
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
621
|
-
*/
|
|
622
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
623
|
-
}
|
|
624
|
-
export declare class RulesResourceClient<O> {
|
|
625
|
-
protected httpClient: HttpClient<O>;
|
|
626
|
-
constructor(httpClient: HttpClient<O>);
|
|
627
|
-
/**
|
|
628
|
-
* HTTP POST /rules
|
|
629
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
630
|
-
*/
|
|
631
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
632
|
-
/**
|
|
633
|
-
* HTTP GET /rules
|
|
634
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
635
|
-
*/
|
|
636
|
-
getGlobalRulesets(queryParams?: {
|
|
637
|
-
language?: Model.RulesetLang[];
|
|
638
|
-
fullyPopulate?: boolean;
|
|
639
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
640
|
-
/**
|
|
641
|
-
* HTTP POST /rules/asset
|
|
642
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
643
|
-
*/
|
|
644
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
645
|
-
/**
|
|
646
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
647
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
648
|
-
*/
|
|
649
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
650
|
-
language?: Model.RulesetLang[];
|
|
651
|
-
fullyPopulate?: boolean;
|
|
652
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
653
|
-
/**
|
|
654
|
-
* HTTP DELETE /rules/asset/{id}
|
|
655
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
656
|
-
*/
|
|
657
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
658
|
-
/**
|
|
659
|
-
* HTTP GET /rules/asset/{id}
|
|
660
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
661
|
-
*/
|
|
662
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
663
|
-
/**
|
|
664
|
-
* HTTP PUT /rules/asset/{id}
|
|
665
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
666
|
-
*/
|
|
667
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
668
|
-
/**
|
|
669
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
670
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
671
|
-
*/
|
|
672
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
673
|
-
/**
|
|
674
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
675
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
676
|
-
*/
|
|
677
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
678
|
-
/**
|
|
679
|
-
* HTTP GET /rules/info/global
|
|
680
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
681
|
-
*/
|
|
682
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
683
|
-
/**
|
|
684
|
-
* HTTP GET /rules/info/realm/{realm}
|
|
685
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
686
|
-
*/
|
|
687
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
688
|
-
/**
|
|
689
|
-
* HTTP POST /rules/realm
|
|
690
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
691
|
-
*/
|
|
692
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
693
|
-
/**
|
|
694
|
-
* HTTP GET /rules/realm/for/{realm}
|
|
695
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
696
|
-
*/
|
|
697
|
-
getRealmRulesets(realm: string, queryParams?: {
|
|
698
|
-
language?: Model.RulesetLang[];
|
|
699
|
-
fullyPopulate?: boolean;
|
|
700
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
701
|
-
/**
|
|
702
|
-
* HTTP DELETE /rules/realm/{id}
|
|
703
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
704
|
-
*/
|
|
705
|
-
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
706
|
-
/**
|
|
707
|
-
* HTTP GET /rules/realm/{id}
|
|
708
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
709
|
-
*/
|
|
710
|
-
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
711
|
-
/**
|
|
712
|
-
* HTTP PUT /rules/realm/{id}
|
|
713
|
-
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
714
|
-
*/
|
|
715
|
-
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
716
|
-
/**
|
|
717
|
-
* HTTP DELETE /rules/{id}
|
|
718
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
719
|
-
*/
|
|
720
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
721
|
-
/**
|
|
722
|
-
* HTTP GET /rules/{id}
|
|
723
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
724
|
-
*/
|
|
725
|
-
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
726
|
-
/**
|
|
727
|
-
* HTTP PUT /rules/{id}
|
|
728
|
-
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
729
|
-
*/
|
|
730
|
-
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
731
|
-
}
|
|
732
|
-
export declare class ConsoleResourceClient<O> {
|
|
733
|
-
protected httpClient: HttpClient<O>;
|
|
734
|
-
constructor(httpClient: HttpClient<O>);
|
|
735
|
-
/**
|
|
736
|
-
* HTTP POST /console/register
|
|
737
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
738
|
-
*/
|
|
739
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
740
|
-
}
|
|
741
|
-
export declare class AssetModelResourceClient<O> {
|
|
742
|
-
protected httpClient: HttpClient<O>;
|
|
743
|
-
constructor(httpClient: HttpClient<O>);
|
|
744
|
-
/**
|
|
745
|
-
* HTTP GET /model/assetDescriptors
|
|
746
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
747
|
-
*/
|
|
748
|
-
getAssetDescriptors(queryParams?: {
|
|
749
|
-
parentId?: string;
|
|
750
|
-
parentType?: string;
|
|
751
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
752
|
-
/**
|
|
753
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
754
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
755
|
-
*/
|
|
756
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
757
|
-
parentId?: string;
|
|
758
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
759
|
-
/**
|
|
760
|
-
* HTTP GET /model/assetInfos
|
|
761
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
762
|
-
*/
|
|
763
|
-
getAssetInfos(queryParams?: {
|
|
764
|
-
parentId?: string;
|
|
765
|
-
parentType?: string;
|
|
766
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
767
|
-
/**
|
|
768
|
-
* HTTP GET /model/metaItemDescriptors
|
|
769
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
770
|
-
*/
|
|
771
|
-
getMetaItemDescriptors(queryParams?: {
|
|
772
|
-
parentId?: string;
|
|
773
|
-
}, options?: O): RestResponse<{
|
|
774
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
775
|
-
}>;
|
|
776
|
-
/**
|
|
777
|
-
* HTTP GET /model/valueDescriptors
|
|
778
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
779
|
-
*/
|
|
780
|
-
getValueDescriptors(queryParams?: {
|
|
781
|
-
parentId?: string;
|
|
782
|
-
}, options?: O): RestResponse<{
|
|
783
|
-
[index: string]: Model.ValueDescriptor;
|
|
784
|
-
}>;
|
|
785
|
-
}
|
|
786
|
-
export declare class AlarmResourceClient<O> {
|
|
787
|
-
protected httpClient: HttpClient<O>;
|
|
788
|
-
constructor(httpClient: HttpClient<O>);
|
|
789
|
-
/**
|
|
790
|
-
* HTTP POST /alarm
|
|
791
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
792
|
-
*/
|
|
793
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
794
|
-
assetIds?: string[];
|
|
795
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
796
|
-
/**
|
|
797
|
-
* HTTP GET /alarm
|
|
798
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
799
|
-
*/
|
|
800
|
-
getAlarms(queryParams?: {
|
|
801
|
-
realm?: string;
|
|
802
|
-
status?: Model.AlarmStatus;
|
|
803
|
-
assetId?: string;
|
|
804
|
-
assigneeId?: string;
|
|
805
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
806
|
-
/**
|
|
807
|
-
* HTTP DELETE /alarm
|
|
808
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
809
|
-
*/
|
|
810
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
811
|
-
/**
|
|
812
|
-
* HTTP PUT /alarm/assets
|
|
813
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
814
|
-
*/
|
|
815
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
816
|
-
/**
|
|
817
|
-
* HTTP GET /alarm/{alarmId}
|
|
818
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
819
|
-
*/
|
|
820
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
821
|
-
/**
|
|
822
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
823
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
824
|
-
*/
|
|
825
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
826
|
-
/**
|
|
827
|
-
* HTTP PUT /alarm/{alarmId}
|
|
828
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
829
|
-
*/
|
|
830
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
831
|
-
/**
|
|
832
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
833
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
834
|
-
*/
|
|
835
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
836
|
-
realm?: string;
|
|
837
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
838
|
-
}
|
|
839
|
-
export declare class DashboardResourceClient<O> {
|
|
840
|
-
protected httpClient: HttpClient<O>;
|
|
841
|
-
constructor(httpClient: HttpClient<O>);
|
|
842
|
-
/**
|
|
843
|
-
* HTTP POST /dashboard
|
|
844
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
845
|
-
*/
|
|
846
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
847
|
-
/**
|
|
848
|
-
* HTTP PUT /dashboard
|
|
849
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
850
|
-
*/
|
|
851
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
852
|
-
/**
|
|
853
|
-
* HTTP GET /dashboard/all/{realm}
|
|
854
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
855
|
-
*/
|
|
856
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP POST /dashboard/query
|
|
859
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
860
|
-
*/
|
|
861
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
862
|
-
/**
|
|
863
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
864
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
865
|
-
*/
|
|
866
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
867
|
-
/**
|
|
868
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
869
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
870
|
-
*/
|
|
871
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
872
|
-
}
|
|
873
|
-
export declare class ConfigurationResourceClient<O> {
|
|
874
|
-
protected httpClient: HttpClient<O>;
|
|
875
|
-
constructor(httpClient: HttpClient<O>);
|
|
876
|
-
/**
|
|
877
|
-
* HTTP GET /configuration/manager
|
|
878
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
879
|
-
*/
|
|
880
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
881
|
-
/**
|
|
882
|
-
* HTTP PUT /configuration/manager
|
|
883
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
884
|
-
*/
|
|
885
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
886
|
-
/**
|
|
887
|
-
* HTTP POST /configuration/manager/file
|
|
888
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
889
|
-
*/
|
|
890
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
891
|
-
path?: string;
|
|
892
|
-
}, options?: O): RestResponse<string>;
|
|
893
|
-
/**
|
|
894
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
895
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
896
|
-
*/
|
|
897
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
897
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
901
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
902
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
902
903
|
protected _userResource: AxiosUserResourceClient;
|
|
903
|
-
protected
|
|
904
|
-
protected
|
|
904
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
905
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
905
906
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
906
|
-
protected
|
|
907
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
908
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
907
909
|
protected _mapResource: AxiosMapResourceClient;
|
|
910
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
911
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
912
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
908
913
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
909
914
|
protected _agentResource: AxiosAgentResourceClient;
|
|
910
|
-
protected
|
|
915
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
916
|
+
protected _appResource: AxiosAppResourceClient;
|
|
917
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
918
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
911
919
|
protected _assetResource: AxiosAssetResourceClient;
|
|
912
920
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
913
|
-
protected
|
|
914
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
915
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
916
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
917
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
918
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
919
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
920
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
921
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
921
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
923
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
924
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
924
925
|
get UserResource(): AxiosUserResourceClient;
|
|
925
|
-
get
|
|
926
|
-
get
|
|
926
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
927
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
927
928
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
928
|
-
get
|
|
929
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
930
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
929
931
|
get MapResource(): AxiosMapResourceClient;
|
|
932
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
933
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
934
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
930
935
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
931
936
|
get AgentResource(): AxiosAgentResourceClient;
|
|
932
|
-
get
|
|
937
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
938
|
+
get AppResource(): AxiosAppResourceClient;
|
|
939
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
940
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
933
941
|
get AssetResource(): AxiosAssetResourceClient;
|
|
934
942
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
935
|
-
get
|
|
936
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
937
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
938
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
939
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
940
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
941
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
942
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
943
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
943
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
|
-
export declare class
|
|
978
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|