@openremote/rest 1.31.0-snapshot.20260924084538 → 1.31.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,6 +9,88 @@ export interface HttpClient<O> {
9
9
  options?: O;
10
10
  }): RestResponse<R>;
11
11
  }
12
+ export declare class RealmResourceClient<O> {
13
+ protected httpClient: HttpClient<O>;
14
+ constructor(httpClient: HttpClient<O>);
15
+ /**
16
+ * Creates and configures a realm in the identity provider. This operation is restricted to a super user.
17
+ * HTTP POST /realm
18
+ * Java method: org.openremote.model.security.RealmResource.create
19
+ */
20
+ create(realm: Model.Realm, options?: O): RestResponse<void>;
21
+ /**
22
+ * Returns complete realm records from the identity provider. This operation is restricted to a super user.
23
+ * HTTP GET /realm
24
+ * Java method: org.openremote.model.security.RealmResource.getAll
25
+ */
26
+ getAll(options?: O): RestResponse<Model.Realm[]>;
27
+ /**
28
+ * Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
29
+ * HTTP GET /realm/accessible
30
+ * Java method: org.openremote.model.security.RealmResource.getAccessible
31
+ */
32
+ getAccessible(options?: O): RestResponse<Model.Realm[]>;
33
+ /**
34
+ * Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
35
+ * Response code 405 - The master realm cannot be deleted
36
+ * HTTP DELETE /realm/{name}
37
+ * Java method: org.openremote.model.security.RealmResource.delete
38
+ */
39
+ delete(name: string, options?: O): RestResponse<void>;
40
+ /**
41
+ * Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
42
+ * HTTP GET /realm/{name}
43
+ * Java method: org.openremote.model.security.RealmResource.get
44
+ */
45
+ get(name: string, options?: O): RestResponse<Model.Realm>;
46
+ /**
47
+ * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
48
+ * Response code 405 - The requested mutation is not allowed for the master realm
49
+ * HTTP PUT /realm/{name}
50
+ * Java method: org.openremote.model.security.RealmResource.update
51
+ */
52
+ update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
53
+ }
54
+ export declare class DashboardResourceClient<O> {
55
+ protected httpClient: HttpClient<O>;
56
+ constructor(httpClient: HttpClient<O>);
57
+ /**
58
+ * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
59
+ * HTTP POST /dashboard
60
+ * Java method: org.openremote.model.dashboard.DashboardResource.create
61
+ */
62
+ create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
63
+ /**
64
+ * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
65
+ * HTTP PUT /dashboard
66
+ * Java method: org.openremote.model.dashboard.DashboardResource.update
67
+ */
68
+ update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
69
+ /**
70
+ * Returns dashboards visible to the caller in the requested realm. Anonymous callers receive public dashboards only; authenticated access also depends on roles, ownership, and linked assets.
71
+ * HTTP GET /dashboard/all/{realm}
72
+ * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
73
+ */
74
+ getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
75
+ /**
76
+ * Executes a dashboard query after constraining it to the caller's realm, roles, ownership, and asset access. A missing body uses the request realm and default visibility rules.
77
+ * HTTP POST /dashboard/query
78
+ * Java method: org.openremote.model.dashboard.DashboardResource.query
79
+ */
80
+ query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
81
+ /**
82
+ * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
83
+ * HTTP DELETE /dashboard/{realm}/{dashboardId}
84
+ * Java method: org.openremote.model.dashboard.DashboardResource.delete
85
+ */
86
+ delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
87
+ /**
88
+ * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
89
+ * HTTP GET /dashboard/{realm}/{dashboardId}
90
+ * Java method: org.openremote.model.dashboard.DashboardResource.get
91
+ */
92
+ get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
93
+ }
12
94
  export declare class AssetResourceClient<O> {
13
95
  protected httpClient: HttpClient<O>;
14
96
  constructor(httpClient: HttpClient<O>);
@@ -149,118 +231,268 @@ export declare class AssetResourceClient<O> {
149
231
  assetIds?: string[];
150
232
  }, options?: O): RestResponse<void>;
151
233
  }
