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