@openremote/rest 1.8.0-snapshot.20250818122707 → 1.8.0-snapshot.20250818131019
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 +454 -454
- 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,97 +9,31 @@ 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 DELETE /gateway/connection
|
|
17
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
18
|
-
*/
|
|
19
|
-
deleteConnections(queryParams?: {
|
|
20
|
-
realm?: string[];
|
|
21
|
-
}, options?: O): RestResponse<void>;
|
|
22
|
-
/**
|
|
23
|
-
* HTTP GET /gateway/connection
|
|
24
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
25
|
-
*/
|
|
26
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
27
|
-
/**
|
|
28
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
30
|
-
*/
|
|
31
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
32
|
-
/**
|
|
33
|
-
* HTTP GET /gateway/connection/{realm}
|
|
34
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
35
|
-
*/
|
|
36
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
37
|
-
/**
|
|
38
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
39
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
40
|
-
*/
|
|
41
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
42
|
-
/**
|
|
43
|
-
* HTTP GET /gateway/status/{realm}
|
|
44
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
45
|
-
*/
|
|
46
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
47
|
-
}
|
|
48
|
-
export declare class SyslogResourceClient<O> {
|
|
49
|
-
protected httpClient: HttpClient<O>;
|
|
50
|
-
constructor(httpClient: HttpClient<O>);
|
|
51
|
-
/**
|
|
52
|
-
* HTTP GET /syslog/config
|
|
53
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
54
|
-
*/
|
|
55
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
56
|
-
/**
|
|
57
|
-
* HTTP PUT /syslog/config
|
|
58
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
59
|
-
*/
|
|
60
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
61
|
-
/**
|
|
62
|
-
* HTTP DELETE /syslog/event
|
|
63
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
64
|
-
*/
|
|
65
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
66
|
-
/**
|
|
67
|
-
* HTTP GET /syslog/event
|
|
68
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
69
|
-
*/
|
|
70
|
-
getEvents(queryParams?: {
|
|
71
|
-
level?: Model.SyslogLevel;
|
|
72
|
-
per_page?: number;
|
|
73
|
-
page?: number;
|
|
74
|
-
from?: number;
|
|
75
|
-
to?: number;
|
|
76
|
-
category?: Model.SyslogCategory[];
|
|
77
|
-
subCategory?: string[];
|
|
78
|
-
}, options?: O): RestResponse<any>;
|
|
79
|
-
}
|
|
80
|
-
export declare class ProvisioningResourceClient<O> {
|
|
12
|
+
export declare class ConfigurationResourceClient<O> {
|
|
81
13
|
protected httpClient: HttpClient<O>;
|
|
82
14
|
constructor(httpClient: HttpClient<O>);
|
|
83
15
|
/**
|
|
84
|
-
* HTTP
|
|
85
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /configuration/manager
|
|
17
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
86
18
|
*/
|
|
87
|
-
|
|
19
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
88
20
|
/**
|
|
89
|
-
* HTTP
|
|
90
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /configuration/manager
|
|
22
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
91
23
|
*/
|
|
92
|
-
|
|
24
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
93
25
|
/**
|
|
94
|
-
* HTTP
|
|
95
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP POST /configuration/manager/file
|
|
27
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
96
28
|
*/
|
|
97
|
-
|
|
29
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
30
|
+
path?: string;
|
|
31
|
+
}, options?: O): RestResponse<string>;
|
|
98
32
|
/**
|
|
99
|
-
* HTTP
|
|
100
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
34
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
101
35
|
*/
|
|
102
|
-
|
|
36
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
103
37
|
}
|
|
104
38
|
export declare class GatewayServiceResourceClient<O> {
|
|
105
39
|
protected httpClient: HttpClient<O>;
|
|
@@ -238,39 +172,95 @@ export declare class RulesResourceClient<O> {
|
|
|
238
172
|
*/
|
|
239
173
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
240
174
|
}
|
|
241
|
-
export declare class
|
|
175
|
+
export declare class AppResourceClient<O> {
|
|
242
176
|
protected httpClient: HttpClient<O>;
|
|
243
177
|
constructor(httpClient: HttpClient<O>);
|
|
244
178
|
/**
|
|
245
|
-
* HTTP
|
|
246
|
-
* Java method: org.openremote.model.
|
|
179
|
+
* HTTP GET /apps
|
|
180
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
247
181
|
*/
|
|
248
|
-
|
|
182
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
249
183
|
/**
|
|
250
|
-
* HTTP GET /
|
|
251
|
-
* Java method: org.openremote.model.
|
|
184
|
+
* HTTP GET /apps/consoleConfig
|
|
185
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
252
186
|
*/
|
|
253
|
-
|
|
187
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
254
188
|
/**
|
|
255
|
-
* HTTP GET /
|
|
256
|
-
* Java method: org.openremote.model.
|
|
189
|
+
* HTTP GET /apps/info
|
|
190
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
257
191
|
*/
|
|
258
|
-
|
|
192
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
193
|
+
}
|
|
194
|
+
export declare class AssetModelResourceClient<O> {
|
|
195
|
+
protected httpClient: HttpClient<O>;
|
|
196
|
+
constructor(httpClient: HttpClient<O>);
|
|
259
197
|
/**
|
|
260
|
-
* HTTP
|
|
261
|
-
* Java method: org.openremote.model.
|
|
198
|
+
* HTTP GET /model/assetDescriptors
|
|
199
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
262
200
|
*/
|
|
263
|
-
|
|
201
|
+
getAssetDescriptors(queryParams?: {
|
|
202
|
+
parentId?: string;
|
|
203
|
+
parentType?: string;
|
|
204
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
264
205
|
/**
|
|
265
|
-
* HTTP GET /
|
|
266
|
-
* Java method: org.openremote.model.
|
|
206
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
207
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
267
208
|
*/
|
|
268
|
-
|
|
209
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
210
|
+
parentId?: string;
|
|
211
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
269
212
|
/**
|
|
270
|
-
* HTTP
|
|
271
|
-
* Java method: org.openremote.model.
|
|
213
|
+
* HTTP GET /model/assetInfos
|
|
214
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
272
215
|
*/
|
|
273
|
-
|
|
216
|
+
getAssetInfos(queryParams?: {
|
|
217
|
+
parentId?: string;
|
|
218
|
+
parentType?: string;
|
|
219
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
220
|
+
/**
|
|
221
|
+
* HTTP GET /model/metaItemDescriptors
|
|
222
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
223
|
+
*/
|
|
224
|
+
getMetaItemDescriptors(queryParams?: {
|
|
225
|
+
parentId?: string;
|
|
226
|
+
}, options?: O): RestResponse<{
|
|
227
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
228
|
+
}>;
|
|
229
|
+
/**
|
|
230
|
+
* HTTP GET /model/valueDescriptors
|
|
231
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
232
|
+
*/
|
|
233
|
+
getValueDescriptors(queryParams?: {
|
|
234
|
+
parentId?: string;
|
|
235
|
+
}, options?: O): RestResponse<{
|
|
236
|
+
[index: string]: Model.ValueDescriptor;
|
|
237
|
+
}>;
|
|
238
|
+
}
|
|
239
|
+
export declare class AgentResourceClient<O> {
|
|
240
|
+
protected httpClient: HttpClient<O>;
|
|
241
|
+
constructor(httpClient: HttpClient<O>);
|
|
242
|
+
/**
|
|
243
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
244
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
245
|
+
*/
|
|
246
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
247
|
+
realm?: string;
|
|
248
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
249
|
+
/**
|
|
250
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
251
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
252
|
+
*/
|
|
253
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
254
|
+
realm?: string;
|
|
255
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
256
|
+
/**
|
|
257
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
258
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
259
|
+
*/
|
|
260
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
261
|
+
parentId?: string;
|
|
262
|
+
realm?: string;
|
|
263
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
274
264
|
}
|
|
275
265
|
export declare class ConsoleResourceClient<O> {
|
|
276
266
|
protected httpClient: HttpClient<O>;
|
|
@@ -281,85 +271,91 @@ export declare class ConsoleResourceClient<O> {
|
|
|
281
271
|
*/
|
|
282
272
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
283
273
|
}
|
|
284
|
-
export declare class
|
|
274
|
+
export declare class StatusResourceClient<O> {
|
|
285
275
|
protected httpClient: HttpClient<O>;
|
|
286
276
|
constructor(httpClient: HttpClient<O>);
|
|
287
277
|
/**
|
|
288
|
-
* HTTP GET /
|
|
289
|
-
* Java method: org.openremote.model.
|
|
290
|
-
*/
|
|
291
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP PUT /configuration/manager
|
|
294
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
295
|
-
*/
|
|
296
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
297
|
-
/**
|
|
298
|
-
* HTTP POST /configuration/manager/file
|
|
299
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
278
|
+
* HTTP GET /health
|
|
279
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
300
280
|
*/
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
}
|
|
281
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
282
|
+
[index: string]: any;
|
|
283
|
+
}>;
|
|
304
284
|
/**
|
|
305
|
-
* HTTP GET /
|
|
306
|
-
* Java method: org.openremote.model.
|
|
285
|
+
* HTTP GET /info
|
|
286
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
307
287
|
*/
|
|
308
|
-
|
|
288
|
+
getInfo(options?: O): RestResponse<{
|
|
289
|
+
[index: string]: any;
|
|
290
|
+
}>;
|
|
309
291
|
}
|
|
310
|
-
export declare class
|
|
292
|
+
export declare class DashboardResourceClient<O> {
|
|
311
293
|
protected httpClient: HttpClient<O>;
|
|
312
294
|
constructor(httpClient: HttpClient<O>);
|
|
313
295
|
/**
|
|
314
|
-
* HTTP
|
|
315
|
-
* Java method: org.openremote.model.
|
|
296
|
+
* HTTP POST /dashboard
|
|
297
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
316
298
|
*/
|
|
317
|
-
|
|
318
|
-
id?: number;
|
|
319
|
-
type?: string;
|
|
320
|
-
from?: number;
|
|
321
|
-
to?: number;
|
|
322
|
-
realmId?: string;
|
|
323
|
-
userId?: string;
|
|
324
|
-
assetId?: string;
|
|
325
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
299
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
326
300
|
/**
|
|
327
|
-
* HTTP
|
|
328
|
-
* Java method: org.openremote.model.
|
|
301
|
+
* HTTP PUT /dashboard
|
|
302
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
329
303
|
*/
|
|
330
|
-
|
|
331
|
-
id?: number;
|
|
332
|
-
type?: string;
|
|
333
|
-
from?: number;
|
|
334
|
-
to?: number;
|
|
335
|
-
realmId?: string;
|
|
336
|
-
userId?: string;
|
|
337
|
-
assetId?: string;
|
|
338
|
-
}, options?: O): RestResponse<void>;
|
|
304
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
339
305
|
/**
|
|
340
|
-
* HTTP
|
|
341
|
-
* Java method: org.openremote.model.
|
|
306
|
+
* HTTP GET /dashboard/all/{realm}
|
|
307
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
342
308
|
*/
|
|
343
|
-
|
|
309
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
344
310
|
/**
|
|
345
|
-
* HTTP
|
|
346
|
-
* Java method: org.openremote.model.
|
|
311
|
+
* HTTP POST /dashboard/query
|
|
312
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
347
313
|
*/
|
|
348
|
-
|
|
314
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
349
315
|
/**
|
|
350
|
-
* HTTP
|
|
351
|
-
* Java method: org.openremote.model.
|
|
316
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
317
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
352
318
|
*/
|
|
353
|
-
|
|
354
|
-
targetId?: string;
|
|
355
|
-
}, options?: O): RestResponse<void>;
|
|
319
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
356
320
|
/**
|
|
357
|
-
* HTTP
|
|
358
|
-
* Java method: org.openremote.model.
|
|
321
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
322
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
359
323
|
*/
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
324
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
325
|
+
}
|
|
326
|
+
export declare class RealmResourceClient<O> {
|
|
327
|
+
protected httpClient: HttpClient<O>;
|
|
328
|
+
constructor(httpClient: HttpClient<O>);
|
|
329
|
+
/**
|
|
330
|
+
* HTTP POST /realm
|
|
331
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
332
|
+
*/
|
|
333
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
334
|
+
/**
|
|
335
|
+
* HTTP GET /realm
|
|
336
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
337
|
+
*/
|
|
338
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
339
|
+
/**
|
|
340
|
+
* HTTP GET /realm/accessible
|
|
341
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
342
|
+
*/
|
|
343
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
344
|
+
/**
|
|
345
|
+
* HTTP DELETE /realm/{name}
|
|
346
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
347
|
+
*/
|
|
348
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
349
|
+
/**
|
|
350
|
+
* HTTP GET /realm/{name}
|
|
351
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
352
|
+
*/
|
|
353
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
354
|
+
/**
|
|
355
|
+
* HTTP PUT /realm/{name}
|
|
356
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
357
|
+
*/
|
|
358
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
363
359
|
}
|
|
364
360
|
export declare class AssetDatapointResourceClient<O> {
|
|
365
361
|
protected httpClient: HttpClient<O>;
|
|
@@ -387,6 +383,205 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
387
383
|
*/
|
|
388
384
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
389
385
|
}
|
|
386
|
+
export declare class ProvisioningResourceClient<O> {
|
|
387
|
+
protected httpClient: HttpClient<O>;
|
|
388
|
+
constructor(httpClient: HttpClient<O>);
|
|
389
|
+
/**
|
|
390
|
+
* HTTP POST /provisioning
|
|
391
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
392
|
+
*/
|
|
393
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
394
|
+
/**
|
|
395
|
+
* HTTP GET /provisioning
|
|
396
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
397
|
+
*/
|
|
398
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
399
|
+
/**
|
|
400
|
+
* HTTP DELETE /provisioning/{id}
|
|
401
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
402
|
+
*/
|
|
403
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
404
|
+
/**
|
|
405
|
+
* HTTP PUT /provisioning/{id}
|
|
406
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
407
|
+
*/
|
|
408
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
409
|
+
}
|
|
410
|
+
export declare class NotificationResourceClient<O> {
|
|
411
|
+
protected httpClient: HttpClient<O>;
|
|
412
|
+
constructor(httpClient: HttpClient<O>);
|
|
413
|
+
/**
|
|
414
|
+
* HTTP GET /notification
|
|
415
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
416
|
+
*/
|
|
417
|
+
getNotifications(queryParams?: {
|
|
418
|
+
id?: number;
|
|
419
|
+
type?: string;
|
|
420
|
+
from?: number;
|
|
421
|
+
to?: number;
|
|
422
|
+
realmId?: string;
|
|
423
|
+
userId?: string;
|
|
424
|
+
assetId?: string;
|
|
425
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
426
|
+
/**
|
|
427
|
+
* HTTP DELETE /notification
|
|
428
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
429
|
+
*/
|
|
430
|
+
removeNotifications(queryParams?: {
|
|
431
|
+
id?: number;
|
|
432
|
+
type?: string;
|
|
433
|
+
from?: number;
|
|
434
|
+
to?: number;
|
|
435
|
+
realmId?: string;
|
|
436
|
+
userId?: string;
|
|
437
|
+
assetId?: string;
|
|
438
|
+
}, options?: O): RestResponse<void>;
|
|
439
|
+
/**
|
|
440
|
+
* HTTP POST /notification/alert
|
|
441
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
442
|
+
*/
|
|
443
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
444
|
+
/**
|
|
445
|
+
* HTTP DELETE /notification/{notificationId}
|
|
446
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
447
|
+
*/
|
|
448
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
449
|
+
/**
|
|
450
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
451
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
452
|
+
*/
|
|
453
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
454
|
+
targetId?: string;
|
|
455
|
+
}, options?: O): RestResponse<void>;
|
|
456
|
+
/**
|
|
457
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
458
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
459
|
+
*/
|
|
460
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
461
|
+
targetId?: string;
|
|
462
|
+
}, options?: O): RestResponse<void>;
|
|
463
|
+
}
|
|
464
|
+
export declare class SyslogResourceClient<O> {
|
|
465
|
+
protected httpClient: HttpClient<O>;
|
|
466
|
+
constructor(httpClient: HttpClient<O>);
|
|
467
|
+
/**
|
|
468
|
+
* HTTP GET /syslog/config
|
|
469
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
470
|
+
*/
|
|
471
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
472
|
+
/**
|
|
473
|
+
* HTTP PUT /syslog/config
|
|
474
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
475
|
+
*/
|
|
476
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
477
|
+
/**
|
|
478
|
+
* HTTP DELETE /syslog/event
|
|
479
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
480
|
+
*/
|
|
481
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
482
|
+
/**
|
|
483
|
+
* HTTP GET /syslog/event
|
|
484
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
485
|
+
*/
|
|
486
|
+
getEvents(queryParams?: {
|
|
487
|
+
level?: Model.SyslogLevel;
|
|
488
|
+
per_page?: number;
|
|
489
|
+
page?: number;
|
|
490
|
+
from?: number;
|
|
491
|
+
to?: number;
|
|
492
|
+
category?: Model.SyslogCategory[];
|
|
493
|
+
subCategory?: string[];
|
|
494
|
+
}, options?: O): RestResponse<any>;
|
|
495
|
+
}
|
|
496
|
+
export declare class GatewayClientResourceClient<O> {
|
|
497
|
+
protected httpClient: HttpClient<O>;
|
|
498
|
+
constructor(httpClient: HttpClient<O>);
|
|
499
|
+
/**
|
|
500
|
+
* HTTP DELETE /gateway/connection
|
|
501
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
502
|
+
*/
|
|
503
|
+
deleteConnections(queryParams?: {
|
|
504
|
+
realm?: string[];
|
|
505
|
+
}, options?: O): RestResponse<void>;
|
|
506
|
+
/**
|
|
507
|
+
* HTTP GET /gateway/connection
|
|
508
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
509
|
+
*/
|
|
510
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
511
|
+
/**
|
|
512
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
513
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
514
|
+
*/
|
|
515
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
516
|
+
/**
|
|
517
|
+
* HTTP GET /gateway/connection/{realm}
|
|
518
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
519
|
+
*/
|
|
520
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
521
|
+
/**
|
|
522
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
523
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
524
|
+
*/
|
|
525
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
526
|
+
/**
|
|
527
|
+
* HTTP GET /gateway/status/{realm}
|
|
528
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
529
|
+
*/
|
|
530
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
531
|
+
}
|
|
532
|
+
export declare class AlarmResourceClient<O> {
|
|
533
|
+
protected httpClient: HttpClient<O>;
|
|
534
|
+
constructor(httpClient: HttpClient<O>);
|
|
535
|
+
/**
|
|
536
|
+
* HTTP POST /alarm
|
|
537
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
538
|
+
*/
|
|
539
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
540
|
+
assetIds?: string[];
|
|
541
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
542
|
+
/**
|
|
543
|
+
* HTTP GET /alarm
|
|
544
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
545
|
+
*/
|
|
546
|
+
getAlarms(queryParams?: {
|
|
547
|
+
realm?: string;
|
|
548
|
+
status?: Model.AlarmStatus;
|
|
549
|
+
assetId?: string;
|
|
550
|
+
assigneeId?: string;
|
|
551
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
552
|
+
/**
|
|
553
|
+
* HTTP DELETE /alarm
|
|
554
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
555
|
+
*/
|
|
556
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
557
|
+
/**
|
|
558
|
+
* HTTP PUT /alarm/assets
|
|
559
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
560
|
+
*/
|
|
561
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
562
|
+
/**
|
|
563
|
+
* HTTP GET /alarm/{alarmId}
|
|
564
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
565
|
+
*/
|
|
566
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
567
|
+
/**
|
|
568
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
569
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
570
|
+
*/
|
|
571
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
572
|
+
/**
|
|
573
|
+
* HTTP PUT /alarm/{alarmId}
|
|
574
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
575
|
+
*/
|
|
576
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
577
|
+
/**
|
|
578
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
579
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
580
|
+
*/
|
|
581
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
582
|
+
realm?: string;
|
|
583
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
584
|
+
}
|
|
390
585
|
export declare class UserResourceClient<O> {
|
|
391
586
|
protected httpClient: HttpClient<O>;
|
|
392
587
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -511,58 +706,77 @@ export declare class UserResourceClient<O> {
|
|
|
511
706
|
*/
|
|
512
707
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
513
708
|
}
|
|
514
|
-
export declare class
|
|
709
|
+
export declare class FlowResourceClient<O> {
|
|
515
710
|
protected httpClient: HttpClient<O>;
|
|
516
711
|
constructor(httpClient: HttpClient<O>);
|
|
517
712
|
/**
|
|
518
|
-
* HTTP
|
|
519
|
-
* Java method: org.openremote.model.
|
|
713
|
+
* HTTP GET /flow
|
|
714
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
520
715
|
*/
|
|
521
|
-
|
|
522
|
-
assetIds?: string[];
|
|
523
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
716
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
524
717
|
/**
|
|
525
|
-
* HTTP GET /
|
|
526
|
-
* Java method: org.openremote.model.
|
|
718
|
+
* HTTP GET /flow/{name}
|
|
719
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
527
720
|
*/
|
|
528
|
-
|
|
529
|
-
realm?: string;
|
|
530
|
-
status?: Model.AlarmStatus;
|
|
531
|
-
assetId?: string;
|
|
532
|
-
assigneeId?: string;
|
|
533
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
721
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
534
722
|
/**
|
|
535
|
-
* HTTP
|
|
536
|
-
* Java method: org.openremote.model.
|
|
723
|
+
* HTTP GET /flow/{type}
|
|
724
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
537
725
|
*/
|
|
538
|
-
|
|
726
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
727
|
+
}
|
|
728
|
+
export declare class MapResourceClient<O> {
|
|
729
|
+
protected httpClient: HttpClient<O>;
|
|
730
|
+
constructor(httpClient: HttpClient<O>);
|
|
539
731
|
/**
|
|
540
|
-
* HTTP
|
|
541
|
-
* Java method: org.openremote.model.
|
|
732
|
+
* HTTP GET /map
|
|
733
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
542
734
|
*/
|
|
543
|
-
|
|
735
|
+
getSettings(options?: O): RestResponse<{
|
|
736
|
+
[id: string]: unknown;
|
|
737
|
+
}>;
|
|
544
738
|
/**
|
|
545
|
-
* HTTP
|
|
546
|
-
* Java method: org.openremote.model.
|
|
739
|
+
* HTTP PUT /map
|
|
740
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
547
741
|
*/
|
|
548
|
-
|
|
742
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
743
|
+
[id: string]: unknown;
|
|
744
|
+
}>;
|
|
549
745
|
/**
|
|
550
|
-
* HTTP DELETE /
|
|
551
|
-
* Java method: org.openremote.model.
|
|
746
|
+
* HTTP DELETE /map/deleteMap
|
|
747
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
552
748
|
*/
|
|
553
|
-
|
|
749
|
+
deleteMap(options?: O): RestResponse<{
|
|
750
|
+
[id: string]: unknown;
|
|
751
|
+
}>;
|
|
554
752
|
/**
|
|
555
|
-
* HTTP
|
|
556
|
-
* Java method: org.openremote.model.
|
|
753
|
+
* HTTP GET /map/getCustomMapInfo
|
|
754
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
557
755
|
*/
|
|
558
|
-
|
|
756
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
757
|
+
[id: string]: unknown;
|
|
758
|
+
}>;
|
|
559
759
|
/**
|
|
560
|
-
* HTTP GET /
|
|
561
|
-
* Java method: org.openremote.model.
|
|
760
|
+
* HTTP GET /map/js
|
|
761
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
562
762
|
*/
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
}
|
|
763
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
764
|
+
[id: string]: unknown;
|
|
765
|
+
}>;
|
|
766
|
+
/**
|
|
767
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
768
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
769
|
+
*/
|
|
770
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
771
|
+
/**
|
|
772
|
+
* HTTP POST /map/upload
|
|
773
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
774
|
+
*/
|
|
775
|
+
uploadMap(queryParams?: {
|
|
776
|
+
filename?: string;
|
|
777
|
+
}, options?: O): RestResponse<{
|
|
778
|
+
[id: string]: unknown;
|
|
779
|
+
}>;
|
|
566
780
|
}
|
|
567
781
|
export declare class AssetResourceClient<O> {
|
|
568
782
|
protected httpClient: HttpClient<O>;
|
|
@@ -668,51 +882,6 @@ export declare class AssetResourceClient<O> {
|
|
|
668
882
|
assetIds?: string[];
|
|
669
883
|
}, options?: O): RestResponse<void>;
|
|
670
884
|
}
|
|
671
|
-
export declare class AssetModelResourceClient<O> {
|
|
672
|
-
protected httpClient: HttpClient<O>;
|
|
673
|
-
constructor(httpClient: HttpClient<O>);
|
|
674
|
-
/**
|
|
675
|
-
* HTTP GET /model/assetDescriptors
|
|
676
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
677
|
-
*/
|
|
678
|
-
getAssetDescriptors(queryParams?: {
|
|
679
|
-
parentId?: string;
|
|
680
|
-
parentType?: string;
|
|
681
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
682
|
-
/**
|
|
683
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
684
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
685
|
-
*/
|
|
686
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
687
|
-
parentId?: string;
|
|
688
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
689
|
-
/**
|
|
690
|
-
* HTTP GET /model/assetInfos
|
|
691
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
692
|
-
*/
|
|
693
|
-
getAssetInfos(queryParams?: {
|
|
694
|
-
parentId?: string;
|
|
695
|
-
parentType?: string;
|
|
696
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
697
|
-
/**
|
|
698
|
-
* HTTP GET /model/metaItemDescriptors
|
|
699
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
700
|
-
*/
|
|
701
|
-
getMetaItemDescriptors(queryParams?: {
|
|
702
|
-
parentId?: string;
|
|
703
|
-
}, options?: O): RestResponse<{
|
|
704
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
705
|
-
}>;
|
|
706
|
-
/**
|
|
707
|
-
* HTTP GET /model/valueDescriptors
|
|
708
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
709
|
-
*/
|
|
710
|
-
getValueDescriptors(queryParams?: {
|
|
711
|
-
parentId?: string;
|
|
712
|
-
}, options?: O): RestResponse<{
|
|
713
|
-
[index: string]: Model.ValueDescriptor;
|
|
714
|
-
}>;
|
|
715
|
-
}
|
|
716
885
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
717
886
|
protected httpClient: HttpClient<O>;
|
|
718
887
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -727,220 +896,51 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
727
896
|
*/
|
|
728
897
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
729
898
|
}
|
|
730
|
-
export declare class AgentResourceClient<O> {
|
|
731
|
-
protected httpClient: HttpClient<O>;
|
|
732
|
-
constructor(httpClient: HttpClient<O>);
|
|
733
|
-
/**
|
|
734
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
735
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
736
|
-
*/
|
|
737
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
738
|
-
realm?: string;
|
|
739
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
740
|
-
/**
|
|
741
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
742
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
743
|
-
*/
|
|
744
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
745
|
-
realm?: string;
|
|
746
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
747
|
-
/**
|
|
748
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
749
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
750
|
-
*/
|
|
751
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
752
|
-
parentId?: string;
|
|
753
|
-
realm?: string;
|
|
754
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
755
|
-
}
|
|
756
|
-
export declare class FlowResourceClient<O> {
|
|
757
|
-
protected httpClient: HttpClient<O>;
|
|
758
|
-
constructor(httpClient: HttpClient<O>);
|
|
759
|
-
/**
|
|
760
|
-
* HTTP GET /flow
|
|
761
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
762
|
-
*/
|
|
763
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
764
|
-
/**
|
|
765
|
-
* HTTP GET /flow/{name}
|
|
766
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
767
|
-
*/
|
|
768
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
769
|
-
/**
|
|
770
|
-
* HTTP GET /flow/{type}
|
|
771
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
772
|
-
*/
|
|
773
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
774
|
-
}
|
|
775
|
-
export declare class AppResourceClient<O> {
|
|
776
|
-
protected httpClient: HttpClient<O>;
|
|
777
|
-
constructor(httpClient: HttpClient<O>);
|
|
778
|
-
/**
|
|
779
|
-
* HTTP GET /apps
|
|
780
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
781
|
-
*/
|
|
782
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
783
|
-
/**
|
|
784
|
-
* HTTP GET /apps/consoleConfig
|
|
785
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
786
|
-
*/
|
|
787
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
788
|
-
/**
|
|
789
|
-
* HTTP GET /apps/info
|
|
790
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
791
|
-
*/
|
|
792
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
793
|
-
}
|
|
794
|
-
export declare class StatusResourceClient<O> {
|
|
795
|
-
protected httpClient: HttpClient<O>;
|
|
796
|
-
constructor(httpClient: HttpClient<O>);
|
|
797
|
-
/**
|
|
798
|
-
* HTTP GET /health
|
|
799
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
800
|
-
*/
|
|
801
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
802
|
-
[index: string]: any;
|
|
803
|
-
}>;
|
|
804
|
-
/**
|
|
805
|
-
* HTTP GET /info
|
|
806
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
807
|
-
*/
|
|
808
|
-
getInfo(options?: O): RestResponse<{
|
|
809
|
-
[index: string]: any;
|
|
810
|
-
}>;
|
|
811
|
-
}
|
|
812
|
-
export declare class MapResourceClient<O> {
|
|
813
|
-
protected httpClient: HttpClient<O>;
|
|
814
|
-
constructor(httpClient: HttpClient<O>);
|
|
815
|
-
/**
|
|
816
|
-
* HTTP GET /map
|
|
817
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
818
|
-
*/
|
|
819
|
-
getSettings(options?: O): RestResponse<{
|
|
820
|
-
[id: string]: unknown;
|
|
821
|
-
}>;
|
|
822
|
-
/**
|
|
823
|
-
* HTTP PUT /map
|
|
824
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
825
|
-
*/
|
|
826
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
827
|
-
[id: string]: unknown;
|
|
828
|
-
}>;
|
|
829
|
-
/**
|
|
830
|
-
* HTTP DELETE /map/deleteMap
|
|
831
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
832
|
-
*/
|
|
833
|
-
deleteMap(options?: O): RestResponse<{
|
|
834
|
-
[id: string]: unknown;
|
|
835
|
-
}>;
|
|
836
|
-
/**
|
|
837
|
-
* HTTP GET /map/getCustomMapInfo
|
|
838
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
839
|
-
*/
|
|
840
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
841
|
-
[id: string]: unknown;
|
|
842
|
-
}>;
|
|
843
|
-
/**
|
|
844
|
-
* HTTP GET /map/js
|
|
845
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
846
|
-
*/
|
|
847
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
848
|
-
[id: string]: unknown;
|
|
849
|
-
}>;
|
|
850
|
-
/**
|
|
851
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
852
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
853
|
-
*/
|
|
854
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
855
|
-
/**
|
|
856
|
-
* HTTP POST /map/upload
|
|
857
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
858
|
-
*/
|
|
859
|
-
uploadMap(queryParams?: {
|
|
860
|
-
filename?: string;
|
|
861
|
-
}, options?: O): RestResponse<{
|
|
862
|
-
[id: string]: unknown;
|
|
863
|
-
}>;
|
|
864
|
-
}
|
|
865
|
-
export declare class DashboardResourceClient<O> {
|
|
866
|
-
protected httpClient: HttpClient<O>;
|
|
867
|
-
constructor(httpClient: HttpClient<O>);
|
|
868
|
-
/**
|
|
869
|
-
* HTTP POST /dashboard
|
|
870
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
871
|
-
*/
|
|
872
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
873
|
-
/**
|
|
874
|
-
* HTTP PUT /dashboard
|
|
875
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
876
|
-
*/
|
|
877
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
878
|
-
/**
|
|
879
|
-
* HTTP GET /dashboard/all/{realm}
|
|
880
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
881
|
-
*/
|
|
882
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
883
|
-
/**
|
|
884
|
-
* HTTP POST /dashboard/query
|
|
885
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
886
|
-
*/
|
|
887
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
888
|
-
/**
|
|
889
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
890
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
891
|
-
*/
|
|
892
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
893
|
-
/**
|
|
894
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
895
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
896
|
-
*/
|
|
897
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
898
|
-
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
902
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
903
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
901
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
904
902
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
905
903
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
906
|
-
protected
|
|
904
|
+
protected _appResource: AxiosAppResourceClient;
|
|
905
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
906
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
907
907
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
908
|
-
protected
|
|
909
|
-
protected
|
|
908
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
909
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
910
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
910
911
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
911
|
-
protected
|
|
912
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
913
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
914
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
915
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
912
916
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
913
|
-
protected
|
|
914
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
915
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
916
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
917
|
+
protected _userResource: AxiosUserResourceClient;
|
|
917
918
|
protected _flowResource: AxiosFlowResourceClient;
|
|
918
|
-
protected _appResource: AxiosAppResourceClient;
|
|
919
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
920
919
|
protected _mapResource: AxiosMapResourceClient;
|
|
921
|
-
protected
|
|
920
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
921
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
924
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
925
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
923
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
926
924
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
927
925
|
get RulesResource(): AxiosRulesResourceClient;
|
|
928
|
-
get
|
|
926
|
+
get AppResource(): AxiosAppResourceClient;
|
|
927
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
928
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
929
929
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
930
|
-
get
|
|
931
|
-
get
|
|
930
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
931
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
932
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
932
933
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
933
|
-
get
|
|
934
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
935
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
936
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
937
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
934
938
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
935
|
-
get
|
|
936
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
937
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
938
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
939
|
+
get UserResource(): AxiosUserResourceClient;
|
|
939
940
|
get FlowResource(): AxiosFlowResourceClient;
|
|
940
|
-
get AppResource(): AxiosAppResourceClient;
|
|
941
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
942
941
|
get MapResource(): AxiosMapResourceClient;
|
|
943
|
-
get
|
|
942
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
943
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
969
|
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
|
-
export declare class
|
|
978
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|