@openremote/rest 1.32.0-snapshot.20261012115031 → 1.32.0

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