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