@openremote/rest 1.34.0-snapshot.20261104153615 → 1.34.0

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