@openremote/rest 1.32.0 → 1.32.2

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