@openremote/rest 1.6.0-snapshot.20250514095754 → 1.6.0-snapshot.20250515141253
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 +452 -452
- 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,113 +9,89 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class ConfigurationResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP GET /rules
|
|
22
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
23
|
-
*/
|
|
24
|
-
getGlobalRulesets(queryParams?: {
|
|
25
|
-
language?: Model.RulesetLang[];
|
|
26
|
-
fullyPopulate?: boolean;
|
|
27
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
28
|
-
/**
|
|
29
|
-
* HTTP POST /rules/asset
|
|
30
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
31
|
-
*/
|
|
32
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
33
|
-
/**
|
|
34
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
35
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
36
|
-
*/
|
|
37
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
38
|
-
language?: Model.RulesetLang[];
|
|
39
|
-
fullyPopulate?: boolean;
|
|
40
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP DELETE /rules/asset/{id}
|
|
43
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
44
|
-
*/
|
|
45
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
46
|
-
/**
|
|
47
|
-
* HTTP GET /rules/asset/{id}
|
|
48
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
49
|
-
*/
|
|
50
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
51
|
-
/**
|
|
52
|
-
* HTTP PUT /rules/asset/{id}
|
|
53
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
54
|
-
*/
|
|
55
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
56
|
-
/**
|
|
57
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
58
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
59
|
-
*/
|
|
60
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
61
|
-
/**
|
|
62
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
63
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
16
|
+
* HTTP GET /configuration/manager
|
|
17
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
64
18
|
*/
|
|
65
|
-
|
|
19
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
66
20
|
/**
|
|
67
|
-
* HTTP
|
|
68
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /configuration/manager
|
|
22
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
69
23
|
*/
|
|
70
|
-
|
|
24
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
71
25
|
/**
|
|
72
|
-
* HTTP
|
|
73
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP POST /configuration/manager/file
|
|
27
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
74
28
|
*/
|
|
75
|
-
|
|
29
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
30
|
+
path?: string;
|
|
31
|
+
}, options?: O): RestResponse<string>;
|
|
76
32
|
/**
|
|
77
|
-
* HTTP
|
|
78
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
34
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
79
35
|
*/
|
|
80
|
-
|
|
36
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
37
|
+
}
|
|
38
|
+
export declare class SyslogResourceClient<O> {
|
|
39
|
+
protected httpClient: HttpClient<O>;
|
|
40
|
+
constructor(httpClient: HttpClient<O>);
|
|
81
41
|
/**
|
|
82
|
-
* HTTP GET /
|
|
83
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP GET /syslog/config
|
|
43
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
84
44
|
*/
|
|
85
|
-
|
|
86
|
-
language?: Model.RulesetLang[];
|
|
87
|
-
fullyPopulate?: boolean;
|
|
88
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
45
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
89
46
|
/**
|
|
90
|
-
* HTTP
|
|
91
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP PUT /syslog/config
|
|
48
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
92
49
|
*/
|
|
93
|
-
|
|
50
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
94
51
|
/**
|
|
95
|
-
* HTTP
|
|
96
|
-
* Java method: org.openremote.model.
|
|
52
|
+
* HTTP DELETE /syslog/event
|
|
53
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
97
54
|
*/
|
|
98
|
-
|
|
55
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
99
56
|
/**
|
|
100
|
-
* HTTP
|
|
101
|
-
* Java method: org.openremote.model.
|
|
57
|
+
* HTTP GET /syslog/event
|
|
58
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
102
59
|
*/
|
|
103
|
-
|
|
60
|
+
getEvents(queryParams?: {
|
|
61
|
+
level?: Model.SyslogLevel;
|
|
62
|
+
per_page?: number;
|
|
63
|
+
page?: number;
|
|
64
|
+
from?: number;
|
|
65
|
+
to?: number;
|
|
66
|
+
category?: Model.SyslogCategory[];
|
|
67
|
+
subCategory?: string[];
|
|
68
|
+
}, options?: O): RestResponse<any>;
|
|
69
|
+
}
|
|
70
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
71
|
+
protected httpClient: HttpClient<O>;
|
|
72
|
+
constructor(httpClient: HttpClient<O>);
|
|
104
73
|
/**
|
|
105
|
-
* HTTP
|
|
106
|
-
* Java method: org.openremote.model.
|
|
74
|
+
* HTTP GET /asset/datapoint/export
|
|
75
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
107
76
|
*/
|
|
108
|
-
|
|
77
|
+
getDatapointExport(queryParams?: {
|
|
78
|
+
attributeRefs?: string;
|
|
79
|
+
fromTimestamp?: number;
|
|
80
|
+
toTimestamp?: number;
|
|
81
|
+
}, options?: O): RestResponse<any>;
|
|
109
82
|
/**
|
|
110
|
-
* HTTP GET /
|
|
111
|
-
* Java method: org.openremote.model.
|
|
83
|
+
* HTTP GET /asset/datapoint/periods
|
|
84
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
112
85
|
*/
|
|
113
|
-
|
|
86
|
+
getDatapointPeriod(queryParams?: {
|
|
87
|
+
assetId?: string;
|
|
88
|
+
attributeName?: string;
|
|
89
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
114
90
|
/**
|
|
115
|
-
* HTTP
|
|
116
|
-
* Java method: org.openremote.model.
|
|
91
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
92
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
117
93
|
*/
|
|
118
|
-
|
|
94
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
119
95
|
}
|
|
120
96
|
export declare class AlarmResourceClient<O> {
|
|
121
97
|
protected httpClient: HttpClient<O>;
|
|
@@ -199,244 +175,164 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
199
175
|
*/
|
|
200
176
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
201
177
|
}
|
|
202
|
-
export declare class
|
|
178
|
+
export declare class FlowResourceClient<O> {
|
|
203
179
|
protected httpClient: HttpClient<O>;
|
|
204
180
|
constructor(httpClient: HttpClient<O>);
|
|
205
181
|
/**
|
|
206
|
-
* HTTP
|
|
207
|
-
* Java method: org.openremote.model.
|
|
182
|
+
* HTTP GET /flow
|
|
183
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
208
184
|
*/
|
|
209
|
-
|
|
185
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
210
186
|
/**
|
|
211
|
-
* HTTP
|
|
212
|
-
* Java method: org.openremote.model.
|
|
187
|
+
* HTTP GET /flow/{name}
|
|
188
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
213
189
|
*/
|
|
214
|
-
|
|
215
|
-
assetId?: string[];
|
|
216
|
-
}, options?: O): RestResponse<void>;
|
|
190
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
217
191
|
/**
|
|
218
|
-
* HTTP
|
|
219
|
-
* Java method: org.openremote.model.
|
|
192
|
+
* HTTP GET /flow/{type}
|
|
193
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
220
194
|
*/
|
|
221
|
-
|
|
195
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
196
|
+
}
|
|
197
|
+
export declare class StatusResourceClient<O> {
|
|
198
|
+
protected httpClient: HttpClient<O>;
|
|
199
|
+
constructor(httpClient: HttpClient<O>);
|
|
222
200
|
/**
|
|
223
|
-
* HTTP
|
|
224
|
-
* Java method: org.openremote.model.
|
|
201
|
+
* HTTP GET /health
|
|
202
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
225
203
|
*/
|
|
226
|
-
|
|
204
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
205
|
+
[index: string]: any;
|
|
206
|
+
}>;
|
|
227
207
|
/**
|
|
228
|
-
* HTTP
|
|
229
|
-
* Java method: org.openremote.model.
|
|
208
|
+
* HTTP GET /info
|
|
209
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
230
210
|
*/
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
}
|
|
211
|
+
getInfo(options?: O): RestResponse<{
|
|
212
|
+
[index: string]: any;
|
|
213
|
+
}>;
|
|
214
|
+
}
|
|
215
|
+
export declare class AppResourceClient<O> {
|
|
216
|
+
protected httpClient: HttpClient<O>;
|
|
217
|
+
constructor(httpClient: HttpClient<O>);
|
|
234
218
|
/**
|
|
235
|
-
* HTTP GET /
|
|
236
|
-
* Java method: org.openremote.model.
|
|
219
|
+
* HTTP GET /apps
|
|
220
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
237
221
|
*/
|
|
238
|
-
|
|
222
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
239
223
|
/**
|
|
240
|
-
* HTTP
|
|
241
|
-
* Java method: org.openremote.model.
|
|
224
|
+
* HTTP GET /apps/consoleConfig
|
|
225
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
242
226
|
*/
|
|
243
|
-
|
|
227
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
244
228
|
/**
|
|
245
|
-
* HTTP GET /
|
|
246
|
-
* Java method: org.openremote.model.
|
|
229
|
+
* HTTP GET /apps/info
|
|
230
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
247
231
|
*/
|
|
248
|
-
|
|
232
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
233
|
+
}
|
|
234
|
+
export declare class ProvisioningResourceClient<O> {
|
|
235
|
+
protected httpClient: HttpClient<O>;
|
|
236
|
+
constructor(httpClient: HttpClient<O>);
|
|
249
237
|
/**
|
|
250
|
-
* HTTP POST /
|
|
251
|
-
* Java method: org.openremote.model.
|
|
238
|
+
* HTTP POST /provisioning
|
|
239
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
252
240
|
*/
|
|
253
|
-
|
|
241
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
254
242
|
/**
|
|
255
|
-
* HTTP GET /
|
|
256
|
-
* Java method: org.openremote.model.
|
|
243
|
+
* HTTP GET /provisioning
|
|
244
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
257
245
|
*/
|
|
258
|
-
|
|
259
|
-
realm?: string;
|
|
260
|
-
userId?: string;
|
|
261
|
-
assetId?: string;
|
|
262
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
246
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
263
247
|
/**
|
|
264
|
-
* HTTP
|
|
265
|
-
* Java method: org.openremote.model.
|
|
248
|
+
* HTTP DELETE /provisioning/{id}
|
|
249
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
266
250
|
*/
|
|
267
|
-
|
|
251
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
268
252
|
/**
|
|
269
|
-
* HTTP
|
|
270
|
-
* Java method: org.openremote.model.
|
|
253
|
+
* HTTP PUT /provisioning/{id}
|
|
254
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
271
255
|
*/
|
|
272
|
-
|
|
256
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
257
|
+
}
|
|
258
|
+
export declare class AgentResourceClient<O> {
|
|
259
|
+
protected httpClient: HttpClient<O>;
|
|
260
|
+
constructor(httpClient: HttpClient<O>);
|
|
273
261
|
/**
|
|
274
|
-
* HTTP
|
|
275
|
-
* Java method: org.openremote.model.asset.
|
|
262
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
263
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
276
264
|
*/
|
|
277
|
-
|
|
265
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
266
|
+
realm?: string;
|
|
267
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
278
268
|
/**
|
|
279
|
-
* HTTP
|
|
280
|
-
* Java method: org.openremote.model.asset.
|
|
269
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
270
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
281
271
|
*/
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
286
|
-
*/
|
|
287
|
-
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
288
|
-
/**
|
|
289
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
290
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
291
|
-
*/
|
|
292
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
293
|
-
/**
|
|
294
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
295
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
296
|
-
*/
|
|
297
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
298
|
-
/**
|
|
299
|
-
* HTTP PUT /asset/{parentAssetId}/child
|
|
300
|
-
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
301
|
-
*/
|
|
302
|
-
updateParent(parentAssetId: string, queryParams?: {
|
|
303
|
-
assetIds?: string[];
|
|
304
|
-
}, options?: O): RestResponse<void>;
|
|
305
|
-
}
|
|
306
|
-
export declare class GatewayClientResourceClient<O> {
|
|
307
|
-
protected httpClient: HttpClient<O>;
|
|
308
|
-
constructor(httpClient: HttpClient<O>);
|
|
309
|
-
/**
|
|
310
|
-
* HTTP DELETE /gateway/connection
|
|
311
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
312
|
-
*/
|
|
313
|
-
deleteConnections(queryParams?: {
|
|
314
|
-
realm?: string[];
|
|
315
|
-
}, options?: O): RestResponse<void>;
|
|
316
|
-
/**
|
|
317
|
-
* HTTP GET /gateway/connection
|
|
318
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
319
|
-
*/
|
|
320
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
321
|
-
/**
|
|
322
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
323
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
324
|
-
*/
|
|
325
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
326
|
-
/**
|
|
327
|
-
* HTTP GET /gateway/connection/{realm}
|
|
328
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
329
|
-
*/
|
|
330
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
331
|
-
/**
|
|
332
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
333
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
334
|
-
*/
|
|
335
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP GET /gateway/status/{realm}
|
|
338
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
339
|
-
*/
|
|
340
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
341
|
-
}
|
|
342
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
343
|
-
protected httpClient: HttpClient<O>;
|
|
344
|
-
constructor(httpClient: HttpClient<O>);
|
|
345
|
-
/**
|
|
346
|
-
* HTTP GET /asset/datapoint/export
|
|
347
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
348
|
-
*/
|
|
349
|
-
getDatapointExport(queryParams?: {
|
|
350
|
-
attributeRefs?: string;
|
|
351
|
-
fromTimestamp?: number;
|
|
352
|
-
toTimestamp?: number;
|
|
353
|
-
}, options?: O): RestResponse<any>;
|
|
354
|
-
/**
|
|
355
|
-
* HTTP GET /asset/datapoint/periods
|
|
356
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
357
|
-
*/
|
|
358
|
-
getDatapointPeriod(queryParams?: {
|
|
359
|
-
assetId?: string;
|
|
360
|
-
attributeName?: string;
|
|
361
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
272
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
273
|
+
realm?: string;
|
|
274
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
362
275
|
/**
|
|
363
|
-
* HTTP
|
|
364
|
-
* Java method: org.openremote.model.
|
|
276
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
277
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
365
278
|
*/
|
|
366
|
-
|
|
279
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
280
|
+
parentId?: string;
|
|
281
|
+
realm?: string;
|
|
282
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
367
283
|
}
|
|
368
|
-
export declare class
|
|
284
|
+
export declare class MapResourceClient<O> {
|
|
369
285
|
protected httpClient: HttpClient<O>;
|
|
370
286
|
constructor(httpClient: HttpClient<O>);
|
|
371
287
|
/**
|
|
372
|
-
* HTTP GET /
|
|
373
|
-
* Java method: org.openremote.model.
|
|
288
|
+
* HTTP GET /map
|
|
289
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
374
290
|
*/
|
|
375
|
-
|
|
376
|
-
[
|
|
291
|
+
getSettings(options?: O): RestResponse<{
|
|
292
|
+
[id: string]: unknown;
|
|
377
293
|
}>;
|
|
378
294
|
/**
|
|
379
|
-
* HTTP
|
|
380
|
-
* Java method: org.openremote.model.
|
|
295
|
+
* HTTP PUT /map
|
|
296
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
381
297
|
*/
|
|
382
|
-
|
|
383
|
-
[
|
|
298
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
299
|
+
[id: string]: unknown;
|
|
384
300
|
}>;
|
|
385
|
-
}
|
|
386
|
-
export declare class ConsoleResourceClient<O> {
|
|
387
|
-
protected httpClient: HttpClient<O>;
|
|
388
|
-
constructor(httpClient: HttpClient<O>);
|
|
389
|
-
/**
|
|
390
|
-
* HTTP POST /console/register
|
|
391
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
392
|
-
*/
|
|
393
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
394
|
-
}
|
|
395
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
396
|
-
protected httpClient: HttpClient<O>;
|
|
397
|
-
constructor(httpClient: HttpClient<O>);
|
|
398
301
|
/**
|
|
399
|
-
* HTTP
|
|
400
|
-
* Java method: org.openremote.model.
|
|
401
|
-
*/
|
|
402
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
403
|
-
/**
|
|
404
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
405
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
302
|
+
* HTTP DELETE /map/deleteMap
|
|
303
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
406
304
|
*/
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
protected httpClient: HttpClient<O>;
|
|
411
|
-
constructor(httpClient: HttpClient<O>);
|
|
305
|
+
deleteMap(options?: O): RestResponse<{
|
|
306
|
+
[id: string]: unknown;
|
|
307
|
+
}>;
|
|
412
308
|
/**
|
|
413
|
-
* HTTP GET /
|
|
414
|
-
* Java method: org.openremote.model.
|
|
309
|
+
* HTTP GET /map/getCustomMapInfo
|
|
310
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
415
311
|
*/
|
|
416
|
-
|
|
312
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
313
|
+
[id: string]: unknown;
|
|
314
|
+
}>;
|
|
417
315
|
/**
|
|
418
|
-
* HTTP
|
|
419
|
-
* Java method: org.openremote.model.
|
|
316
|
+
* HTTP GET /map/js
|
|
317
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
420
318
|
*/
|
|
421
|
-
|
|
319
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
320
|
+
[id: string]: unknown;
|
|
321
|
+
}>;
|
|
422
322
|
/**
|
|
423
|
-
* HTTP
|
|
424
|
-
* Java method: org.openremote.model.
|
|
323
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
324
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
425
325
|
*/
|
|
426
|
-
|
|
326
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
427
327
|
/**
|
|
428
|
-
* HTTP
|
|
429
|
-
* Java method: org.openremote.model.
|
|
328
|
+
* HTTP POST /map/upload
|
|
329
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
430
330
|
*/
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
to?: number;
|
|
437
|
-
category?: Model.SyslogCategory[];
|
|
438
|
-
subCategory?: string[];
|
|
439
|
-
}, options?: O): RestResponse<any>;
|
|
331
|
+
uploadMap(queryParams?: {
|
|
332
|
+
filename?: string;
|
|
333
|
+
}, options?: O): RestResponse<{
|
|
334
|
+
[id: string]: unknown;
|
|
335
|
+
}>;
|
|
440
336
|
}
|
|
441
337
|
export declare class DashboardResourceClient<O> {
|
|
442
338
|
protected httpClient: HttpClient<O>;
|
|
@@ -472,31 +368,53 @@ export declare class DashboardResourceClient<O> {
|
|
|
472
368
|
*/
|
|
473
369
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
474
370
|
}
|
|
475
|
-
export declare class
|
|
371
|
+
export declare class RealmResourceClient<O> {
|
|
476
372
|
protected httpClient: HttpClient<O>;
|
|
477
373
|
constructor(httpClient: HttpClient<O>);
|
|
478
374
|
/**
|
|
479
|
-
* HTTP
|
|
480
|
-
* Java method: org.openremote.model.
|
|
375
|
+
* HTTP POST /realm
|
|
376
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
481
377
|
*/
|
|
482
|
-
|
|
483
|
-
realm?: string;
|
|
484
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
378
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
485
379
|
/**
|
|
486
|
-
* HTTP
|
|
487
|
-
* Java method: org.openremote.model.
|
|
380
|
+
* HTTP GET /realm
|
|
381
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
488
382
|
*/
|
|
489
|
-
|
|
490
|
-
realm?: string;
|
|
491
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
383
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
492
384
|
/**
|
|
493
|
-
* HTTP GET /
|
|
494
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP GET /realm/accessible
|
|
386
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
495
387
|
*/
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
388
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
389
|
+
/**
|
|
390
|
+
* HTTP DELETE /realm/{name}
|
|
391
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
392
|
+
*/
|
|
393
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
394
|
+
/**
|
|
395
|
+
* HTTP GET /realm/{name}
|
|
396
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
397
|
+
*/
|
|
398
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
399
|
+
/**
|
|
400
|
+
* HTTP PUT /realm/{name}
|
|
401
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
402
|
+
*/
|
|
403
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
404
|
+
}
|
|
405
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
406
|
+
protected httpClient: HttpClient<O>;
|
|
407
|
+
constructor(httpClient: HttpClient<O>);
|
|
408
|
+
/**
|
|
409
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
410
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
411
|
+
*/
|
|
412
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
413
|
+
/**
|
|
414
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
415
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
416
|
+
*/
|
|
417
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
500
418
|
}
|
|
501
419
|
export declare class AssetModelResourceClient<O> {
|
|
502
420
|
protected httpClient: HttpClient<O>;
|
|
@@ -543,161 +461,262 @@ export declare class AssetModelResourceClient<O> {
|
|
|
543
461
|
[index: string]: Model.ValueDescriptor;
|
|
544
462
|
}>;
|
|
545
463
|
}
|
|
546
|
-
export declare class
|
|
464
|
+
export declare class RulesResourceClient<O> {
|
|
547
465
|
protected httpClient: HttpClient<O>;
|
|
548
466
|
constructor(httpClient: HttpClient<O>);
|
|
549
467
|
/**
|
|
550
|
-
* HTTP POST /
|
|
551
|
-
* Java method: org.openremote.model.
|
|
468
|
+
* HTTP POST /rules
|
|
469
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
552
470
|
*/
|
|
553
|
-
|
|
471
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
554
472
|
/**
|
|
555
|
-
* HTTP GET /
|
|
556
|
-
* Java method: org.openremote.model.
|
|
473
|
+
* HTTP GET /rules
|
|
474
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
557
475
|
*/
|
|
558
|
-
|
|
476
|
+
getGlobalRulesets(queryParams?: {
|
|
477
|
+
language?: Model.RulesetLang[];
|
|
478
|
+
fullyPopulate?: boolean;
|
|
479
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
559
480
|
/**
|
|
560
|
-
* HTTP
|
|
561
|
-
* Java method: org.openremote.model.
|
|
481
|
+
* HTTP POST /rules/asset
|
|
482
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
562
483
|
*/
|
|
563
|
-
|
|
484
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
564
485
|
/**
|
|
565
|
-
* HTTP
|
|
566
|
-
* Java method: org.openremote.model.
|
|
486
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
487
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
567
488
|
*/
|
|
568
|
-
|
|
489
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
490
|
+
language?: Model.RulesetLang[];
|
|
491
|
+
fullyPopulate?: boolean;
|
|
492
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
493
|
+
/**
|
|
494
|
+
* HTTP DELETE /rules/asset/{id}
|
|
495
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
496
|
+
*/
|
|
497
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
498
|
+
/**
|
|
499
|
+
* HTTP GET /rules/asset/{id}
|
|
500
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
501
|
+
*/
|
|
502
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
503
|
+
/**
|
|
504
|
+
* HTTP PUT /rules/asset/{id}
|
|
505
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
506
|
+
*/
|
|
507
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
508
|
+
/**
|
|
509
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
510
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
511
|
+
*/
|
|
512
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
513
|
+
/**
|
|
514
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
515
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
516
|
+
*/
|
|
517
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
518
|
+
/**
|
|
519
|
+
* HTTP GET /rules/info/global
|
|
520
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
521
|
+
*/
|
|
522
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
523
|
+
/**
|
|
524
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
525
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
526
|
+
*/
|
|
527
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
528
|
+
/**
|
|
529
|
+
* HTTP POST /rules/realm
|
|
530
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
531
|
+
*/
|
|
532
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
533
|
+
/**
|
|
534
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
535
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
536
|
+
*/
|
|
537
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
538
|
+
language?: Model.RulesetLang[];
|
|
539
|
+
fullyPopulate?: boolean;
|
|
540
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
541
|
+
/**
|
|
542
|
+
* HTTP DELETE /rules/realm/{id}
|
|
543
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
544
|
+
*/
|
|
545
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
546
|
+
/**
|
|
547
|
+
* HTTP GET /rules/realm/{id}
|
|
548
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
549
|
+
*/
|
|
550
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
551
|
+
/**
|
|
552
|
+
* HTTP PUT /rules/realm/{id}
|
|
553
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
554
|
+
*/
|
|
555
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
556
|
+
/**
|
|
557
|
+
* HTTP DELETE /rules/{id}
|
|
558
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
559
|
+
*/
|
|
560
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
561
|
+
/**
|
|
562
|
+
* HTTP GET /rules/{id}
|
|
563
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
564
|
+
*/
|
|
565
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
566
|
+
/**
|
|
567
|
+
* HTTP PUT /rules/{id}
|
|
568
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
569
|
+
*/
|
|
570
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
569
571
|
}
|
|
570
|
-
export declare class
|
|
572
|
+
export declare class AssetResourceClient<O> {
|
|
571
573
|
protected httpClient: HttpClient<O>;
|
|
572
574
|
constructor(httpClient: HttpClient<O>);
|
|
573
575
|
/**
|
|
574
|
-
* HTTP POST /
|
|
575
|
-
* Java method: org.openremote.model.
|
|
576
|
+
* HTTP POST /asset
|
|
577
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
576
578
|
*/
|
|
577
|
-
create(
|
|
579
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
578
580
|
/**
|
|
579
|
-
* HTTP
|
|
580
|
-
* Java method: org.openremote.model.
|
|
581
|
+
* HTTP DELETE /asset
|
|
582
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
581
583
|
*/
|
|
582
|
-
|
|
584
|
+
delete(queryParams?: {
|
|
585
|
+
assetId?: string[];
|
|
586
|
+
}, options?: O): RestResponse<void>;
|
|
583
587
|
/**
|
|
584
|
-
* HTTP
|
|
585
|
-
* Java method: org.openremote.model.
|
|
588
|
+
* HTTP PUT /asset/attributes
|
|
589
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
590
|
+
*/
|
|
591
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
592
|
+
/**
|
|
593
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
594
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
595
|
+
*/
|
|
596
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
597
|
+
/**
|
|
598
|
+
* HTTP DELETE /asset/parent
|
|
599
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
600
|
+
*/
|
|
601
|
+
updateNoneParent(queryParams?: {
|
|
602
|
+
assetIds?: string[];
|
|
603
|
+
}, options?: O): RestResponse<void>;
|
|
604
|
+
/**
|
|
605
|
+
* HTTP GET /asset/partial/{assetId}
|
|
606
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
607
|
+
*/
|
|
608
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
609
|
+
/**
|
|
610
|
+
* HTTP POST /asset/query
|
|
611
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
612
|
+
*/
|
|
613
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
614
|
+
/**
|
|
615
|
+
* HTTP GET /asset/user/current
|
|
616
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
586
617
|
*/
|
|
587
|
-
|
|
618
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
588
619
|
/**
|
|
589
|
-
* HTTP
|
|
590
|
-
* Java method: org.openremote.model.
|
|
620
|
+
* HTTP POST /asset/user/link
|
|
621
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
591
622
|
*/
|
|
592
|
-
|
|
623
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
593
624
|
/**
|
|
594
|
-
* HTTP GET /
|
|
595
|
-
* Java method: org.openremote.model.
|
|
625
|
+
* HTTP GET /asset/user/link
|
|
626
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
596
627
|
*/
|
|
597
|
-
|
|
628
|
+
getUserAssetLinks(queryParams?: {
|
|
629
|
+
realm?: string;
|
|
630
|
+
userId?: string;
|
|
631
|
+
assetId?: string;
|
|
632
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
598
633
|
/**
|
|
599
|
-
* HTTP
|
|
600
|
-
* Java method: org.openremote.model.
|
|
634
|
+
* HTTP POST /asset/user/link/delete
|
|
635
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
601
636
|
*/
|
|
602
|
-
|
|
603
|
-
}
|
|
604
|
-
export declare class MapResourceClient<O> {
|
|
605
|
-
protected httpClient: HttpClient<O>;
|
|
606
|
-
constructor(httpClient: HttpClient<O>);
|
|
637
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
607
638
|
/**
|
|
608
|
-
* HTTP
|
|
609
|
-
* Java method: org.openremote.model.
|
|
639
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
640
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
610
641
|
*/
|
|
611
|
-
|
|
612
|
-
[id: string]: unknown;
|
|
613
|
-
}>;
|
|
642
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
614
643
|
/**
|
|
615
|
-
* HTTP
|
|
616
|
-
* Java method: org.openremote.model.
|
|
644
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
645
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
617
646
|
*/
|
|
618
|
-
|
|
619
|
-
[id: string]: unknown;
|
|
620
|
-
}>;
|
|
647
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
621
648
|
/**
|
|
622
|
-
* HTTP
|
|
623
|
-
* Java method: org.openremote.model.
|
|
649
|
+
* HTTP GET /asset/{assetId}
|
|
650
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
624
651
|
*/
|
|
625
|
-
|
|
626
|
-
[id: string]: unknown;
|
|
627
|
-
}>;
|
|
652
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
628
653
|
/**
|
|
629
|
-
* HTTP
|
|
630
|
-
* Java method: org.openremote.model.
|
|
654
|
+
* HTTP PUT /asset/{assetId}
|
|
655
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
631
656
|
*/
|
|
632
|
-
|
|
633
|
-
[id: string]: unknown;
|
|
634
|
-
}>;
|
|
657
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
635
658
|
/**
|
|
636
|
-
* HTTP
|
|
637
|
-
* Java method: org.openremote.model.
|
|
659
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
660
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
638
661
|
*/
|
|
639
|
-
|
|
640
|
-
[id: string]: unknown;
|
|
641
|
-
}>;
|
|
662
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
642
663
|
/**
|
|
643
|
-
* HTTP
|
|
644
|
-
* Java method: org.openremote.model.
|
|
664
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
665
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
645
666
|
*/
|
|
646
|
-
|
|
667
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
647
668
|
/**
|
|
648
|
-
* HTTP
|
|
649
|
-
* Java method: org.openremote.model.
|
|
669
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
670
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
650
671
|
*/
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
}, options?: O): RestResponse<
|
|
654
|
-
[id: string]: unknown;
|
|
655
|
-
}>;
|
|
672
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
673
|
+
assetIds?: string[];
|
|
674
|
+
}, options?: O): RestResponse<void>;
|
|
656
675
|
}
|
|
657
|
-
export declare class
|
|
676
|
+
export declare class GatewayClientResourceClient<O> {
|
|
658
677
|
protected httpClient: HttpClient<O>;
|
|
659
678
|
constructor(httpClient: HttpClient<O>);
|
|
660
679
|
/**
|
|
661
|
-
* HTTP
|
|
662
|
-
* Java method: org.openremote.model.
|
|
680
|
+
* HTTP DELETE /gateway/connection
|
|
681
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
663
682
|
*/
|
|
664
|
-
|
|
683
|
+
deleteConnections(queryParams?: {
|
|
684
|
+
realm?: string[];
|
|
685
|
+
}, options?: O): RestResponse<void>;
|
|
665
686
|
/**
|
|
666
|
-
* HTTP
|
|
667
|
-
* Java method: org.openremote.model.
|
|
687
|
+
* HTTP GET /gateway/connection
|
|
688
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
668
689
|
*/
|
|
669
|
-
|
|
690
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
670
691
|
/**
|
|
671
|
-
* HTTP
|
|
672
|
-
* Java method: org.openremote.model.
|
|
692
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
693
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
673
694
|
*/
|
|
674
|
-
|
|
675
|
-
path?: string;
|
|
676
|
-
}, options?: O): RestResponse<string>;
|
|
695
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
677
696
|
/**
|
|
678
|
-
* HTTP GET /
|
|
679
|
-
* Java method: org.openremote.model.
|
|
697
|
+
* HTTP GET /gateway/connection/{realm}
|
|
698
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
680
699
|
*/
|
|
681
|
-
|
|
682
|
-
}
|
|
683
|
-
export declare class FlowResourceClient<O> {
|
|
684
|
-
protected httpClient: HttpClient<O>;
|
|
685
|
-
constructor(httpClient: HttpClient<O>);
|
|
700
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
686
701
|
/**
|
|
687
|
-
* HTTP
|
|
688
|
-
* Java method: org.openremote.model.
|
|
702
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
703
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
689
704
|
*/
|
|
690
|
-
|
|
705
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
691
706
|
/**
|
|
692
|
-
* HTTP GET /
|
|
693
|
-
* Java method: org.openremote.model.
|
|
707
|
+
* HTTP GET /gateway/status/{realm}
|
|
708
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
694
709
|
*/
|
|
695
|
-
|
|
710
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
711
|
+
}
|
|
712
|
+
export declare class ConsoleResourceClient<O> {
|
|
713
|
+
protected httpClient: HttpClient<O>;
|
|
714
|
+
constructor(httpClient: HttpClient<O>);
|
|
696
715
|
/**
|
|
697
|
-
* HTTP
|
|
698
|
-
* Java method: org.openremote.model.
|
|
716
|
+
* HTTP POST /console/register
|
|
717
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
699
718
|
*/
|
|
700
|
-
|
|
719
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
701
720
|
}
|
|
702
721
|
export declare class UserResourceClient<O> {
|
|
703
722
|
protected httpClient: HttpClient<O>;
|
|
@@ -857,70 +876,51 @@ export declare class NotificationResourceClient<O> {
|
|
|
857
876
|
targetId?: string;
|
|
858
877
|
}, options?: O): RestResponse<void>;
|
|
859
878
|
}
|
|
860
|
-
export declare class AppResourceClient<O> {
|
|
861
|
-
protected httpClient: HttpClient<O>;
|
|
862
|
-
constructor(httpClient: HttpClient<O>);
|
|
863
|
-
/**
|
|
864
|
-
* HTTP GET /apps
|
|
865
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
866
|
-
*/
|
|
867
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
868
|
-
/**
|
|
869
|
-
* HTTP GET /apps/consoleConfig
|
|
870
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
871
|
-
*/
|
|
872
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
873
|
-
/**
|
|
874
|
-
* HTTP GET /apps/info
|
|
875
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
876
|
-
*/
|
|
877
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
878
|
-
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected
|
|
881
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
882
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
883
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
882
884
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
883
885
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
884
|
-
protected
|
|
885
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
886
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
886
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
887
887
|
protected _statusResource: AxiosStatusResourceClient;
|
|
888
|
-
protected
|
|
889
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
890
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
891
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
892
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
893
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
888
|
+
protected _appResource: AxiosAppResourceClient;
|
|
894
889
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
895
|
-
protected
|
|
890
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
896
891
|
protected _mapResource: AxiosMapResourceClient;
|
|
897
|
-
protected
|
|
898
|
-
protected
|
|
892
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
893
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
894
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
895
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
896
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
897
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
898
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
899
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
899
900
|
protected _userResource: AxiosUserResourceClient;
|
|
900
901
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
901
|
-
protected _appResource: AxiosAppResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get
|
|
903
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
904
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
905
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
904
906
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
905
907
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
906
|
-
get
|
|
907
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
908
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
908
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
909
909
|
get StatusResource(): AxiosStatusResourceClient;
|
|
910
|
-
get
|
|
911
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
912
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
913
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
914
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
915
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
910
|
+
get AppResource(): AxiosAppResourceClient;
|
|
916
911
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
917
|
-
get
|
|
912
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
918
913
|
get MapResource(): AxiosMapResourceClient;
|
|
919
|
-
get
|
|
920
|
-
get
|
|
914
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
915
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
916
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
917
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
918
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
919
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
920
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
921
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
921
922
|
get UserResource(): AxiosUserResourceClient;
|
|
922
923
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
923
|
-
get AppResource(): AxiosAppResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,58 +928,61 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
949
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
959
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
|
+
}
|
|
961
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
959
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
963
|
}
|
|
961
964
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
962
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
966
|
}
|
|
964
|
-
export declare class
|
|
967
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
965
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
969
|
}
|
|
967
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
968
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
972
|
}
|
|
970
|
-
export declare class
|
|
973
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
971
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
975
|
}
|
|
973
|
-
export declare class
|
|
976
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
974
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
978
|
}
|
|
976
|
-
export declare class
|
|
979
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
977
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
981
|
}
|
|
979
|
-
export declare class
|
|
982
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
980
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
984
|
}
|
|
982
|
-
export declare class
|
|
985
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
983
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
987
|
}
|
|
985
988
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -988,6 +991,3 @@ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.Ax
|
|
|
988
991
|
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
989
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
993
|
}
|
|
991
|
-
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
992
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
|
-
}
|