@openremote/rest 1.9.0-snapshot.20250904112310 → 1.9.0-snapshot.20250905083755
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 +456 -456
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -62,43 +62,6 @@ export declare class AlarmResourceClient<O> {
|
|
|
62
62
|
realm?: string;
|
|
63
63
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
64
64
|
}
|
|
65
|
-
export declare class FlowResourceClient<O> {
|
|
66
|
-
protected httpClient: HttpClient<O>;
|
|
67
|
-
constructor(httpClient: HttpClient<O>);
|
|
68
|
-
/**
|
|
69
|
-
* HTTP GET /flow
|
|
70
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
71
|
-
*/
|
|
72
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
73
|
-
/**
|
|
74
|
-
* HTTP GET /flow/{name}
|
|
75
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
76
|
-
*/
|
|
77
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
78
|
-
/**
|
|
79
|
-
* HTTP GET /flow/{type}
|
|
80
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
81
|
-
*/
|
|
82
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
83
|
-
}
|
|
84
|
-
export declare class StatusResourceClient<O> {
|
|
85
|
-
protected httpClient: HttpClient<O>;
|
|
86
|
-
constructor(httpClient: HttpClient<O>);
|
|
87
|
-
/**
|
|
88
|
-
* HTTP GET /health
|
|
89
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
90
|
-
*/
|
|
91
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
92
|
-
[index: string]: any;
|
|
93
|
-
}>;
|
|
94
|
-
/**
|
|
95
|
-
* HTTP GET /info
|
|
96
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
97
|
-
*/
|
|
98
|
-
getInfo(options?: O): RestResponse<{
|
|
99
|
-
[index: string]: any;
|
|
100
|
-
}>;
|
|
101
|
-
}
|
|
102
65
|
export declare class ConfigurationResourceClient<O> {
|
|
103
66
|
protected httpClient: HttpClient<O>;
|
|
104
67
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -125,6 +88,49 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
125
88
|
*/
|
|
126
89
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
127
90
|
}
|
|
91
|
+
export declare class ConsoleResourceClient<O> {
|
|
92
|
+
protected httpClient: HttpClient<O>;
|
|
93
|
+
constructor(httpClient: HttpClient<O>);
|
|
94
|
+
/**
|
|
95
|
+
* HTTP POST /console/register
|
|
96
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
97
|
+
*/
|
|
98
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
99
|
+
}
|
|
100
|
+
export declare class RealmResourceClient<O> {
|
|
101
|
+
protected httpClient: HttpClient<O>;
|
|
102
|
+
constructor(httpClient: HttpClient<O>);
|
|
103
|
+
/**
|
|
104
|
+
* HTTP POST /realm
|
|
105
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
106
|
+
*/
|
|
107
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
108
|
+
/**
|
|
109
|
+
* HTTP GET /realm
|
|
110
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
111
|
+
*/
|
|
112
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
113
|
+
/**
|
|
114
|
+
* HTTP GET /realm/accessible
|
|
115
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
116
|
+
*/
|
|
117
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
118
|
+
/**
|
|
119
|
+
* HTTP DELETE /realm/{name}
|
|
120
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
121
|
+
*/
|
|
122
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
123
|
+
/**
|
|
124
|
+
* HTTP GET /realm/{name}
|
|
125
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
126
|
+
*/
|
|
127
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
128
|
+
/**
|
|
129
|
+
* HTTP PUT /realm/{name}
|
|
130
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
131
|
+
*/
|
|
132
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
133
|
+
}
|
|
128
134
|
export declare class AgentResourceClient<O> {
|
|
129
135
|
protected httpClient: HttpClient<O>;
|
|
130
136
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -151,6 +157,139 @@ export declare class AgentResourceClient<O> {
|
|
|
151
157
|
realm?: string;
|
|
152
158
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
153
159
|
}
|
|
160
|
+
export declare class SyslogResourceClient<O> {
|
|
161
|
+
protected httpClient: HttpClient<O>;
|
|
162
|
+
constructor(httpClient: HttpClient<O>);
|
|
163
|
+
/**
|
|
164
|
+
* HTTP GET /syslog/config
|
|
165
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
166
|
+
*/
|
|
167
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
168
|
+
/**
|
|
169
|
+
* HTTP PUT /syslog/config
|
|
170
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
171
|
+
*/
|
|
172
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
173
|
+
/**
|
|
174
|
+
* HTTP DELETE /syslog/event
|
|
175
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
176
|
+
*/
|
|
177
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
178
|
+
/**
|
|
179
|
+
* HTTP GET /syslog/event
|
|
180
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
181
|
+
*/
|
|
182
|
+
getEvents(queryParams?: {
|
|
183
|
+
level?: Model.SyslogLevel;
|
|
184
|
+
per_page?: number;
|
|
185
|
+
page?: number;
|
|
186
|
+
from?: number;
|
|
187
|
+
to?: number;
|
|
188
|
+
category?: Model.SyslogCategory[];
|
|
189
|
+
subCategory?: string[];
|
|
190
|
+
}, options?: O): RestResponse<any>;
|
|
191
|
+
}
|
|
192
|
+
export declare class AppResourceClient<O> {
|
|
193
|
+
protected httpClient: HttpClient<O>;
|
|
194
|
+
constructor(httpClient: HttpClient<O>);
|
|
195
|
+
/**
|
|
196
|
+
* HTTP GET /apps
|
|
197
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
198
|
+
*/
|
|
199
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
200
|
+
/**
|
|
201
|
+
* HTTP GET /apps/consoleConfig
|
|
202
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
203
|
+
*/
|
|
204
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
205
|
+
/**
|
|
206
|
+
* HTTP GET /apps/info
|
|
207
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
208
|
+
*/
|
|
209
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
210
|
+
}
|
|
211
|
+
export declare class MapResourceClient<O> {
|
|
212
|
+
protected httpClient: HttpClient<O>;
|
|
213
|
+
constructor(httpClient: HttpClient<O>);
|
|
214
|
+
/**
|
|
215
|
+
* HTTP GET /map
|
|
216
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
217
|
+
*/
|
|
218
|
+
getSettings(options?: O): RestResponse<{
|
|
219
|
+
[id: string]: unknown;
|
|
220
|
+
}>;
|
|
221
|
+
/**
|
|
222
|
+
* HTTP PUT /map
|
|
223
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
224
|
+
*/
|
|
225
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
226
|
+
[id: string]: unknown;
|
|
227
|
+
}>;
|
|
228
|
+
/**
|
|
229
|
+
* HTTP DELETE /map/deleteMap
|
|
230
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
231
|
+
*/
|
|
232
|
+
deleteMap(options?: O): RestResponse<{
|
|
233
|
+
[id: string]: unknown;
|
|
234
|
+
}>;
|
|
235
|
+
/**
|
|
236
|
+
* HTTP GET /map/getCustomMapInfo
|
|
237
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
238
|
+
*/
|
|
239
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
240
|
+
[id: string]: unknown;
|
|
241
|
+
}>;
|
|
242
|
+
/**
|
|
243
|
+
* HTTP GET /map/js
|
|
244
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
245
|
+
*/
|
|
246
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
247
|
+
[id: string]: unknown;
|
|
248
|
+
}>;
|
|
249
|
+
/**
|
|
250
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
251
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
252
|
+
*/
|
|
253
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
254
|
+
/**
|
|
255
|
+
* HTTP POST /map/upload
|
|
256
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
257
|
+
*/
|
|
258
|
+
uploadMap(queryParams?: {
|
|
259
|
+
filename?: string;
|
|
260
|
+
}, options?: O): RestResponse<{
|
|
261
|
+
[id: string]: unknown;
|
|
262
|
+
}>;
|
|
263
|
+
}
|
|
264
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
265
|
+
protected httpClient: HttpClient<O>;
|
|
266
|
+
constructor(httpClient: HttpClient<O>);
|
|
267
|
+
/**
|
|
268
|
+
* HTTP POST /gateway/tunnel
|
|
269
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
270
|
+
*/
|
|
271
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
272
|
+
/**
|
|
273
|
+
* HTTP DELETE /gateway/tunnel
|
|
274
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
275
|
+
*/
|
|
276
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
277
|
+
/**
|
|
278
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
279
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
280
|
+
*/
|
|
281
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
282
|
+
/**
|
|
283
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
284
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
285
|
+
*/
|
|
286
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
287
|
+
/**
|
|
288
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
289
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
290
|
+
*/
|
|
291
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
292
|
+
}
|
|
154
293
|
export declare class RulesResourceClient<O> {
|
|
155
294
|
protected httpClient: HttpClient<O>;
|
|
156
295
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -259,39 +398,90 @@ export declare class RulesResourceClient<O> {
|
|
|
259
398
|
*/
|
|
260
399
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
261
400
|
}
|
|
262
|
-
export declare class
|
|
401
|
+
export declare class AssetModelResourceClient<O> {
|
|
263
402
|
protected httpClient: HttpClient<O>;
|
|
264
403
|
constructor(httpClient: HttpClient<O>);
|
|
265
404
|
/**
|
|
266
|
-
* HTTP
|
|
267
|
-
* Java method: org.openremote.model.
|
|
405
|
+
* HTTP GET /model/assetDescriptors
|
|
406
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
268
407
|
*/
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
constructor(httpClient: HttpClient<O>);
|
|
408
|
+
getAssetDescriptors(queryParams?: {
|
|
409
|
+
parentId?: string;
|
|
410
|
+
parentType?: string;
|
|
411
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
274
412
|
/**
|
|
275
|
-
* HTTP GET /
|
|
276
|
-
* Java method: org.openremote.model.
|
|
413
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
414
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
277
415
|
*/
|
|
278
|
-
|
|
416
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
417
|
+
parentId?: string;
|
|
418
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
279
419
|
/**
|
|
280
|
-
* HTTP GET /
|
|
281
|
-
* Java method: org.openremote.model.
|
|
420
|
+
* HTTP GET /model/assetInfos
|
|
421
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
282
422
|
*/
|
|
283
|
-
|
|
423
|
+
getAssetInfos(queryParams?: {
|
|
424
|
+
parentId?: string;
|
|
425
|
+
parentType?: string;
|
|
426
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
284
427
|
/**
|
|
285
|
-
* HTTP GET /
|
|
286
|
-
* Java method: org.openremote.model.
|
|
428
|
+
* HTTP GET /model/metaItemDescriptors
|
|
429
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
287
430
|
*/
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
/**
|
|
294
|
-
* HTTP GET /
|
|
431
|
+
getMetaItemDescriptors(queryParams?: {
|
|
432
|
+
parentId?: string;
|
|
433
|
+
}, options?: O): RestResponse<{
|
|
434
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
435
|
+
}>;
|
|
436
|
+
/**
|
|
437
|
+
* HTTP GET /model/valueDescriptors
|
|
438
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
439
|
+
*/
|
|
440
|
+
getValueDescriptors(queryParams?: {
|
|
441
|
+
parentId?: string;
|
|
442
|
+
}, options?: O): RestResponse<{
|
|
443
|
+
[index: string]: Model.ValueDescriptor;
|
|
444
|
+
}>;
|
|
445
|
+
}
|
|
446
|
+
export declare class DashboardResourceClient<O> {
|
|
447
|
+
protected httpClient: HttpClient<O>;
|
|
448
|
+
constructor(httpClient: HttpClient<O>);
|
|
449
|
+
/**
|
|
450
|
+
* HTTP POST /dashboard
|
|
451
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
452
|
+
*/
|
|
453
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
454
|
+
/**
|
|
455
|
+
* HTTP PUT /dashboard
|
|
456
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
457
|
+
*/
|
|
458
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
459
|
+
/**
|
|
460
|
+
* HTTP GET /dashboard/all/{realm}
|
|
461
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
462
|
+
*/
|
|
463
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
464
|
+
/**
|
|
465
|
+
* HTTP POST /dashboard/query
|
|
466
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
467
|
+
*/
|
|
468
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
469
|
+
/**
|
|
470
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
471
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
472
|
+
*/
|
|
473
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
474
|
+
/**
|
|
475
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
476
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
477
|
+
*/
|
|
478
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
479
|
+
}
|
|
480
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
481
|
+
protected httpClient: HttpClient<O>;
|
|
482
|
+
constructor(httpClient: HttpClient<O>);
|
|
483
|
+
/**
|
|
484
|
+
* HTTP GET /asset/datapoint/export
|
|
295
485
|
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
296
486
|
*/
|
|
297
487
|
getDatapointExport(queryParams?: {
|
|
@@ -313,34 +503,98 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
313
503
|
*/
|
|
314
504
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
315
505
|
}
|
|
316
|
-
export declare class
|
|
506
|
+
export declare class FlowResourceClient<O> {
|
|
317
507
|
protected httpClient: HttpClient<O>;
|
|
318
508
|
constructor(httpClient: HttpClient<O>);
|
|
319
509
|
/**
|
|
320
|
-
* HTTP
|
|
321
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP GET /flow
|
|
511
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
322
512
|
*/
|
|
323
|
-
|
|
513
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
324
514
|
/**
|
|
325
|
-
* HTTP
|
|
326
|
-
* Java method: org.openremote.model.
|
|
515
|
+
* HTTP GET /flow/{name}
|
|
516
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
327
517
|
*/
|
|
328
|
-
|
|
518
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
329
519
|
/**
|
|
330
|
-
* HTTP GET /
|
|
331
|
-
* Java method: org.openremote.model.
|
|
520
|
+
* HTTP GET /flow/{type}
|
|
521
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
332
522
|
*/
|
|
333
|
-
|
|
523
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
524
|
+
}
|
|
525
|
+
export declare class GatewayClientResourceClient<O> {
|
|
526
|
+
protected httpClient: HttpClient<O>;
|
|
527
|
+
constructor(httpClient: HttpClient<O>);
|
|
334
528
|
/**
|
|
335
|
-
* HTTP
|
|
336
|
-
* Java method: org.openremote.model.gateway.
|
|
529
|
+
* HTTP DELETE /gateway/connection
|
|
530
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
337
531
|
*/
|
|
338
|
-
|
|
532
|
+
deleteConnections(queryParams?: {
|
|
533
|
+
realm?: string[];
|
|
534
|
+
}, options?: O): RestResponse<void>;
|
|
339
535
|
/**
|
|
340
|
-
* HTTP GET /gateway/
|
|
341
|
-
* Java method: org.openremote.model.gateway.
|
|
536
|
+
* HTTP GET /gateway/connection
|
|
537
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
342
538
|
*/
|
|
343
|
-
|
|
539
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
540
|
+
/**
|
|
541
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
542
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
543
|
+
*/
|
|
544
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
545
|
+
/**
|
|
546
|
+
* HTTP GET /gateway/connection/{realm}
|
|
547
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
548
|
+
*/
|
|
549
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
550
|
+
/**
|
|
551
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
552
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
553
|
+
*/
|
|
554
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
555
|
+
/**
|
|
556
|
+
* HTTP GET /gateway/status/{realm}
|
|
557
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
558
|
+
*/
|
|
559
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
560
|
+
}
|
|
561
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
562
|
+
protected httpClient: HttpClient<O>;
|
|
563
|
+
constructor(httpClient: HttpClient<O>);
|
|
564
|
+
/**
|
|
565
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
566
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
567
|
+
*/
|
|
568
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
569
|
+
/**
|
|
570
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
571
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
572
|
+
*/
|
|
573
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
574
|
+
}
|
|
575
|
+
export declare class ProvisioningResourceClient<O> {
|
|
576
|
+
protected httpClient: HttpClient<O>;
|
|
577
|
+
constructor(httpClient: HttpClient<O>);
|
|
578
|
+
/**
|
|
579
|
+
* HTTP POST /provisioning
|
|
580
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
581
|
+
*/
|
|
582
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
583
|
+
/**
|
|
584
|
+
* HTTP GET /provisioning
|
|
585
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
586
|
+
*/
|
|
587
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
588
|
+
/**
|
|
589
|
+
* HTTP DELETE /provisioning/{id}
|
|
590
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
591
|
+
*/
|
|
592
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
593
|
+
/**
|
|
594
|
+
* HTTP PUT /provisioning/{id}
|
|
595
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
596
|
+
*/
|
|
597
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
344
598
|
}
|
|
345
599
|
export declare class UserResourceClient<O> {
|
|
346
600
|
protected httpClient: HttpClient<O>;
|
|
@@ -419,332 +673,52 @@ export declare class UserResourceClient<O> {
|
|
|
419
673
|
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
420
674
|
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
421
675
|
*/
|
|
422
|
-
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
423
|
-
/**
|
|
424
|
-
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
425
|
-
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
426
|
-
*/
|
|
427
|
-
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
428
|
-
/**
|
|
429
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
430
|
-
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
431
|
-
*/
|
|
432
|
-
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
433
|
-
/**
|
|
434
|
-
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
435
|
-
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
436
|
-
*/
|
|
437
|
-
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
438
|
-
/**
|
|
439
|
-
* HTTP POST /user/{realm}/users
|
|
440
|
-
* Java method: org.openremote.model.security.UserResource.create
|
|
441
|
-
*/
|
|
442
|
-
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
443
|
-
/**
|
|
444
|
-
* HTTP PUT /user/{realm}/users
|
|
445
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
446
|
-
*/
|
|
447
|
-
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
448
|
-
/**
|
|
449
|
-
* HTTP DELETE /user/{realm}/users/{userId}
|
|
450
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
451
|
-
*/
|
|
452
|
-
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
453
|
-
/**
|
|
454
|
-
* HTTP GET /user/{realm}/{clientId}/roles
|
|
455
|
-
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
456
|
-
*/
|
|
457
|
-
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
458
|
-
/**
|
|
459
|
-
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
460
|
-
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
461
|
-
*/
|
|
462
|
-
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
463
|
-
/**
|
|
464
|
-
* HTTP GET /user/{realm}/{userId}
|
|
465
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
466
|
-
*/
|
|
467
|
-
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
468
|
-
}
|
|
469
|
-
export declare class ProvisioningResourceClient<O> {
|
|
470
|
-
protected httpClient: HttpClient<O>;
|
|
471
|
-
constructor(httpClient: HttpClient<O>);
|
|
472
|
-
/**
|
|
473
|
-
* HTTP POST /provisioning
|
|
474
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
475
|
-
*/
|
|
476
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
477
|
-
/**
|
|
478
|
-
* HTTP GET /provisioning
|
|
479
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
480
|
-
*/
|
|
481
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
482
|
-
/**
|
|
483
|
-
* HTTP DELETE /provisioning/{id}
|
|
484
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
485
|
-
*/
|
|
486
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
487
|
-
/**
|
|
488
|
-
* HTTP PUT /provisioning/{id}
|
|
489
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
490
|
-
*/
|
|
491
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
492
|
-
}
|
|
493
|
-
export declare class NotificationResourceClient<O> {
|
|
494
|
-
protected httpClient: HttpClient<O>;
|
|
495
|
-
constructor(httpClient: HttpClient<O>);
|
|
496
|
-
/**
|
|
497
|
-
* HTTP GET /notification
|
|
498
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
499
|
-
*/
|
|
500
|
-
getNotifications(queryParams?: {
|
|
501
|
-
id?: number;
|
|
502
|
-
type?: string;
|
|
503
|
-
from?: number;
|
|
504
|
-
to?: number;
|
|
505
|
-
realmId?: string;
|
|
506
|
-
userId?: string;
|
|
507
|
-
assetId?: string;
|
|
508
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
509
|
-
/**
|
|
510
|
-
* HTTP DELETE /notification
|
|
511
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
512
|
-
*/
|
|
513
|
-
removeNotifications(queryParams?: {
|
|
514
|
-
id?: number;
|
|
515
|
-
type?: string;
|
|
516
|
-
from?: number;
|
|
517
|
-
to?: number;
|
|
518
|
-
realmId?: string;
|
|
519
|
-
userId?: string;
|
|
520
|
-
assetId?: string;
|
|
521
|
-
}, options?: O): RestResponse<void>;
|
|
522
|
-
/**
|
|
523
|
-
* HTTP POST /notification/alert
|
|
524
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
525
|
-
*/
|
|
526
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
527
|
-
/**
|
|
528
|
-
* HTTP DELETE /notification/{notificationId}
|
|
529
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
530
|
-
*/
|
|
531
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
532
|
-
/**
|
|
533
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
534
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
535
|
-
*/
|
|
536
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
537
|
-
targetId?: string;
|
|
538
|
-
}, options?: O): RestResponse<void>;
|
|
539
|
-
/**
|
|
540
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
541
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
542
|
-
*/
|
|
543
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
544
|
-
targetId?: string;
|
|
545
|
-
}, options?: O): RestResponse<void>;
|
|
546
|
-
}
|
|
547
|
-
export declare class DashboardResourceClient<O> {
|
|
548
|
-
protected httpClient: HttpClient<O>;
|
|
549
|
-
constructor(httpClient: HttpClient<O>);
|
|
550
|
-
/**
|
|
551
|
-
* HTTP POST /dashboard
|
|
552
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
553
|
-
*/
|
|
554
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
555
|
-
/**
|
|
556
|
-
* HTTP PUT /dashboard
|
|
557
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
558
|
-
*/
|
|
559
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
560
|
-
/**
|
|
561
|
-
* HTTP GET /dashboard/all/{realm}
|
|
562
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
563
|
-
*/
|
|
564
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
565
|
-
/**
|
|
566
|
-
* HTTP POST /dashboard/query
|
|
567
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
568
|
-
*/
|
|
569
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
570
|
-
/**
|
|
571
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
572
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
573
|
-
*/
|
|
574
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
575
|
-
/**
|
|
576
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
577
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
578
|
-
*/
|
|
579
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
580
|
-
}
|
|
581
|
-
export declare class GatewayClientResourceClient<O> {
|
|
582
|
-
protected httpClient: HttpClient<O>;
|
|
583
|
-
constructor(httpClient: HttpClient<O>);
|
|
584
|
-
/**
|
|
585
|
-
* HTTP DELETE /gateway/connection
|
|
586
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
587
|
-
*/
|
|
588
|
-
deleteConnections(queryParams?: {
|
|
589
|
-
realm?: string[];
|
|
590
|
-
}, options?: O): RestResponse<void>;
|
|
591
|
-
/**
|
|
592
|
-
* HTTP GET /gateway/connection
|
|
593
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
594
|
-
*/
|
|
595
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
596
|
-
/**
|
|
597
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
598
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
599
|
-
*/
|
|
600
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
601
|
-
/**
|
|
602
|
-
* HTTP GET /gateway/connection/{realm}
|
|
603
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
604
|
-
*/
|
|
605
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
606
|
-
/**
|
|
607
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
608
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
609
|
-
*/
|
|
610
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
611
|
-
/**
|
|
612
|
-
* HTTP GET /gateway/status/{realm}
|
|
613
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
614
|
-
*/
|
|
615
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
616
|
-
}
|
|
617
|
-
export declare class RealmResourceClient<O> {
|
|
618
|
-
protected httpClient: HttpClient<O>;
|
|
619
|
-
constructor(httpClient: HttpClient<O>);
|
|
620
|
-
/**
|
|
621
|
-
* HTTP POST /realm
|
|
622
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
623
|
-
*/
|
|
624
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
625
|
-
/**
|
|
626
|
-
* HTTP GET /realm
|
|
627
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
628
|
-
*/
|
|
629
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
630
|
-
/**
|
|
631
|
-
* HTTP GET /realm/accessible
|
|
632
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
633
|
-
*/
|
|
634
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
635
|
-
/**
|
|
636
|
-
* HTTP DELETE /realm/{name}
|
|
637
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
638
|
-
*/
|
|
639
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
640
|
-
/**
|
|
641
|
-
* HTTP GET /realm/{name}
|
|
642
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
643
|
-
*/
|
|
644
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
645
|
-
/**
|
|
646
|
-
* HTTP PUT /realm/{name}
|
|
647
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
648
|
-
*/
|
|
649
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
650
|
-
}
|
|
651
|
-
export declare class MapResourceClient<O> {
|
|
652
|
-
protected httpClient: HttpClient<O>;
|
|
653
|
-
constructor(httpClient: HttpClient<O>);
|
|
654
|
-
/**
|
|
655
|
-
* HTTP GET /map
|
|
656
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
657
|
-
*/
|
|
658
|
-
getSettings(options?: O): RestResponse<{
|
|
659
|
-
[id: string]: unknown;
|
|
660
|
-
}>;
|
|
661
|
-
/**
|
|
662
|
-
* HTTP PUT /map
|
|
663
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
664
|
-
*/
|
|
665
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
666
|
-
[id: string]: unknown;
|
|
667
|
-
}>;
|
|
668
|
-
/**
|
|
669
|
-
* HTTP DELETE /map/deleteMap
|
|
670
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
671
|
-
*/
|
|
672
|
-
deleteMap(options?: O): RestResponse<{
|
|
673
|
-
[id: string]: unknown;
|
|
674
|
-
}>;
|
|
676
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
675
677
|
/**
|
|
676
|
-
* HTTP GET /
|
|
677
|
-
* Java method: org.openremote.model.
|
|
678
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
679
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
678
680
|
*/
|
|
679
|
-
|
|
680
|
-
[id: string]: unknown;
|
|
681
|
-
}>;
|
|
681
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
682
682
|
/**
|
|
683
|
-
* HTTP
|
|
684
|
-
* Java method: org.openremote.model.
|
|
683
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
684
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
685
685
|
*/
|
|
686
|
-
|
|
687
|
-
[id: string]: unknown;
|
|
688
|
-
}>;
|
|
686
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
689
687
|
/**
|
|
690
|
-
* HTTP GET /
|
|
691
|
-
* Java method: org.openremote.model.
|
|
688
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
689
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
692
690
|
*/
|
|
693
|
-
|
|
691
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
694
692
|
/**
|
|
695
|
-
* HTTP POST /
|
|
696
|
-
* Java method: org.openremote.model.
|
|
693
|
+
* HTTP POST /user/{realm}/users
|
|
694
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
697
695
|
*/
|
|
698
|
-
|
|
699
|
-
filename?: string;
|
|
700
|
-
}, options?: O): RestResponse<{
|
|
701
|
-
[id: string]: unknown;
|
|
702
|
-
}>;
|
|
703
|
-
}
|
|
704
|
-
export declare class AssetModelResourceClient<O> {
|
|
705
|
-
protected httpClient: HttpClient<O>;
|
|
706
|
-
constructor(httpClient: HttpClient<O>);
|
|
696
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
707
697
|
/**
|
|
708
|
-
* HTTP
|
|
709
|
-
* Java method: org.openremote.model.
|
|
698
|
+
* HTTP PUT /user/{realm}/users
|
|
699
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
710
700
|
*/
|
|
711
|
-
|
|
712
|
-
parentId?: string;
|
|
713
|
-
parentType?: string;
|
|
714
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
701
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
715
702
|
/**
|
|
716
|
-
* HTTP
|
|
717
|
-
* Java method: org.openremote.model.
|
|
703
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
704
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
718
705
|
*/
|
|
719
|
-
|
|
720
|
-
parentId?: string;
|
|
721
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
706
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
722
707
|
/**
|
|
723
|
-
* HTTP GET /
|
|
724
|
-
* Java method: org.openremote.model.
|
|
708
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
709
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
725
710
|
*/
|
|
726
|
-
|
|
727
|
-
parentId?: string;
|
|
728
|
-
parentType?: string;
|
|
729
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
711
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
730
712
|
/**
|
|
731
|
-
* HTTP
|
|
732
|
-
* Java method: org.openremote.model.
|
|
713
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
714
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
733
715
|
*/
|
|
734
|
-
|
|
735
|
-
parentId?: string;
|
|
736
|
-
}, options?: O): RestResponse<{
|
|
737
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
738
|
-
}>;
|
|
716
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
739
717
|
/**
|
|
740
|
-
* HTTP GET /
|
|
741
|
-
* Java method: org.openremote.model.
|
|
718
|
+
* HTTP GET /user/{realm}/{userId}
|
|
719
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
742
720
|
*/
|
|
743
|
-
|
|
744
|
-
parentId?: string;
|
|
745
|
-
}, options?: O): RestResponse<{
|
|
746
|
-
[index: string]: Model.ValueDescriptor;
|
|
747
|
-
}>;
|
|
721
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
748
722
|
}
|
|
749
723
|
export declare class AssetResourceClient<O> {
|
|
750
724
|
protected httpClient: HttpClient<O>;
|
|
@@ -850,97 +824,123 @@ export declare class AssetResourceClient<O> {
|
|
|
850
824
|
assetIds?: string[];
|
|
851
825
|
}, options?: O): RestResponse<void>;
|
|
852
826
|
}
|
|
853
|
-
export declare class
|
|
827
|
+
export declare class StatusResourceClient<O> {
|
|
854
828
|
protected httpClient: HttpClient<O>;
|
|
855
829
|
constructor(httpClient: HttpClient<O>);
|
|
856
830
|
/**
|
|
857
|
-
* HTTP GET /
|
|
858
|
-
* Java method: org.openremote.model.
|
|
831
|
+
* HTTP GET /health
|
|
832
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
859
833
|
*/
|
|
860
|
-
|
|
834
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
835
|
+
[index: string]: any;
|
|
836
|
+
}>;
|
|
861
837
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
838
|
+
* HTTP GET /info
|
|
839
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
864
840
|
*/
|
|
865
|
-
|
|
841
|
+
getInfo(options?: O): RestResponse<{
|
|
842
|
+
[index: string]: any;
|
|
843
|
+
}>;
|
|
844
|
+
}
|
|
845
|
+
export declare class NotificationResourceClient<O> {
|
|
846
|
+
protected httpClient: HttpClient<O>;
|
|
847
|
+
constructor(httpClient: HttpClient<O>);
|
|
866
848
|
/**
|
|
867
|
-
* HTTP
|
|
868
|
-
* Java method: org.openremote.model.
|
|
849
|
+
* HTTP GET /notification
|
|
850
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
869
851
|
*/
|
|
870
|
-
|
|
852
|
+
getNotifications(queryParams?: {
|
|
853
|
+
id?: number;
|
|
854
|
+
type?: string;
|
|
855
|
+
from?: number;
|
|
856
|
+
to?: number;
|
|
857
|
+
realmId?: string;
|
|
858
|
+
userId?: string;
|
|
859
|
+
assetId?: string;
|
|
860
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
871
861
|
/**
|
|
872
|
-
* HTTP
|
|
873
|
-
* Java method: org.openremote.model.
|
|
862
|
+
* HTTP DELETE /notification
|
|
863
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
874
864
|
*/
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
page?: number;
|
|
865
|
+
removeNotifications(queryParams?: {
|
|
866
|
+
id?: number;
|
|
867
|
+
type?: string;
|
|
879
868
|
from?: number;
|
|
880
869
|
to?: number;
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
}
|
|
885
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
886
|
-
protected httpClient: HttpClient<O>;
|
|
887
|
-
constructor(httpClient: HttpClient<O>);
|
|
870
|
+
realmId?: string;
|
|
871
|
+
userId?: string;
|
|
872
|
+
assetId?: string;
|
|
873
|
+
}, options?: O): RestResponse<void>;
|
|
888
874
|
/**
|
|
889
|
-
* HTTP POST /
|
|
890
|
-
* Java method: org.openremote.model.
|
|
875
|
+
* HTTP POST /notification/alert
|
|
876
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
891
877
|
*/
|
|
892
|
-
|
|
878
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
893
879
|
/**
|
|
894
|
-
* HTTP
|
|
895
|
-
* Java method: org.openremote.model.
|
|
880
|
+
* HTTP DELETE /notification/{notificationId}
|
|
881
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
896
882
|
*/
|
|
897
|
-
|
|
883
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
884
|
+
/**
|
|
885
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
886
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
887
|
+
*/
|
|
888
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
889
|
+
targetId?: string;
|
|
890
|
+
}, options?: O): RestResponse<void>;
|
|
891
|
+
/**
|
|
892
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
893
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
894
|
+
*/
|
|
895
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
896
|
+
targetId?: string;
|
|
897
|
+
}, options?: O): RestResponse<void>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
901
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
902
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
903
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
904
902
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
905
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
906
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
907
903
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
904
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
905
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
906
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
908
907
|
protected _appResource: AxiosAppResourceClient;
|
|
909
|
-
protected
|
|
908
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
910
909
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
911
|
-
protected
|
|
912
|
-
protected
|
|
913
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
910
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
911
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
914
912
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
913
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
914
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
915
915
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
916
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
917
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
918
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
919
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
920
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
921
916
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
917
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
918
|
+
protected _userResource: AxiosUserResourceClient;
|
|
919
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
920
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
921
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
923
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
924
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
925
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
926
924
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
927
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
928
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
929
925
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
926
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
927
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
928
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
930
929
|
get AppResource(): AxiosAppResourceClient;
|
|
931
|
-
get
|
|
930
|
+
get MapResource(): AxiosMapResourceClient;
|
|
932
931
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
933
|
-
get
|
|
934
|
-
get
|
|
935
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
932
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
933
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
936
934
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
935
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
936
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
937
937
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
938
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
939
|
-
get MapResource(): AxiosMapResourceClient;
|
|
940
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
941
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
942
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
943
938
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
939
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
940
|
+
get UserResource(): AxiosUserResourceClient;
|
|
941
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
942
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
943
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -951,63 +951,63 @@ declare module "axios" {
|
|
|
951
951
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
963
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
967
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
|
-
}
|
|
969
|
-
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
966
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
970
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
968
|
}
|
|
972
969
|
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
973
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
971
|
}
|
|
975
|
-
export declare class
|
|
972
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
976
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
974
|
}
|
|
978
975
|
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
979
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
977
|
}
|
|
981
|
-
export declare class
|
|
978
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
982
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
980
|
}
|
|
984
|
-
export declare class
|
|
981
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
985
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
983
|
}
|
|
987
|
-
export declare class
|
|
984
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
988
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
986
|
}
|
|
990
|
-
export declare class
|
|
987
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
988
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
|
+
}
|
|
990
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
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 AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
1005
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|