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