@openremote/rest 1.12.0-snapshot.20251212145816 → 1.12.0-snapshot.20251212161717

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