@openremote/rest 1.3.0-snapshot.20250219152724 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +455 -455
- 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,153 +9,211 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class ProvisioningResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP POST /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP POST /provisioning
|
|
17
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
20
20
|
/**
|
|
21
|
-
* HTTP GET /
|
|
22
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /provisioning
|
|
22
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
23
23
|
*/
|
|
24
|
-
|
|
25
|
-
language?: Model.RulesetLang[];
|
|
26
|
-
fullyPopulate?: boolean;
|
|
27
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
24
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
28
25
|
/**
|
|
29
|
-
* HTTP
|
|
30
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP DELETE /provisioning/{id}
|
|
27
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
31
28
|
*/
|
|
32
|
-
|
|
29
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
33
30
|
/**
|
|
34
|
-
* HTTP
|
|
35
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP PUT /provisioning/{id}
|
|
32
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
36
33
|
*/
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
34
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
35
|
+
}
|
|
36
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
37
|
+
protected httpClient: HttpClient<O>;
|
|
38
|
+
constructor(httpClient: HttpClient<O>);
|
|
41
39
|
/**
|
|
42
|
-
* HTTP
|
|
43
|
-
* Java method: org.openremote.model.
|
|
40
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
41
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
44
42
|
*/
|
|
45
|
-
|
|
43
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
46
44
|
/**
|
|
47
|
-
* HTTP
|
|
48
|
-
* Java method: org.openremote.model.
|
|
45
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
46
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
49
47
|
*/
|
|
50
|
-
|
|
48
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
49
|
+
}
|
|
50
|
+
export declare class AppResourceClient<O> {
|
|
51
|
+
protected httpClient: HttpClient<O>;
|
|
52
|
+
constructor(httpClient: HttpClient<O>);
|
|
51
53
|
/**
|
|
52
|
-
* HTTP
|
|
53
|
-
* Java method: org.openremote.model.
|
|
54
|
+
* HTTP GET /apps
|
|
55
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
54
56
|
*/
|
|
55
|
-
|
|
57
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
56
58
|
/**
|
|
57
|
-
* HTTP GET /
|
|
58
|
-
* Java method: org.openremote.model.
|
|
59
|
+
* HTTP GET /apps/consoleConfig
|
|
60
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
59
61
|
*/
|
|
60
|
-
|
|
62
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
61
63
|
/**
|
|
62
|
-
* HTTP GET /
|
|
63
|
-
* Java method: org.openremote.model.
|
|
64
|
+
* HTTP GET /apps/info
|
|
65
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
64
66
|
*/
|
|
65
|
-
|
|
67
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
68
|
+
}
|
|
69
|
+
export declare class FlowResourceClient<O> {
|
|
70
|
+
protected httpClient: HttpClient<O>;
|
|
71
|
+
constructor(httpClient: HttpClient<O>);
|
|
66
72
|
/**
|
|
67
|
-
* HTTP GET /
|
|
68
|
-
* Java method: org.openremote.model.rules.
|
|
73
|
+
* HTTP GET /flow
|
|
74
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
69
75
|
*/
|
|
70
|
-
|
|
76
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
71
77
|
/**
|
|
72
|
-
* HTTP GET /
|
|
73
|
-
* Java method: org.openremote.model.rules.
|
|
78
|
+
* HTTP GET /flow/{name}
|
|
79
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
74
80
|
*/
|
|
75
|
-
|
|
81
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
76
82
|
/**
|
|
77
|
-
* HTTP
|
|
78
|
-
* Java method: org.openremote.model.rules.
|
|
83
|
+
* HTTP GET /flow/{type}
|
|
84
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
79
85
|
*/
|
|
80
|
-
|
|
86
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
87
|
+
}
|
|
88
|
+
export declare class AlarmResourceClient<O> {
|
|
89
|
+
protected httpClient: HttpClient<O>;
|
|
90
|
+
constructor(httpClient: HttpClient<O>);
|
|
81
91
|
/**
|
|
82
|
-
* HTTP
|
|
83
|
-
* Java method: org.openremote.model.
|
|
92
|
+
* HTTP POST /alarm
|
|
93
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
84
94
|
*/
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
95
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
96
|
+
assetIds?: string[];
|
|
97
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
89
98
|
/**
|
|
90
|
-
* HTTP
|
|
91
|
-
* Java method: org.openremote.model.
|
|
99
|
+
* HTTP GET /alarm
|
|
100
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
92
101
|
*/
|
|
93
|
-
|
|
102
|
+
getAlarms(queryParams?: {
|
|
103
|
+
realm?: string;
|
|
104
|
+
status?: Model.AlarmStatus;
|
|
105
|
+
assetId?: string;
|
|
106
|
+
assigneeId?: string;
|
|
107
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
94
108
|
/**
|
|
95
|
-
* HTTP
|
|
96
|
-
* Java method: org.openremote.model.
|
|
109
|
+
* HTTP DELETE /alarm
|
|
110
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
97
111
|
*/
|
|
98
|
-
|
|
112
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
99
113
|
/**
|
|
100
|
-
* HTTP PUT /
|
|
101
|
-
* Java method: org.openremote.model.
|
|
114
|
+
* HTTP PUT /alarm/assets
|
|
115
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
102
116
|
*/
|
|
103
|
-
|
|
117
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
104
118
|
/**
|
|
105
|
-
* HTTP
|
|
106
|
-
* Java method: org.openremote.model.
|
|
119
|
+
* HTTP GET /alarm/{alarmId}
|
|
120
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
107
121
|
*/
|
|
108
|
-
|
|
122
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
109
123
|
/**
|
|
110
|
-
* HTTP
|
|
111
|
-
* Java method: org.openremote.model.
|
|
124
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
125
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
112
126
|
*/
|
|
113
|
-
|
|
127
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
114
128
|
/**
|
|
115
|
-
* HTTP PUT /
|
|
116
|
-
* Java method: org.openremote.model.
|
|
129
|
+
* HTTP PUT /alarm/{alarmId}
|
|
130
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
117
131
|
*/
|
|
118
|
-
|
|
132
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
133
|
+
/**
|
|
134
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
135
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
136
|
+
*/
|
|
137
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
138
|
+
realm?: string;
|
|
139
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
119
140
|
}
|
|
120
|
-
export declare class
|
|
141
|
+
export declare class StatusResourceClient<O> {
|
|
121
142
|
protected httpClient: HttpClient<O>;
|
|
122
143
|
constructor(httpClient: HttpClient<O>);
|
|
123
144
|
/**
|
|
124
|
-
* HTTP
|
|
125
|
-
* Java method: org.openremote.model.
|
|
145
|
+
* HTTP GET /health
|
|
146
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
126
147
|
*/
|
|
127
|
-
|
|
148
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
149
|
+
[index: string]: any;
|
|
150
|
+
}>;
|
|
128
151
|
/**
|
|
129
|
-
* HTTP
|
|
130
|
-
* Java method: org.openremote.model.
|
|
152
|
+
* HTTP GET /info
|
|
153
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
131
154
|
*/
|
|
132
|
-
|
|
155
|
+
getInfo(options?: O): RestResponse<{
|
|
156
|
+
[index: string]: any;
|
|
157
|
+
}>;
|
|
133
158
|
}
|
|
134
|
-
export declare class
|
|
159
|
+
export declare class MapResourceClient<O> {
|
|
135
160
|
protected httpClient: HttpClient<O>;
|
|
136
161
|
constructor(httpClient: HttpClient<O>);
|
|
137
162
|
/**
|
|
138
|
-
* HTTP GET /
|
|
139
|
-
* Java method: org.openremote.model.
|
|
163
|
+
* HTTP GET /map
|
|
164
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
140
165
|
*/
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
}
|
|
166
|
+
getSettings(options?: O): RestResponse<{
|
|
167
|
+
[id: string]: unknown;
|
|
168
|
+
}>;
|
|
144
169
|
/**
|
|
145
|
-
* HTTP
|
|
146
|
-
* Java method: org.openremote.model.
|
|
170
|
+
* HTTP PUT /map
|
|
171
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
147
172
|
*/
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
}, options?: O): RestResponse<
|
|
173
|
+
saveSettings(mapConfig: {
|
|
174
|
+
[index: string]: Model.MapRealmConfig;
|
|
175
|
+
}, options?: O): RestResponse<any>;
|
|
151
176
|
/**
|
|
152
|
-
* HTTP GET /
|
|
153
|
-
* Java method: org.openremote.model.
|
|
177
|
+
* HTTP GET /map/js
|
|
178
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
154
179
|
*/
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
180
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
181
|
+
[id: string]: unknown;
|
|
182
|
+
}>;
|
|
183
|
+
/**
|
|
184
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
185
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
186
|
+
*/
|
|
187
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
188
|
+
}
|
|
189
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
190
|
+
protected httpClient: HttpClient<O>;
|
|
191
|
+
constructor(httpClient: HttpClient<O>);
|
|
192
|
+
/**
|
|
193
|
+
* HTTP POST /gateway/tunnel
|
|
194
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
195
|
+
*/
|
|
196
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
197
|
+
/**
|
|
198
|
+
* HTTP DELETE /gateway/tunnel
|
|
199
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
200
|
+
*/
|
|
201
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
202
|
+
/**
|
|
203
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
204
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
205
|
+
*/
|
|
206
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
207
|
+
/**
|
|
208
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
209
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
210
|
+
*/
|
|
211
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
212
|
+
/**
|
|
213
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
214
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
215
|
+
*/
|
|
216
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
159
217
|
}
|
|
160
218
|
export declare class SyslogResourceClient<O> {
|
|
161
219
|
protected httpClient: HttpClient<O>;
|
|
@@ -189,30 +247,6 @@ export declare class SyslogResourceClient<O> {
|
|
|
189
247
|
subCategory?: string[];
|
|
190
248
|
}, options?: O): RestResponse<any>;
|
|
191
249
|
}
|
|
192
|
-
export declare class ProvisioningResourceClient<O> {
|
|
193
|
-
protected httpClient: HttpClient<O>;
|
|
194
|
-
constructor(httpClient: HttpClient<O>);
|
|
195
|
-
/**
|
|
196
|
-
* HTTP POST /provisioning
|
|
197
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
198
|
-
*/
|
|
199
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
200
|
-
/**
|
|
201
|
-
* HTTP GET /provisioning
|
|
202
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
203
|
-
*/
|
|
204
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
205
|
-
/**
|
|
206
|
-
* HTTP DELETE /provisioning/{id}
|
|
207
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
208
|
-
*/
|
|
209
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
210
|
-
/**
|
|
211
|
-
* HTTP PUT /provisioning/{id}
|
|
212
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
213
|
-
*/
|
|
214
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
215
|
-
}
|
|
216
250
|
export declare class AssetResourceClient<O> {
|
|
217
251
|
protected httpClient: HttpClient<O>;
|
|
218
252
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -317,166 +351,156 @@ export declare class AssetResourceClient<O> {
|
|
|
317
351
|
assetIds?: string[];
|
|
318
352
|
}, options?: O): RestResponse<void>;
|
|
319
353
|
}
|
|
320
|
-
export declare class
|
|
354
|
+
export declare class RulesResourceClient<O> {
|
|
321
355
|
protected httpClient: HttpClient<O>;
|
|
322
356
|
constructor(httpClient: HttpClient<O>);
|
|
323
357
|
/**
|
|
324
|
-
* HTTP
|
|
325
|
-
* Java method: org.openremote.model.
|
|
358
|
+
* HTTP POST /rules
|
|
359
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
326
360
|
*/
|
|
327
|
-
|
|
361
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
328
362
|
/**
|
|
329
|
-
* HTTP
|
|
330
|
-
* Java method: org.openremote.model.
|
|
363
|
+
* HTTP GET /rules
|
|
364
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
331
365
|
*/
|
|
332
|
-
|
|
366
|
+
getGlobalRulesets(queryParams?: {
|
|
367
|
+
language?: Model.RulesetLang[];
|
|
368
|
+
fullyPopulate?: boolean;
|
|
369
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
333
370
|
/**
|
|
334
|
-
* HTTP POST /
|
|
335
|
-
* Java method: org.openremote.model.
|
|
371
|
+
* HTTP POST /rules/asset
|
|
372
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
336
373
|
*/
|
|
337
|
-
|
|
338
|
-
path?: string;
|
|
339
|
-
}, options?: O): RestResponse<string>;
|
|
374
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
340
375
|
/**
|
|
341
|
-
* HTTP GET /
|
|
342
|
-
* Java method: org.openremote.model.
|
|
376
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
377
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
343
378
|
*/
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
constructor(httpClient: HttpClient<O>);
|
|
379
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
380
|
+
language?: Model.RulesetLang[];
|
|
381
|
+
fullyPopulate?: boolean;
|
|
382
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
349
383
|
/**
|
|
350
|
-
* HTTP
|
|
351
|
-
* Java method: org.openremote.model.
|
|
384
|
+
* HTTP DELETE /rules/asset/{id}
|
|
385
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
352
386
|
*/
|
|
353
|
-
|
|
387
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
354
388
|
/**
|
|
355
|
-
* HTTP
|
|
356
|
-
* Java method: org.openremote.model.
|
|
389
|
+
* HTTP GET /rules/asset/{id}
|
|
390
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
357
391
|
*/
|
|
358
|
-
|
|
392
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
359
393
|
/**
|
|
360
|
-
* HTTP
|
|
361
|
-
* Java method: org.openremote.model.
|
|
394
|
+
* HTTP PUT /rules/asset/{id}
|
|
395
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
362
396
|
*/
|
|
363
|
-
|
|
397
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
364
398
|
/**
|
|
365
|
-
* HTTP
|
|
366
|
-
* Java method: org.openremote.model.
|
|
399
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
400
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
367
401
|
*/
|
|
368
|
-
|
|
402
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
369
403
|
/**
|
|
370
|
-
* HTTP
|
|
371
|
-
* Java method: org.openremote.model.
|
|
404
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
405
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
372
406
|
*/
|
|
373
|
-
|
|
407
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
374
408
|
/**
|
|
375
|
-
* HTTP GET /
|
|
376
|
-
* Java method: org.openremote.model.
|
|
409
|
+
* HTTP GET /rules/info/global
|
|
410
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
377
411
|
*/
|
|
378
|
-
|
|
379
|
-
}
|
|
380
|
-
export declare class AssetModelResourceClient<O> {
|
|
381
|
-
protected httpClient: HttpClient<O>;
|
|
382
|
-
constructor(httpClient: HttpClient<O>);
|
|
412
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
383
413
|
/**
|
|
384
|
-
* HTTP GET /
|
|
385
|
-
* Java method: org.openremote.model.
|
|
414
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
415
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
386
416
|
*/
|
|
387
|
-
|
|
388
|
-
parentId?: string;
|
|
389
|
-
parentType?: string;
|
|
390
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
417
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
391
418
|
/**
|
|
392
|
-
* HTTP
|
|
393
|
-
* Java method: org.openremote.model.
|
|
419
|
+
* HTTP POST /rules/realm
|
|
420
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
394
421
|
*/
|
|
395
|
-
|
|
396
|
-
parentId?: string;
|
|
397
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
422
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
398
423
|
/**
|
|
399
|
-
* HTTP GET /
|
|
400
|
-
* Java method: org.openremote.model.
|
|
424
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
425
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
401
426
|
*/
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
}, options?: O): RestResponse<Model.
|
|
427
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
428
|
+
language?: Model.RulesetLang[];
|
|
429
|
+
fullyPopulate?: boolean;
|
|
430
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
406
431
|
/**
|
|
407
|
-
* HTTP
|
|
408
|
-
* Java method: org.openremote.model.
|
|
432
|
+
* HTTP DELETE /rules/realm/{id}
|
|
433
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
409
434
|
*/
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
435
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
436
|
+
/**
|
|
437
|
+
* HTTP GET /rules/realm/{id}
|
|
438
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
439
|
+
*/
|
|
440
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
441
|
+
/**
|
|
442
|
+
* HTTP PUT /rules/realm/{id}
|
|
443
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
444
|
+
*/
|
|
445
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
446
|
+
/**
|
|
447
|
+
* HTTP DELETE /rules/{id}
|
|
448
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
449
|
+
*/
|
|
450
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
451
|
+
/**
|
|
452
|
+
* HTTP GET /rules/{id}
|
|
453
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
454
|
+
*/
|
|
455
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
415
456
|
/**
|
|
416
|
-
* HTTP
|
|
417
|
-
* Java method: org.openremote.model.
|
|
457
|
+
* HTTP PUT /rules/{id}
|
|
458
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
418
459
|
*/
|
|
419
|
-
|
|
420
|
-
parentId?: string;
|
|
421
|
-
}, options?: O): RestResponse<{
|
|
422
|
-
[index: string]: Model.ValueDescriptor;
|
|
423
|
-
}>;
|
|
460
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
424
461
|
}
|
|
425
|
-
export declare class
|
|
462
|
+
export declare class DashboardResourceClient<O> {
|
|
426
463
|
protected httpClient: HttpClient<O>;
|
|
427
464
|
constructor(httpClient: HttpClient<O>);
|
|
428
465
|
/**
|
|
429
|
-
* HTTP
|
|
430
|
-
* Java method: org.openremote.model.
|
|
466
|
+
* HTTP POST /dashboard
|
|
467
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
431
468
|
*/
|
|
432
|
-
|
|
469
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
433
470
|
/**
|
|
434
|
-
* HTTP
|
|
435
|
-
* Java method: org.openremote.model.
|
|
471
|
+
* HTTP PUT /dashboard
|
|
472
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
436
473
|
*/
|
|
437
|
-
|
|
474
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
438
475
|
/**
|
|
439
|
-
* HTTP GET /
|
|
440
|
-
* Java method: org.openremote.model.
|
|
476
|
+
* HTTP GET /dashboard/all/{realm}
|
|
477
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
441
478
|
*/
|
|
442
|
-
|
|
443
|
-
}
|
|
444
|
-
export declare class StatusResourceClient<O> {
|
|
445
|
-
protected httpClient: HttpClient<O>;
|
|
446
|
-
constructor(httpClient: HttpClient<O>);
|
|
479
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
447
480
|
/**
|
|
448
|
-
* HTTP
|
|
449
|
-
* Java method: org.openremote.model.
|
|
481
|
+
* HTTP POST /dashboard/query
|
|
482
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
450
483
|
*/
|
|
451
|
-
|
|
452
|
-
[index: string]: any;
|
|
453
|
-
}>;
|
|
484
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
454
485
|
/**
|
|
455
|
-
* HTTP
|
|
456
|
-
* Java method: org.openremote.model.
|
|
486
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
487
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
457
488
|
*/
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
489
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
490
|
+
/**
|
|
491
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
492
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
493
|
+
*/
|
|
494
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
461
495
|
}
|
|
462
|
-
export declare class
|
|
496
|
+
export declare class ConsoleResourceClient<O> {
|
|
463
497
|
protected httpClient: HttpClient<O>;
|
|
464
498
|
constructor(httpClient: HttpClient<O>);
|
|
465
499
|
/**
|
|
466
|
-
* HTTP
|
|
467
|
-
* Java method: org.openremote.model.
|
|
468
|
-
*/
|
|
469
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
470
|
-
/**
|
|
471
|
-
* HTTP GET /flow/{name}
|
|
472
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
473
|
-
*/
|
|
474
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
475
|
-
/**
|
|
476
|
-
* HTTP GET /flow/{type}
|
|
477
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
500
|
+
* HTTP POST /console/register
|
|
501
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
478
502
|
*/
|
|
479
|
-
|
|
503
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
480
504
|
}
|
|
481
505
|
export declare class UserResourceClient<O> {
|
|
482
506
|
protected httpClient: HttpClient<O>;
|
|
@@ -602,39 +626,112 @@ export declare class UserResourceClient<O> {
|
|
|
602
626
|
*/
|
|
603
627
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
604
628
|
}
|
|
605
|
-
export declare class
|
|
629
|
+
export declare class AssetModelResourceClient<O> {
|
|
606
630
|
protected httpClient: HttpClient<O>;
|
|
607
631
|
constructor(httpClient: HttpClient<O>);
|
|
608
632
|
/**
|
|
609
|
-
* HTTP
|
|
610
|
-
* Java method: org.openremote.model.
|
|
633
|
+
* HTTP GET /model/assetDescriptors
|
|
634
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
611
635
|
*/
|
|
612
|
-
|
|
636
|
+
getAssetDescriptors(queryParams?: {
|
|
637
|
+
parentId?: string;
|
|
638
|
+
parentType?: string;
|
|
639
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
613
640
|
/**
|
|
614
|
-
* HTTP GET /
|
|
615
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
642
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
616
643
|
*/
|
|
617
|
-
|
|
644
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
645
|
+
parentId?: string;
|
|
646
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
618
647
|
/**
|
|
619
|
-
* HTTP GET /
|
|
620
|
-
* Java method: org.openremote.model.
|
|
648
|
+
* HTTP GET /model/assetInfos
|
|
649
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
621
650
|
*/
|
|
622
|
-
|
|
651
|
+
getAssetInfos(queryParams?: {
|
|
652
|
+
parentId?: string;
|
|
653
|
+
parentType?: string;
|
|
654
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
623
655
|
/**
|
|
624
|
-
* HTTP
|
|
625
|
-
* Java method: org.openremote.model.
|
|
656
|
+
* HTTP GET /model/metaItemDescriptors
|
|
657
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
626
658
|
*/
|
|
627
|
-
|
|
659
|
+
getMetaItemDescriptors(queryParams?: {
|
|
660
|
+
parentId?: string;
|
|
661
|
+
}, options?: O): RestResponse<{
|
|
662
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
663
|
+
}>;
|
|
628
664
|
/**
|
|
629
|
-
* HTTP GET /
|
|
630
|
-
* Java method: org.openremote.model.
|
|
665
|
+
* HTTP GET /model/valueDescriptors
|
|
666
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
631
667
|
*/
|
|
632
|
-
|
|
668
|
+
getValueDescriptors(queryParams?: {
|
|
669
|
+
parentId?: string;
|
|
670
|
+
}, options?: O): RestResponse<{
|
|
671
|
+
[index: string]: Model.ValueDescriptor;
|
|
672
|
+
}>;
|
|
673
|
+
}
|
|
674
|
+
export declare class GatewayClientResourceClient<O> {
|
|
675
|
+
protected httpClient: HttpClient<O>;
|
|
676
|
+
constructor(httpClient: HttpClient<O>);
|
|
633
677
|
/**
|
|
634
|
-
* HTTP
|
|
635
|
-
* Java method: org.openremote.model.
|
|
678
|
+
* HTTP DELETE /gateway/connection
|
|
679
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
636
680
|
*/
|
|
637
|
-
|
|
681
|
+
deleteConnections(queryParams?: {
|
|
682
|
+
realm?: string[];
|
|
683
|
+
}, options?: O): RestResponse<void>;
|
|
684
|
+
/**
|
|
685
|
+
* HTTP GET /gateway/connection
|
|
686
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
687
|
+
*/
|
|
688
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
689
|
+
/**
|
|
690
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
691
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
692
|
+
*/
|
|
693
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
694
|
+
/**
|
|
695
|
+
* HTTP GET /gateway/connection/{realm}
|
|
696
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
697
|
+
*/
|
|
698
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
699
|
+
/**
|
|
700
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
701
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
702
|
+
*/
|
|
703
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
704
|
+
/**
|
|
705
|
+
* HTTP GET /gateway/status/{realm}
|
|
706
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
707
|
+
*/
|
|
708
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
709
|
+
}
|
|
710
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
711
|
+
protected httpClient: HttpClient<O>;
|
|
712
|
+
constructor(httpClient: HttpClient<O>);
|
|
713
|
+
/**
|
|
714
|
+
* HTTP GET /asset/datapoint/export
|
|
715
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
716
|
+
*/
|
|
717
|
+
getDatapointExport(queryParams?: {
|
|
718
|
+
attributeRefs?: string;
|
|
719
|
+
fromTimestamp?: number;
|
|
720
|
+
toTimestamp?: number;
|
|
721
|
+
}, options?: O): RestResponse<any>;
|
|
722
|
+
/**
|
|
723
|
+
* HTTP GET /asset/datapoint/periods
|
|
724
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
725
|
+
*/
|
|
726
|
+
getDatapointPeriod(queryParams?: {
|
|
727
|
+
assetId?: string;
|
|
728
|
+
attributeName?: string;
|
|
729
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
730
|
+
/**
|
|
731
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
732
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
733
|
+
*/
|
|
734
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
638
735
|
}
|
|
639
736
|
export declare class NotificationResourceClient<O> {
|
|
640
737
|
protected httpClient: HttpClient<O>;
|
|
@@ -667,257 +764,160 @@ export declare class NotificationResourceClient<O> {
|
|
|
667
764
|
}, options?: O): RestResponse<void>;
|
|
668
765
|
/**
|
|
669
766
|
* HTTP POST /notification/alert
|
|
670
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
671
|
-
*/
|
|
672
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
673
|
-
/**
|
|
674
|
-
* HTTP DELETE /notification/{notificationId}
|
|
675
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
676
|
-
*/
|
|
677
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
678
|
-
/**
|
|
679
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
680
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
681
|
-
*/
|
|
682
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
683
|
-
targetId?: string;
|
|
684
|
-
}, options?: O): RestResponse<void>;
|
|
685
|
-
/**
|
|
686
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
687
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
688
|
-
*/
|
|
689
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
690
|
-
targetId?: string;
|
|
691
|
-
}, options?: O): RestResponse<void>;
|
|
692
|
-
}
|
|
693
|
-
export declare class MapResourceClient<O> {
|
|
694
|
-
protected httpClient: HttpClient<O>;
|
|
695
|
-
constructor(httpClient: HttpClient<O>);
|
|
696
|
-
/**
|
|
697
|
-
* HTTP GET /map
|
|
698
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
699
|
-
*/
|
|
700
|
-
getSettings(options?: O): RestResponse<{
|
|
701
|
-
[id: string]: unknown;
|
|
702
|
-
}>;
|
|
703
|
-
/**
|
|
704
|
-
* HTTP PUT /map
|
|
705
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
706
|
-
*/
|
|
707
|
-
saveSettings(mapConfig: {
|
|
708
|
-
[index: string]: Model.MapRealmConfig;
|
|
709
|
-
}, options?: O): RestResponse<any>;
|
|
710
|
-
/**
|
|
711
|
-
* HTTP GET /map/js
|
|
712
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
713
|
-
*/
|
|
714
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
715
|
-
[id: string]: unknown;
|
|
716
|
-
}>;
|
|
717
|
-
/**
|
|
718
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
719
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
720
|
-
*/
|
|
721
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
722
|
-
}
|
|
723
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
724
|
-
protected httpClient: HttpClient<O>;
|
|
725
|
-
constructor(httpClient: HttpClient<O>);
|
|
726
|
-
/**
|
|
727
|
-
* HTTP POST /gateway/tunnel
|
|
728
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
729
|
-
*/
|
|
730
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
731
|
-
/**
|
|
732
|
-
* HTTP DELETE /gateway/tunnel
|
|
733
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
734
|
-
*/
|
|
735
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
736
|
-
/**
|
|
737
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
738
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
767
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
739
768
|
*/
|
|
740
|
-
|
|
769
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
741
770
|
/**
|
|
742
|
-
* HTTP
|
|
743
|
-
* Java method: org.openremote.model.
|
|
771
|
+
* HTTP DELETE /notification/{notificationId}
|
|
772
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
744
773
|
*/
|
|
745
|
-
|
|
774
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
746
775
|
/**
|
|
747
|
-
* HTTP
|
|
748
|
-
* Java method: org.openremote.model.
|
|
776
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
777
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
749
778
|
*/
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
protected httpClient: HttpClient<O>;
|
|
754
|
-
constructor(httpClient: HttpClient<O>);
|
|
779
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
780
|
+
targetId?: string;
|
|
781
|
+
}, options?: O): RestResponse<void>;
|
|
755
782
|
/**
|
|
756
|
-
* HTTP
|
|
757
|
-
* Java method: org.openremote.model.
|
|
783
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
784
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
758
785
|
*/
|
|
759
|
-
|
|
786
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
787
|
+
targetId?: string;
|
|
788
|
+
}, options?: O): RestResponse<void>;
|
|
760
789
|
}
|
|
761
|
-
export declare class
|
|
790
|
+
export declare class ConfigurationResourceClient<O> {
|
|
762
791
|
protected httpClient: HttpClient<O>;
|
|
763
792
|
constructor(httpClient: HttpClient<O>);
|
|
764
793
|
/**
|
|
765
|
-
* HTTP
|
|
766
|
-
* Java method: org.openremote.model.
|
|
767
|
-
*/
|
|
768
|
-
deleteConnections(queryParams?: {
|
|
769
|
-
realm?: string[];
|
|
770
|
-
}, options?: O): RestResponse<void>;
|
|
771
|
-
/**
|
|
772
|
-
* HTTP GET /gateway/connection
|
|
773
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
774
|
-
*/
|
|
775
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
776
|
-
/**
|
|
777
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
778
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
794
|
+
* HTTP GET /configuration/manager
|
|
795
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
779
796
|
*/
|
|
780
|
-
|
|
797
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
781
798
|
/**
|
|
782
|
-
* HTTP
|
|
783
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP PUT /configuration/manager
|
|
800
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
784
801
|
*/
|
|
785
|
-
|
|
802
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
786
803
|
/**
|
|
787
|
-
* HTTP
|
|
788
|
-
* Java method: org.openremote.model.
|
|
804
|
+
* HTTP POST /configuration/manager/file
|
|
805
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
789
806
|
*/
|
|
790
|
-
|
|
807
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
808
|
+
path?: string;
|
|
809
|
+
}, options?: O): RestResponse<string>;
|
|
791
810
|
/**
|
|
792
|
-
* HTTP GET /
|
|
793
|
-
* Java method: org.openremote.model.
|
|
811
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
812
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
794
813
|
*/
|
|
795
|
-
|
|
814
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
796
815
|
}
|
|
797
|
-
export declare class
|
|
816
|
+
export declare class AgentResourceClient<O> {
|
|
798
817
|
protected httpClient: HttpClient<O>;
|
|
799
818
|
constructor(httpClient: HttpClient<O>);
|
|
800
819
|
/**
|
|
801
|
-
* HTTP
|
|
802
|
-
* Java method: org.openremote.model.
|
|
803
|
-
*/
|
|
804
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
805
|
-
assetIds?: string[];
|
|
806
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
807
|
-
/**
|
|
808
|
-
* HTTP GET /alarm
|
|
809
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
820
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
821
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
810
822
|
*/
|
|
811
|
-
|
|
823
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
812
824
|
realm?: string;
|
|
813
|
-
|
|
814
|
-
assetId?: string;
|
|
815
|
-
assigneeId?: string;
|
|
816
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
817
|
-
/**
|
|
818
|
-
* HTTP DELETE /alarm
|
|
819
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
820
|
-
*/
|
|
821
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
825
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
822
826
|
/**
|
|
823
|
-
* HTTP
|
|
824
|
-
* Java method: org.openremote.model.
|
|
827
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
828
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
825
829
|
*/
|
|
826
|
-
|
|
830
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
831
|
+
realm?: string;
|
|
832
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
827
833
|
/**
|
|
828
|
-
* HTTP GET /
|
|
829
|
-
* Java method: org.openremote.model.
|
|
834
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
835
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
830
836
|
*/
|
|
831
|
-
|
|
837
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
838
|
+
parentId?: string;
|
|
839
|
+
realm?: string;
|
|
840
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
841
|
+
}
|
|
842
|
+
export declare class RealmResourceClient<O> {
|
|
843
|
+
protected httpClient: HttpClient<O>;
|
|
844
|
+
constructor(httpClient: HttpClient<O>);
|
|
832
845
|
/**
|
|
833
|
-
* HTTP
|
|
834
|
-
* Java method: org.openremote.model.
|
|
846
|
+
* HTTP POST /realm
|
|
847
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
835
848
|
*/
|
|
836
|
-
|
|
849
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
837
850
|
/**
|
|
838
|
-
* HTTP
|
|
839
|
-
* Java method: org.openremote.model.
|
|
851
|
+
* HTTP GET /realm
|
|
852
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
840
853
|
*/
|
|
841
|
-
|
|
854
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
842
855
|
/**
|
|
843
|
-
* HTTP GET /
|
|
844
|
-
* Java method: org.openremote.model.
|
|
856
|
+
* HTTP GET /realm/accessible
|
|
857
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
845
858
|
*/
|
|
846
|
-
|
|
847
|
-
realm?: string;
|
|
848
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
849
|
-
}
|
|
850
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
851
|
-
protected httpClient: HttpClient<O>;
|
|
852
|
-
constructor(httpClient: HttpClient<O>);
|
|
859
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
853
860
|
/**
|
|
854
|
-
* HTTP
|
|
855
|
-
* Java method: org.openremote.model.
|
|
861
|
+
* HTTP DELETE /realm/{name}
|
|
862
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
856
863
|
*/
|
|
857
|
-
|
|
858
|
-
attributeRefs?: string;
|
|
859
|
-
fromTimestamp?: number;
|
|
860
|
-
toTimestamp?: number;
|
|
861
|
-
}, options?: O): RestResponse<any>;
|
|
864
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
862
865
|
/**
|
|
863
|
-
* HTTP GET /
|
|
864
|
-
* Java method: org.openremote.model.
|
|
866
|
+
* HTTP GET /realm/{name}
|
|
867
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
865
868
|
*/
|
|
866
|
-
|
|
867
|
-
assetId?: string;
|
|
868
|
-
attributeName?: string;
|
|
869
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
869
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
870
870
|
/**
|
|
871
|
-
* HTTP
|
|
872
|
-
* Java method: org.openremote.model.
|
|
871
|
+
* HTTP PUT /realm/{name}
|
|
872
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
873
873
|
*/
|
|
874
|
-
|
|
874
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
879
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
880
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
881
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
882
878
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
883
|
-
protected
|
|
884
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
885
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
886
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
879
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
887
880
|
protected _appResource: AxiosAppResourceClient;
|
|
888
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
889
881
|
protected _flowResource: AxiosFlowResourceClient;
|
|
890
|
-
protected
|
|
891
|
-
protected
|
|
892
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
882
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
883
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
893
884
|
protected _mapResource: AxiosMapResourceClient;
|
|
894
885
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
886
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
887
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
888
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
889
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
895
890
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
891
|
+
protected _userResource: AxiosUserResourceClient;
|
|
892
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
896
893
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
897
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
898
894
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
895
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
896
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
897
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
898
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
901
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
902
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
903
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
904
900
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
905
|
-
get
|
|
906
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
907
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
908
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
901
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
909
902
|
get AppResource(): AxiosAppResourceClient;
|
|
910
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
911
903
|
get FlowResource(): AxiosFlowResourceClient;
|
|
912
|
-
get
|
|
913
|
-
get
|
|
914
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
904
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
905
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
915
906
|
get MapResource(): AxiosMapResourceClient;
|
|
916
907
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
908
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
909
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
910
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
911
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
917
912
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
913
|
+
get UserResource(): AxiosUserResourceClient;
|
|
914
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
918
915
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
919
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
920
916
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
917
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
918
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
919
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
920
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
931
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|