@openremote/rest 1.11.0-snapshot.20251110094044 → 1.11.0

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.
@@ -9,37 +9,98 @@ export interface HttpClient<O> {
9
9
  options?: O;
10
10
  }): RestResponse<R>;
11
11
  }
12
- export declare class SyslogResourceClient<O> {
12
+ export declare class ConsoleResourceClient<O> {
13
13
  protected httpClient: HttpClient<O>;
14
14
  constructor(httpClient: HttpClient<O>);
15
15
  /**
16
- * HTTP GET /syslog/config
17
- * Java method: org.openremote.model.syslog.SyslogResource.getConfig
16
+ * HTTP POST /console/register
17
+ * Java method: org.openremote.model.console.ConsoleResource.register
18
18
  */
19
- getConfig(options?: O): RestResponse<Model.SyslogConfig>;
19
+ register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
20
+ }
21
+ export declare class RealmResourceClient<O> {
22
+ protected httpClient: HttpClient<O>;
23
+ constructor(httpClient: HttpClient<O>);
20
24
  /**
21
- * HTTP PUT /syslog/config
22
- * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
25
+ * HTTP POST /realm
26
+ * Java method: org.openremote.model.security.RealmResource.create
23
27
  */
24
- updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
28
+ create(realm: Model.Realm, options?: O): RestResponse<void>;
25
29
  /**
26
- * HTTP DELETE /syslog/event
27
- * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
30
+ * HTTP GET /realm
31
+ * Java method: org.openremote.model.security.RealmResource.getAll
28
32
  */
29
- clearEvents(options?: O): RestResponse<void>;
33
+ getAll(options?: O): RestResponse<Model.Realm[]>;
30
34
  /**
31
- * HTTP GET /syslog/event
32
- * Java method: org.openremote.model.syslog.SyslogResource.getEvents
35
+ * HTTP GET /realm/accessible
36
+ * Java method: org.openremote.model.security.RealmResource.getAccessible
33
37
  */
34
- getEvents(queryParams?: {
35
- level?: Model.SyslogLevel;
36
- per_page?: number;
37
- page?: number;
38
- from?: number;
39
- to?: number;
40
- category?: Model.SyslogCategory[];
41
- subCategory?: string[];
38
+ getAccessible(options?: O): RestResponse<Model.Realm[]>;
39
+ /**
40
+ * HTTP DELETE /realm/{name}
41
+ * Java method: org.openremote.model.security.RealmResource.delete
42
+ */
43
+ delete(name: string, options?: O): RestResponse<void>;
44
+ /**
45
+ * HTTP GET /realm/{name}
46
+ * Java method: org.openremote.model.security.RealmResource.get
47
+ */
48
+ get(name: string, options?: O): RestResponse<Model.Realm>;
49
+ /**
50
+ * HTTP PUT /realm/{name}
51
+ * Java method: org.openremote.model.security.RealmResource.update
52
+ */
53
+ update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
54
+ }
55
+ export declare class ProvisioningResourceClient<O> {
56
+ protected httpClient: HttpClient<O>;
57
+ constructor(httpClient: HttpClient<O>);
58
+ /**
59
+ * HTTP POST /provisioning
60
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
61
+ */
62
+ createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
63
+ /**
64
+ * HTTP GET /provisioning
65
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
66
+ */
67
+ getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
68
+ /**
69
+ * HTTP DELETE /provisioning/{id}
70
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
71
+ */
72
+ deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
73
+ /**
74
+ * HTTP PUT /provisioning/{id}
75
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
76
+ */
77
+ updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
78
+ }
79
+ export declare class AssetDatapointResourceClient<O> {
80
+ protected httpClient: HttpClient<O>;
81
+ constructor(httpClient: HttpClient<O>);
82
+ /**
83
+ * HTTP GET /asset/datapoint/export
84
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
85
+ */
86
+ getDatapointExport(queryParams?: {
87
+ attributeRefs?: string;
88
+ fromTimestamp?: number;
89
+ toTimestamp?: number;
42
90
  }, options?: O): RestResponse<any>;
91
+ /**
92
+ * HTTP GET /asset/datapoint/periods
93
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
94
+ */
95
+ getDatapointPeriod(queryParams?: {
96
+ assetId?: string;
97
+ attributeName?: string;
98
+ }, options?: O): RestResponse<Model.DatapointPeriod>;
99
+ /**
100
+ * HTTP POST /asset/datapoint/{assetId}/{attributeName}
101
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
102
+ */
103
+ getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
43
104
  }
44
105
  export declare class AssetResourceClient<O> {
45
106
  protected httpClient: HttpClient<O>;
@@ -150,14 +211,37 @@ export declare class AssetResourceClient<O> {
150
211
  assetIds?: string[];
151
212
  }, options?: O): RestResponse<void>;
152
213
  }
153
- export declare class ConsoleResourceClient<O> {
214
+ export declare class SyslogResourceClient<O> {
154
215
  protected httpClient: HttpClient<O>;
155
216
  constructor(httpClient: HttpClient<O>);
156
217
  /**
157
- * HTTP POST /console/register
158
- * Java method: org.openremote.model.console.ConsoleResource.register
218
+ * HTTP GET /syslog/config
219
+ * Java method: org.openremote.model.syslog.SyslogResource.getConfig
159
220
  */
160
- register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
221
+ getConfig(options?: O): RestResponse<Model.SyslogConfig>;
222
+ /**
223
+ * HTTP PUT /syslog/config
224
+ * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
225
+ */
226
+ updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
227
+ /**
228
+ * HTTP DELETE /syslog/event
229
+ * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
230
+ */
231
+ clearEvents(options?: O): RestResponse<void>;
232
+ /**
233
+ * HTTP GET /syslog/event
234
+ * Java method: org.openremote.model.syslog.SyslogResource.getEvents
235
+ */
236
+ getEvents(queryParams?: {
237
+ level?: Model.SyslogLevel;
238
+ per_page?: number;
239
+ page?: number;
240
+ from?: number;
241
+ to?: number;
242
+ category?: Model.SyslogCategory[];
243
+ subCategory?: string[];
244
+ }, options?: O): RestResponse<any>;
161
245
  }
162
246
  export declare class RulesResourceClient<O> {
163
247
  protected httpClient: HttpClient<O>;
@@ -267,31 +351,101 @@ export declare class RulesResourceClient<O> {
267
351
  */
268
352
  updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
269
353
  }
270
- export declare class AssetDatapointResourceClient<O> {
354
+ export declare class MapResourceClient<O> {
271
355
  protected httpClient: HttpClient<O>;
272
356
  constructor(httpClient: HttpClient<O>);
273
357
  /**
274
- * HTTP GET /asset/datapoint/export
275
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
358
+ * HTTP GET /map
359
+ * Java method: org.openremote.model.map.MapResource.getSettings
276
360
  */
277
- getDatapointExport(queryParams?: {
278
- attributeRefs?: string;
279
- fromTimestamp?: number;
280
- toTimestamp?: number;
281
- }, options?: O): RestResponse<any>;
361
+ getSettings(options?: O): RestResponse<{
362
+ [id: string]: unknown;
363
+ }>;
282
364
  /**
283
- * HTTP GET /asset/datapoint/periods
284
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
365
+ * HTTP PUT /map
366
+ * Java method: org.openremote.model.map.MapResource.saveSettings
285
367
  */
286
- getDatapointPeriod(queryParams?: {
287
- assetId?: string;
288
- attributeName?: string;
289
- }, options?: O): RestResponse<Model.DatapointPeriod>;
368
+ saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
369
+ [id: string]: unknown;
370
+ }>;
290
371
  /**
291
- * HTTP POST /asset/datapoint/{assetId}/{attributeName}
292
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
372
+ * HTTP DELETE /map/deleteMap
373
+ * Java method: org.openremote.model.map.MapResource.deleteMap
293
374
  */
294
- getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
375
+ deleteMap(options?: O): RestResponse<{
376
+ [id: string]: unknown;
377
+ }>;
378
+ /**
379
+ * HTTP GET /map/getCustomMapInfo
380
+ * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
381
+ */
382
+ getCustomMapInfo(options?: O): RestResponse<{
383
+ [id: string]: unknown;
384
+ }>;
385
+ /**
386
+ * HTTP GET /map/js
387
+ * Java method: org.openremote.model.map.MapResource.getSettingsJs
388
+ */
389
+ getSettingsJs(options?: O): RestResponse<{
390
+ [id: string]: unknown;
391
+ }>;
392
+ /**
393
+ * HTTP GET /map/tile/{zoom}/{column}/{row}
394
+ * Java method: org.openremote.model.map.MapResource.getTile
395
+ */
396
+ getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
397
+ /**
398
+ * HTTP POST /map/upload
399
+ * Java method: org.openremote.model.map.MapResource.uploadMap
400
+ */
401
+ uploadMap(queryParams?: {
402
+ filename?: string;
403
+ }, options?: O): RestResponse<{
404
+ [id: string]: unknown;
405
+ }>;
406
+ }
407
+ export declare class GatewayServiceResourceClient<O> {
408
+ protected httpClient: HttpClient<O>;
409
+ constructor(httpClient: HttpClient<O>);
410
+ /**
411
+ * HTTP POST /gateway/tunnel
412
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
413
+ */
414
+ startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
415
+ /**
416
+ * HTTP DELETE /gateway/tunnel
417
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
418
+ */
419
+ stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
420
+ /**
421
+ * HTTP GET /gateway/tunnel/{realm}
422
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
423
+ */
424
+ getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
425
+ /**
426
+ * HTTP GET /gateway/tunnel/{realm}/{id}
427
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
428
+ */
429
+ getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
430
+ /**
431
+ * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
432
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
433
+ */
434
+ getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
435
+ }
436
+ export declare class AssetPredictedDatapointResourceClient<O> {
437
+ protected httpClient: HttpClient<O>;
438
+ constructor(httpClient: HttpClient<O>);
439
+ /**
440
+ * HTTP POST /asset/predicted/{assetId}/{attributeName}
441
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
442
+ */
443
+ getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
444
+ /**
445
+ * HTTP PUT /asset/predicted/{assetId}/{attributeName}
446
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
447
+ */
448
+ writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
295
449
  }
296
450
  export declare class AppResourceClient<O> {
297
451
  protected httpClient: HttpClient<O>;
@@ -312,482 +466,39 @@ export declare class AppResourceClient<O> {
312
466
  */
313
467
  getAppInfos(options?: O): RestResponse<any>;
314
468
  }
315
- export declare class GatewayClientResourceClient<O> {
469
+ export declare class DashboardResourceClient<O> {
316
470
  protected httpClient: HttpClient<O>;
317
471
  constructor(httpClient: HttpClient<O>);
318
472
  /**
319
- * HTTP DELETE /gateway/connection
320
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
473
+ * HTTP POST /dashboard
474
+ * Java method: org.openremote.model.dashboard.DashboardResource.create
321
475
  */
322
- deleteConnections(queryParams?: {
323
- realm?: string[];
324
- }, options?: O): RestResponse<void>;
476
+ create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
325
477
  /**
326
- * HTTP GET /gateway/connection
327
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
478
+ * HTTP PUT /dashboard
479
+ * Java method: org.openremote.model.dashboard.DashboardResource.update
328
480
  */
329
- getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
481
+ update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
330
482
  /**
331
- * HTTP DELETE /gateway/connection/{realm}
332
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
483
+ * HTTP GET /dashboard/all/{realm}
484
+ * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
333
485
  */
334
- deleteConnection(realm: string, options?: O): RestResponse<void>;
335
- /**
336
- * HTTP GET /gateway/connection/{realm}
337
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
338
- */
339
- getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
340
- /**
341
- * HTTP PUT /gateway/connection/{realm}
342
- * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
343
- */
344
- setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
345
- /**
346
- * HTTP GET /gateway/status/{realm}
347
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
348
- */
349
- getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
350
- }
351
- export declare class DashboardResourceClient<O> {
352
- protected httpClient: HttpClient<O>;
353
- constructor(httpClient: HttpClient<O>);
354
- /**
355
- * HTTP POST /dashboard
356
- * Java method: org.openremote.model.dashboard.DashboardResource.create
357
- */
358
- create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
359
- /**
360
- * HTTP PUT /dashboard
361
- * Java method: org.openremote.model.dashboard.DashboardResource.update
362
- */
363
- update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
364
- /**
365
- * HTTP GET /dashboard/all/{realm}
366
- * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
367
- */
368
- getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
369
- /**
370
- * HTTP POST /dashboard/query
371
- * Java method: org.openremote.model.dashboard.DashboardResource.query
372
- */
373
- query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
374
- /**
375
- * HTTP DELETE /dashboard/{realm}/{dashboardId}
376
- * Java method: org.openremote.model.dashboard.DashboardResource.delete
377
- */
378
- delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
379
- /**
380
- * HTTP GET /dashboard/{realm}/{dashboardId}
381
- * Java method: org.openremote.model.dashboard.DashboardResource.get
382
- */
383
- get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
384
- }
385
- export declare class NotificationResourceClient<O> {
386
- protected httpClient: HttpClient<O>;
387
- constructor(httpClient: HttpClient<O>);
388
- /**
389
- * HTTP GET /notification
390
- * Java method: org.openremote.model.notification.NotificationResource.getNotifications
391
- */
392
- getNotifications(queryParams?: {
393
- id?: number;
394
- type?: string;
395
- from?: number;
396
- to?: number;
397
- realmId?: string;
398
- userId?: string;
399
- assetId?: string;
400
- }, options?: O): RestResponse<Model.SentNotification[]>;
401
- /**
402
- * HTTP DELETE /notification
403
- * Java method: org.openremote.model.notification.NotificationResource.removeNotifications
404
- */
405
- removeNotifications(queryParams?: {
406
- id?: number;
407
- type?: string;
408
- from?: number;
409
- to?: number;
410
- realmId?: string;
411
- userId?: string;
412
- assetId?: string;
413
- }, options?: O): RestResponse<void>;
414
- /**
415
- * HTTP POST /notification/alert
416
- * Java method: org.openremote.model.notification.NotificationResource.sendNotification
417
- */
418
- sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
419
- /**
420
- * HTTP DELETE /notification/{notificationId}
421
- * Java method: org.openremote.model.notification.NotificationResource.removeNotification
422
- */
423
- removeNotification(notificationId: number, options?: O): RestResponse<void>;
424
- /**
425
- * HTTP PUT /notification/{notificationId}/acknowledged
426
- * Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
427
- */
428
- notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
429
- targetId?: string;
430
- }, options?: O): RestResponse<void>;
431
- /**
432
- * HTTP PUT /notification/{notificationId}/delivered
433
- * Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
434
- */
435
- notificationDelivered(notificationId: number, queryParams?: {
436
- targetId?: string;
437
- }, options?: O): RestResponse<void>;
438
- }
439
- export declare class GatewayServiceResourceClient<O> {
440
- protected httpClient: HttpClient<O>;
441
- constructor(httpClient: HttpClient<O>);
442
- /**
443
- * HTTP POST /gateway/tunnel
444
- * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
445
- */
446
- startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
447
- /**
448
- * HTTP DELETE /gateway/tunnel
449
- * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
450
- */
451
- stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
452
- /**
453
- * HTTP GET /gateway/tunnel/{realm}
454
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
455
- */
456
- getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
457
- /**
458
- * HTTP GET /gateway/tunnel/{realm}/{id}
459
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
460
- */
461
- getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
462
- /**
463
- * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
464
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
465
- */
466
- getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
467
- }
468
- export declare class AssetModelResourceClient<O> {
469
- protected httpClient: HttpClient<O>;
470
- constructor(httpClient: HttpClient<O>);
471
- /**
472
- * HTTP GET /model/assetDescriptors
473
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
474
- */
475
- getAssetDescriptors(queryParams?: {
476
- parentId?: string;
477
- parentType?: string;
478
- }, options?: O): RestResponse<Model.AssetDescriptor[]>;
479
- /**
480
- * HTTP GET /model/assetInfo/{assetType}
481
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
482
- */
483
- getAssetInfo(assetType: string, queryParams?: {
484
- parentId?: string;
485
- }, options?: O): RestResponse<Model.AssetTypeInfo>;
486
- /**
487
- * HTTP GET /model/assetInfos
488
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
489
- */
490
- getAssetInfos(queryParams?: {
491
- parentId?: string;
492
- parentType?: string;
493
- }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
494
- /**
495
- * HTTP GET /model/getValueDescriptorSchema
496
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
497
- */
498
- getValueDescriptorSchema(queryParams?: {
499
- name?: string;
500
- hash?: string;
501
- }, options?: O): RestResponse<any>;
502
- /**
503
- * HTTP GET /model/metaItemDescriptors
504
- * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
505
- */
506
- getMetaItemDescriptors(queryParams?: {
507
- parentId?: string;
508
- }, options?: O): RestResponse<{
509
- [index: string]: Model.MetaItemDescriptor;
510
- }>;
511
- /**
512
- * HTTP GET /model/valueDescriptors
513
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
514
- */
515
- getValueDescriptors(queryParams?: {
516
- parentId?: string;
517
- }, options?: O): RestResponse<{
518
- [index: string]: Model.ValueDescriptor;
519
- }>;
520
- }
521
- export declare class ProvisioningResourceClient<O> {
522
- protected httpClient: HttpClient<O>;
523
- constructor(httpClient: HttpClient<O>);
524
- /**
525
- * HTTP POST /provisioning
526
- * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
527
- */
528
- createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
529
- /**
530
- * HTTP GET /provisioning
531
- * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
532
- */
533
- getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
534
- /**
535
- * HTTP DELETE /provisioning/{id}
536
- * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
537
- */
538
- deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
539
- /**
540
- * HTTP PUT /provisioning/{id}
541
- * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
542
- */
543
- updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
544
- }
545
- export declare class AlarmResourceClient<O> {
546
- protected httpClient: HttpClient<O>;
547
- constructor(httpClient: HttpClient<O>);
548
- /**
549
- * HTTP POST /alarm
550
- * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
551
- */
552
- createAlarm(alarm: Model.Alarm, queryParams?: {
553
- assetIds?: string[];
554
- }, options?: O): RestResponse<Model.SentAlarm>;
555
- /**
556
- * HTTP GET /alarm
557
- * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
558
- */
559
- getAlarms(queryParams?: {
560
- realm?: string;
561
- status?: Model.AlarmStatus;
562
- assetId?: string;
563
- assigneeId?: string;
564
- }, options?: O): RestResponse<Model.SentAlarm[]>;
565
- /**
566
- * HTTP DELETE /alarm
567
- * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
568
- */
569
- removeAlarms(ids: number[], options?: O): RestResponse<void>;
570
- /**
571
- * HTTP PUT /alarm/assets
572
- * Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
573
- */
574
- setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
575
- /**
576
- * HTTP GET /alarm/{alarmId}
577
- * Java method: org.openremote.model.alarm.AlarmResource.getAlarm
578
- */
579
- getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
580
- /**
581
- * HTTP DELETE /alarm/{alarmId}
582
- * Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
583
- */
584
- removeAlarm(alarmId: number, options?: O): RestResponse<void>;
585
- /**
586
- * HTTP PUT /alarm/{alarmId}
587
- * Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
588
- */
589
- updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
590
- /**
591
- * HTTP GET /alarm/{alarmId}/assets
592
- * Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
593
- */
594
- getAssetLinks(alarmId: number, queryParams?: {
595
- realm?: string;
596
- }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
597
- }
598
- export declare class ExternalServiceResourceClient<O> {
599
- protected httpClient: HttpClient<O>;
600
- constructor(httpClient: HttpClient<O>);
601
- /**
602
- * Response code 200 - List of registered external services
603
- * HTTP GET /service
604
- * Java method: org.openremote.model.services.ExternalServiceResource.getServices
605
- */
606
- getServices(queryParams?: {
607
- realm?: string;
608
- }, options?: O): RestResponse<Model.ExternalService[]>;
609
- /**
610
- * Response code 200 - Service registered successfully
611
- * Response code 400 - Invalid external service object
612
- * Response code 409 - ExternalService instance already registered
613
- * HTTP POST /service
614
- * Java method: org.openremote.model.services.ExternalServiceResource.registerService
615
- */
616
- registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
617
- /**
618
- * Response code 200 - List of registered external services
619
- * HTTP GET /service/global
620
- * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
621
- */
622
- getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
623
- /**
624
- * Response code 200 - Service registered successfully
625
- * Response code 400 - Invalid external service object
626
- * Response code 409 - ExternalService instance already registered
627
- * HTTP POST /service/global
628
- * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
629
- */
630
- registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
631
- /**
632
- * Response code 204 - Service deregistered successfully
633
- * Response code 404 - Service instance not found
634
- * HTTP DELETE /service/{serviceId}/{instanceId}
635
- * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
636
- */
637
- deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
638
- /**
639
- * Response code 200 - ExternalService retrieved successfully
640
- * Response code 404 - ExternalService not found
641
- * HTTP GET /service/{serviceId}/{instanceId}
642
- * Java method: org.openremote.model.services.ExternalServiceResource.getService
643
- */
644
- getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
645
- /**
646
- * Response code 204 - Heartbeat sent successfully
647
- * Response code 404 - Service instance not found
648
- * HTTP PUT /service/{serviceId}/{instanceId}
649
- * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
650
- */
651
- heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
652
- }
653
- export declare class MapResourceClient<O> {
654
- protected httpClient: HttpClient<O>;
655
- constructor(httpClient: HttpClient<O>);
656
- /**
657
- * HTTP GET /map
658
- * Java method: org.openremote.model.map.MapResource.getSettings
659
- */
660
- getSettings(options?: O): RestResponse<{
661
- [id: string]: unknown;
662
- }>;
663
- /**
664
- * HTTP PUT /map
665
- * Java method: org.openremote.model.map.MapResource.saveSettings
666
- */
667
- saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
668
- [id: string]: unknown;
669
- }>;
670
- /**
671
- * HTTP DELETE /map/deleteMap
672
- * Java method: org.openremote.model.map.MapResource.deleteMap
673
- */
674
- deleteMap(options?: O): RestResponse<{
675
- [id: string]: unknown;
676
- }>;
677
- /**
678
- * HTTP GET /map/getCustomMapInfo
679
- * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
680
- */
681
- getCustomMapInfo(options?: O): RestResponse<{
682
- [id: string]: unknown;
683
- }>;
684
- /**
685
- * HTTP GET /map/js
686
- * Java method: org.openremote.model.map.MapResource.getSettingsJs
687
- */
688
- getSettingsJs(options?: O): RestResponse<{
689
- [id: string]: unknown;
690
- }>;
691
- /**
692
- * HTTP GET /map/tile/{zoom}/{column}/{row}
693
- * Java method: org.openremote.model.map.MapResource.getTile
694
- */
695
- getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
696
- /**
697
- * HTTP POST /map/upload
698
- * Java method: org.openremote.model.map.MapResource.uploadMap
699
- */
700
- uploadMap(queryParams?: {
701
- filename?: string;
702
- }, options?: O): RestResponse<{
703
- [id: string]: unknown;
704
- }>;
705
- }
706
- export declare class AgentResourceClient<O> {
707
- protected httpClient: HttpClient<O>;
708
- constructor(httpClient: HttpClient<O>);
709
- /**
710
- * HTTP GET /agent/assetDiscovery/{agentId}
711
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
712
- */
713
- doProtocolAssetDiscovery(agentId: string, queryParams?: {
714
- realm?: string;
715
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
716
- /**
717
- * HTTP POST /agent/assetImport/{agentId}
718
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
719
- */
720
- doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
721
- realm?: string;
722
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
723
- /**
724
- * HTTP GET /agent/instanceDiscovery/{agentType}
725
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
726
- */
727
- doProtocolInstanceDiscovery(agentType: string, queryParams?: {
728
- parentId?: string;
729
- realm?: string;
730
- }, options?: O): RestResponse<Model.Agent[]>;
731
- }
732
- export declare class ConfigurationResourceClient<O> {
733
- protected httpClient: HttpClient<O>;
734
- constructor(httpClient: HttpClient<O>);
735
- /**
736
- * HTTP GET /configuration/manager
737
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
738
- */
739
- getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
740
- /**
741
- * HTTP PUT /configuration/manager
742
- * Java method: org.openremote.model.manager.ConfigurationResource.update
743
- */
744
- update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
745
- /**
746
- * HTTP POST /configuration/manager/file
747
- * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
748
- */
749
- fileUpload(fileInfo: Model.FileInfo, queryParams?: {
750
- path?: string;
751
- }, options?: O): RestResponse<string>;
752
- /**
753
- * HTTP GET /configuration/manager/image/{filename: .+}
754
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
755
- */
756
- getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
757
- }
758
- export declare class RealmResourceClient<O> {
759
- protected httpClient: HttpClient<O>;
760
- constructor(httpClient: HttpClient<O>);
761
- /**
762
- * HTTP POST /realm
763
- * Java method: org.openremote.model.security.RealmResource.create
764
- */
765
- create(realm: Model.Realm, options?: O): RestResponse<void>;
766
- /**
767
- * HTTP GET /realm
768
- * Java method: org.openremote.model.security.RealmResource.getAll
769
- */
770
- getAll(options?: O): RestResponse<Model.Realm[]>;
771
- /**
772
- * HTTP GET /realm/accessible
773
- * Java method: org.openremote.model.security.RealmResource.getAccessible
774
- */
775
- getAccessible(options?: O): RestResponse<Model.Realm[]>;
486
+ getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
776
487
  /**
777
- * HTTP DELETE /realm/{name}
778
- * Java method: org.openremote.model.security.RealmResource.delete
488
+ * HTTP POST /dashboard/query
489
+ * Java method: org.openremote.model.dashboard.DashboardResource.query
779
490
  */
780
- delete(name: string, options?: O): RestResponse<void>;
491
+ query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
781
492
  /**
782
- * HTTP GET /realm/{name}
783
- * Java method: org.openremote.model.security.RealmResource.get
493
+ * HTTP DELETE /dashboard/{realm}/{dashboardId}
494
+ * Java method: org.openremote.model.dashboard.DashboardResource.delete
784
495
  */
785
- get(name: string, options?: O): RestResponse<Model.Realm>;
496
+ delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
786
497
  /**
787
- * HTTP PUT /realm/{name}
788
- * Java method: org.openremote.model.security.RealmResource.update
498
+ * HTTP GET /dashboard/{realm}/{dashboardId}
499
+ * Java method: org.openremote.model.dashboard.DashboardResource.get
789
500
  */
790
- update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
501
+ get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
791
502
  }
792
503
  export declare class UserResourceClient<O> {
793
504
  protected httpClient: HttpClient<O>;
@@ -893,39 +604,239 @@ export declare class UserResourceClient<O> {
893
604
  */
894
605
  update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
895
606
  /**
896
- * HTTP DELETE /user/{realm}/users/{userId}
897
- * Java method: org.openremote.model.security.UserResource.delete
607
+ * HTTP DELETE /user/{realm}/users/{userId}
608
+ * Java method: org.openremote.model.security.UserResource.delete
609
+ */
610
+ delete(realm: string, userId: string, options?: O): RestResponse<void>;
611
+ /**
612
+ * HTTP GET /user/{realm}/{clientId}/roles
613
+ * Java method: org.openremote.model.security.UserResource.getClientRoles
614
+ */
615
+ getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
616
+ /**
617
+ * HTTP PUT /user/{realm}/{clientId}/roles
618
+ * Java method: org.openremote.model.security.UserResource.updateClientRoles
619
+ */
620
+ updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
621
+ /**
622
+ * HTTP GET /user/{realm}/{userId}
623
+ * Java method: org.openremote.model.security.UserResource.get
624
+ */
625
+ get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
626
+ }
627
+ export declare class GatewayClientResourceClient<O> {
628
+ protected httpClient: HttpClient<O>;
629
+ constructor(httpClient: HttpClient<O>);
630
+ /**
631
+ * HTTP DELETE /gateway/connection
632
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
633
+ */
634
+ deleteConnections(queryParams?: {
635
+ realm?: string[];
636
+ }, options?: O): RestResponse<void>;
637
+ /**
638
+ * HTTP GET /gateway/connection
639
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
640
+ */
641
+ getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
642
+ /**
643
+ * HTTP DELETE /gateway/connection/{realm}
644
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
645
+ */
646
+ deleteConnection(realm: string, options?: O): RestResponse<void>;
647
+ /**
648
+ * HTTP GET /gateway/connection/{realm}
649
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
650
+ */
651
+ getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
652
+ /**
653
+ * HTTP PUT /gateway/connection/{realm}
654
+ * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
655
+ */
656
+ setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
657
+ /**
658
+ * HTTP GET /gateway/status/{realm}
659
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
660
+ */
661
+ getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
662
+ }
663
+ export declare class ConfigurationResourceClient<O> {
664
+ protected httpClient: HttpClient<O>;
665
+ constructor(httpClient: HttpClient<O>);
666
+ /**
667
+ * HTTP GET /configuration/manager
668
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
669
+ */
670
+ getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
671
+ /**
672
+ * HTTP PUT /configuration/manager
673
+ * Java method: org.openremote.model.manager.ConfigurationResource.update
674
+ */
675
+ update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
676
+ /**
677
+ * HTTP POST /configuration/manager/file
678
+ * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
679
+ */
680
+ fileUpload(fileInfo: Model.FileInfo, queryParams?: {
681
+ path?: string;
682
+ }, options?: O): RestResponse<string>;
683
+ /**
684
+ * HTTP GET /configuration/manager/image/{filename: .+}
685
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
686
+ */
687
+ getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
688
+ }
689
+ export declare class FlowResourceClient<O> {
690
+ protected httpClient: HttpClient<O>;
691
+ constructor(httpClient: HttpClient<O>);
692
+ /**
693
+ * HTTP GET /flow
694
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
695
+ */
696
+ getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
697
+ /**
698
+ * HTTP GET /flow/{name}
699
+ * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
700
+ */
701
+ getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
702
+ /**
703
+ * HTTP GET /flow/{type}
704
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
705
+ */
706
+ getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
707
+ }
708
+ export declare class NotificationResourceClient<O> {
709
+ protected httpClient: HttpClient<O>;
710
+ constructor(httpClient: HttpClient<O>);
711
+ /**
712
+ * HTTP GET /notification
713
+ * Java method: org.openremote.model.notification.NotificationResource.getNotifications
714
+ */
715
+ getNotifications(queryParams?: {
716
+ id?: number;
717
+ type?: string;
718
+ from?: number;
719
+ to?: number;
720
+ realmId?: string;
721
+ userId?: string;
722
+ assetId?: string;
723
+ }, options?: O): RestResponse<Model.SentNotification[]>;
724
+ /**
725
+ * HTTP DELETE /notification
726
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotifications
727
+ */
728
+ removeNotifications(queryParams?: {
729
+ id?: number;
730
+ type?: string;
731
+ from?: number;
732
+ to?: number;
733
+ realmId?: string;
734
+ userId?: string;
735
+ assetId?: string;
736
+ }, options?: O): RestResponse<void>;
737
+ /**
738
+ * HTTP POST /notification/alert
739
+ * Java method: org.openremote.model.notification.NotificationResource.sendNotification
740
+ */
741
+ sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
742
+ /**
743
+ * HTTP DELETE /notification/{notificationId}
744
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotification
745
+ */
746
+ removeNotification(notificationId: number, options?: O): RestResponse<void>;
747
+ /**
748
+ * HTTP PUT /notification/{notificationId}/acknowledged
749
+ * Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
750
+ */
751
+ notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
752
+ targetId?: string;
753
+ }, options?: O): RestResponse<void>;
754
+ /**
755
+ * HTTP PUT /notification/{notificationId}/delivered
756
+ * Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
757
+ */
758
+ notificationDelivered(notificationId: number, queryParams?: {
759
+ targetId?: string;
760
+ }, options?: O): RestResponse<void>;
761
+ }
762
+ export declare class AgentResourceClient<O> {
763
+ protected httpClient: HttpClient<O>;
764
+ constructor(httpClient: HttpClient<O>);
765
+ /**
766
+ * HTTP GET /agent/assetDiscovery/{agentId}
767
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
768
+ */
769
+ doProtocolAssetDiscovery(agentId: string, queryParams?: {
770
+ realm?: string;
771
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
772
+ /**
773
+ * HTTP POST /agent/assetImport/{agentId}
774
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
775
+ */
776
+ doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
777
+ realm?: string;
778
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
779
+ /**
780
+ * HTTP GET /agent/instanceDiscovery/{agentType}
781
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
782
+ */
783
+ doProtocolInstanceDiscovery(agentType: string, queryParams?: {
784
+ parentId?: string;
785
+ realm?: string;
786
+ }, options?: O): RestResponse<Model.Agent[]>;
787
+ }
788
+ export declare class AlarmResourceClient<O> {
789
+ protected httpClient: HttpClient<O>;
790
+ constructor(httpClient: HttpClient<O>);
791
+ /**
792
+ * HTTP POST /alarm
793
+ * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
794
+ */
795
+ createAlarm(alarm: Model.Alarm, queryParams?: {
796
+ assetIds?: string[];
797
+ }, options?: O): RestResponse<Model.SentAlarm>;
798
+ /**
799
+ * HTTP GET /alarm
800
+ * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
801
+ */
802
+ getAlarms(queryParams?: {
803
+ realm?: string;
804
+ status?: Model.AlarmStatus;
805
+ assetId?: string;
806
+ assigneeId?: string;
807
+ }, options?: O): RestResponse<Model.SentAlarm[]>;
808
+ /**
809
+ * HTTP DELETE /alarm
810
+ * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
898
811
  */
899
- delete(realm: string, userId: string, options?: O): RestResponse<void>;
812
+ removeAlarms(ids: number[], options?: O): RestResponse<void>;
900
813
  /**
901
- * HTTP GET /user/{realm}/{clientId}/roles
902
- * Java method: org.openremote.model.security.UserResource.getClientRoles
814
+ * HTTP PUT /alarm/assets
815
+ * Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
903
816
  */
904
- getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
817
+ setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
905
818
  /**
906
- * HTTP PUT /user/{realm}/{clientId}/roles
907
- * Java method: org.openremote.model.security.UserResource.updateClientRoles
819
+ * HTTP GET /alarm/{alarmId}
820
+ * Java method: org.openremote.model.alarm.AlarmResource.getAlarm
908
821
  */
909
- updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
822
+ getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
910
823
  /**
911
- * HTTP GET /user/{realm}/{userId}
912
- * Java method: org.openremote.model.security.UserResource.get
824
+ * HTTP DELETE /alarm/{alarmId}
825
+ * Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
913
826
  */
914
- get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
915
- }
916
- export declare class AssetPredictedDatapointResourceClient<O> {
917
- protected httpClient: HttpClient<O>;
918
- constructor(httpClient: HttpClient<O>);
827
+ removeAlarm(alarmId: number, options?: O): RestResponse<void>;
919
828
  /**
920
- * HTTP POST /asset/predicted/{assetId}/{attributeName}
921
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
829
+ * HTTP PUT /alarm/{alarmId}
830
+ * Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
922
831
  */
923
- getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
832
+ updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
924
833
  /**
925
- * HTTP PUT /asset/predicted/{assetId}/{attributeName}
926
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
834
+ * HTTP GET /alarm/{alarmId}/assets
835
+ * Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
927
836
  */
928
- writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
837
+ getAssetLinks(alarmId: number, queryParams?: {
838
+ realm?: string;
839
+ }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
929
840
  }
930
841
  export declare class StatusResourceClient<O> {
931
842
  protected httpClient: HttpClient<O>;
@@ -945,72 +856,161 @@ export declare class StatusResourceClient<O> {
945
856
  [index: string]: any;
946
857
  }>;
947
858
  }
948
- export declare class FlowResourceClient<O> {
859
+ export declare class AssetModelResourceClient<O> {
949
860
  protected httpClient: HttpClient<O>;
950
861
  constructor(httpClient: HttpClient<O>);
951
862
  /**
952
- * HTTP GET /flow
953
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
863
+ * HTTP GET /model/assetDescriptors
864
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
954
865
  */
955
- getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
866
+ getAssetDescriptors(queryParams?: {
867
+ parentId?: string;
868
+ parentType?: string;
869
+ }, options?: O): RestResponse<Model.AssetDescriptor[]>;
956
870
  /**
957
- * HTTP GET /flow/{name}
958
- * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
871
+ * HTTP GET /model/assetInfo/{assetType}
872
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
959
873
  */
960
- getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
874
+ getAssetInfo(assetType: string, queryParams?: {
875
+ parentId?: string;
876
+ }, options?: O): RestResponse<Model.AssetTypeInfo>;
961
877
  /**
962
- * HTTP GET /flow/{type}
963
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
878
+ * HTTP GET /model/assetInfos
879
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
964
880
  */
965
- getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
881
+ getAssetInfos(queryParams?: {
882
+ parentId?: string;
883
+ parentType?: string;
884
+ }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
885
+ /**
886
+ * HTTP GET /model/getValueDescriptorSchema
887
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
888
+ */
889
+ getValueDescriptorSchema(queryParams?: {
890
+ name?: string;
891
+ hash?: string;
892
+ }, options?: O): RestResponse<any>;
893
+ /**
894
+ * HTTP GET /model/metaItemDescriptors
895
+ * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
896
+ */
897
+ getMetaItemDescriptors(queryParams?: {
898
+ parentId?: string;
899
+ }, options?: O): RestResponse<{
900
+ [index: string]: Model.MetaItemDescriptor;
901
+ }>;
902
+ /**
903
+ * HTTP GET /model/valueDescriptors
904
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
905
+ */
906
+ getValueDescriptors(queryParams?: {
907
+ parentId?: string;
908
+ }, options?: O): RestResponse<{
909
+ [index: string]: Model.ValueDescriptor;
910
+ }>;
911
+ }
912
+ export declare class ExternalServiceResourceClient<O> {
913
+ protected httpClient: HttpClient<O>;
914
+ constructor(httpClient: HttpClient<O>);
915
+ /**
916
+ * Response code 200 - List of registered external services
917
+ * HTTP GET /service
918
+ * Java method: org.openremote.model.services.ExternalServiceResource.getServices
919
+ */
920
+ getServices(queryParams?: {
921
+ realm?: string;
922
+ }, options?: O): RestResponse<Model.ExternalService[]>;
923
+ /**
924
+ * Response code 200 - Service registered successfully
925
+ * Response code 400 - Invalid external service object
926
+ * Response code 409 - ExternalService instance already registered
927
+ * HTTP POST /service
928
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerService
929
+ */
930
+ registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
931
+ /**
932
+ * Response code 200 - List of registered external services
933
+ * HTTP GET /service/global
934
+ * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
935
+ */
936
+ getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
937
+ /**
938
+ * Response code 200 - Service registered successfully
939
+ * Response code 400 - Invalid external service object
940
+ * Response code 409 - ExternalService instance already registered
941
+ * HTTP POST /service/global
942
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
943
+ */
944
+ registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
945
+ /**
946
+ * Response code 204 - Service deregistered successfully
947
+ * Response code 404 - Service instance not found
948
+ * HTTP DELETE /service/{serviceId}/{instanceId}
949
+ * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
950
+ */
951
+ deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
952
+ /**
953
+ * Response code 200 - ExternalService retrieved successfully
954
+ * Response code 404 - ExternalService not found
955
+ * HTTP GET /service/{serviceId}/{instanceId}
956
+ * Java method: org.openremote.model.services.ExternalServiceResource.getService
957
+ */
958
+ getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
959
+ /**
960
+ * Response code 204 - Heartbeat sent successfully
961
+ * Response code 404 - Service instance not found
962
+ * HTTP PUT /service/{serviceId}/{instanceId}
963
+ * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
964
+ */
965
+ heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
966
966
  }
967
967
  export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
968
968
  export declare class ApiClient {
969
- protected _syslogResource: AxiosSyslogResourceClient;
970
- protected _assetResource: AxiosAssetResourceClient;
971
969
  protected _consoleResource: AxiosConsoleResourceClient;
972
- protected _rulesResource: AxiosRulesResourceClient;
970
+ protected _realmResource: AxiosRealmResourceClient;
971
+ protected _provisioningResource: AxiosProvisioningResourceClient;
973
972
  protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
973
+ protected _assetResource: AxiosAssetResourceClient;
974
+ protected _syslogResource: AxiosSyslogResourceClient;
975
+ protected _rulesResource: AxiosRulesResourceClient;
976
+ protected _mapResource: AxiosMapResourceClient;
977
+ protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
978
+ protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
974
979
  protected _appResource: AxiosAppResourceClient;
975
- protected _gatewayClientResource: AxiosGatewayClientResourceClient;
976
980
  protected _dashboardResource: AxiosDashboardResourceClient;
981
+ protected _userResource: AxiosUserResourceClient;
982
+ protected _gatewayClientResource: AxiosGatewayClientResourceClient;
983
+ protected _configurationResource: AxiosConfigurationResourceClient;
984
+ protected _flowResource: AxiosFlowResourceClient;
977
985
  protected _notificationResource: AxiosNotificationResourceClient;
978
- protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
979
- protected _assetModelResource: AxiosAssetModelResourceClient;
980
- protected _provisioningResource: AxiosProvisioningResourceClient;
981
- protected _alarmResource: AxiosAlarmResourceClient;
982
- protected _externalServiceResource: AxiosExternalServiceResourceClient;
983
- protected _mapResource: AxiosMapResourceClient;
984
986
  protected _agentResource: AxiosAgentResourceClient;
985
- protected _configurationResource: AxiosConfigurationResourceClient;
986
- protected _realmResource: AxiosRealmResourceClient;
987
- protected _userResource: AxiosUserResourceClient;
988
- protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
987
+ protected _alarmResource: AxiosAlarmResourceClient;
989
988
  protected _statusResource: AxiosStatusResourceClient;
990
- protected _flowResource: AxiosFlowResourceClient;
989
+ protected _assetModelResource: AxiosAssetModelResourceClient;
990
+ protected _externalServiceResource: AxiosExternalServiceResourceClient;
991
991
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
992
- get SyslogResource(): AxiosSyslogResourceClient;
993
- get AssetResource(): AxiosAssetResourceClient;
994
992
  get ConsoleResource(): AxiosConsoleResourceClient;
995
- get RulesResource(): AxiosRulesResourceClient;
993
+ get RealmResource(): AxiosRealmResourceClient;
994
+ get ProvisioningResource(): AxiosProvisioningResourceClient;
996
995
  get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
996
+ get AssetResource(): AxiosAssetResourceClient;
997
+ get SyslogResource(): AxiosSyslogResourceClient;
998
+ get RulesResource(): AxiosRulesResourceClient;
999
+ get MapResource(): AxiosMapResourceClient;
1000
+ get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1001
+ get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
997
1002
  get AppResource(): AxiosAppResourceClient;
998
- get GatewayClientResource(): AxiosGatewayClientResourceClient;
999
1003
  get DashboardResource(): AxiosDashboardResourceClient;
1004
+ get UserResource(): AxiosUserResourceClient;
1005
+ get GatewayClientResource(): AxiosGatewayClientResourceClient;
1006
+ get ConfigurationResource(): AxiosConfigurationResourceClient;
1007
+ get FlowResource(): AxiosFlowResourceClient;
1000
1008
  get NotificationResource(): AxiosNotificationResourceClient;
1001
- get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1002
- get AssetModelResource(): AxiosAssetModelResourceClient;
1003
- get ProvisioningResource(): AxiosProvisioningResourceClient;
1004
- get AlarmResource(): AxiosAlarmResourceClient;
1005
- get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1006
- get MapResource(): AxiosMapResourceClient;
1007
1009
  get AgentResource(): AxiosAgentResourceClient;
1008
- get ConfigurationResource(): AxiosConfigurationResourceClient;
1009
- get RealmResource(): AxiosRealmResourceClient;
1010
- get UserResource(): AxiosUserResourceClient;
1011
- get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1010
+ get AlarmResource(): AxiosAlarmResourceClient;
1012
1011
  get StatusResource(): AxiosStatusResourceClient;
1013
- get FlowResource(): AxiosFlowResourceClient;
1012
+ get AssetModelResource(): AxiosAssetModelResourceClient;
1013
+ get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1014
1014
  }
1015
1015
  import * as Axios from "axios";
1016
1016
  declare module "axios" {
@@ -1018,69 +1018,69 @@ declare module "axios" {
1018
1018
  data: R;
1019
1019
  }
1020
1020
  }
1021
- export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1022
- constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1023
- }
1024
- export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1021
+ export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1025
1022
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1026
1023
  }
1027
- export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1024
+ export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1028
1025
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1029
1026
  }
1030
- export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1027
+ export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1031
1028
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1032
1029
  }
1033
1030
  export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1034
1031
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1035
1032
  }
1036
- export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1033
+ export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1037
1034
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1038
1035
  }
1039
- export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1036
+ export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1040
1037
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1041
1038
  }
1042
- export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1039
+ export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1043
1040
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1044
1041
  }
1045
- export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1042
+ export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1046
1043
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1047
1044
  }
1048
1045
  export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1049
1046
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1050
1047
  }
1051
- export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1048
+ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1052
1049
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1053
1050
  }
1054
- export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1051
+ export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1055
1052
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1056
1053
  }
1057
- export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1054
+ export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1058
1055
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1059
1056
  }
1060
- export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1057
+ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1061
1058
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1062
1059
  }
1063
- export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1060
+ export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1064
1061
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1065
1062
  }
1066
- export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1063
+ export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1067
1064
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1068
1065
  }
1069
- export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1066
+ export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1070
1067
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1071
1068
  }
1072
- export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1069
+ export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1073
1070
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1074
1071
  }
1075
- export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1072
+ export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1076
1073
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1077
1074
  }
1078
- export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1075
+ export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1079
1076
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1080
1077
  }
1081
1078
  export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1082
1079
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1083
1080
  }
1084
- export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1081
+ export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1082
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1083
+ }
1084
+ export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1085
1085
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1086
1086
  }