@openremote/rest 1.30.0-snapshot.20260902114525 → 1.30.0

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