152
- export declare class GatewayServiceResourceClient<O> {
234
+ export declare class ConfigurationResourceClient<O> {
153
235
  protected httpClient: HttpClient<O>;
154
236
  constructor(httpClient: HttpClient<O>);
155
237
  /**
156
- * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
157
- * Response code 417 - The gateway could not establish the requested tunnel
158
- * HTTP POST /gateway/tunnel
159
- * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
160
- */
161
- startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
162
- /**
163
- * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
164
- * HTTP DELETE /gateway/tunnel
165
- * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
238
+ * Returns the public Manager application configuration used by clients before and after authentication.
239
+ * HTTP GET /configuration/manager
240
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
166
241
  */
167
- stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
242
+ getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
168
243
  /**
169
- * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
170
- * HTTP GET /gateway/tunnel/{realm}
171
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
244
+ * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
245
+ * HTTP PUT /configuration/manager
246
+ * Java method: org.openremote.model.manager.ConfigurationResource.update
172
247
  */
173
- getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
248
+ update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
174
249
  /**
175
- * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
176
- * HTTP GET /gateway/tunnel/{realm}/{id}
177
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
250
+ * Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
251
+ * HTTP POST /configuration/manager/file
252
+ * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
178
253
  */
179
- getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
254
+ fileUpload(fileInfo: Model.FileInfo, queryParams?: {
255
+ path?: string;
256
+ }, options?: O): RestResponse<string>;
180
257
  /**
181
- * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
182
- * Response code 204 - No active tunnel matches the requested endpoint
183
- * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
184
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
258
+ * Streams a previously uploaded configuration image using its detected media type.
259
+ * Response code 200 - The image file
260
+ * HTTP GET /configuration/manager/image/{filename: .+}
261
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
185
262
  */
186
- getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
263
+ getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
187
264
  }
188
- export declare class GatewayClientResourceClient<O> {
265
+ export declare class NotificationResourceClient<O> {
189
266
  protected httpClient: HttpClient<O>;
190
267
  constructor(httpClient: HttpClient<O>);
191
268
  /**
192
- * Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
193
- * HTTP DELETE /gateway/connection
194
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
269
+ * Returns sent-notification records filtered by identity, message type, time, realm, target, source, sorting, and pagination. Results are realm-scoped and sensitive target/source identifiers are redacted when the caller lacks user or asset read permission.
270
+ * HTTP GET /notification
271
+ * Java method: org.openremote.model.notification.NotificationResource.getNotifications
195
272
  */
196
- deleteConnections(queryParams?: {
197
- realm?: string[];
273
+ getNotifications(queryParams?: {
274
+ id?: number;
275
+ type?: string;
276
+ from?: number;
277
+ to?: number;
278
+ realmId?: string;
279
+ userId?: string;
280
+ assetId?: string;
281
+ source?: Model.NotificationSource;
282
+ sort?: Model.SentNotificationSortField;
283
+ descending?: boolean;
284
+ offset?: number;
285
+ limit?: number;
286
+ }, options?: O): RestResponse<Model.SentNotification[]>;
287
+ /**
288
+ * Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
289
+ * HTTP DELETE /notification
290
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotifications
291
+ */
292
+ removeNotifications(queryParams?: {
293
+ id?: number;
294
+ type?: string;
295
+ from?: number;
296
+ to?: number;
297
+ realmId?: string;
298
+ userId?: string;
299
+ assetId?: string;
198
300
  }, options?: O): RestResponse<void>;
199
301
  /**
200
- * Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
201
- * HTTP GET /gateway/connection
202
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
302
+ * Queues a notification for delivery. Authorization is checked for every target; if any target is inaccessible, the complete request fails rather than sending a partial set.
303
+ * HTTP POST /notification/alert
304
+ * Java method: org.openremote.model.notification.NotificationResource.sendNotification
203
305
  */
204
- getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
306
+ sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
205
307
  /**
206
- * Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
207
- * HTTP DELETE /gateway/connection/{realm}
208
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
308
+ * Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
309
+ * HTTP GET /notification/count
310
+ * Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
209
311
  */
210
- deleteConnection(realm: string, options?: O): RestResponse<void>;
312
+ getNotificationsCount(queryParams?: {
313
+ type?: string;
314
+ from?: number;
315
+ to?: number;
316
+ realmId?: string;
317
+ userId?: string;
318
+ assetId?: string;
319
+ source?: Model.NotificationSource;
320
+ }, options?: O): RestResponse<number>;
211
321
  /**
212
- * Returns the central-manager connection configured for a realm, or null when none exists. Realm administrators can read their own realm; super users can read any realm.
213
- * Response code 204 - No gateway connection is configured for the realm
214
- * HTTP GET /gateway/connection/{realm}
215
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
322
+ * Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
323
+ * HTTP DELETE /notification/{notificationId}
324
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotification
216
325
  */
217
- getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
326
+ removeNotification(notificationId: number, options?: O): RestResponse<void>;
218
327
  /**
219
- * Creates or replaces the connection for the path realm. The server forces the local realm, including realm predicates in attribute filters, to match the path.
220
- * HTTP PUT /gateway/connection/{realm}
221
- * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
328
+ * Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
329
+ * HTTP PUT /notification/{notificationId}/acknowledged
330
+ * Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
222
331
  */
223
- setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
332
+ notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
333
+ targetId?: string;
334
+ }, options?: O): RestResponse<void>;
224
335
  /**
225
- * Returns the live connection state for the requested local realm.
226
- * HTTP GET /gateway/status/{realm}
227
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
336
+ * Marks one target's notification as delivered after matching both notificationId and targetId. Anonymous callers may update notifications sent to a public asset; authenticated callers are constrained to their own user, realm, or accessible assets.
337
+ * HTTP PUT /notification/{notificationId}/delivered
338
+ * Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
228
339
  */
229
- getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
340
+ notificationDelivered(notificationId: number, queryParams?: {
341
+ targetId?: string;
342
+ }, options?: O): RestResponse<void>;
230
343
  }
231
- export declare class AlarmResourceClient<O> {
344
+ export declare class ExternalServiceResourceClient<O> {
232
345
  protected httpClient: HttpClient<O>;
233
346
  constructor(httpClient: HttpClient<O>);
234
347
  /**
235
- * Creates a manual alarm in an accessible realm and optionally links it to the supplied asset IDs. The authenticated user or client becomes the alarm source.
236
- * HTTP POST /alarm
237
- * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
238
- */
239
- createAlarm(alarm: Model.Alarm, queryParams?: {
240
- assetIds?: string[];
241
- }, options?: O): RestResponse<Model.SentAlarm>;
242
- /**
243
- * Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
244
- * HTTP GET /alarm
245
- * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
348
+ * Returns all active realm-scoped service registrations for an active realm accessible to the caller.
349
+ * Response code 200 - List of registered external services
350
+ * HTTP GET /service
351
+ * Java method: org.openremote.model.services.ExternalServiceResource.getServices
246
352
  */
247
- getAlarms(queryParams?: {
353
+ getServices(queryParams?: {
248
354
  realm?: string;
249
- status?: Model.AlarmStatus;
250
- assetId?: string;
251
- assigneeId?: string;
252
- }, options?: O): RestResponse<Model.SentAlarm[]>;
355
+ }, options?: O): RestResponse<Model.ExternalService[]>;
253
356
  /**
254
- * Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
255
- * HTTP DELETE /alarm
256
- * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
357
+ * Registers a realm-scoped service instance for the request realm. The caller must be a service account; the returned object contains the assigned instance ID and initial lease state.
358
+ * Response code 200 - Service registered successfully
359
+ * Response code 400 - Invalid external service object
360
+ * Response code 409 - ExternalService instance already registered
361
+ * HTTP POST /service
362
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerService
257
363
  */
258
- removeAlarms(ids: number[], options?: O): RestResponse<void>;
364
+ registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
259
365
  /**
260
- * Adds links between assets and one existing alarm.
261
-
262
- The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
263
- every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
366
+ * Returns active registrations marked as globally available across realms.
367
+ * Response code 200 - List of registered external services
368
+ * HTTP GET /service/global
369
+ * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
370
+ */
371
+ getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
372
+ /**
373
+ * Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
374
+ * Response code 200 - Service registered successfully
375
+ * Response code 400 - Invalid external service object
376
+ * Response code 409 - ExternalService instance already registered
377
+ * HTTP POST /service/global
378
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
379
+ */
380
+ registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
381
+ /**
382
+ * Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
383
+ * Response code 204 - Service deregistered successfully
384
+ * Response code 404 - Service instance not found
385
+ * HTTP DELETE /service/{serviceId}/{instanceId}
386
+ * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
387
+ */
388
+ deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
389
+ /**
390
+ * Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
391
+ * Response code 200 - ExternalService retrieved successfully
392
+ * Response code 404 - ExternalService not found
393
+ * HTTP GET /service/{serviceId}/{instanceId}
394
+ * Java method: org.openremote.model.services.ExternalServiceResource.getService
395
+ */
396
+ getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
397
+ /**
398
+ * Extends the lease of one service instance. The caller must be the service account that registered it; global-service heartbeats additionally require a super user.
399
+ * Response code 204 - Heartbeat sent successfully
400
+ * Response code 404 - Service instance not found
401
+ * HTTP PUT /service/{serviceId}/{instanceId}
402
+ * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
403
+ */
404
+ heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
405
+ }
406
+ export declare class AgentResourceClient<O> {
407
+ protected httpClient: HttpClient<O>;
408
+ constructor(httpClient: HttpClient<O>);
409
+ /**
410
+ * Runs the agent protocol's asset discovery, waits up to ten seconds for results, returns the discovered tree, and asynchronously persists discovered assets below the agent.
411
+ * HTTP GET /agent/assetDiscovery/{agentId}
412
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
413
+ */
414
+ doProtocolAssetDiscovery(agentId: string, queryParams?: {
415
+ realm?: string;
416
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
417
+ /**
418
+ * Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
419
+ * Response code 405 - The selected agent protocol does not support asset import
420
+ * HTTP POST /agent/assetImport/{agentId}
421
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
422
+ */
423
+ doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
424
+ realm?: string;
425
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
426
+ /**
427
+ * Runs instance discovery for an agent type and returns candidate Agent assets. parentId selects local versus edge-gateway discovery; non-super users are always constrained to their authenticated realm.
428
+ * Response code 415 - The selected agent protocol does not support instance discovery
429
+ * HTTP GET /agent/instanceDiscovery/{agentType}
430
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
431
+ */
432
+ doProtocolInstanceDiscovery(agentType: string, queryParams?: {
433
+ parentId?: string;
434
+ realm?: string;
435
+ }, options?: O): RestResponse<Model.Agent[]>;
436
+ }
437
+ export declare class ConsoleResourceClient<O> {
438
+ protected httpClient: HttpClient<O>;
439
+ constructor(httpClient: HttpClient<O>);
440
+ /**
441
+ * Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
442
+ * HTTP POST /console/register
443
+ * Java method: org.openremote.model.console.ConsoleResource.register
444
+ */
445
+ register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
446
+ }
447
+ export declare class AssetPredictedDatapointResourceClient<O> {
448
+ protected httpClient: HttpClient<O>;
449
+ constructor(httpClient: HttpClient<O>);
450
+ /**
451
+ * Queries predicted values for one attribute using the supplied time-range and aggregation criteria. Anonymous access requires public-read access on both asset and attribute.
452
+ * HTTP POST /asset/predicted/{assetId}/{attributeName}
453
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
454
+ */
455
+ getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
456
+ /**
457
+ * Replaces or adds predicted values for one attribute. Anonymous access is allowed only when the asset and attribute are public-write; authenticated callers require attribute-write access.
458
+ * HTTP PUT /asset/predicted/{assetId}/{attributeName}
459
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
460
+ */
461
+ writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
462
+ }
463
+ export declare class AlarmResourceClient<O> {
464
+ protected httpClient: HttpClient<O>;
465
+ constructor(httpClient: HttpClient<O>);
466
+ /**
467
+ * Creates a manual alarm in an accessible realm and optionally links it to the supplied asset IDs. The authenticated user or client becomes the alarm source.
468
+ * HTTP POST /alarm
469
+ * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
470
+ */
471
+ createAlarm(alarm: Model.Alarm, queryParams?: {
472
+ assetIds?: string[];
473
+ }, options?: O): RestResponse<Model.SentAlarm>;
474
+ /**
475
+ * Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
476
+ * HTTP GET /alarm
477
+ * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
478
+ */
479
+ getAlarms(queryParams?: {
480
+ realm?: string;
481
+ status?: Model.AlarmStatus;
482
+ assetId?: string;
483
+ assigneeId?: string;
484
+ }, options?: O): RestResponse<Model.SentAlarm[]>;
485
+ /**
486
+ * Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
487
+ * HTTP DELETE /alarm
488
+ * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
489
+ */
490
+ removeAlarms(ids: number[], options?: O): RestResponse<void>;
491
+ /**
492
+ * Adds links between assets and one existing alarm.
493
+
494
+ The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
495
+ every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
264
496
  every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
265
497
  containing mixed alarm IDs or realms are rejected as bad requests.
266
498
 
@@ -298,66 +530,33 @@ This operation does not remove existing links from the alarm.
298
530
  realm?: string;
299
531
  }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
300
532
  }
301
- export declare class AssetModelResourceClient<O> {
533
+ export declare class ProvisioningResourceClient<O> {
302
534
  protected httpClient: HttpClient<O>;
303
535
  constructor(httpClient: HttpClient<O>);
304
536
  /**
305
- * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
306
- * HTTP GET /model/assetDescriptors
307
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
308
- */
309
- getAssetDescriptors(queryParams?: {
310
- parentId?: string;
311
- parentType?: string;
312
- }, options?: O): RestResponse<Model.AssetDescriptor[]>;
313
- /**
314
- * Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
315
- * Response code 204 - No model information is available for the requested asset type
316
- * HTTP GET /model/assetInfo/{assetType}
317
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
318
- */
319
- getAssetInfo(assetType: string, queryParams?: {
320
- parentId?: string;
321
- }, options?: O): RestResponse<Model.AssetTypeInfo>;
322
- /**
323
- * Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
324
- * HTTP GET /model/assetInfos
325
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
537
+ * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
538
+ * HTTP POST /provisioning
539
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
326
540
  */
327
- getAssetInfos(queryParams?: {
328
- parentId?: string;
329
- parentType?: string;
330
- }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
541
+ createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
331
542
  /**
332
- * Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
333
- * Response code 200 - The current JSON Schema
334
- * Response code 304 - The supplied ETag still identifies the current schema
335
- * HTTP GET /model/getValueDescriptorSchema
336
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
543
+ * Returns every provisioning configuration. This operation is restricted to a super administrator.
544
+ * HTTP GET /provisioning
545
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
337
546
  */
338
- getValueDescriptorSchema(queryParams?: {
339
- name?: string;
340
- }, options?: O): RestResponse<any>;
547
+ getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
341
548
  /**
342
- * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
343
- * HTTP GET /model/metaItemDescriptors
344
- * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
549
+ * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
550
+ * HTTP DELETE /provisioning/{id}
551
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
345
552
  */
346
- getMetaItemDescriptors(queryParams?: {
347
- parentId?: string;
348
- }, options?: O): RestResponse<{
349
- [index: string]: Model.MetaItemDescriptor;
350
- }>;
553
+ deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
351
554
  /**
352
- * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
353
- * HTTP GET /model/valueDescriptors
354
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
555
+ * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
556
+ * HTTP PUT /provisioning/{id}
557
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
355
558
  */
356
- getValueDescriptors(queryParams?: {
357
- parentId?: string;
358
- }, options?: O): RestResponse<{
359
- [index: string]: Model.ValueDescriptor;
360
- }>;
559
+ updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
361
560
  }
362
561
  export declare class AssetDatapointResourceClient<O> {
363
562
  protected httpClient: HttpClient<O>;
@@ -390,69 +589,42 @@ export declare class AssetDatapointResourceClient<O> {
390
589
  */
391
590
  getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
392
591
  }
393
- export declare class DashboardResourceClient<O> {
592
+ export declare class SyslogResourceClient<O> {
394
593
  protected httpClient: HttpClient<O>;
395
594
  constructor(httpClient: HttpClient<O>);
396
595
  /**
397
- * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
398
- * HTTP POST /dashboard
399
- * Java method: org.openremote.model.dashboard.DashboardResource.create
400
- */
401
- create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
402
- /**
403
- * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
404
- * HTTP PUT /dashboard
405
- * Java method: org.openremote.model.dashboard.DashboardResource.update
406
- */
407
- update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
408
- /**
409
- * Returns dashboards visible to the caller in the requested realm. Anonymous callers receive public dashboards only; authenticated access also depends on roles, ownership, and linked assets.
410
- * HTTP GET /dashboard/all/{realm}
411
- * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
412
- */
413
- getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
414
- /**
415
- * Executes a dashboard query after constraining it to the caller's realm, roles, ownership, and asset access. A missing body uses the request realm and default visibility rules.
416
- * HTTP POST /dashboard/query
417
- * Java method: org.openremote.model.dashboard.DashboardResource.query
418
- */
419
- query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
420
- /**
421
- * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
422
- * HTTP DELETE /dashboard/{realm}/{dashboardId}
423
- * Java method: org.openremote.model.dashboard.DashboardResource.delete
424
- */
425
- delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
426
- /**
427
- * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
428
- * HTTP GET /dashboard/{realm}/{dashboardId}
429
- * Java method: org.openremote.model.dashboard.DashboardResource.get
596
+ * Returns the current log-storage and retention configuration.
597
+ * HTTP GET /syslog/config
598
+ * Java method: org.openremote.model.syslog.SyslogResource.getConfig
430
599
  */
431
- get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
432
- }
433
- export declare class AppResourceClient<O> {
434
- protected httpClient: HttpClient<O>;
435
- constructor(httpClient: HttpClient<O>);
600
+ getConfig(options?: O): RestResponse<Model.SyslogConfig>;
436
601
  /**
437
- * Returns the identifiers of applications installed in the Manager web root.
438
- * HTTP GET /apps
439
- * Java method: org.openremote.model.apps.AppResource.getApps
602
+ * Validates and applies log-storage and retention settings.
603
+ * HTTP PUT /syslog/config
604
+ * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
440
605
  */
441
- getApps(options?: O): RestResponse<string[]>;
606
+ updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
442
607
  /**
443
- * Loads the public console_config.json document used to configure console clients before sign-in.
444
- * HTTP GET /apps/consoleConfig
445
- * Java method: org.openremote.model.apps.AppResource.getConsoleConfig
608
+ * Permanently removes all events from the configured syslog storage.
609
+ * HTTP DELETE /syslog/event
610
+ * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
446
611
  */
447
- getConsoleConfig(options?: O): RestResponse<any>;
612
+ clearEvents(options?: O): RestResponse<void>;
448
613
  /**
449
- * Loads each installed application's info.json file and returns the documents keyed by application identifier.
450
- * HTTP GET /apps/info
451
- * Java method: org.openremote.model.apps.AppResource.getAppInfos
614
+ * Returns a page of log events filtered by severity, Unix-millisecond time range, categories, and subcategories. RFC 8288 Link headers point to the next and last pages.
615
+ * Response code 200 - The requested page of syslog events
616
+ * HTTP GET /syslog/event
617
+ * Java method: org.openremote.model.syslog.SyslogResource.getEvents
452
618
  */
453
- getAppInfos(options?: O): RestResponse<{
454
- [index: string]: any;
455
- }>;
619
+ getEvents(queryParams?: {
620
+ level?: Model.SyslogLevel;
621
+ per_page?: number;
622
+ page?: number;
623
+ from?: number;
624
+ to?: number;
625
+ category?: Model.SyslogCategory[];
626
+ subCategory?: string[];
627
+ }, options?: O): RestResponse<any>;
456
628
  }
457
629
  export declare class RulesResourceClient<O> {
458
630
  protected httpClient: HttpClient<O>;
@@ -584,187 +756,27 @@ export declare class RulesResourceClient<O> {
584
756
  */
585
757
  updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
586
758
  }
587
- export declare class StatusResourceClient<O> {
588
- protected httpClient: HttpClient<O>;
589
- constructor(httpClient: HttpClient<O>);
590
- /**
591
- * Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
592
- * HTTP GET /health
593
- * Java method: org.openremote.model.system.StatusResource.getHealthStatus
594
- */
595
- getHealthStatus(options?: O): RestResponse<{
596
- [index: string]: any;
597
- }>;
598
- /**
599
- * Returns public bootstrap information, including the Manager version and identity-provider URL.
600
- * HTTP GET /info
601
- * Java method: org.openremote.model.system.StatusResource.getInfo
602
- */
603
- getInfo(options?: O): RestResponse<{
604
- [index: string]: any;
605
- }>;
606
- }
607
- export declare class ConsoleResourceClient<O> {
608
- protected httpClient: HttpClient<O>;
609
- constructor(httpClient: HttpClient<O>);
610
- /**
611
- * Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
612
- * HTTP POST /console/register
613
- * Java method: org.openremote.model.console.ConsoleResource.register
614
- */
615
- register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
616
- }
617
- export declare class AgentResourceClient<O> {
618
- protected httpClient: HttpClient<O>;
619
- constructor(httpClient: HttpClient<O>);
620
- /**
621
- * Runs the agent protocol's asset discovery, waits up to ten seconds for results, returns the discovered tree, and asynchronously persists discovered assets below the agent.
622
- * HTTP GET /agent/assetDiscovery/{agentId}
623
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
624
- */
625
- doProtocolAssetDiscovery(agentId: string, queryParams?: {
626
- realm?: string;
627
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
628
- /**
629
- * Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
630
- * Response code 405 - The selected agent protocol does not support asset import
631
- * HTTP POST /agent/assetImport/{agentId}
632
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
633
- */
634
- doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
635
- realm?: string;
636
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
637
- /**
638
- * Runs instance discovery for an agent type and returns candidate Agent assets. parentId selects local versus edge-gateway discovery; non-super users are always constrained to their authenticated realm.
639
- * Response code 415 - The selected agent protocol does not support instance discovery
640
- * HTTP GET /agent/instanceDiscovery/{agentType}
641
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
642
- */
643
- doProtocolInstanceDiscovery(agentType: string, queryParams?: {
644
- parentId?: string;
645
- realm?: string;
646
- }, options?: O): RestResponse<Model.Agent[]>;
647
- }
648
- export declare class NotificationResourceClient<O> {
649
- protected httpClient: HttpClient<O>;
650
- constructor(httpClient: HttpClient<O>);
651
- /**
652
- * Returns sent-notification records filtered by identity, message type, time, realm, target, source, sorting, and pagination. Results are realm-scoped and sensitive target/source identifiers are redacted when the caller lacks user or asset read permission.
653
- * HTTP GET /notification
654
- * Java method: org.openremote.model.notification.NotificationResource.getNotifications
655
- */
656
- getNotifications(queryParams?: {
657
- id?: number;
658
- type?: string;
659
- from?: number;
660
- to?: number;
661
- realmId?: string;
662
- userId?: string;
663
- assetId?: string;
664
- source?: Model.NotificationSource;
665
- sort?: Model.SentNotificationSortField;
666
- descending?: boolean;
667
- offset?: number;
668
- limit?: number;
669
- }, options?: O): RestResponse<Model.SentNotification[]>;
670
- /**
671
- * Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
672
- * HTTP DELETE /notification
673
- * Java method: org.openremote.model.notification.NotificationResource.removeNotifications
674
- */
675
- removeNotifications(queryParams?: {
676
- id?: number;
677
- type?: string;
678
- from?: number;
679
- to?: number;
680
- realmId?: string;
681
- userId?: string;
682
- assetId?: string;
683
- }, options?: O): RestResponse<void>;
684
- /**
685
- * Queues a notification for delivery. Authorization is checked for every target; if any target is inaccessible, the complete request fails rather than sending a partial set.
686
- * HTTP POST /notification/alert
687
- * Java method: org.openremote.model.notification.NotificationResource.sendNotification
688
- */
689
- sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
690
- /**
691
- * Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
692
- * HTTP GET /notification/count
693
- * Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
694
- */
695
- getNotificationsCount(queryParams?: {
696
- type?: string;
697
- from?: number;
698
- to?: number;
699
- realmId?: string;
700
- userId?: string;
701
- assetId?: string;
702
- source?: Model.NotificationSource;
703
- }, options?: O): RestResponse<number>;
704
- /**
705
- * Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
706
- * HTTP DELETE /notification/{notificationId}
707
- * Java method: org.openremote.model.notification.NotificationResource.removeNotification
708
- */
709
- removeNotification(notificationId: number, options?: O): RestResponse<void>;
710
- /**
711
- * Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
712
- * HTTP PUT /notification/{notificationId}/acknowledged
713
- * Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
714
- */
715
- notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
716
- targetId?: string;
717
- }, options?: O): RestResponse<void>;
718
- /**
719
- * Marks one target's notification as delivered after matching both notificationId and targetId. Anonymous callers may update notifications sent to a public asset; authenticated callers are constrained to their own user, realm, or accessible assets.
720
- * HTTP PUT /notification/{notificationId}/delivered
721
- * Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
722
- */
723
- notificationDelivered(notificationId: number, queryParams?: {
724
- targetId?: string;
725
- }, options?: O): RestResponse<void>;
726
- }
727
- export declare class RealmResourceClient<O> {
759
+ export declare class FlowResourceClient<O> {
728
760
  protected httpClient: HttpClient<O>;
729
761
  constructor(httpClient: HttpClient<O>);
730
762
  /**
731
- * Creates and configures a realm in the identity provider. This operation is restricted to a super user.
732
- * HTTP POST /realm
733
- * Java method: org.openremote.model.security.RealmResource.create
734
- */
735
- create(realm: Model.Realm, options?: O): RestResponse<void>;
736
- /**
737
- * Returns complete realm records from the identity provider. This operation is restricted to a super user.
738
- * HTTP GET /realm
739
- * Java method: org.openremote.model.security.RealmResource.getAll
740
- */
741
- getAll(options?: O): RestResponse<Model.Realm[]>;
742
- /**
743
- * Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
744
- * HTTP GET /realm/accessible
745
- * Java method: org.openremote.model.security.RealmResource.getAccessible
746
- */
747
- getAccessible(options?: O): RestResponse<Model.Realm[]>;
748
- /**
749
- * Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
750
- * Response code 405 - The master realm cannot be deleted
751
- * HTTP DELETE /realm/{name}
752
- * Java method: org.openremote.model.security.RealmResource.delete
763
+ * Returns every supported flow node definition except the internal LOG_OUTPUT node.
764
+ * HTTP GET /flow
765
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
753
766
  */
754
- delete(name: string, options?: O): RestResponse<void>;
755
- /**
756
- * Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
757
- * HTTP GET /realm/{name}
758
- * Java method: org.openremote.model.security.RealmResource.get
767
+ getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
768
+ /**
769
+ * Resolves one flow node definition by its model name.
770
+ * HTTP GET /flow/{name}
771
+ * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
759
772
  */
760
- get(name: string, options?: O): RestResponse<Model.Realm>;
773
+ getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
761
774
  /**
762
- * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
763
- * Response code 405 - The requested mutation is not allowed for the master realm
764
- * HTTP PUT /realm/{name}
765
- * Java method: org.openremote.model.security.RealmResource.update
775
+ * Returns supported flow node definitions whose category matches the requested node type.
776
+ * HTTP GET /flow/{type}
777
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
766
778
  */
767
- update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
779
+ getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
768
780
  }
769
781
  export declare class MapResourceClient<O> {
770
782
  protected httpClient: HttpClient<O>;
@@ -820,401 +832,392 @@ export declare class MapResourceClient<O> {
820
832
  [id: string]: unknown;
821
833
  }>;
822
834
  }
823
- export declare class SyslogResourceClient<O> {
824
- protected httpClient: HttpClient<O>;
825
- constructor(httpClient: HttpClient<O>);
826
- /**
827
- * Returns the current log-storage and retention configuration.
828
- * HTTP GET /syslog/config
829
- * Java method: org.openremote.model.syslog.SyslogResource.getConfig
830
- */
831
- getConfig(options?: O): RestResponse<Model.SyslogConfig>;
832
- /**
833
- * Validates and applies log-storage and retention settings.
834
- * HTTP PUT /syslog/config
835
- * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
836
- */
837
- updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
838
- /**
839
- * Permanently removes all events from the configured syslog storage.
840
- * HTTP DELETE /syslog/event
841
- * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
842
- */
843
- clearEvents(options?: O): RestResponse<void>;
844
- /**
845
- * Returns a page of log events filtered by severity, Unix-millisecond time range, categories, and subcategories. RFC 8288 Link headers point to the next and last pages.
846
- * Response code 200 - The requested page of syslog events
847
- * HTTP GET /syslog/event
848
- * Java method: org.openremote.model.syslog.SyslogResource.getEvents
849
- */
850
- getEvents(queryParams?: {
851
- level?: Model.SyslogLevel;
852
- per_page?: number;
853
- page?: number;
854
- from?: number;
855
- to?: number;
856
- category?: Model.SyslogCategory[];
857
- subCategory?: string[];
858
- }, options?: O): RestResponse<any>;
859
- }
860
- export declare class ConfigurationResourceClient<O> {
861
- protected httpClient: HttpClient<O>;
862
- constructor(httpClient: HttpClient<O>);
863
- /**
864
- * Returns the public Manager application configuration used by clients before and after authentication.
865
- * HTTP GET /configuration/manager
866
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
867
- */
868
- getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
869
- /**
870
- * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
871
- * HTTP PUT /configuration/manager
872
- * Java method: org.openremote.model.manager.ConfigurationResource.update
873
- */
874
- update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
875
- /**
876
- * Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
877
- * HTTP POST /configuration/manager/file
878
- * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
879
- */
880
- fileUpload(fileInfo: Model.FileInfo, queryParams?: {
881
- path?: string;
882
- }, options?: O): RestResponse<string>;
883
- /**
884
- * Streams a previously uploaded configuration image using its detected media type.
885
- * Response code 200 - The image file
886
- * HTTP GET /configuration/manager/image/{filename: .+}
887
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
888
- */
889
- getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
890
- }
891
- export declare class ExternalServiceResourceClient<O> {
892
- protected httpClient: HttpClient<O>;
893
- constructor(httpClient: HttpClient<O>);
894
- /**
895
- * Returns all active realm-scoped service registrations for an active realm accessible to the caller.
896
- * Response code 200 - List of registered external services
897
- * HTTP GET /service
898
- * Java method: org.openremote.model.services.ExternalServiceResource.getServices
899
- */
900
- getServices(queryParams?: {
901
- realm?: string;
902
- }, options?: O): RestResponse<Model.ExternalService[]>;
903
- /**
904
- * Registers a realm-scoped service instance for the request realm. The caller must be a service account; the returned object contains the assigned instance ID and initial lease state.
905
- * Response code 200 - Service registered successfully
906
- * Response code 400 - Invalid external service object
907
- * Response code 409 - ExternalService instance already registered
908
- * HTTP POST /service
909
- * Java method: org.openremote.model.services.ExternalServiceResource.registerService
910
- */
911
- registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
912
- /**
913
- * Returns active registrations marked as globally available across realms.
914
- * Response code 200 - List of registered external services
915
- * HTTP GET /service/global
916
- * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
917
- */
918
- getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
919
- /**
920
- * Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
921
- * Response code 200 - Service registered successfully
922
- * Response code 400 - Invalid external service object
923
- * Response code 409 - ExternalService instance already registered
924
- * HTTP POST /service/global
925
- * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
926
- */
927
- registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
928
- /**
929
- * Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
930
- * Response code 204 - Service deregistered successfully
931
- * Response code 404 - Service instance not found
932
- * HTTP DELETE /service/{serviceId}/{instanceId}
933
- * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
934
- */
935
- deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
936
- /**
937
- * Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
938
- * Response code 200 - ExternalService retrieved successfully
939
- * Response code 404 - ExternalService not found
940
- * HTTP GET /service/{serviceId}/{instanceId}
941
- * Java method: org.openremote.model.services.ExternalServiceResource.getService
942
- */
943
- getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
944
- /**
945
- * Extends the lease of one service instance. The caller must be the service account that registered it; global-service heartbeats additionally require a super user.
946
- * Response code 204 - Heartbeat sent successfully
947
- * Response code 404 - Service instance not found
948
- * HTTP PUT /service/{serviceId}/{instanceId}
949
- * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
950
- */
951
- heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
952
- }
953
835
  export declare class UserResourceClient<O> {
954
836
  protected httpClient: HttpClient<O>;
955
837
  constructor(httpClient: HttpClient<O>);
956
838
  /**
957
- * Stores the supplied non-empty locale string as the caller's identity-provider locale attribute.
839
+ * Stores the supplied non-empty locale string as the caller's identity-provider locale attribute. The target realm must be active unless the caller is a superuser.
958
840
  * HTTP PUT /user/locale
959
841
  * Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
960
842
  */
961
843
  updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
962
844
  /**
963
- * Executes a UserQuery. Non-super users are forced into their authenticated realm and cannot see system accounts; callers with read-users but not read-admin receive basic fields only.
845
+ * Executes a UserQuery. Non-super users are forced into their authenticated realm and cannot see system accounts; callers with read-users but not read-admin receive basic fields only. The target realm must be active unless the caller is a superuser.
964
846
  * HTTP POST /user/query
965
847
  * Java method: org.openremote.model.security.UserResource.query
966
848
  */
967
849
  query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
968
850
  /**
969
- * Initiates the identity provider's configured password-reset action for the caller's own account.
851
+ * Initiates the identity provider's configured password-reset action for the caller's own account. The target realm must be active unless the caller is a superuser.
970
852
  * HTTP PUT /user/request-password-reset
971
853
  * Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
972
854
  */
973
855
  requestPasswordResetCurrent(options?: O): RestResponse<void>;
974
856
  /**
975
- * Replaces the caller's own identity-provider credential using the supplied credential representation.
857
+ * Replaces the caller's own identity-provider credential using the supplied credential representation. The target realm must be active unless the caller is a superuser.
976
858
  * HTTP PUT /user/reset-password
977
859
  * Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
978
860
  */
979
861
  updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
980
862
  /**
981
- * Updates the caller's own profile. A supplied user ID must match the access token; role and realm administration are not provided by this endpoint.
863
+ * Updates the caller's own profile. A supplied user ID must match the access token; role and realm administration are not provided by this endpoint. The target realm must be active unless the caller is a superuser.
982
864
  * HTTP PUT /user/update
983
865
  * Java method: org.openremote.model.security.UserResource.updateCurrent
984
866
  */
985
867
  updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
986
868
  /**
987
- * Returns the identity-provider record corresponding to the current access token.
869
+ * Returns the identity-provider record corresponding to the current access token. The target realm must be active unless the caller is a superuser.
988
870
  * HTTP GET /user/user
989
871
  * Java method: org.openremote.model.security.UserResource.getCurrent
990
872
  */
991
873
  getCurrent(options?: O): RestResponse<Model.User>;
992
874
  /**
993
- * Returns realm-level role names assigned to the caller.
875
+ * Returns realm-level role names assigned to the caller. The target realm must be active unless the caller is a superuser.
994
876
  * HTTP GET /user/userRealmRoles
995
877
  * Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
996
878
  */
997
879
  getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
998
880
  /**
999
- * Returns role names assigned to the caller for the named identity-provider client.
881
+ * Returns role names assigned to the caller for the named identity-provider client. The target realm must be active unless the caller is a superuser.
1000
882
  * HTTP GET /user/userRoles/{clientId}
1001
883
  * Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
1002
884
  */
1003
885
  getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
1004
886
  /**
1005
- * Terminates the active MQTT connection identified by sessionID.
1006
- * HTTP GET /user/{realm}/disconnect/{sessionID}
887
+ * Terminates the active MQTT connection identified by sessionID. The realm must match the session owner's realm. Authenticated users may disconnect their own sessions without an additional client role. Disconnecting another user's session requires the openremote client role write:admin or superuser status. Non-superusers are limited to their own active realm; superusers may disconnect sessions across realms, including inactive realms.
888
+ * Response code 403 - The realm is inactive for a non-superuser, or the caller is neither the session owner, a user with write:admin, nor a superuser
889
+ * Response code 404 - The session or its owning user does not exist, or the session does not belong to the specified realm
890
+ * Response code 405 - A non-superuser cannot access the session owner's realm
891
+ * HTTP DELETE /user/{realm}/disconnect/{sessionID}
1007
892
  * Java method: org.openremote.model.security.UserResource.disconnectUserSession
1008
893
  */
1009
894
  disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
1010
895
  /**
1011
- * Asks the identity provider to send or initiate its configured password-reset action for the specified user.
896
+ * Asks the identity provider to send or initiate its configured password-reset action for the specified user. The target realm must be active unless the caller is a superuser.
1012
897
  * Response code 405 - The caller cannot mutate a user in the requested realm
1013
898
  * HTTP PUT /user/{realm}/request-password-reset/{userId}
1014
899
  * Java method: org.openremote.model.security.UserResource.requestPasswordReset
1015
900
  */
1016
901
  requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
1017
902
  /**
1018
- * Replaces a user's credential in an administered realm using the supplied credential representation.
903
+ * Replaces a user's credential in an administered realm using the supplied credential representation. The target realm must be active unless the caller is a superuser.
1019
904
  * Response code 405 - The caller cannot mutate a user in the requested realm
1020
905
  * HTTP PUT /user/{realm}/reset-password/{userId}
1021
906
  * Java method: org.openremote.model.security.UserResource.updatePassword
1022
907
  */
1023
908
  updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
1024
909
  /**
1025
- * Generates and returns a new client secret for a service user in an administered realm.
910
+ * Generates and returns a new client secret for a service user in an administered realm. The target realm must be active unless the caller is a superuser.
1026
911
  * HTTP GET /user/{realm}/reset-secret/{userId}
1027
912
  * Java method: org.openremote.model.security.UserResource.resetSecret
1028
913
  */
1029
914
  resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
1030
915
  /**
1031
- * Creates, updates, or removes role definitions for the default OpenRemote client in the requested realm.
916
+ * Creates, updates, or removes role definitions for the default OpenRemote client in the requested realm. The target realm must be active unless the caller is a superuser.
1032
917
  * HTTP PUT /user/{realm}/roles
1033
918
  * Java method: org.openremote.model.security.UserResource.updateRoles
1034
919
  */
1035
920
  updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
1036
921
  /**
1037
- * Returns realm-level role names assigned to one user. Without read-admin permission, callers may retrieve only their own roles.
922
+ * Returns realm-level role names assigned to one user. Without read-admin permission, callers may retrieve only their own roles. The target realm must be active unless the caller is a superuser.
1038
923
  * HTTP GET /user/{realm}/userRealmRoles/{userId}
1039
924
  * Java method: org.openremote.model.security.UserResource.getUserRealmRoles
1040
925
  */
1041
926
  getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
1042
927
  /**
1043
- * Replaces the user's assigned realm-level role names in an administered realm.
928
+ * Replaces the user's assigned realm-level role names in an administered realm. The target realm must be active unless the caller is a superuser.
1044
929
  * HTTP PUT /user/{realm}/userRealmRoles/{userId}
1045
930
  * Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
1046
931
  */
1047
932
  updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
1048
933
  /**
1049
- * Returns role names assigned to one user for the named client. Without read-admin permission, callers may retrieve only their own roles.
934
+ * Returns role names assigned to one user for the named client. Without read-admin permission, callers may retrieve only their own roles. The target realm must be active unless the caller is a superuser.
1050
935
  * HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
1051
936
  * Java method: org.openremote.model.security.UserResource.getUserClientRoles
1052
937
  */
1053
938
  getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
1054
939
  /**
1055
- * Replaces the user's assigned role names for the named client in an administered realm.
940
+ * Replaces the user's assigned role names for the named client in an administered realm. The target realm must be active unless the caller is a superuser.
1056
941
  * HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
1057
942
  * Java method: org.openremote.model.security.UserResource.updateUserClientRoles
1058
943
  */
1059
- updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
944
+ updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
945
+ /**
946
+ * Returns active MQTT sessions for one user, including connection ID, creation time, and remote address. Without read-admin permission, callers may inspect only themselves. The target realm must be active unless the caller is a superuser.
947
+ * HTTP GET /user/{realm}/userSessions/{userId}
948
+ * Java method: org.openremote.model.security.UserResource.getUserSessions
949
+ */
950
+ getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
951
+ /**
952
+ * Creates an identity-provider user in a realm administered by the caller and returns the resulting user record. The target realm must be active unless the caller is a superuser.
953
+ * HTTP POST /user/{realm}/users
954
+ * Java method: org.openremote.model.security.UserResource.create
955
+ */
956
+ create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
957
+ /**
958
+ * Updates an existing identity-provider user in an administered realm. The master administrator cannot be disabled. The target realm must be active unless the caller is a superuser.
959
+ * Response code 405 - The requested cross-realm or protected master-administrator mutation is not allowed
960
+ * HTTP PUT /user/{realm}/users
961
+ * Java method: org.openremote.model.security.UserResource.update
962
+ */
963
+ update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
964
+ /**
965
+ * Permanently deletes a user from an administered realm. The master-realm administrator cannot be deleted. The target realm must be active unless the caller is a superuser.
966
+ * Response code 405 - The master-realm administrator cannot be deleted
967
+ * HTTP DELETE /user/{realm}/users/{userId}
968
+ * Java method: org.openremote.model.security.UserResource.delete
969
+ */
970
+ delete(realm: string, userId: string, options?: O): RestResponse<void>;
971
+ /**
972
+ * Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required. The target realm must be active unless the caller is a superuser.
973
+ * HTTP GET /user/{realm}/{clientId}/roles
974
+ * Java method: org.openremote.model.security.UserResource.getClientRoles
975
+ */
976
+ getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
977
+ /**
978
+ * Creates, updates, or removes role definitions for a named identity-provider client. The target realm must be active unless the caller is a superuser.
979
+ * HTTP PUT /user/{realm}/{clientId}/roles
980
+ * Java method: org.openremote.model.security.UserResource.updateClientRoles
981
+ */
982
+ updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
983
+ /**
984
+ * Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user. The target realm must be active unless the caller is a superuser.
985
+ * HTTP GET /user/{realm}/{userId}
986
+ * Java method: org.openremote.model.security.UserResource.get
987
+ */
988
+ get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
989
+ }
990
+ export declare class AssetModelResourceClient<O> {
991
+ protected httpClient: HttpClient<O>;
992
+ constructor(httpClient: HttpClient<O>);
993
+ /**
994
+ * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
995
+ * HTTP GET /model/assetDescriptors
996
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
997
+ */
998
+ getAssetDescriptors(queryParams?: {
999
+ parentId?: string;
1000
+ parentType?: string;
1001
+ }, options?: O): RestResponse<Model.AssetDescriptor[]>;
1002
+ /**
1003
+ * Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
1004
+ * Response code 204 - No model information is available for the requested asset type
1005
+ * HTTP GET /model/assetInfo/{assetType}
1006
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
1007
+ */
1008
+ getAssetInfo(assetType: string, queryParams?: {
1009
+ parentId?: string;
1010
+ }, options?: O): RestResponse<Model.AssetTypeInfo>;
1011
+ /**
1012
+ * Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
1013
+ * HTTP GET /model/assetInfos
1014
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
1015
+ */
1016
+ getAssetInfos(queryParams?: {
1017
+ parentId?: string;
1018
+ parentType?: string;
1019
+ }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
1020
+ /**
1021
+ * Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
1022
+ * Response code 200 - The current JSON Schema
1023
+ * Response code 304 - The supplied ETag still identifies the current schema
1024
+ * HTTP GET /model/getValueDescriptorSchema
1025
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
1026
+ */
1027
+ getValueDescriptorSchema(queryParams?: {
1028
+ name?: string;
1029
+ }, options?: O): RestResponse<any>;
1030
+ /**
1031
+ * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
1032
+ * HTTP GET /model/metaItemDescriptors
1033
+ * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
1034
+ */
1035
+ getMetaItemDescriptors(queryParams?: {
1036
+ parentId?: string;
1037
+ }, options?: O): RestResponse<{
1038
+ [index: string]: Model.MetaItemDescriptor;
1039
+ }>;
1040
+ /**
1041
+ * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
1042
+ * HTTP GET /model/valueDescriptors
1043
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
1044
+ */
1045
+ getValueDescriptors(queryParams?: {
1046
+ parentId?: string;
1047
+ }, options?: O): RestResponse<{
1048
+ [index: string]: Model.ValueDescriptor;
1049
+ }>;
1050
+ }
1051
+ export declare class AppResourceClient<O> {
1052
+ protected httpClient: HttpClient<O>;
1053
+ constructor(httpClient: HttpClient<O>);
1054
+ /**
1055
+ * Returns the identifiers of applications installed in the Manager web root.
1056
+ * HTTP GET /apps
1057
+ * Java method: org.openremote.model.apps.AppResource.getApps
1058
+ */
1059
+ getApps(options?: O): RestResponse<string[]>;
1060
+ /**
1061
+ * Loads the public console_config.json document used to configure console clients before sign-in.
1062
+ * HTTP GET /apps/consoleConfig
1063
+ * Java method: org.openremote.model.apps.AppResource.getConsoleConfig
1064
+ */
1065
+ getConsoleConfig(options?: O): RestResponse<any>;
1060
1066
  /**
1061
- * Returns active MQTT sessions for one user, including connection ID, creation time, and remote address. Without read-admin permission, callers may inspect only themselves.
1062
- * HTTP GET /user/{realm}/userSessions/{userId}
1063
- * Java method: org.openremote.model.security.UserResource.getUserSessions
1067
+ * Loads each installed application's info.json file and returns the documents keyed by application identifier.
1068
+ * HTTP GET /apps/info
1069
+ * Java method: org.openremote.model.apps.AppResource.getAppInfos
1064
1070
  */
1065
- getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
1071
+ getAppInfos(options?: O): RestResponse<{
1072
+ [index: string]: any;
1073
+ }>;
1074
+ }
1075
+ export declare class GatewayClientResourceClient<O> {
1076
+ protected httpClient: HttpClient<O>;
1077
+ constructor(httpClient: HttpClient<O>);
1066
1078
  /**
1067
- * Creates an identity-provider user in a realm administered by the caller and returns the resulting user record.
1068
- * HTTP POST /user/{realm}/users
1069
- * Java method: org.openremote.model.security.UserResource.create
1079
+ * Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
1080
+ * HTTP DELETE /gateway/connection
1081
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
1070
1082
  */
1071
- create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
1083
+ deleteConnections(queryParams?: {
1084
+ realm?: string[];
1085
+ }, options?: O): RestResponse<void>;
1072
1086
  /**
1073
- * Updates an existing identity-provider user in an administered realm. The master administrator cannot be disabled.
1074
- * Response code 405 - The requested cross-realm or protected master-administrator mutation is not allowed
1075
- * HTTP PUT /user/{realm}/users
1076
- * Java method: org.openremote.model.security.UserResource.update
1087
+ * Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
1088
+ * HTTP GET /gateway/connection
1089
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
1077
1090
  */
1078
- update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
1091
+ getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
1079
1092
  /**
1080
- * Permanently deletes a user from an administered realm. The master-realm administrator cannot be deleted.
1081
- * Response code 405 - The master-realm administrator cannot be deleted
1082
- * HTTP DELETE /user/{realm}/users/{userId}
1083
- * Java method: org.openremote.model.security.UserResource.delete
1093
+ * Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
1094
+ * HTTP DELETE /gateway/connection/{realm}
1095
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
1084
1096
  */
1085
- delete(realm: string, userId: string, options?: O): RestResponse<void>;
1097
+ deleteConnection(realm: string, options?: O): RestResponse<void>;
1086
1098
  /**
1087
- * Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required.
1088
- * HTTP GET /user/{realm}/{clientId}/roles
1089
- * Java method: org.openremote.model.security.UserResource.getClientRoles
1099
+ * Returns the central-manager connection configured for a realm, or null when none exists. Realm administrators can read their own realm; super users can read any realm.
1100
+ * Response code 204 - No gateway connection is configured for the realm
1101
+ * HTTP GET /gateway/connection/{realm}
1102
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
1090
1103
  */
1091
- getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
1104
+ getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
1092
1105
  /**
1093
- * Creates, updates, or removes role definitions for a named identity-provider client.
1094
- * HTTP PUT /user/{realm}/{clientId}/roles
1095
- * Java method: org.openremote.model.security.UserResource.updateClientRoles
1106
+ * Creates or replaces the connection for the path realm. The server forces the local realm, including realm predicates in attribute filters, to match the path.
1107
+ * HTTP PUT /gateway/connection/{realm}
1108
+ * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
1096
1109
  */
1097
- updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
1110
+ setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
1098
1111
  /**
1099
- * Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user.
1100
- * HTTP GET /user/{realm}/{userId}
1101
- * Java method: org.openremote.model.security.UserResource.get
1112
+ * Returns the live connection state for the requested local realm.
1113
+ * HTTP GET /gateway/status/{realm}
1114
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
1102
1115
  */
1103
- get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
1116
+ getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
1104
1117
  }
1105
- export declare class FlowResourceClient<O> {
1118
+ export declare class StatusResourceClient<O> {
1106
1119
  protected httpClient: HttpClient<O>;
1107
1120
  constructor(httpClient: HttpClient<O>);
1108
1121
  /**
1109
- * Returns every supported flow node definition except the internal LOG_OUTPUT node.
1110
- * HTTP GET /flow
1111
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
1112
- */
1113
- getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
1114
- /**
1115
- * Resolves one flow node definition by its model name.
1116
- * HTTP GET /flow/{name}
1117
- * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
1122
+ * Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
1123
+ * HTTP GET /health
1124
+ * Java method: org.openremote.model.system.StatusResource.getHealthStatus
1118
1125
  */
1119
- getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
1126
+ getHealthStatus(options?: O): RestResponse<{
1127
+ [index: string]: any;
1128
+ }>;
1120
1129
  /**
1121
- * Returns supported flow node definitions whose category matches the requested node type.
1122
- * HTTP GET /flow/{type}
1123
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
1130
+ * Returns public bootstrap information, including the Manager version and identity-provider URL.
1131
+ * HTTP GET /info
1132
+ * Java method: org.openremote.model.system.StatusResource.getInfo
1124
1133
  */
1125
- getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
1134
+ getInfo(options?: O): RestResponse<{
1135
+ [index: string]: any;
1136
+ }>;
1126
1137
  }
1127
- export declare class ProvisioningResourceClient<O> {
1138
+ export declare class GatewayServiceResourceClient<O> {
1128
1139
  protected httpClient: HttpClient<O>;
1129
1140
  constructor(httpClient: HttpClient<O>);
1130
1141
  /**
1131
- * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
1132
- * HTTP POST /provisioning
1133
- * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
1134
- */
1135
- createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
1136
- /**
1137
- * Returns every provisioning configuration. This operation is restricted to a super administrator.
1138
- * HTTP GET /provisioning
1139
- * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
1142
+ * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
1143
+ * Response code 417 - The gateway could not establish the requested tunnel
1144
+ * HTTP POST /gateway/tunnel
1145
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
1140
1146
  */
1141
- getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
1147
+ startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
1142
1148
  /**
1143
- * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
1144
- * HTTP DELETE /provisioning/{id}
1145
- * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
1149
+ * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
1150
+ * HTTP DELETE /gateway/tunnel
1151
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
1146
1152
  */
1147
- deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
1153
+ stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
1148
1154
  /**
1149
- * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
1150
- * HTTP PUT /provisioning/{id}
1151
- * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
1155
+ * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
1156
+ * HTTP GET /gateway/tunnel/{realm}
1157
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
1152
1158
  */
1153
- updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
1154
- }
1155
- export declare class AssetPredictedDatapointResourceClient<O> {
1156
- protected httpClient: HttpClient<O>;
1157
- constructor(httpClient: HttpClient<O>);
1159
+ getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
1158
1160
  /**
1159
- * Queries predicted values for one attribute using the supplied time-range and aggregation criteria. Anonymous access requires public-read access on both asset and attribute.
1160
- * HTTP POST /asset/predicted/{assetId}/{attributeName}
1161
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
1161
+ * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
1162
+ * HTTP GET /gateway/tunnel/{realm}/{id}
1163
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
1162
1164
  */
1163
- getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
1165
+ getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
1164
1166
  /**
1165
- * Replaces or adds predicted values for one attribute. Anonymous access is allowed only when the asset and attribute are public-write; authenticated callers require attribute-write access.
1166
- * HTTP PUT /asset/predicted/{assetId}/{attributeName}
1167
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
1167
+ * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
1168
+ * Response code 204 - No active tunnel matches the requested endpoint
1169
+ * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
1170
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
1168
1171
  */
1169
- writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
1172
+ getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
1170
1173
  }
1171
1174
  export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
1172
1175
  export declare class ApiClient {
1176
+ protected _realmResource: AxiosRealmResourceClient;
1177
+ protected _dashboardResource: AxiosDashboardResourceClient;
1173
1178
  protected _assetResource: AxiosAssetResourceClient;
1174
- protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1175
- protected _gatewayClientResource: AxiosGatewayClientResourceClient;
1179
+ protected _configurationResource: AxiosConfigurationResourceClient;
1180
+ protected _notificationResource: AxiosNotificationResourceClient;
1181
+ protected _externalServiceResource: AxiosExternalServiceResourceClient;
1182
+ protected _agentResource: AxiosAgentResourceClient;
1183
+ protected _consoleResource: AxiosConsoleResourceClient;
1184
+ protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
1176
1185
  protected _alarmResource: AxiosAlarmResourceClient;
1177
- protected _assetModelResource: AxiosAssetModelResourceClient;
1186
+ protected _provisioningResource: AxiosProvisioningResourceClient;
1178
1187
  protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
1179
- protected _dashboardResource: AxiosDashboardResourceClient;
1180
- protected _appResource: AxiosAppResourceClient;
1188
+ protected _syslogResource: AxiosSyslogResourceClient;
1181
1189
  protected _rulesResource: AxiosRulesResourceClient;
1182
- protected _statusResource: AxiosStatusResourceClient;
1183
- protected _consoleResource: AxiosConsoleResourceClient;
1184
- protected _agentResource: AxiosAgentResourceClient;
1185
- protected _notificationResource: AxiosNotificationResourceClient;
1186
- protected _realmResource: AxiosRealmResourceClient;
1190
+ protected _flowResource: AxiosFlowResourceClient;
1187
1191
  protected _mapResource: AxiosMapResourceClient;
1188
- protected _syslogResource: AxiosSyslogResourceClient;
1189
- protected _configurationResource: AxiosConfigurationResourceClient;
1190
- protected _externalServiceResource: AxiosExternalServiceResourceClient;
1191
1192
  protected _userResource: AxiosUserResourceClient;
1192
- protected _flowResource: AxiosFlowResourceClient;
1193
- protected _provisioningResource: AxiosProvisioningResourceClient;
1194
- protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
1193
+ protected _assetModelResource: AxiosAssetModelResourceClient;
1194
+ protected _appResource: AxiosAppResourceClient;
1195
+ protected _gatewayClientResource: AxiosGatewayClientResourceClient;
1196
+ protected _statusResource: AxiosStatusResourceClient;
1197
+ protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1195
1198
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1199
+ get RealmResource(): AxiosRealmResourceClient;
1200
+ get DashboardResource(): AxiosDashboardResourceClient;
1196
1201
  get AssetResource(): AxiosAssetResourceClient;
1197
- get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1198
- get GatewayClientResource(): AxiosGatewayClientResourceClient;
1202
+ get ConfigurationResource(): AxiosConfigurationResourceClient;
1203
+ get NotificationResource(): AxiosNotificationResourceClient;
1204
+ get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1205
+ get AgentResource(): AxiosAgentResourceClient;
1206
+ get ConsoleResource(): AxiosConsoleResourceClient;
1207
+ get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1199
1208
  get AlarmResource(): AxiosAlarmResourceClient;
1200
- get AssetModelResource(): AxiosAssetModelResourceClient;
1209
+ get ProvisioningResource(): AxiosProvisioningResourceClient;
1201
1210
  get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
1202
- get DashboardResource(): AxiosDashboardResourceClient;
1203
- get AppResource(): AxiosAppResourceClient;
1211
+ get SyslogResource(): AxiosSyslogResourceClient;
1204
1212
  get RulesResource(): AxiosRulesResourceClient;
1205
- get StatusResource(): AxiosStatusResourceClient;
1206
- get ConsoleResource(): AxiosConsoleResourceClient;
1207
- get AgentResource(): AxiosAgentResourceClient;
1208
- get NotificationResource(): AxiosNotificationResourceClient;
1209
- get RealmResource(): AxiosRealmResourceClient;
1213
+ get FlowResource(): AxiosFlowResourceClient;
1210
1214
  get MapResource(): AxiosMapResourceClient;
1211
- get SyslogResource(): AxiosSyslogResourceClient;
1212
- get ConfigurationResource(): AxiosConfigurationResourceClient;
1213
- get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1214
1215
  get UserResource(): AxiosUserResourceClient;
1215
- get FlowResource(): AxiosFlowResourceClient;
1216
- get ProvisioningResource(): AxiosProvisioningResourceClient;
1217
- get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1216
+ get AssetModelResource(): AxiosAssetModelResourceClient;
1217
+ get AppResource(): AxiosAppResourceClient;
1218
+ get GatewayClientResource(): AxiosGatewayClientResourceClient;
1219
+ get StatusResource(): AxiosStatusResourceClient;
1220
+ get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1218
1221
  }
1219
1222
  import * as Axios from "axios";
1220
1223
  declare module "axios" {
@@ -1222,70 +1225,70 @@ declare module "axios" {
1222
1225
  data: R;
1223
1226
  }
1224
1227
  }
1225
- export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1228
+ export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1226
1229
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1227
1230
  }
1228
- export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1231
+ export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1229
1232
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1230
1233
  }
1231
- export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1234
+ export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1232
1235
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1233
1236
  }
1234
- export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1237
+ export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1235
1238
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1236
1239
  }
1237
- export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1240
+ export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1238
1241
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1239
1242
  }
1240
- export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1243
+ export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1241
1244
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1242
1245
  }
1243
- export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1246
+ export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1244
1247
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1245
1248
  }
1246
- export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1249
+ export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1247
1250
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1248
1251
  }
1249
- export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1252
+ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1250
1253
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1251
1254
  }
1252
- export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1255
+ export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1253
1256
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1254
1257
  }
1255
- export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1258
+ export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1256
1259
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1257
1260
  }
1258
- export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1261
+ export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1259
1262
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1260
1263
  }
1261
- export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1264
+ export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1262
1265
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1263
1266
  }
1264
- export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1267
+ export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1265
1268
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1266
1269
  }
1267
- export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1270
+ export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1268
1271
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1269
1272
  }
1270
- export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1273
+ export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1271
1274
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1272
1275
  }
1273
- export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1276
+ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1274
1277
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1275
1278
  }
1276
- export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1279
+ export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1277
1280
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1278
1281
  }
1279
- export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1282
+ export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1280
1283
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1281
1284
  }
1282
- export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1285
+ export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1283
1286
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1284
1287
  }
1285
- export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1288
+ export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1286
1289
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1287
1290
  }
1288
- export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1291
+ export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1289
1292
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1290
1293
  }
1291
1294
  //# sourceMappingURL=restclient.d.ts.map