@openremote/rest 1.34.0-snapshot.20261104133435 → 1.34.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,29 +9,225 @@ export interface HttpClient<O> {
9
9
  options?: O;
10
10
  }): RestResponse<R>;
11
11
  }
12
- export declare class AppResourceClient<O> {
12
+ export declare class RealmResourceClient<O> {
13
13
  protected httpClient: HttpClient<O>;
14
14
  constructor(httpClient: HttpClient<O>);
15
15
  /**
16
- * Returns the identifiers of applications installed in the Manager web root.
17
- * HTTP GET /apps
18
- * Java method: org.openremote.model.apps.AppResource.getApps
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
19
  */
20
- getApps(options?: O): RestResponse<string[]>;
20
+ create(realm: Model.Realm, options?: O): RestResponse<void>;
21
21
  /**
22
- * Loads the public console_config.json document used to configure console clients before sign-in.
23
- * HTTP GET /apps/consoleConfig
24
- * Java method: org.openremote.model.apps.AppResource.getConsoleConfig
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
25
  */
26
- getConsoleConfig(options?: O): RestResponse<any>;
26
+ getAll(options?: O): RestResponse<Model.Realm[]>;
27
27
  /**
28
- * Loads each installed application's info.json file and returns the documents keyed by application identifier.
29
- * HTTP GET /apps/info
30
- * Java method: org.openremote.model.apps.AppResource.getAppInfos
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
31
  */
32
- getAppInfos(options?: O): RestResponse<{
33
- [index: string]: any;
34
- }>;
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
+ * Response code 409 - Realm cannot be deleted while it still contains assets
37
+ * HTTP DELETE /realm/{name}
38
+ * Java method: org.openremote.model.security.RealmResource.delete
39
+ */
40
+ delete(name: string, options?: O): RestResponse<void>;
41
+ /**
42
+ * 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.
43
+ * HTTP GET /realm/{name}
44
+ * Java method: org.openremote.model.security.RealmResource.get
45
+ */
46
+ get(name: string, options?: O): RestResponse<Model.Realm>;
47
+ /**
48
+ * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
49
+ * Response code 405 - The requested mutation is not allowed for the master realm
50
+ * HTTP PUT /realm/{name}
51
+ * Java method: org.openremote.model.security.RealmResource.update
52
+ */
53
+ update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
54
+ }
55
+ export declare class AgentResourceClient<O> {
56
+ protected httpClient: HttpClient<O>;
57
+ constructor(httpClient: HttpClient<O>);
58
+ /**
59
+ * 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.
60
+ * HTTP GET /agent/assetDiscovery/{agentId}
61
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
62
+ */
63
+ doProtocolAssetDiscovery(agentId: string, queryParams?: {
64
+ realm?: string;
65
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
66
+ /**
67
+ * Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
68
+ * Response code 405 - The selected agent protocol does not support asset import
69
+ * HTTP POST /agent/assetImport/{agentId}
70
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
71
+ */
72
+ doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
73
+ realm?: string;
74
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
75
+ /**
76
+ * 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.
77
+ * Response code 415 - The selected agent protocol does not support instance discovery
78
+ * HTTP GET /agent/instanceDiscovery/{agentType}
79
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
80
+ */
81
+ doProtocolInstanceDiscovery(agentType: string, queryParams?: {
82
+ parentId?: string;
83
+ realm?: string;
84
+ }, options?: O): RestResponse<Model.Agent[]>;
85
+ }
86
+ export declare class NotificationResourceClient<O> {
87
+ protected httpClient: HttpClient<O>;
88
+ constructor(httpClient: HttpClient<O>);
89
+ /**
90
+ * 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.
91
+ * HTTP GET /notification
92
+ * Java method: org.openremote.model.notification.NotificationResource.getNotifications
93
+ */
94
+ getNotifications(queryParams?: {
95
+ id?: number;
96
+ type?: string;
97
+ from?: number;
98
+ to?: number;
99
+ realmId?: string;
100
+ userId?: string;
101
+ assetId?: string;
102
+ source?: Model.NotificationSource;
103
+ sort?: Model.SentNotificationSortField;
104
+ descending?: boolean;
105
+ offset?: number;
106
+ limit?: number;
107
+ }, options?: O): RestResponse<Model.SentNotification[]>;
108
+ /**
109
+ * Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
110
+ * HTTP DELETE /notification
111
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotifications
112
+ */
113
+ removeNotifications(queryParams?: {
114
+ id?: number;
115
+ type?: string;
116
+ from?: number;
117
+ to?: number;
118
+ realmId?: string;
119
+ userId?: string;
120
+ assetId?: string;
121
+ }, options?: O): RestResponse<void>;
122
+ /**
123
+ * 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.
124
+ * HTTP POST /notification/alert
125
+ * Java method: org.openremote.model.notification.NotificationResource.sendNotification
126
+ */
127
+ sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
128
+ /**
129
+ * Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
130
+ * HTTP GET /notification/count
131
+ * Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
132
+ */
133
+ getNotificationsCount(queryParams?: {
134
+ type?: string;
135
+ from?: number;
136
+ to?: number;
137
+ realmId?: string;
138
+ userId?: string;
139
+ assetId?: string;
140
+ source?: Model.NotificationSource;
141
+ }, options?: O): RestResponse<number>;
142
+ /**
143
+ * Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
144
+ * HTTP DELETE /notification/{notificationId}
145
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotification
146
+ */
147
+ removeNotification(notificationId: number, options?: O): RestResponse<void>;
148
+ /**
149
+ * Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
150
+ * HTTP PUT /notification/{notificationId}/acknowledged
151
+ * Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
152
+ */
153
+ notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
154
+ targetId?: string;
155
+ }, options?: O): RestResponse<void>;
156
+ /**
157
+ * 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.
158
+ * HTTP PUT /notification/{notificationId}/delivered
159
+ * Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
160
+ */
161
+ notificationDelivered(notificationId: number, queryParams?: {
162
+ targetId?: string;
163
+ }, options?: O): RestResponse<void>;
164
+ }
165
+ export declare class ConfigurationResourceClient<O> {
166
+ protected httpClient: HttpClient<O>;
167
+ constructor(httpClient: HttpClient<O>);
168
+ /**
169
+ * Returns the public Manager application configuration used by clients before and after authentication.
170
+ * HTTP GET /configuration/manager
171
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
172
+ */
173
+ getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
174
+ /**
175
+ * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior. This operation is restricted to a super administrator.
176
+ * HTTP PUT /configuration/manager
177
+ * Java method: org.openremote.model.manager.ConfigurationResource.update
178
+ */
179
+ update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
180
+ /**
181
+ * Validates and stores the supplied image FileInfo at the requested relative path, replacing an existing image, then returns its Manager API path. This operation is restricted to a super administrator.
182
+ * HTTP POST /configuration/manager/image
183
+ * Java method: org.openremote.model.manager.ConfigurationResource.imageUpload
184
+ */
185
+ imageUpload(fileInfo: Model.FileInfo, queryParams?: {
186
+ path?: string;
187
+ }, options?: O): RestResponse<string>;
188
+ /**
189
+ * Streams a configuration image using a fixed media type determined by its filename extension. Only png, jpg, jpeg, ico, and svg extensions are served, ignoring case; unsupported extensions return 404.
190
+ * Response code 200 - The image file
191
+ * HTTP GET /configuration/manager/image/{filename: .+}
192
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
193
+ */
194
+ getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
195
+ }
196
+ export declare class GatewayServiceResourceClient<O> {
197
+ protected httpClient: HttpClient<O>;
198
+ constructor(httpClient: HttpClient<O>);
199
+ /**
200
+ * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
201
+ * Response code 417 - The gateway could not establish the requested tunnel
202
+ * HTTP POST /gateway/tunnel
203
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
204
+ */
205
+ startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
206
+ /**
207
+ * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
208
+ * HTTP DELETE /gateway/tunnel
209
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
210
+ */
211
+ stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
212
+ /**
213
+ * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
214
+ * HTTP GET /gateway/tunnel/{realm}
215
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
216
+ */
217
+ getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
218
+ /**
219
+ * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
220
+ * HTTP GET /gateway/tunnel/{realm}/{id}
221
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
222
+ */
223
+ getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
224
+ /**
225
+ * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
226
+ * Response code 204 - No active tunnel matches the requested endpoint
227
+ * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
228
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
229
+ */
230
+ getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
35
231
  }
36
232
  export declare class RulesResourceClient<O> {
37
233
  protected httpClient: HttpClient<O>;
@@ -163,422 +359,23 @@ export declare class RulesResourceClient<O> {
163
359
  */
164
360
  updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
165
361
  }
166
- export declare class AssetModelResourceClient<O> {
362
+ export declare class AssetResourceClient<O> {
167
363
  protected httpClient: HttpClient<O>;
168
364
  constructor(httpClient: HttpClient<O>);
169
365
  /**
170
- * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
171
- * HTTP GET /model/assetDescriptors
172
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
366
+ * Creates an asset in an accessible realm and returns the persisted representation. The server generates an ID when absent; supplied IDs must be globally unique and 22 characters long.
367
+ * HTTP POST /asset
368
+ * Java method: org.openremote.model.asset.AssetResource.create
173
369
  */
174
- getAssetDescriptors(queryParams?: {
175
- parentId?: string;
176
- parentType?: string;
177
- }, options?: O): RestResponse<Model.AssetDescriptor[]>;
370
+ create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
178
371
  /**
179
- * 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.
180
- * Response code 204 - No model information is available for the requested asset type
181
- * HTTP GET /model/assetInfo/{assetType}
182
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
372
+ * Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
373
+ * HTTP DELETE /asset
374
+ * Java method: org.openremote.model.asset.AssetResource.delete
183
375
  */
184
- getAssetInfo(assetType: string, queryParams?: {
185
- parentId?: string;
186
- }, options?: O): RestResponse<Model.AssetTypeInfo>;
187
- /**
188
- * 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.
189
- * HTTP GET /model/assetInfos
190
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
191
- */
192
- getAssetInfos(queryParams?: {
193
- parentId?: string;
194
- parentType?: string;
195
- }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
196
- /**
197
- * 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.
198
- * Response code 200 - The current JSON Schema
199
- * Response code 304 - The supplied ETag still identifies the current schema
200
- * HTTP GET /model/getValueDescriptorSchema
201
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
202
- */
203
- getValueDescriptorSchema(queryParams?: {
204
- name?: string;
205
- }, options?: O): RestResponse<any>;
206
- /**
207
- * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
208
- * HTTP GET /model/metaItemDescriptors
209
- * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
210
- */
211
- getMetaItemDescriptors(queryParams?: {
212
- parentId?: string;
213
- }, options?: O): RestResponse<{
214
- [index: string]: Model.MetaItemDescriptor;
215
- }>;
216
- /**
217
- * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
218
- * HTTP GET /model/valueDescriptors
219
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
220
- */
221
- getValueDescriptors(queryParams?: {
222
- parentId?: string;
223
- }, options?: O): RestResponse<{
224
- [index: string]: Model.ValueDescriptor;
225
- }>;
226
- }
227
- export declare class AlarmResourceClient<O> {
228
- protected httpClient: HttpClient<O>;
229
- constructor(httpClient: HttpClient<O>);
230
- /**
231
- * 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.
232
- * HTTP POST /alarm
233
- * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
234
- */
235
- createAlarm(alarm: Model.Alarm, queryParams?: {
236
- assetIds?: string[];
237
- }, options?: O): RestResponse<Model.SentAlarm>;
238
- /**
239
- * Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
240
- * HTTP GET /alarm
241
- * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
242
- */
243
- getAlarms(queryParams?: {
244
- realm?: string;
245
- status?: Model.AlarmStatus;
246
- assetId?: string;
247
- assigneeId?: string;
248
- }, options?: O): RestResponse<Model.SentAlarm[]>;
249
- /**
250
- * Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
251
- * HTTP DELETE /alarm
252
- * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
253
- */
254
- removeAlarms(ids: number[], options?: O): RestResponse<void>;
255
- /**
256
- * Adds links between assets and one existing alarm.
257
-
258
- The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
259
- every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
260
- every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
261
- containing mixed alarm IDs or realms are rejected as bad requests.
262
-
263
- Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
264
- This operation does not remove existing links from the alarm.
265
-
266
- * HTTP PUT /alarm/assets
267
- * Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
268
- */
269
- setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
270
- /**
271
- * Returns one alarm when its realm is active and accessible to the authenticated user.
272
- * HTTP GET /alarm/{alarmId}
273
- * Java method: org.openremote.model.alarm.AlarmResource.getAlarm
274
- */
275
- getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
276
- /**
277
- * Permanently removes one alarm after verifying access to its realm.
278
- * HTTP DELETE /alarm/{alarmId}
279
- * Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
280
- */
281
- removeAlarm(alarmId: number, options?: O): RestResponse<void>;
282
- /**
283
- * Updates the mutable state of an existing alarm after verifying access to its current realm.
284
- * HTTP PUT /alarm/{alarmId}
285
- * Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
286
- */
287
- updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
288
- /**
289
- * Returns links from the alarm to assets in the explicitly supplied accessible realm.
290
- * HTTP GET /alarm/{alarmId}/assets
291
- * Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
292
- */
293
- getAssetLinks(alarmId: number, queryParams?: {
294
- realm?: string;
295
- }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
296
- }
297
- export declare class SyslogResourceClient<O> {
298
- protected httpClient: HttpClient<O>;
299
- constructor(httpClient: HttpClient<O>);
300
- /**
301
- * Returns the current log-storage and retention configuration. This operation is restricted to a super administrator.
302
- * HTTP GET /syslog/config
303
- * Java method: org.openremote.model.syslog.SyslogResource.getConfig
304
- */
305
- getConfig(options?: O): RestResponse<Model.SyslogConfig>;
306
- /**
307
- * Validates and applies log-storage and retention settings. This operation is restricted to a super administrator.
308
- * HTTP PUT /syslog/config
309
- * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
310
- */
311
- updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
312
- /**
313
- * Permanently removes all events from the configured syslog storage. This operation is restricted to a super administrator.
314
- * HTTP DELETE /syslog/event
315
- * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
316
- */
317
- clearEvents(options?: O): RestResponse<void>;
318
- /**
319
- * 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.
320
- * Response code 200 - The requested page of syslog events
321
- * HTTP GET /syslog/event
322
- * Java method: org.openremote.model.syslog.SyslogResource.getEvents
323
- */
324
- getEvents(queryParams?: {
325
- level?: Model.SyslogLevel;
326
- per_page?: number;
327
- page?: number;
328
- from?: number;
329
- to?: number;
330
- category?: Model.SyslogCategory[];
331
- subCategory?: string[];
332
- }, options?: O): RestResponse<any>;
333
- }
334
- export declare class GatewayClientResourceClient<O> {
335
- protected httpClient: HttpClient<O>;
336
- constructor(httpClient: HttpClient<O>);
337
- /**
338
- * Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
339
- * HTTP DELETE /gateway/connection
340
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
341
- */
342
- deleteConnections(queryParams?: {
343
- realm?: string[];
344
- }, options?: O): RestResponse<void>;
345
- /**
346
- * Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
347
- * HTTP GET /gateway/connection
348
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
349
- */
350
- getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
351
- /**
352
- * Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
353
- * HTTP DELETE /gateway/connection/{realm}
354
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
355
- */
356
- deleteConnection(realm: string, options?: O): RestResponse<void>;
357
- /**
358
- * 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.
359
- * Response code 204 - No gateway connection is configured for the realm
360
- * HTTP GET /gateway/connection/{realm}
361
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
362
- */
363
- getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
364
- /**
365
- * 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.
366
- * HTTP PUT /gateway/connection/{realm}
367
- * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
368
- */
369
- setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
370
- /**
371
- * Returns the live connection state for the requested local realm.
372
- * HTTP GET /gateway/status/{realm}
373
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
374
- */
375
- getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
376
- }
377
- export declare class FlowResourceClient<O> {
378
- protected httpClient: HttpClient<O>;
379
- constructor(httpClient: HttpClient<O>);
380
- /**
381
- * Returns every supported flow node definition except the internal LOG_OUTPUT node.
382
- * HTTP GET /flow
383
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
384
- */
385
- getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
386
- /**
387
- * Resolves one flow node definition by its model name.
388
- * HTTP GET /flow/{name}
389
- * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
390
- */
391
- getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
392
- /**
393
- * Returns supported flow node definitions whose category matches the requested node type.
394
- * HTTP GET /flow/{type}
395
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
396
- */
397
- getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
398
- }
399
- export declare class AssetDatapointResourceClient<O> {
400
- protected httpClient: HttpClient<O>;
401
- constructor(httpClient: HttpClient<O>);
402
- /**
403
- * Streams a ZIP archive containing exported datapoints for one or more attribute references over the requested inclusive time range. attributeRefs is a JSON-encoded array of objects with id and name fields.
404
- * Response code 200 - A ZIP archive containing the exported data
405
- * HTTP GET /asset/datapoint/export
406
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
407
- */
408
- getDatapointExport(queryParams?: {
409
- attributeRefs?: string;
410
- fromTimestamp?: number;
411
- toTimestamp?: number;
412
- format?: Model.DatapointExportFormat;
413
- }, options?: O): RestResponse<any>;
414
- /**
415
- * Returns the oldest and newest stored timestamps for one attribute. The asset and attribute must be readable by the authenticated user and configured for datapoint storage.
416
- * HTTP GET /asset/datapoint/periods
417
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
418
- */
419
- getDatapointPeriod(queryParams?: {
420
- assetId?: string;
421
- attributeName?: string;
422
- }, options?: O): RestResponse<Model.DatapointPeriod>;
423
- /**
424
- * Returns stored historical values for one attribute. A null body returns the available series; a polymorphic query body controls the time range and retrieval or aggregation strategy. Anonymous access requires public-read access on both asset and attribute.
425
- * HTTP POST /asset/datapoint/{assetId}/{attributeName}
426
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
427
- */
428
- getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
429
- }
430
- export declare class ProvisioningResourceClient<O> {
431
- protected httpClient: HttpClient<O>;
432
- constructor(httpClient: HttpClient<O>);
433
- /**
434
- * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
435
- * HTTP POST /provisioning
436
- * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
437
- */
438
- createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
439
- /**
440
- * Returns every provisioning configuration. This operation is restricted to a super administrator.
441
- * HTTP GET /provisioning
442
- * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
443
- */
444
- getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
445
- /**
446
- * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
447
- * HTTP DELETE /provisioning/{id}
448
- * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
449
- */
450
- deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
451
- /**
452
- * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
453
- * HTTP PUT /provisioning/{id}
454
- * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
455
- */
456
- updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
457
- }
458
- export declare class GatewayServiceResourceClient<O> {
459
- protected httpClient: HttpClient<O>;
460
- constructor(httpClient: HttpClient<O>);
461
- /**
462
- * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
463
- * Response code 417 - The gateway could not establish the requested tunnel
464
- * HTTP POST /gateway/tunnel
465
- * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
466
- */
467
- startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
468
- /**
469
- * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
470
- * HTTP DELETE /gateway/tunnel
471
- * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
472
- */
473
- stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
474
- /**
475
- * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
476
- * HTTP GET /gateway/tunnel/{realm}
477
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
478
- */
479
- getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
480
- /**
481
- * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
482
- * HTTP GET /gateway/tunnel/{realm}/{id}
483
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
484
- */
485
- getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
486
- /**
487
- * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
488
- * Response code 204 - No active tunnel matches the requested endpoint
489
- * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
490
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
491
- */
492
- getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
493
- }
494
- export declare class DashboardResourceClient<O> {
495
- protected httpClient: HttpClient<O>;
496
- constructor(httpClient: HttpClient<O>);
497
- /**
498
- * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
499
- * HTTP POST /dashboard
500
- * Java method: org.openremote.model.dashboard.DashboardResource.create
501
- */
502
- create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
503
- /**
504
- * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
505
- * HTTP PUT /dashboard
506
- * Java method: org.openremote.model.dashboard.DashboardResource.update
507
- */
508
- update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
509
- /**
510
- * 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.
511
- * HTTP GET /dashboard/all/{realm}
512
- * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
513
- */
514
- getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
515
- /**
516
- * 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.
517
- * HTTP POST /dashboard/query
518
- * Java method: org.openremote.model.dashboard.DashboardResource.query
519
- */
520
- query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
521
- /**
522
- * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
523
- * HTTP DELETE /dashboard/{realm}/{dashboardId}
524
- * Java method: org.openremote.model.dashboard.DashboardResource.delete
525
- */
526
- delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
527
- /**
528
- * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
529
- * HTTP GET /dashboard/{realm}/{dashboardId}
530
- * Java method: org.openremote.model.dashboard.DashboardResource.get
531
- */
532
- get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
533
- }
534
- export declare class AgentResourceClient<O> {
535
- protected httpClient: HttpClient<O>;
536
- constructor(httpClient: HttpClient<O>);
537
- /**
538
- * 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.
539
- * HTTP GET /agent/assetDiscovery/{agentId}
540
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
541
- */
542
- doProtocolAssetDiscovery(agentId: string, queryParams?: {
543
- realm?: string;
544
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
545
- /**
546
- * Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
547
- * Response code 405 - The selected agent protocol does not support asset import
548
- * HTTP POST /agent/assetImport/{agentId}
549
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
550
- */
551
- doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
552
- realm?: string;
553
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
554
- /**
555
- * 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.
556
- * Response code 415 - The selected agent protocol does not support instance discovery
557
- * HTTP GET /agent/instanceDiscovery/{agentType}
558
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
559
- */
560
- doProtocolInstanceDiscovery(agentType: string, queryParams?: {
561
- parentId?: string;
562
- realm?: string;
563
- }, options?: O): RestResponse<Model.Agent[]>;
564
- }
565
- export declare class AssetResourceClient<O> {
566
- protected httpClient: HttpClient<O>;
567
- constructor(httpClient: HttpClient<O>);
568
- /**
569
- * Creates an asset in an accessible realm and returns the persisted representation. The server generates an ID when absent; supplied IDs must be globally unique and 22 characters long.
570
- * HTTP POST /asset
571
- * Java method: org.openremote.model.asset.AssetResource.create
572
- */
573
- create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
574
- /**
575
- * Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
576
- * HTTP DELETE /asset
577
- * Java method: org.openremote.model.asset.AssetResource.delete
578
- */
579
- delete(queryParams?: {
580
- assetId?: string[];
581
- }, options?: O): RestResponse<void>;
376
+ delete(queryParams?: {
377
+ assetId?: string[];
378
+ }, options?: O): RestResponse<void>;
582
379
  /**
583
380
  * Submits a batch of attribute states using current server time and returns one result per input item. Authorization and processing failures are encoded in each AttributeWriteResult rather than returned as an HTTP error.
584
381
  * HTTP PUT /asset/attributes
@@ -857,368 +654,571 @@ export declare class UserResourceClient<O> {
857
654
  */
858
655
  get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
859
656
  }
860
- export declare class AssetPredictedDatapointResourceClient<O> {
657
+ export declare class AssetDatapointResourceClient<O> {
861
658
  protected httpClient: HttpClient<O>;
862
659
  constructor(httpClient: HttpClient<O>);
863
660
  /**
864
- * 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.
865
- * HTTP POST /asset/predicted/{assetId}/{attributeName}
866
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
661
+ * Streams a ZIP archive containing exported datapoints for one or more attribute references over the requested inclusive time range. attributeRefs is a JSON-encoded array of objects with id and name fields.
662
+ * Response code 200 - A ZIP archive containing the exported data
663
+ * HTTP GET /asset/datapoint/export
664
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
867
665
  */
868
- getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
666
+ getDatapointExport(queryParams?: {
667
+ attributeRefs?: string;
668
+ fromTimestamp?: number;
669
+ toTimestamp?: number;
670
+ format?: Model.DatapointExportFormat;
671
+ }, options?: O): RestResponse<any>;
869
672
  /**
870
- * 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.
871
- * HTTP PUT /asset/predicted/{assetId}/{attributeName}
872
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
673
+ * Returns the oldest and newest stored timestamps for one attribute. The asset and attribute must be readable by the authenticated user and configured for datapoint storage.
674
+ * HTTP GET /asset/datapoint/periods
675
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
873
676
  */
874
- writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
677
+ getDatapointPeriod(queryParams?: {
678
+ assetId?: string;
679
+ attributeName?: string;
680
+ }, options?: O): RestResponse<Model.DatapointPeriod>;
681
+ /**
682
+ * Returns stored historical values for one attribute. A null body returns the available series; a polymorphic query body controls the time range and retrieval or aggregation strategy. Anonymous access requires public-read access on both asset and attribute.
683
+ * HTTP POST /asset/datapoint/{assetId}/{attributeName}
684
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
685
+ */
686
+ getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
687
+ }
688
+ export declare class AppResourceClient<O> {
689
+ protected httpClient: HttpClient<O>;
690
+ constructor(httpClient: HttpClient<O>);
691
+ /**
692
+ * Returns the identifiers of applications installed in the Manager web root.
693
+ * HTTP GET /apps
694
+ * Java method: org.openremote.model.apps.AppResource.getApps
695
+ */
696
+ getApps(options?: O): RestResponse<string[]>;
697
+ /**
698
+ * Loads the public console_config.json document used to configure console clients before sign-in.
699
+ * HTTP GET /apps/consoleConfig
700
+ * Java method: org.openremote.model.apps.AppResource.getConsoleConfig
701
+ */
702
+ getConsoleConfig(options?: O): RestResponse<any>;
703
+ /**
704
+ * Loads each installed application's info.json file and returns the documents keyed by application identifier.
705
+ * HTTP GET /apps/info
706
+ * Java method: org.openremote.model.apps.AppResource.getAppInfos
707
+ */
708
+ getAppInfos(options?: O): RestResponse<{
709
+ [index: string]: any;
710
+ }>;
711
+ }
712
+ export declare class ExternalServiceResourceClient<O> {
713
+ protected httpClient: HttpClient<O>;
714
+ constructor(httpClient: HttpClient<O>);
715
+ /**
716
+ * Returns all active realm-scoped service registrations for an active realm accessible to the caller.
717
+ * Response code 200 - List of registered external services
718
+ * HTTP GET /service
719
+ * Java method: org.openremote.model.services.ExternalServiceResource.getServices
720
+ */
721
+ getServices(queryParams?: {
722
+ realm?: string;
723
+ }, options?: O): RestResponse<Model.ExternalService[]>;
724
+ /**
725
+ * 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.
726
+ * Response code 200 - Service registered successfully
727
+ * Response code 400 - Invalid external service object
728
+ * Response code 409 - ExternalService instance already registered
729
+ * HTTP POST /service
730
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerService
731
+ */
732
+ registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
733
+ /**
734
+ * Returns active registrations marked as globally available across realms.
735
+ * Response code 200 - List of registered external services
736
+ * HTTP GET /service/global
737
+ * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
738
+ */
739
+ getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
740
+ /**
741
+ * Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
742
+ * Response code 200 - Service registered successfully
743
+ * Response code 400 - Invalid external service object
744
+ * Response code 409 - ExternalService instance already registered
745
+ * HTTP POST /service/global
746
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
747
+ */
748
+ registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
749
+ /**
750
+ * Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
751
+ * Response code 204 - Service deregistered successfully
752
+ * Response code 404 - Service instance not found
753
+ * HTTP DELETE /service/{serviceId}/{instanceId}
754
+ * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
755
+ */
756
+ deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
757
+ /**
758
+ * Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
759
+ * Response code 200 - ExternalService retrieved successfully
760
+ * Response code 404 - ExternalService not found
761
+ * HTTP GET /service/{serviceId}/{instanceId}
762
+ * Java method: org.openremote.model.services.ExternalServiceResource.getService
763
+ */
764
+ getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
765
+ /**
766
+ * 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.
767
+ * Response code 204 - Heartbeat sent successfully
768
+ * Response code 404 - Service instance not found
769
+ * HTTP PUT /service/{serviceId}/{instanceId}
770
+ * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
771
+ */
772
+ heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
773
+ }
774
+ export declare class AlarmResourceClient<O> {
775
+ protected httpClient: HttpClient<O>;
776
+ constructor(httpClient: HttpClient<O>);
777
+ /**
778
+ * 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.
779
+ * HTTP POST /alarm
780
+ * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
781
+ */
782
+ createAlarm(alarm: Model.Alarm, queryParams?: {
783
+ assetIds?: string[];
784
+ }, options?: O): RestResponse<Model.SentAlarm>;
785
+ /**
786
+ * Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
787
+ * HTTP GET /alarm
788
+ * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
789
+ */
790
+ getAlarms(queryParams?: {
791
+ realm?: string;
792
+ status?: Model.AlarmStatus;
793
+ assetId?: string;
794
+ assigneeId?: string;
795
+ }, options?: O): RestResponse<Model.SentAlarm[]>;
796
+ /**
797
+ * Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
798
+ * HTTP DELETE /alarm
799
+ * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
800
+ */
801
+ removeAlarms(ids: number[], options?: O): RestResponse<void>;
802
+ /**
803
+ * Adds links between assets and one existing alarm.
804
+
805
+ The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
806
+ every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
807
+ every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
808
+ containing mixed alarm IDs or realms are rejected as bad requests.
809
+
810
+ Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
811
+ This operation does not remove existing links from the alarm.
812
+
813
+ * HTTP PUT /alarm/assets
814
+ * Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
815
+ */
816
+ setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
817
+ /**
818
+ * Returns one alarm when its realm is active and accessible to the authenticated user.
819
+ * HTTP GET /alarm/{alarmId}
820
+ * Java method: org.openremote.model.alarm.AlarmResource.getAlarm
821
+ */
822
+ getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
823
+ /**
824
+ * Permanently removes one alarm after verifying access to its realm.
825
+ * HTTP DELETE /alarm/{alarmId}
826
+ * Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
827
+ */
828
+ removeAlarm(alarmId: number, options?: O): RestResponse<void>;
829
+ /**
830
+ * Updates the mutable state of an existing alarm after verifying access to its current realm.
831
+ * HTTP PUT /alarm/{alarmId}
832
+ * Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
833
+ */
834
+ updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
835
+ /**
836
+ * Returns links from the alarm to assets in the explicitly supplied accessible realm.
837
+ * HTTP GET /alarm/{alarmId}/assets
838
+ * Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
839
+ */
840
+ getAssetLinks(alarmId: number, queryParams?: {
841
+ realm?: string;
842
+ }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
843
+ }
844
+ export declare class AssetModelResourceClient<O> {
845
+ protected httpClient: HttpClient<O>;
846
+ constructor(httpClient: HttpClient<O>);
847
+ /**
848
+ * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
849
+ * HTTP GET /model/assetDescriptors
850
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
851
+ */
852
+ getAssetDescriptors(queryParams?: {
853
+ parentId?: string;
854
+ parentType?: string;
855
+ }, options?: O): RestResponse<Model.AssetDescriptor[]>;
856
+ /**
857
+ * 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.
858
+ * Response code 204 - No model information is available for the requested asset type
859
+ * HTTP GET /model/assetInfo/{assetType}
860
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
861
+ */
862
+ getAssetInfo(assetType: string, queryParams?: {
863
+ parentId?: string;
864
+ }, options?: O): RestResponse<Model.AssetTypeInfo>;
865
+ /**
866
+ * 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.
867
+ * HTTP GET /model/assetInfos
868
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
869
+ */
870
+ getAssetInfos(queryParams?: {
871
+ parentId?: string;
872
+ parentType?: string;
873
+ }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
874
+ /**
875
+ * 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.
876
+ * Response code 200 - The current JSON Schema
877
+ * Response code 304 - The supplied ETag still identifies the current schema
878
+ * HTTP GET /model/getValueDescriptorSchema
879
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
880
+ */
881
+ getValueDescriptorSchema(queryParams?: {
882
+ name?: string;
883
+ }, options?: O): RestResponse<any>;
884
+ /**
885
+ * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
886
+ * HTTP GET /model/metaItemDescriptors
887
+ * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
888
+ */
889
+ getMetaItemDescriptors(queryParams?: {
890
+ parentId?: string;
891
+ }, options?: O): RestResponse<{
892
+ [index: string]: Model.MetaItemDescriptor;
893
+ }>;
894
+ /**
895
+ * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
896
+ * HTTP GET /model/valueDescriptors
897
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
898
+ */
899
+ getValueDescriptors(queryParams?: {
900
+ parentId?: string;
901
+ }, options?: O): RestResponse<{
902
+ [index: string]: Model.ValueDescriptor;
903
+ }>;
875
904
  }
876
- export declare class ExternalServiceResourceClient<O> {
905
+ export declare class ConsoleResourceClient<O> {
877
906
  protected httpClient: HttpClient<O>;
878
907
  constructor(httpClient: HttpClient<O>);
879
908
  /**
880
- * Returns all active realm-scoped service registrations for an active realm accessible to the caller.
881
- * Response code 200 - List of registered external services
882
- * HTTP GET /service
883
- * Java method: org.openremote.model.services.ExternalServiceResource.getServices
884
- */
885
- getServices(queryParams?: {
886
- realm?: string;
887
- }, options?: O): RestResponse<Model.ExternalService[]>;
888
- /**
889
- * 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.
890
- * Response code 200 - Service registered successfully
891
- * Response code 400 - Invalid external service object
892
- * Response code 409 - ExternalService instance already registered
893
- * HTTP POST /service
894
- * Java method: org.openremote.model.services.ExternalServiceResource.registerService
895
- */
896
- registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
897
- /**
898
- * Returns active registrations marked as globally available across realms.
899
- * Response code 200 - List of registered external services
900
- * HTTP GET /service/global
901
- * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
909
+ * 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.
910
+ * HTTP POST /console/register
911
+ * Java method: org.openremote.model.console.ConsoleResource.register
902
912
  */
903
- getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
913
+ register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
914
+ }
915
+ export declare class ProvisioningResourceClient<O> {
916
+ protected httpClient: HttpClient<O>;
917
+ constructor(httpClient: HttpClient<O>);
904
918
  /**
905
- * Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
906
- * Response code 200 - Service registered successfully
907
- * Response code 400 - Invalid external service object
908
- * Response code 409 - ExternalService instance already registered
909
- * HTTP POST /service/global
910
- * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
919
+ * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
920
+ * HTTP POST /provisioning
921
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
911
922
  */
912
- registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
923
+ createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
913
924
  /**
914
- * Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
915
- * Response code 204 - Service deregistered successfully
916
- * Response code 404 - Service instance not found
917
- * HTTP DELETE /service/{serviceId}/{instanceId}
918
- * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
925
+ * Returns every provisioning configuration. This operation is restricted to a super administrator.
926
+ * HTTP GET /provisioning
927
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
919
928
  */
920
- deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
929
+ getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
921
930
  /**
922
- * Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
923
- * Response code 200 - ExternalService retrieved successfully
924
- * Response code 404 - ExternalService not found
925
- * HTTP GET /service/{serviceId}/{instanceId}
926
- * Java method: org.openremote.model.services.ExternalServiceResource.getService
931
+ * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
932
+ * HTTP DELETE /provisioning/{id}
933
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
927
934
  */
928
- getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
935
+ deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
929
936
  /**
930
- * 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.
931
- * Response code 204 - Heartbeat sent successfully
932
- * Response code 404 - Service instance not found
933
- * HTTP PUT /service/{serviceId}/{instanceId}
934
- * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
937
+ * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
938
+ * HTTP PUT /provisioning/{id}
939
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
935
940
  */
936
- heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
941
+ updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
937
942
  }
938
- export declare class MapResourceClient<O> {
943
+ export declare class GatewayClientResourceClient<O> {
939
944
  protected httpClient: HttpClient<O>;
940
945
  constructor(httpClient: HttpClient<O>);
941
946
  /**
942
- * Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
943
- * HTTP GET /map
944
- * Java method: org.openremote.model.map.MapResource.getSettings
947
+ * Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
948
+ * HTTP DELETE /gateway/connection
949
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
945
950
  */
946
- getSettings(options?: O): RestResponse<{
947
- [id: string]: unknown;
948
- }>;
951
+ deleteConnections(queryParams?: {
952
+ realm?: string[];
953
+ }, options?: O): RestResponse<void>;
949
954
  /**
950
- * Stores the map configuration and returns the resulting public MapLibre settings. This operation is restricted to a super administrator.
951
- * HTTP PUT /map
952
- * Java method: org.openremote.model.map.MapResource.saveSettings
955
+ * Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
956
+ * HTTP GET /gateway/connection
957
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
953
958
  */
954
- saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
955
- [id: string]: unknown;
956
- }>;
959
+ getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
957
960
  /**
958
- * Deletes the installed custom MBTiles database and returns the fallback public map settings. This operation is restricted to a super administrator.
959
- * HTTP DELETE /map/deleteMap
960
- * Java method: org.openremote.model.map.MapResource.deleteMap
961
+ * Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
962
+ * HTTP DELETE /gateway/connection/{realm}
963
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
961
964
  */
962
- deleteMap(options?: O): RestResponse<{
963
- [id: string]: unknown;
964
- }>;
965
+ deleteConnection(realm: string, options?: O): RestResponse<void>;
965
966
  /**
966
- * Reports whether custom MBTiles data is installed and the maximum accepted upload size.
967
- * HTTP GET /map/getCustomMapInfo
968
- * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
967
+ * 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.
968
+ * Response code 204 - No gateway connection is configured for the realm
969
+ * HTTP GET /gateway/connection/{realm}
970
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
969
971
  */
970
- getCustomMapInfo(options?: O): RestResponse<{
971
- [id: string]: unknown;
972
- }>;
972
+ getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
973
973
  /**
974
- * Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
975
- * Response code 200 - Gzip-compressed vector tile
976
- * Response code 204 - No tile exists at the requested coordinates
977
- * HTTP GET /map/tile/{zoom}/{column}/{row}
978
- * Java method: org.openremote.model.map.MapResource.getTile
974
+ * 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.
975
+ * HTTP PUT /gateway/connection/{realm}
976
+ * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
979
977
  */
980
- getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
978
+ setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
981
979
  /**
982
- * Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings. This operation is restricted to a super administrator.
983
- * HTTP POST /map/upload
984
- * Java method: org.openremote.model.map.MapResource.uploadMap
980
+ * Returns the live connection state for the requested local realm.
981
+ * HTTP GET /gateway/status/{realm}
982
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
985
983
  */
986
- uploadMap(queryParams?: {
987
- filename?: string;
988
- }, options?: O): RestResponse<{
989
- [id: string]: unknown;
990
- }>;
984
+ getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
991
985
  }
992
- export declare class StatusResourceClient<O> {
986
+ export declare class SyslogResourceClient<O> {
993
987
  protected httpClient: HttpClient<O>;
994
988
  constructor(httpClient: HttpClient<O>);
995
989
  /**
996
- * Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
997
- * HTTP GET /health
998
- * Java method: org.openremote.model.system.StatusResource.getHealthStatus
990
+ * Returns the current log-storage and retention configuration. This operation is restricted to a super administrator.
991
+ * HTTP GET /syslog/config
992
+ * Java method: org.openremote.model.syslog.SyslogResource.getConfig
999
993
  */
1000
- getHealthStatus(options?: O): RestResponse<{
1001
- [index: string]: any;
1002
- }>;
994
+ getConfig(options?: O): RestResponse<Model.SyslogConfig>;
1003
995
  /**
1004
- * Returns public bootstrap information, including the Manager version and identity-provider URL.
1005
- * HTTP GET /info
1006
- * Java method: org.openremote.model.system.StatusResource.getInfo
996
+ * Validates and applies log-storage and retention settings. This operation is restricted to a super administrator.
997
+ * HTTP PUT /syslog/config
998
+ * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
1007
999
  */
1008
- getInfo(options?: O): RestResponse<{
1009
- [index: string]: any;
1010
- }>;
1011
- }
1012
- export declare class NotificationResourceClient<O> {
1013
- protected httpClient: HttpClient<O>;
1014
- constructor(httpClient: HttpClient<O>);
1000
+ updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
1015
1001
  /**
1016
- * 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.
1017
- * HTTP GET /notification
1018
- * Java method: org.openremote.model.notification.NotificationResource.getNotifications
1002
+ * Permanently removes all events from the configured syslog storage. This operation is restricted to a super administrator.
1003
+ * HTTP DELETE /syslog/event
1004
+ * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
1019
1005
  */
1020
- getNotifications(queryParams?: {
1021
- id?: number;
1022
- type?: string;
1023
- from?: number;
1024
- to?: number;
1025
- realmId?: string;
1026
- userId?: string;
1027
- assetId?: string;
1028
- source?: Model.NotificationSource;
1029
- sort?: Model.SentNotificationSortField;
1030
- descending?: boolean;
1031
- offset?: number;
1032
- limit?: number;
1033
- }, options?: O): RestResponse<Model.SentNotification[]>;
1006
+ clearEvents(options?: O): RestResponse<void>;
1034
1007
  /**
1035
- * Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
1036
- * HTTP DELETE /notification
1037
- * Java method: org.openremote.model.notification.NotificationResource.removeNotifications
1008
+ * 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.
1009
+ * Response code 200 - The requested page of syslog events
1010
+ * HTTP GET /syslog/event
1011
+ * Java method: org.openremote.model.syslog.SyslogResource.getEvents
1038
1012
  */
1039
- removeNotifications(queryParams?: {
1040
- id?: number;
1041
- type?: string;
1013
+ getEvents(queryParams?: {
1014
+ level?: Model.SyslogLevel;
1015
+ per_page?: number;
1016
+ page?: number;
1042
1017
  from?: number;
1043
1018
  to?: number;
1044
- realmId?: string;
1045
- userId?: string;
1046
- assetId?: string;
1047
- }, options?: O): RestResponse<void>;
1019
+ category?: Model.SyslogCategory[];
1020
+ subCategory?: string[];
1021
+ }, options?: O): RestResponse<any>;
1022
+ }
1023
+ export declare class FlowResourceClient<O> {
1024
+ protected httpClient: HttpClient<O>;
1025
+ constructor(httpClient: HttpClient<O>);
1048
1026
  /**
1049
- * 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.
1050
- * HTTP POST /notification/alert
1051
- * Java method: org.openremote.model.notification.NotificationResource.sendNotification
1027
+ * Returns every supported flow node definition except the internal LOG_OUTPUT node.
1028
+ * HTTP GET /flow
1029
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
1052
1030
  */
1053
- sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
1031
+ getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
1054
1032
  /**
1055
- * Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
1056
- * HTTP GET /notification/count
1057
- * Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
1033
+ * Resolves one flow node definition by its model name.
1034
+ * HTTP GET /flow/{name}
1035
+ * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
1058
1036
  */
1059
- getNotificationsCount(queryParams?: {
1060
- type?: string;
1061
- from?: number;
1062
- to?: number;
1063
- realmId?: string;
1064
- userId?: string;
1065
- assetId?: string;
1066
- source?: Model.NotificationSource;
1067
- }, options?: O): RestResponse<number>;
1037
+ getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
1068
1038
  /**
1069
- * Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
1070
- * HTTP DELETE /notification/{notificationId}
1071
- * Java method: org.openremote.model.notification.NotificationResource.removeNotification
1039
+ * Returns supported flow node definitions whose category matches the requested node type.
1040
+ * HTTP GET /flow/{type}
1041
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
1072
1042
  */
1073
- removeNotification(notificationId: number, options?: O): RestResponse<void>;
1043
+ getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
1044
+ }
1045
+ export declare class AssetPredictedDatapointResourceClient<O> {
1046
+ protected httpClient: HttpClient<O>;
1047
+ constructor(httpClient: HttpClient<O>);
1074
1048
  /**
1075
- * Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
1076
- * HTTP PUT /notification/{notificationId}/acknowledged
1077
- * Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
1049
+ * 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.
1050
+ * HTTP POST /asset/predicted/{assetId}/{attributeName}
1051
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
1078
1052
  */
1079
- notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
1080
- targetId?: string;
1081
- }, options?: O): RestResponse<void>;
1053
+ getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
1082
1054
  /**
1083
- * 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.
1084
- * HTTP PUT /notification/{notificationId}/delivered
1085
- * Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
1055
+ * 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.
1056
+ * HTTP PUT /asset/predicted/{assetId}/{attributeName}
1057
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
1086
1058
  */
1087
- notificationDelivered(notificationId: number, queryParams?: {
1088
- targetId?: string;
1089
- }, options?: O): RestResponse<void>;
1059
+ writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
1090
1060
  }
1091
- export declare class ConfigurationResourceClient<O> {
1061
+ export declare class DashboardResourceClient<O> {
1092
1062
  protected httpClient: HttpClient<O>;
1093
1063
  constructor(httpClient: HttpClient<O>);
1094
1064
  /**
1095
- * Returns the public Manager application configuration used by clients before and after authentication.
1096
- * HTTP GET /configuration/manager
1097
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
1065
+ * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
1066
+ * HTTP POST /dashboard
1067
+ * Java method: org.openremote.model.dashboard.DashboardResource.create
1098
1068
  */
1099
- getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
1069
+ create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
1100
1070
  /**
1101
- * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior. This operation is restricted to a super administrator.
1102
- * HTTP PUT /configuration/manager
1103
- * Java method: org.openremote.model.manager.ConfigurationResource.update
1071
+ * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
1072
+ * HTTP PUT /dashboard
1073
+ * Java method: org.openremote.model.dashboard.DashboardResource.update
1104
1074
  */
1105
- update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
1075
+ update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
1106
1076
  /**
1107
- * Validates and stores the supplied image FileInfo at the requested relative path, replacing an existing image, then returns its Manager API path. This operation is restricted to a super administrator.
1108
- * HTTP POST /configuration/manager/image
1109
- * Java method: org.openremote.model.manager.ConfigurationResource.imageUpload
1077
+ * 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.
1078
+ * HTTP GET /dashboard/all/{realm}
1079
+ * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
1110
1080
  */
1111
- imageUpload(fileInfo: Model.FileInfo, queryParams?: {
1112
- path?: string;
1113
- }, options?: O): RestResponse<string>;
1081
+ getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
1114
1082
  /**
1115
- * Streams a configuration image using a fixed media type determined by its filename extension. Only png, jpg, jpeg, ico, and svg extensions are served, ignoring case; unsupported extensions return 404.
1116
- * Response code 200 - The image file
1117
- * HTTP GET /configuration/manager/image/{filename: .+}
1118
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
1083
+ * 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.
1084
+ * HTTP POST /dashboard/query
1085
+ * Java method: org.openremote.model.dashboard.DashboardResource.query
1119
1086
  */
1120
- getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
1087
+ query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
1088
+ /**
1089
+ * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
1090
+ * HTTP DELETE /dashboard/{realm}/{dashboardId}
1091
+ * Java method: org.openremote.model.dashboard.DashboardResource.delete
1092
+ */
1093
+ delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
1094
+ /**
1095
+ * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
1096
+ * HTTP GET /dashboard/{realm}/{dashboardId}
1097
+ * Java method: org.openremote.model.dashboard.DashboardResource.get
1098
+ */
1099
+ get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
1121
1100
  }
1122
- export declare class RealmResourceClient<O> {
1101
+ export declare class MapResourceClient<O> {
1123
1102
  protected httpClient: HttpClient<O>;
1124
1103
  constructor(httpClient: HttpClient<O>);
1125
1104
  /**
1126
- * Creates and configures a realm in the identity provider. This operation is restricted to a super user.
1127
- * HTTP POST /realm
1128
- * Java method: org.openremote.model.security.RealmResource.create
1105
+ * Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
1106
+ * HTTP GET /map
1107
+ * Java method: org.openremote.model.map.MapResource.getSettings
1129
1108
  */
1130
- create(realm: Model.Realm, options?: O): RestResponse<void>;
1109
+ getSettings(options?: O): RestResponse<{
1110
+ [id: string]: unknown;
1111
+ }>;
1131
1112
  /**
1132
- * Returns complete realm records from the identity provider. This operation is restricted to a super user.
1133
- * HTTP GET /realm
1134
- * Java method: org.openremote.model.security.RealmResource.getAll
1113
+ * Stores the map configuration and returns the resulting public MapLibre settings. This operation is restricted to a super administrator.
1114
+ * HTTP PUT /map
1115
+ * Java method: org.openremote.model.map.MapResource.saveSettings
1135
1116
  */
1136
- getAll(options?: O): RestResponse<Model.Realm[]>;
1117
+ saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
1118
+ [id: string]: unknown;
1119
+ }>;
1137
1120
  /**
1138
- * Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
1139
- * HTTP GET /realm/accessible
1140
- * Java method: org.openremote.model.security.RealmResource.getAccessible
1121
+ * Deletes the installed custom MBTiles database and returns the fallback public map settings. This operation is restricted to a super administrator.
1122
+ * HTTP DELETE /map/deleteMap
1123
+ * Java method: org.openremote.model.map.MapResource.deleteMap
1141
1124
  */
1142
- getAccessible(options?: O): RestResponse<Model.Realm[]>;
1125
+ deleteMap(options?: O): RestResponse<{
1126
+ [id: string]: unknown;
1127
+ }>;
1143
1128
  /**
1144
- * Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
1145
- * Response code 405 - The master realm cannot be deleted
1146
- * Response code 409 - Realm cannot be deleted while it still contains assets
1147
- * HTTP DELETE /realm/{name}
1148
- * Java method: org.openremote.model.security.RealmResource.delete
1129
+ * Reports whether custom MBTiles data is installed and the maximum accepted upload size.
1130
+ * HTTP GET /map/getCustomMapInfo
1131
+ * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
1149
1132
  */
1150
- delete(name: string, options?: O): RestResponse<void>;
1133
+ getCustomMapInfo(options?: O): RestResponse<{
1134
+ [id: string]: unknown;
1135
+ }>;
1151
1136
  /**
1152
- * 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.
1153
- * HTTP GET /realm/{name}
1154
- * Java method: org.openremote.model.security.RealmResource.get
1137
+ * Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
1138
+ * Response code 200 - Gzip-compressed vector tile
1139
+ * Response code 204 - No tile exists at the requested coordinates
1140
+ * HTTP GET /map/tile/{zoom}/{column}/{row}
1141
+ * Java method: org.openremote.model.map.MapResource.getTile
1155
1142
  */
1156
- get(name: string, options?: O): RestResponse<Model.Realm>;
1143
+ getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
1157
1144
  /**
1158
- * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
1159
- * Response code 405 - The requested mutation is not allowed for the master realm
1160
- * HTTP PUT /realm/{name}
1161
- * Java method: org.openremote.model.security.RealmResource.update
1145
+ * Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings. This operation is restricted to a super administrator.
1146
+ * HTTP POST /map/upload
1147
+ * Java method: org.openremote.model.map.MapResource.uploadMap
1162
1148
  */
1163
- update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
1149
+ uploadMap(queryParams?: {
1150
+ filename?: string;
1151
+ }, options?: O): RestResponse<{
1152
+ [id: string]: unknown;
1153
+ }>;
1164
1154
  }
1165
- export declare class ConsoleResourceClient<O> {
1155
+ export declare class StatusResourceClient<O> {
1166
1156
  protected httpClient: HttpClient<O>;
1167
1157
  constructor(httpClient: HttpClient<O>);
1168
1158
  /**
1169
- * 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.
1170
- * HTTP POST /console/register
1171
- * Java method: org.openremote.model.console.ConsoleResource.register
1159
+ * Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
1160
+ * HTTP GET /health
1161
+ * Java method: org.openremote.model.system.StatusResource.getHealthStatus
1172
1162
  */
1173
- register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
1163
+ getHealthStatus(options?: O): RestResponse<{
1164
+ [index: string]: any;
1165
+ }>;
1166
+ /**
1167
+ * Returns public bootstrap information, including the Manager version and identity-provider URL.
1168
+ * HTTP GET /info
1169
+ * Java method: org.openremote.model.system.StatusResource.getInfo
1170
+ */
1171
+ getInfo(options?: O): RestResponse<{
1172
+ [index: string]: any;
1173
+ }>;
1174
1174
  }
1175
1175
  export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
1176
1176
  export declare class ApiClient {
1177
- protected _appResource: AxiosAppResourceClient;
1177
+ protected _realmResource: AxiosRealmResourceClient;
1178
+ protected _agentResource: AxiosAgentResourceClient;
1179
+ protected _notificationResource: AxiosNotificationResourceClient;
1180
+ protected _configurationResource: AxiosConfigurationResourceClient;
1181
+ protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1178
1182
  protected _rulesResource: AxiosRulesResourceClient;
1179
- protected _assetModelResource: AxiosAssetModelResourceClient;
1183
+ protected _assetResource: AxiosAssetResourceClient;
1184
+ protected _userResource: AxiosUserResourceClient;
1185
+ protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
1186
+ protected _appResource: AxiosAppResourceClient;
1187
+ protected _externalServiceResource: AxiosExternalServiceResourceClient;
1180
1188
  protected _alarmResource: AxiosAlarmResourceClient;
1181
- protected _syslogResource: AxiosSyslogResourceClient;
1189
+ protected _assetModelResource: AxiosAssetModelResourceClient;
1190
+ protected _consoleResource: AxiosConsoleResourceClient;
1191
+ protected _provisioningResource: AxiosProvisioningResourceClient;
1182
1192
  protected _gatewayClientResource: AxiosGatewayClientResourceClient;
1193
+ protected _syslogResource: AxiosSyslogResourceClient;
1183
1194
  protected _flowResource: AxiosFlowResourceClient;
1184
- protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
1185
- protected _provisioningResource: AxiosProvisioningResourceClient;
1186
- protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1187
- protected _dashboardResource: AxiosDashboardResourceClient;
1188
- protected _agentResource: AxiosAgentResourceClient;
1189
- protected _assetResource: AxiosAssetResourceClient;
1190
- protected _userResource: AxiosUserResourceClient;
1191
1195
  protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
1192
- protected _externalServiceResource: AxiosExternalServiceResourceClient;
1196
+ protected _dashboardResource: AxiosDashboardResourceClient;
1193
1197
  protected _mapResource: AxiosMapResourceClient;
1194
1198
  protected _statusResource: AxiosStatusResourceClient;
1195
- protected _notificationResource: AxiosNotificationResourceClient;
1196
- protected _configurationResource: AxiosConfigurationResourceClient;
1197
- protected _realmResource: AxiosRealmResourceClient;
1198
- protected _consoleResource: AxiosConsoleResourceClient;
1199
1199
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1200
- get AppResource(): AxiosAppResourceClient;
1200
+ get RealmResource(): AxiosRealmResourceClient;
1201
+ get AgentResource(): AxiosAgentResourceClient;
1202
+ get NotificationResource(): AxiosNotificationResourceClient;
1203
+ get ConfigurationResource(): AxiosConfigurationResourceClient;
1204
+ get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1201
1205
  get RulesResource(): AxiosRulesResourceClient;
1202
- get AssetModelResource(): AxiosAssetModelResourceClient;
1206
+ get AssetResource(): AxiosAssetResourceClient;
1207
+ get UserResource(): AxiosUserResourceClient;
1208
+ get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
1209
+ get AppResource(): AxiosAppResourceClient;
1210
+ get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1203
1211
  get AlarmResource(): AxiosAlarmResourceClient;
1204
- get SyslogResource(): AxiosSyslogResourceClient;
1212
+ get AssetModelResource(): AxiosAssetModelResourceClient;
1213
+ get ConsoleResource(): AxiosConsoleResourceClient;
1214
+ get ProvisioningResource(): AxiosProvisioningResourceClient;
1205
1215
  get GatewayClientResource(): AxiosGatewayClientResourceClient;
1216
+ get SyslogResource(): AxiosSyslogResourceClient;
1206
1217
  get FlowResource(): AxiosFlowResourceClient;
1207
- get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
1208
- get ProvisioningResource(): AxiosProvisioningResourceClient;
1209
- get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1210
- get DashboardResource(): AxiosDashboardResourceClient;
1211
- get AgentResource(): AxiosAgentResourceClient;
1212
- get AssetResource(): AxiosAssetResourceClient;
1213
- get UserResource(): AxiosUserResourceClient;
1214
1218
  get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1215
- get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1219
+ get DashboardResource(): AxiosDashboardResourceClient;
1216
1220
  get MapResource(): AxiosMapResourceClient;
1217
1221
  get StatusResource(): AxiosStatusResourceClient;
1218
- get NotificationResource(): AxiosNotificationResourceClient;
1219
- get ConfigurationResource(): AxiosConfigurationResourceClient;
1220
- get RealmResource(): AxiosRealmResourceClient;
1221
- get ConsoleResource(): AxiosConsoleResourceClient;
1222
1222
  }
1223
1223
  import * as Axios from "axios";
1224
1224
  declare module "axios" {
@@ -1226,70 +1226,70 @@ declare module "axios" {
1226
1226
  data: R;
1227
1227
  }
1228
1228
  }
1229
- export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1229
+ export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1230
1230
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1231
1231
  }
1232
- export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1232
+ export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1233
1233
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1234
1234
  }
1235
- export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1235
+ export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1236
1236
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1237
1237
  }
1238
- export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1238
+ export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1239
1239
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1240
1240
  }
1241
- export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1241
+ export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1242
1242
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1243
1243
  }
1244
- export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1244
+ export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1245
1245
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1246
1246
  }
1247
- export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1247
+ export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1248
1248
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1249
1249
  }
1250
- export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1250
+ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1251
1251
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1252
1252
  }
1253
- export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1253
+ export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1254
1254
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1255
1255
  }
1256
- export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1256
+ export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1257
1257
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1258
1258
  }
1259
- export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1259
+ export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1260
1260
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1261
1261
  }
1262
- export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1262
+ export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1263
1263
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1264
1264
  }
1265
- export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1265
+ export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1266
1266
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1267
1267
  }
1268
- export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1268
+ export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1269
1269
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1270
1270
  }
1271
- export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1271
+ export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1272
1272
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1273
1273
  }
1274
- export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1274
+ export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1275
1275
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1276
1276
  }
1277
- export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1277
+ export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1278
1278
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1279
1279
  }
1280
- export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1280
+ export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1281
1281
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1282
1282
  }
1283
- export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1283
+ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1284
1284
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1285
1285
  }
1286
- export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1286
+ export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1287
1287
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1288
1288
  }
1289
- export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1289
+ export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1290
1290
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1291
1291
  }
1292
- export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1292
+ export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1293
1293
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1294
1294
  }
1295
1295
  //# sourceMappingURL=restclient.d.ts.map