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