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