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