@openremote/rest 1.31.1 → 1.32.0-snapshot.20260928140716

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.
@@ -29,97 +29,213 @@ export declare class StatusResourceClient<O> {
29
29
  [index: string]: any;
30
30
  }>;
31
31
  }
32
- export declare class DashboardResourceClient<O> {
32
+ export declare class FlowResourceClient<O> {
33
33
  protected httpClient: HttpClient<O>;
34
34
  constructor(httpClient: HttpClient<O>);
35
35
  /**
36
- * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
37
- * HTTP POST /dashboard
38
- * Java method: org.openremote.model.dashboard.DashboardResource.create
36
+ * Returns every supported flow node definition except the internal LOG_OUTPUT node.
37
+ * HTTP GET /flow
38
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
39
39
  */
40
- create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
40
+ getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
41
41
  /**
42
- * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
43
- * HTTP PUT /dashboard
44
- * Java method: org.openremote.model.dashboard.DashboardResource.update
42
+ * Resolves one flow node definition by its model name.
43
+ * HTTP GET /flow/{name}
44
+ * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
45
45
  */
46
- update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
46
+ getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
47
47
  /**
48
- * 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.
49
- * HTTP GET /dashboard/all/{realm}
50
- * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
48
+ * Returns supported flow node definitions whose category matches the requested node type.
49
+ * HTTP GET /flow/{type}
50
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
51
51
  */
52
- getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
52
+ getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
53
+ }
54
+ export declare class ConfigurationResourceClient<O> {
55
+ protected httpClient: HttpClient<O>;
56
+ constructor(httpClient: HttpClient<O>);
53
57
  /**
54
- * 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.
55
- * HTTP POST /dashboard/query
56
- * Java method: org.openremote.model.dashboard.DashboardResource.query
58
+ * Returns the public Manager application configuration used by clients before and after authentication.
59
+ * HTTP GET /configuration/manager
60
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
57
61
  */
58
- query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
62
+ getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
59
63
  /**
60
- * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
61
- * HTTP DELETE /dashboard/{realm}/{dashboardId}
62
- * Java method: org.openremote.model.dashboard.DashboardResource.delete
64
+ * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
65
+ * HTTP PUT /configuration/manager
66
+ * Java method: org.openremote.model.manager.ConfigurationResource.update
63
67
  */
64
- delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
68
+ update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
65
69
  /**
66
- * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
67
- * HTTP GET /dashboard/{realm}/{dashboardId}
68
- * Java method: org.openremote.model.dashboard.DashboardResource.get
70
+ * Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
71
+ * HTTP POST /configuration/manager/file
72
+ * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
69
73
  */
70
- get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
74
+ fileUpload(fileInfo: Model.FileInfo, queryParams?: {
75
+ path?: string;
76
+ }, options?: O): RestResponse<string>;
77
+ /**
78
+ * Streams a previously uploaded configuration image using its detected media type.
79
+ * Response code 200 - The image file
80
+ * HTTP GET /configuration/manager/image/{filename: .+}
81
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
82
+ */
83
+ getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
71
84
  }
72
- export declare class RealmResourceClient<O> {
85
+ export declare class AgentResourceClient<O> {
73
86
  protected httpClient: HttpClient<O>;
74
87
  constructor(httpClient: HttpClient<O>);
75
88
  /**
76
- * Creates and configures a realm in the identity provider. This operation is restricted to a super user.
77
- * HTTP POST /realm
78
- * Java method: org.openremote.model.security.RealmResource.create
89
+ * 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.
90
+ * HTTP GET /agent/assetDiscovery/{agentId}
91
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
79
92
  */
80
- create(realm: Model.Realm, options?: O): RestResponse<void>;
93
+ doProtocolAssetDiscovery(agentId: string, queryParams?: {
94
+ realm?: string;
95
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
81
96
  /**
82
- * Returns complete realm records from the identity provider. This operation is restricted to a super user.
83
- * HTTP GET /realm
84
- * Java method: org.openremote.model.security.RealmResource.getAll
97
+ * Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
98
+ * Response code 405 - The selected agent protocol does not support asset import
99
+ * HTTP POST /agent/assetImport/{agentId}
100
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
85
101
  */
86
- getAll(options?: O): RestResponse<Model.Realm[]>;
102
+ doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
103
+ realm?: string;
104
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
87
105
  /**
88
- * Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
89
- * HTTP GET /realm/accessible
90
- * Java method: org.openremote.model.security.RealmResource.getAccessible
106
+ * 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.
107
+ * Response code 415 - The selected agent protocol does not support instance discovery
108
+ * HTTP GET /agent/instanceDiscovery/{agentType}
109
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
91
110
  */
92
- getAccessible(options?: O): RestResponse<Model.Realm[]>;
111
+ doProtocolInstanceDiscovery(agentType: string, queryParams?: {
112
+ parentId?: string;
113
+ realm?: string;
114
+ }, options?: O): RestResponse<Model.Agent[]>;
115
+ }
116
+ export declare class AlarmResourceClient<O> {
117
+ protected httpClient: HttpClient<O>;
118
+ constructor(httpClient: HttpClient<O>);
93
119
  /**
94
- * Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
95
- * Response code 405 - The master realm cannot be deleted
96
- * HTTP DELETE /realm/{name}
97
- * Java method: org.openremote.model.security.RealmResource.delete
120
+ * 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.
121
+ * HTTP POST /alarm
122
+ * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
98
123
  */
99
- delete(name: string, options?: O): RestResponse<void>;
124
+ createAlarm(alarm: Model.Alarm, queryParams?: {
125
+ assetIds?: string[];
126
+ }, options?: O): RestResponse<Model.SentAlarm>;
100
127
  /**
101
- * Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
102
- * HTTP GET /realm/{name}
103
- * Java method: org.openremote.model.security.RealmResource.get
128
+ * Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
129
+ * HTTP GET /alarm
130
+ * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
104
131
  */
105
- get(name: string, options?: O): RestResponse<Model.Realm>;
132
+ getAlarms(queryParams?: {
133
+ realm?: string;
134
+ status?: Model.AlarmStatus;
135
+ assetId?: string;
136
+ assigneeId?: string;
137
+ }, options?: O): RestResponse<Model.SentAlarm[]>;
106
138
  /**
107
- * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
108
- * Response code 405 - The requested mutation is not allowed for the master realm
109
- * HTTP PUT /realm/{name}
110
- * Java method: org.openremote.model.security.RealmResource.update
139
+ * Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
140
+ * HTTP DELETE /alarm
141
+ * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
111
142
  */
112
- update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
143
+ removeAlarms(ids: number[], options?: O): RestResponse<void>;
144
+ /**
145
+ * Adds links between assets and one existing alarm.
146
+
147
+ The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
148
+ every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
149
+ every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
150
+ containing mixed alarm IDs or realms are rejected as bad requests.
151
+
152
+ Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
153
+ This operation does not remove existing links from the alarm.
154
+
155
+ * HTTP PUT /alarm/assets
156
+ * Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
157
+ */
158
+ setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
159
+ /**
160
+ * Returns one alarm when its realm is active and accessible to the authenticated user.
161
+ * HTTP GET /alarm/{alarmId}
162
+ * Java method: org.openremote.model.alarm.AlarmResource.getAlarm
163
+ */
164
+ getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
165
+ /**
166
+ * Permanently removes one alarm after verifying access to its realm.
167
+ * HTTP DELETE /alarm/{alarmId}
168
+ * Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
169
+ */
170
+ removeAlarm(alarmId: number, options?: O): RestResponse<void>;
171
+ /**
172
+ * Updates the mutable state of an existing alarm after verifying access to its current realm.
173
+ * HTTP PUT /alarm/{alarmId}
174
+ * Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
175
+ */
176
+ updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
177
+ /**
178
+ * Returns links from the alarm to assets in the explicitly supplied accessible realm.
179
+ * HTTP GET /alarm/{alarmId}/assets
180
+ * Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
181
+ */
182
+ getAssetLinks(alarmId: number, queryParams?: {
183
+ realm?: string;
184
+ }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
113
185
  }
114
- export declare class ConsoleResourceClient<O> {
186
+ export declare class MapResourceClient<O> {
115
187
  protected httpClient: HttpClient<O>;
116
188
  constructor(httpClient: HttpClient<O>);
117
189
  /**
118
- * 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.
119
- * HTTP POST /console/register
120
- * Java method: org.openremote.model.console.ConsoleResource.register
190
+ * Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
191
+ * HTTP GET /map
192
+ * Java method: org.openremote.model.map.MapResource.getSettings
121
193
  */
122
- register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
194
+ getSettings(options?: O): RestResponse<{
195
+ [id: string]: unknown;
196
+ }>;
197
+ /**
198
+ * Stores the map configuration and returns the resulting public MapLibre settings.
199
+ * HTTP PUT /map
200
+ * Java method: org.openremote.model.map.MapResource.saveSettings
201
+ */
202
+ saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
203
+ [id: string]: unknown;
204
+ }>;
205
+ /**
206
+ * Deletes the installed custom MBTiles database and returns the fallback public map settings.
207
+ * HTTP DELETE /map/deleteMap
208
+ * Java method: org.openremote.model.map.MapResource.deleteMap
209
+ */
210
+ deleteMap(options?: O): RestResponse<{
211
+ [id: string]: unknown;
212
+ }>;
213
+ /**
214
+ * Reports whether custom MBTiles data is installed and the maximum accepted upload size.
215
+ * HTTP GET /map/getCustomMapInfo
216
+ * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
217
+ */
218
+ getCustomMapInfo(options?: O): RestResponse<{
219
+ [id: string]: unknown;
220
+ }>;
221
+ /**
222
+ * Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
223
+ * Response code 200 - Gzip-compressed vector tile
224
+ * Response code 204 - No tile exists at the requested coordinates
225
+ * HTTP GET /map/tile/{zoom}/{column}/{row}
226
+ * Java method: org.openremote.model.map.MapResource.getTile
227
+ */
228
+ getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
229
+ /**
230
+ * Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
231
+ * HTTP POST /map/upload
232
+ * Java method: org.openremote.model.map.MapResource.uploadMap
233
+ */
234
+ uploadMap(queryParams?: {
235
+ filename?: string;
236
+ }, options?: O): RestResponse<{
237
+ [id: string]: unknown;
238
+ }>;
123
239
  }
124
240
  export declare class ExternalServiceResourceClient<O> {
125
241
  protected httpClient: HttpClient<O>;
@@ -183,151 +299,246 @@ export declare class ExternalServiceResourceClient<O> {
183
299
  */
184
300
  heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
185
301
  }
186
- export declare class AssetPredictedDatapointResourceClient<O> {
302
+ export declare class ConsoleResourceClient<O> {
187
303
  protected httpClient: HttpClient<O>;
188
304
  constructor(httpClient: HttpClient<O>);
189
305
  /**
190
- * 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.
191
- * HTTP POST /asset/predicted/{assetId}/{attributeName}
192
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
193
- */
194
- getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
195
- /**
196
- * 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.
197
- * HTTP PUT /asset/predicted/{assetId}/{attributeName}
198
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
306
+ * 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.
307
+ * HTTP POST /console/register
308
+ * Java method: org.openremote.model.console.ConsoleResource.register
199
309
  */
200
- writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
310
+ register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
201
311
  }
202
- export declare class SyslogResourceClient<O> {
312
+ export declare class RulesResourceClient<O> {
203
313
  protected httpClient: HttpClient<O>;
204
314
  constructor(httpClient: HttpClient<O>);
205
315
  /**
206
- * Returns the current log-storage and retention configuration.
207
- * HTTP GET /syslog/config
208
- * Java method: org.openremote.model.syslog.SyslogResource.getConfig
316
+ * Creates and deploys a global ruleset and returns its numeric ID. Super-user access is required; legacy JavaScript rulesets cannot be created.
317
+ * HTTP POST /rules
318
+ * Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
209
319
  */
210
- getConfig(options?: O): RestResponse<Model.SyslogConfig>;
320
+ createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
211
321
  /**
212
- * Validates and applies log-storage and retention settings.
213
- * HTTP PUT /syslog/config
214
- * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
322
+ * Returns global rulesets filtered by repeated language parameters. fullyPopulate controls whether rule source and other large fields are loaded; super-user access is required.
323
+ * HTTP GET /rules
324
+ * Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
215
325
  */
216
- updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
326
+ getGlobalRulesets(queryParams?: {
327
+ language?: Model.RulesetLang[];
328
+ fullyPopulate?: boolean;
329
+ }, options?: O): RestResponse<Model.GlobalRuleset[]>;
217
330
  /**
218
- * Permanently removes all events from the configured syslog storage.
219
- * HTTP DELETE /syslog/event
220
- * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
331
+ * Creates and deploys a ruleset for an accessible asset and returns its numeric ID. The assetId is taken from the request body.
332
+ * HTTP POST /rules/asset
333
+ * Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
221
334
  */
222
- clearEvents(options?: O): RestResponse<void>;
335
+ createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
223
336
  /**
224
- * 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.
225
- * Response code 200 - The requested page of syslog events
226
- * HTTP GET /syslog/event
227
- * Java method: org.openremote.model.syslog.SyslogResource.getEvents
337
+ * Returns asset rulesets filtered by language. Callers without full access receive public rulesets only; a nonexistent asset produces an empty array.
338
+ * HTTP GET /rules/asset/for/{assetId}
339
+ * Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
228
340
  */
229
- getEvents(queryParams?: {
230
- level?: Model.SyslogLevel;
231
- per_page?: number;
232
- page?: number;
233
- from?: number;
234
- to?: number;
235
- category?: Model.SyslogCategory[];
236
- subCategory?: string[];
237
- }, options?: O): RestResponse<any>;
238
- }
239
- export declare class ConfigurationResourceClient<O> {
240
- protected httpClient: HttpClient<O>;
241
- constructor(httpClient: HttpClient<O>);
341
+ getAssetRulesets(assetId: string, queryParams?: {
342
+ language?: Model.RulesetLang[];
343
+ fullyPopulate?: boolean;
344
+ }, options?: O): RestResponse<Model.AssetRuleset[]>;
242
345
  /**
243
- * Returns the public Manager application configuration used by clients before and after authentication.
244
- * HTTP GET /configuration/manager
245
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
346
+ * Permanently removes and undeploys one ruleset from an accessible asset.
347
+ * HTTP DELETE /rules/asset/{id}
348
+ * Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
246
349
  */
247
- getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
350
+ deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
248
351
  /**
249
- * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
250
- * HTTP PUT /configuration/manager
251
- * Java method: org.openremote.model.manager.ConfigurationResource.update
352
+ * Returns one fully populated asset ruleset when the caller can access its realm and owning asset.
353
+ * HTTP GET /rules/asset/{id}
354
+ * Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
252
355
  */
253
- update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
356
+ getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
254
357
  /**
255
- * Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
256
- * HTTP POST /configuration/manager/file
257
- * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
358
+ * Replaces and redeploys one asset ruleset. The ID must match and an existing ruleset cannot be reassigned to another asset.
359
+ * HTTP PUT /rules/asset/{id}
360
+ * Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
258
361
  */
259
- fileUpload(fileInfo: Model.FileInfo, queryParams?: {
260
- path?: string;
261
- }, options?: O): RestResponse<string>;
362
+ updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
262
363
  /**
263
- * Streams a previously uploaded configuration image using its detected media type.
264
- * Response code 200 - The image file
265
- * HTTP GET /configuration/manager/image/{filename: .+}
266
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
364
+ * Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
365
+ * HTTP GET /rules/geofences/{assetId}
366
+ * Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
267
367
  */
268
- getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
368
+ getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
369
+ /**
370
+ * Returns runtime status and error counts for an accessible asset engine. Returns null when the asset or its engine does not exist.
371
+ * Response code 204 - The asset or its rules engine does not exist
372
+ * HTTP GET /rules/info/asset/{assetId}
373
+ * Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
374
+ */
375
+ getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
376
+ /**
377
+ * Returns runtime status and compilation/execution error counts for the global engine, or null when that engine is not running. Super-user access is required.
378
+ * Response code 204 - The global rules engine is not running
379
+ * HTTP GET /rules/info/global
380
+ * Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
381
+ */
382
+ getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
383
+ /**
384
+ * Returns runtime status and error counts for an accessible realm engine, or null when that engine is not running. Restricted users cannot inspect realm engines.
385
+ * Response code 204 - The requested realm rules engine is not running
386
+ * HTTP GET /rules/info/realm/{realm}
387
+ * Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
388
+ */
389
+ getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
390
+ /**
391
+ * Creates and deploys a ruleset in its body realm and returns its numeric ID. Restricted users cannot create realm rulesets; legacy JavaScript is not accepted.
392
+ * HTTP POST /rules/realm
393
+ * Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
394
+ */
395
+ createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
396
+ /**
397
+ * Returns realm rulesets filtered by language. Anonymous, restricted, or callers without read-rules permission receive public rulesets only; fullyPopulate controls loading of rule source.
398
+ * HTTP GET /rules/realm/for/{realm}
399
+ * Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
400
+ */
401
+ getRealmRulesets(realm: string, queryParams?: {
402
+ language?: Model.RulesetLang[];
403
+ fullyPopulate?: boolean;
404
+ }, options?: O): RestResponse<Model.RealmRuleset[]>;
405
+ /**
406
+ * Permanently removes and undeploys one ruleset from an accessible realm.
407
+ * HTTP DELETE /rules/realm/{id}
408
+ * Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
409
+ */
410
+ deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
411
+ /**
412
+ * Returns one fully populated realm ruleset when its realm is accessible to the caller.
413
+ * HTTP GET /rules/realm/{id}
414
+ * Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
415
+ */
416
+ getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
417
+ /**
418
+ * Replaces and redeploys one realm ruleset. Path and body IDs and the existing realm must match; legacy JavaScript cannot be updated.
419
+ * HTTP PUT /rules/realm/{id}
420
+ * Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
421
+ */
422
+ updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
423
+ /**
424
+ * Permanently removes and undeploys one global ruleset. Super-user access is required.
425
+ * HTTP DELETE /rules/{id}
426
+ * Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
427
+ */
428
+ deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
429
+ /**
430
+ * Returns one fully populated global ruleset including transient deployment status and errors. Super-user access is required.
431
+ * HTTP GET /rules/{id}
432
+ * Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
433
+ */
434
+ getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
435
+ /**
436
+ * Replaces and redeploys the identified global ruleset. Path and body IDs must match; legacy JavaScript rulesets cannot be updated.
437
+ * HTTP PUT /rules/{id}
438
+ * Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
439
+ */
440
+ updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
269
441
  }
270
- export declare class AssetDatapointResourceClient<O> {
442
+ export declare class DashboardResourceClient<O> {
271
443
  protected httpClient: HttpClient<O>;
272
444
  constructor(httpClient: HttpClient<O>);
273
445
  /**
274
- * 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.
275
- * Response code 200 - A ZIP archive containing the exported data
276
- * HTTP GET /asset/datapoint/export
277
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
446
+ * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
447
+ * HTTP POST /dashboard
448
+ * Java method: org.openremote.model.dashboard.DashboardResource.create
278
449
  */
279
- getDatapointExport(queryParams?: {
280
- attributeRefs?: string;
281
- fromTimestamp?: number;
282
- toTimestamp?: number;
283
- format?: Model.DatapointExportFormat;
284
- }, options?: O): RestResponse<any>;
450
+ create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
285
451
  /**
286
- * 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.
287
- * HTTP GET /asset/datapoint/periods
288
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
452
+ * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
453
+ * HTTP PUT /dashboard
454
+ * Java method: org.openremote.model.dashboard.DashboardResource.update
289
455
  */
290
- getDatapointPeriod(queryParams?: {
291
- assetId?: string;
292
- attributeName?: string;
293
- }, options?: O): RestResponse<Model.DatapointPeriod>;
456
+ update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
294
457
  /**
295
- * 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.
296
- * HTTP POST /asset/datapoint/{assetId}/{attributeName}
297
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
458
+ * 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.
459
+ * HTTP GET /dashboard/all/{realm}
460
+ * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
298
461
  */
299
- getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
462
+ getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
463
+ /**
464
+ * 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.
465
+ * HTTP POST /dashboard/query
466
+ * Java method: org.openremote.model.dashboard.DashboardResource.query
467
+ */
468
+ query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
469
+ /**
470
+ * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
471
+ * HTTP DELETE /dashboard/{realm}/{dashboardId}
472
+ * Java method: org.openremote.model.dashboard.DashboardResource.delete
473
+ */
474
+ delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
475
+ /**
476
+ * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
477
+ * HTTP GET /dashboard/{realm}/{dashboardId}
478
+ * Java method: org.openremote.model.dashboard.DashboardResource.get
479
+ */
480
+ get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
300
481
  }
301
- export declare class AgentResourceClient<O> {
482
+ export declare class AssetModelResourceClient<O> {
302
483
  protected httpClient: HttpClient<O>;
303
484
  constructor(httpClient: HttpClient<O>);
304
485
  /**
305
- * 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.
306
- * HTTP GET /agent/assetDiscovery/{agentId}
307
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
486
+ * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
487
+ * HTTP GET /model/assetDescriptors
488
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
308
489
  */
309
- doProtocolAssetDiscovery(agentId: string, queryParams?: {
310
- realm?: string;
311
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
490
+ getAssetDescriptors(queryParams?: {
491
+ parentId?: string;
492
+ parentType?: string;
493
+ }, options?: O): RestResponse<Model.AssetDescriptor[]>;
312
494
  /**
313
- * Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
314
- * Response code 405 - The selected agent protocol does not support asset import
315
- * HTTP POST /agent/assetImport/{agentId}
316
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
495
+ * 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.
496
+ * Response code 204 - No model information is available for the requested asset type
497
+ * HTTP GET /model/assetInfo/{assetType}
498
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
317
499
  */
318
- doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
319
- realm?: string;
320
- }, options?: O): RestResponse<Model.AssetTreeNode[]>;
500
+ getAssetInfo(assetType: string, queryParams?: {
501
+ parentId?: string;
502
+ }, options?: O): RestResponse<Model.AssetTypeInfo>;
321
503
  /**
322
- * 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.
323
- * Response code 415 - The selected agent protocol does not support instance discovery
324
- * HTTP GET /agent/instanceDiscovery/{agentType}
325
- * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
504
+ * 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.
505
+ * HTTP GET /model/assetInfos
506
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
507
+ */
508
+ getAssetInfos(queryParams?: {
509
+ parentId?: string;
510
+ parentType?: string;
511
+ }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
512
+ /**
513
+ * 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.
514
+ * Response code 200 - The current JSON Schema
515
+ * Response code 304 - The supplied ETag still identifies the current schema
516
+ * HTTP GET /model/getValueDescriptorSchema
517
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
518
+ */
519
+ getValueDescriptorSchema(queryParams?: {
520
+ name?: string;
521
+ }, options?: O): RestResponse<any>;
522
+ /**
523
+ * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
524
+ * HTTP GET /model/metaItemDescriptors
525
+ * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
526
+ */
527
+ getMetaItemDescriptors(queryParams?: {
528
+ parentId?: string;
529
+ }, options?: O): RestResponse<{
530
+ [index: string]: Model.MetaItemDescriptor;
531
+ }>;
532
+ /**
533
+ * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
534
+ * HTTP GET /model/valueDescriptors
535
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
326
536
  */
327
- doProtocolInstanceDiscovery(agentType: string, queryParams?: {
537
+ getValueDescriptors(queryParams?: {
328
538
  parentId?: string;
329
- realm?: string;
330
- }, options?: O): RestResponse<Model.Agent[]>;
539
+ }, options?: O): RestResponse<{
540
+ [index: string]: Model.ValueDescriptor;
541
+ }>;
331
542
  }
332
543
  export declare class UserResourceClient<O> {
333
544
  protected httpClient: HttpClient<O>;
@@ -457,302 +668,60 @@ export declare class UserResourceClient<O> {
457
668
  * HTTP PUT /user/{realm}/users
458
669
  * Java method: org.openremote.model.security.UserResource.update
459
670
  */
460
- update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
461
- /**
462
- * Permanently deletes a user from an administered realm. The master-realm administrator cannot be deleted. The target realm must be active unless the caller is a superuser.
463
- * Response code 405 - The master-realm administrator cannot be deleted
464
- * HTTP DELETE /user/{realm}/users/{userId}
465
- * Java method: org.openremote.model.security.UserResource.delete
466
- */
467
- delete(realm: string, userId: string, options?: O): RestResponse<void>;
468
- /**
469
- * Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required. The target realm must be active unless the caller is a superuser.
470
- * HTTP GET /user/{realm}/{clientId}/roles
471
- * Java method: org.openremote.model.security.UserResource.getClientRoles
472
- */
473
- getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
474
- /**
475
- * Creates, updates, or removes role definitions for a named identity-provider client. The target realm must be active unless the caller is a superuser.
476
- * HTTP PUT /user/{realm}/{clientId}/roles
477
- * Java method: org.openremote.model.security.UserResource.updateClientRoles
478
- */
479
- updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
480
- /**
481
- * Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user. The target realm must be active unless the caller is a superuser.
482
- * HTTP GET /user/{realm}/{userId}
483
- * Java method: org.openremote.model.security.UserResource.get
484
- */
485
- get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
486
- }
487
- export declare class MapResourceClient<O> {
488
- protected httpClient: HttpClient<O>;
489
- constructor(httpClient: HttpClient<O>);
490
- /**
491
- * Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
492
- * HTTP GET /map
493
- * Java method: org.openremote.model.map.MapResource.getSettings
494
- */
495
- getSettings(options?: O): RestResponse<{
496
- [id: string]: unknown;
497
- }>;
498
- /**
499
- * Stores the map configuration and returns the resulting public MapLibre settings.
500
- * HTTP PUT /map
501
- * Java method: org.openremote.model.map.MapResource.saveSettings
502
- */
503
- saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
504
- [id: string]: unknown;
505
- }>;
506
- /**
507
- * Deletes the installed custom MBTiles database and returns the fallback public map settings.
508
- * HTTP DELETE /map/deleteMap
509
- * Java method: org.openremote.model.map.MapResource.deleteMap
510
- */
511
- deleteMap(options?: O): RestResponse<{
512
- [id: string]: unknown;
513
- }>;
514
- /**
515
- * Reports whether custom MBTiles data is installed and the maximum accepted upload size.
516
- * HTTP GET /map/getCustomMapInfo
517
- * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
518
- */
519
- getCustomMapInfo(options?: O): RestResponse<{
520
- [id: string]: unknown;
521
- }>;
522
- /**
523
- * Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
524
- * Response code 200 - Gzip-compressed vector tile
525
- * Response code 204 - No tile exists at the requested coordinates
526
- * HTTP GET /map/tile/{zoom}/{column}/{row}
527
- * Java method: org.openremote.model.map.MapResource.getTile
528
- */
529
- getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
530
- /**
531
- * Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
532
- * HTTP POST /map/upload
533
- * Java method: org.openremote.model.map.MapResource.uploadMap
534
- */
535
- uploadMap(queryParams?: {
536
- filename?: string;
537
- }, options?: O): RestResponse<{
538
- [id: string]: unknown;
539
- }>;
540
- }
541
- export declare class ProvisioningResourceClient<O> {
542
- protected httpClient: HttpClient<O>;
543
- constructor(httpClient: HttpClient<O>);
544
- /**
545
- * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
546
- * HTTP POST /provisioning
547
- * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
548
- */
549
- createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
550
- /**
551
- * Returns every provisioning configuration. This operation is restricted to a super administrator.
552
- * HTTP GET /provisioning
553
- * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
554
- */
555
- getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
556
- /**
557
- * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
558
- * HTTP DELETE /provisioning/{id}
559
- * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
560
- */
561
- deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
562
- /**
563
- * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
564
- * HTTP PUT /provisioning/{id}
565
- * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
566
- */
567
- updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
568
- }
569
- export declare class FlowResourceClient<O> {
570
- protected httpClient: HttpClient<O>;
571
- constructor(httpClient: HttpClient<O>);
572
- /**
573
- * Returns every supported flow node definition except the internal LOG_OUTPUT node.
574
- * HTTP GET /flow
575
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
576
- */
577
- getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
578
- /**
579
- * Resolves one flow node definition by its model name.
580
- * HTTP GET /flow/{name}
581
- * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
582
- */
583
- getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
584
- /**
585
- * Returns supported flow node definitions whose category matches the requested node type.
586
- * HTTP GET /flow/{type}
587
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
588
- */
589
- getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
590
- }
591
- export declare class GatewayServiceResourceClient<O> {
592
- protected httpClient: HttpClient<O>;
593
- constructor(httpClient: HttpClient<O>);
594
- /**
595
- * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
596
- * Response code 417 - The gateway could not establish the requested tunnel
597
- * HTTP POST /gateway/tunnel
598
- * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
599
- */
600
- startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
601
- /**
602
- * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
603
- * HTTP DELETE /gateway/tunnel
604
- * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
605
- */
606
- stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
607
- /**
608
- * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
609
- * HTTP GET /gateway/tunnel/{realm}
610
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
611
- */
612
- getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
613
- /**
614
- * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
615
- * HTTP GET /gateway/tunnel/{realm}/{id}
616
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
617
- */
618
- getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
619
- /**
620
- * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
621
- * Response code 204 - No active tunnel matches the requested endpoint
622
- * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
623
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
624
- */
625
- getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
626
- }
627
- export declare class RulesResourceClient<O> {
628
- protected httpClient: HttpClient<O>;
629
- constructor(httpClient: HttpClient<O>);
630
- /**
631
- * Creates and deploys a global ruleset and returns its numeric ID. Super-user access is required; legacy JavaScript rulesets cannot be created.
632
- * HTTP POST /rules
633
- * Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
634
- */
635
- createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
636
- /**
637
- * Returns global rulesets filtered by repeated language parameters. fullyPopulate controls whether rule source and other large fields are loaded; super-user access is required.
638
- * HTTP GET /rules
639
- * Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
640
- */
641
- getGlobalRulesets(queryParams?: {
642
- language?: Model.RulesetLang[];
643
- fullyPopulate?: boolean;
644
- }, options?: O): RestResponse<Model.GlobalRuleset[]>;
645
- /**
646
- * Creates and deploys a ruleset for an accessible asset and returns its numeric ID. The assetId is taken from the request body.
647
- * HTTP POST /rules/asset
648
- * Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
649
- */
650
- createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
651
- /**
652
- * Returns asset rulesets filtered by language. Callers without full access receive public rulesets only; a nonexistent asset produces an empty array.
653
- * HTTP GET /rules/asset/for/{assetId}
654
- * Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
655
- */
656
- getAssetRulesets(assetId: string, queryParams?: {
657
- language?: Model.RulesetLang[];
658
- fullyPopulate?: boolean;
659
- }, options?: O): RestResponse<Model.AssetRuleset[]>;
660
- /**
661
- * Permanently removes and undeploys one ruleset from an accessible asset.
662
- * HTTP DELETE /rules/asset/{id}
663
- * Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
664
- */
665
- deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
666
- /**
667
- * Returns one fully populated asset ruleset when the caller can access its realm and owning asset.
668
- * HTTP GET /rules/asset/{id}
669
- * Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
670
- */
671
- getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
672
- /**
673
- * Replaces and redeploys one asset ruleset. The ID must match and an existing ruleset cannot be reassigned to another asset.
674
- * HTTP PUT /rules/asset/{id}
675
- * Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
676
- */
677
- updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
678
- /**
679
- * Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
680
- * HTTP GET /rules/geofences/{assetId}
681
- * Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
682
- */
683
- getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
684
- /**
685
- * Returns runtime status and error counts for an accessible asset engine. Returns null when the asset or its engine does not exist.
686
- * Response code 204 - The asset or its rules engine does not exist
687
- * HTTP GET /rules/info/asset/{assetId}
688
- * Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
689
- */
690
- getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
691
- /**
692
- * Returns runtime status and compilation/execution error counts for the global engine, or null when that engine is not running. Super-user access is required.
693
- * Response code 204 - The global rules engine is not running
694
- * HTTP GET /rules/info/global
695
- * Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
696
- */
697
- getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
698
- /**
699
- * Returns runtime status and error counts for an accessible realm engine, or null when that engine is not running. Restricted users cannot inspect realm engines.
700
- * Response code 204 - The requested realm rules engine is not running
701
- * HTTP GET /rules/info/realm/{realm}
702
- * Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
703
- */
704
- getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
705
- /**
706
- * Creates and deploys a ruleset in its body realm and returns its numeric ID. Restricted users cannot create realm rulesets; legacy JavaScript is not accepted.
707
- * HTTP POST /rules/realm
708
- * Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
671
+ update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
672
+ /**
673
+ * Permanently deletes a user from an administered realm. The master-realm administrator cannot be deleted. The target realm must be active unless the caller is a superuser.
674
+ * Response code 405 - The master-realm administrator cannot be deleted
675
+ * HTTP DELETE /user/{realm}/users/{userId}
676
+ * Java method: org.openremote.model.security.UserResource.delete
709
677
  */
710
- createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
678
+ delete(realm: string, userId: string, options?: O): RestResponse<void>;
711
679
  /**
712
- * Returns realm rulesets filtered by language. Anonymous, restricted, or callers without read-rules permission receive public rulesets only; fullyPopulate controls loading of rule source.
713
- * HTTP GET /rules/realm/for/{realm}
714
- * Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
680
+ * Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required. The target realm must be active unless the caller is a superuser.
681
+ * HTTP GET /user/{realm}/{clientId}/roles
682
+ * Java method: org.openremote.model.security.UserResource.getClientRoles
715
683
  */
716
- getRealmRulesets(realm: string, queryParams?: {
717
- language?: Model.RulesetLang[];
718
- fullyPopulate?: boolean;
719
- }, options?: O): RestResponse<Model.RealmRuleset[]>;
684
+ getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
720
685
  /**
721
- * Permanently removes and undeploys one ruleset from an accessible realm.
722
- * HTTP DELETE /rules/realm/{id}
723
- * Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
686
+ * Creates, updates, or removes role definitions for a named identity-provider client. The target realm must be active unless the caller is a superuser.
687
+ * HTTP PUT /user/{realm}/{clientId}/roles
688
+ * Java method: org.openremote.model.security.UserResource.updateClientRoles
724
689
  */
725
- deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
690
+ updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
726
691
  /**
727
- * Returns one fully populated realm ruleset when its realm is accessible to the caller.
728
- * HTTP GET /rules/realm/{id}
729
- * Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
692
+ * Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user. The target realm must be active unless the caller is a superuser.
693
+ * HTTP GET /user/{realm}/{userId}
694
+ * Java method: org.openremote.model.security.UserResource.get
730
695
  */
731
- getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
696
+ get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
697
+ }
698
+ export declare class ProvisioningResourceClient<O> {
699
+ protected httpClient: HttpClient<O>;
700
+ constructor(httpClient: HttpClient<O>);
732
701
  /**
733
- * Replaces and redeploys one realm ruleset. Path and body IDs and the existing realm must match; legacy JavaScript cannot be updated.
734
- * HTTP PUT /rules/realm/{id}
735
- * Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
702
+ * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
703
+ * HTTP POST /provisioning
704
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
736
705
  */
737
- updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
706
+ createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
738
707
  /**
739
- * Permanently removes and undeploys one global ruleset. Super-user access is required.
740
- * HTTP DELETE /rules/{id}
741
- * Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
708
+ * Returns every provisioning configuration. This operation is restricted to a super administrator.
709
+ * HTTP GET /provisioning
710
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
742
711
  */
743
- deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
712
+ getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
744
713
  /**
745
- * Returns one fully populated global ruleset including transient deployment status and errors. Super-user access is required.
746
- * HTTP GET /rules/{id}
747
- * Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
714
+ * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
715
+ * HTTP DELETE /provisioning/{id}
716
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
748
717
  */
749
- getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
718
+ deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
750
719
  /**
751
- * Replaces and redeploys the identified global ruleset. Path and body IDs must match; legacy JavaScript rulesets cannot be updated.
752
- * HTTP PUT /rules/{id}
753
- * Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
720
+ * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
721
+ * HTTP PUT /provisioning/{id}
722
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
754
723
  */
755
- updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
724
+ updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
756
725
  }
757
726
  export declare class NotificationResourceClient<O> {
758
727
  protected httpClient: HttpClient<O>;
@@ -833,66 +802,210 @@ export declare class NotificationResourceClient<O> {
833
802
  targetId?: string;
834
803
  }, options?: O): RestResponse<void>;
835
804
  }
836
- export declare class AssetModelResourceClient<O> {
805
+ export declare class GatewayServiceResourceClient<O> {
837
806
  protected httpClient: HttpClient<O>;
838
807
  constructor(httpClient: HttpClient<O>);
839
808
  /**
840
- * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
841
- * HTTP GET /model/assetDescriptors
842
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
809
+ * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
810
+ * Response code 417 - The gateway could not establish the requested tunnel
811
+ * HTTP POST /gateway/tunnel
812
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
843
813
  */
844
- getAssetDescriptors(queryParams?: {
845
- parentId?: string;
846
- parentType?: string;
847
- }, options?: O): RestResponse<Model.AssetDescriptor[]>;
814
+ startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
848
815
  /**
849
- * 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.
850
- * Response code 204 - No model information is available for the requested asset type
851
- * HTTP GET /model/assetInfo/{assetType}
852
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
816
+ * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
817
+ * HTTP DELETE /gateway/tunnel
818
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
853
819
  */
854
- getAssetInfo(assetType: string, queryParams?: {
855
- parentId?: string;
856
- }, options?: O): RestResponse<Model.AssetTypeInfo>;
820
+ stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
857
821
  /**
858
- * 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.
859
- * HTTP GET /model/assetInfos
860
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
822
+ * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
823
+ * HTTP GET /gateway/tunnel/{realm}
824
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
825
+ */
826
+ getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
827
+ /**
828
+ * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
829
+ * HTTP GET /gateway/tunnel/{realm}/{id}
830
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
831
+ */
832
+ getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
833
+ /**
834
+ * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
835
+ * Response code 204 - No active tunnel matches the requested endpoint
836
+ * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
837
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
838
+ */
839
+ getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
840
+ }
841
+ export declare class GatewayClientResourceClient<O> {
842
+ protected httpClient: HttpClient<O>;
843
+ constructor(httpClient: HttpClient<O>);
844
+ /**
845
+ * Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
846
+ * HTTP DELETE /gateway/connection
847
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
848
+ */
849
+ deleteConnections(queryParams?: {
850
+ realm?: string[];
851
+ }, options?: O): RestResponse<void>;
852
+ /**
853
+ * Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
854
+ * HTTP GET /gateway/connection
855
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
856
+ */
857
+ getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
858
+ /**
859
+ * Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
860
+ * HTTP DELETE /gateway/connection/{realm}
861
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
862
+ */
863
+ deleteConnection(realm: string, options?: O): RestResponse<void>;
864
+ /**
865
+ * Returns the central-manager connection configured for a realm, or null when none exists. Realm administrators can read their own realm; super users can read any realm.
866
+ * Response code 204 - No gateway connection is configured for the realm
867
+ * HTTP GET /gateway/connection/{realm}
868
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
869
+ */
870
+ getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
871
+ /**
872
+ * Creates or replaces the connection for the path realm. The server forces the local realm, including realm predicates in attribute filters, to match the path.
873
+ * HTTP PUT /gateway/connection/{realm}
874
+ * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
875
+ */
876
+ setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
877
+ /**
878
+ * Returns the live connection state for the requested local realm.
879
+ * HTTP GET /gateway/status/{realm}
880
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
881
+ */
882
+ getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
883
+ }
884
+ export declare class AssetDatapointResourceClient<O> {
885
+ protected httpClient: HttpClient<O>;
886
+ constructor(httpClient: HttpClient<O>);
887
+ /**
888
+ * 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.
889
+ * Response code 200 - A ZIP archive containing the exported data
890
+ * HTTP GET /asset/datapoint/export
891
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
892
+ */
893
+ getDatapointExport(queryParams?: {
894
+ attributeRefs?: string;
895
+ fromTimestamp?: number;
896
+ toTimestamp?: number;
897
+ format?: Model.DatapointExportFormat;
898
+ }, options?: O): RestResponse<any>;
899
+ /**
900
+ * 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.
901
+ * HTTP GET /asset/datapoint/periods
902
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
903
+ */
904
+ getDatapointPeriod(queryParams?: {
905
+ assetId?: string;
906
+ attributeName?: string;
907
+ }, options?: O): RestResponse<Model.DatapointPeriod>;
908
+ /**
909
+ * 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.
910
+ * HTTP POST /asset/datapoint/{assetId}/{attributeName}
911
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
912
+ */
913
+ getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
914
+ }
915
+ export declare class RealmResourceClient<O> {
916
+ protected httpClient: HttpClient<O>;
917
+ constructor(httpClient: HttpClient<O>);
918
+ /**
919
+ * Creates and configures a realm in the identity provider. This operation is restricted to a super user.
920
+ * HTTP POST /realm
921
+ * Java method: org.openremote.model.security.RealmResource.create
922
+ */
923
+ create(realm: Model.Realm, options?: O): RestResponse<void>;
924
+ /**
925
+ * Returns complete realm records from the identity provider. This operation is restricted to a super user.
926
+ * HTTP GET /realm
927
+ * Java method: org.openremote.model.security.RealmResource.getAll
928
+ */
929
+ getAll(options?: O): RestResponse<Model.Realm[]>;
930
+ /**
931
+ * Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
932
+ * HTTP GET /realm/accessible
933
+ * Java method: org.openremote.model.security.RealmResource.getAccessible
934
+ */
935
+ getAccessible(options?: O): RestResponse<Model.Realm[]>;
936
+ /**
937
+ * Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
938
+ * Response code 405 - The master realm cannot be deleted
939
+ * HTTP DELETE /realm/{name}
940
+ * Java method: org.openremote.model.security.RealmResource.delete
941
+ */
942
+ delete(name: string, options?: O): RestResponse<void>;
943
+ /**
944
+ * Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
945
+ * HTTP GET /realm/{name}
946
+ * Java method: org.openremote.model.security.RealmResource.get
947
+ */
948
+ get(name: string, options?: O): RestResponse<Model.Realm>;
949
+ /**
950
+ * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
951
+ * Response code 405 - The requested mutation is not allowed for the master realm
952
+ * HTTP PUT /realm/{name}
953
+ * Java method: org.openremote.model.security.RealmResource.update
954
+ */
955
+ update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
956
+ }
957
+ export declare class AssetPredictedDatapointResourceClient<O> {
958
+ protected httpClient: HttpClient<O>;
959
+ constructor(httpClient: HttpClient<O>);
960
+ /**
961
+ * 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.
962
+ * HTTP POST /asset/predicted/{assetId}/{attributeName}
963
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
964
+ */
965
+ getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
966
+ /**
967
+ * 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.
968
+ * HTTP PUT /asset/predicted/{assetId}/{attributeName}
969
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
970
+ */
971
+ writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
972
+ }
973
+ export declare class SyslogResourceClient<O> {
974
+ protected httpClient: HttpClient<O>;
975
+ constructor(httpClient: HttpClient<O>);
976
+ /**
977
+ * Returns the current log-storage and retention configuration.
978
+ * HTTP GET /syslog/config
979
+ * Java method: org.openremote.model.syslog.SyslogResource.getConfig
861
980
  */
862
- getAssetInfos(queryParams?: {
863
- parentId?: string;
864
- parentType?: string;
865
- }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
981
+ getConfig(options?: O): RestResponse<Model.SyslogConfig>;
866
982
  /**
867
- * 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.
868
- * Response code 200 - The current JSON Schema
869
- * Response code 304 - The supplied ETag still identifies the current schema
870
- * HTTP GET /model/getValueDescriptorSchema
871
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
983
+ * Validates and applies log-storage and retention settings.
984
+ * HTTP PUT /syslog/config
985
+ * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
872
986
  */
873
- getValueDescriptorSchema(queryParams?: {
874
- name?: string;
875
- }, options?: O): RestResponse<any>;
987
+ updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
876
988
  /**
877
- * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
878
- * HTTP GET /model/metaItemDescriptors
879
- * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
989
+ * Permanently removes all events from the configured syslog storage.
990
+ * HTTP DELETE /syslog/event
991
+ * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
880
992
  */
881
- getMetaItemDescriptors(queryParams?: {
882
- parentId?: string;
883
- }, options?: O): RestResponse<{
884
- [index: string]: Model.MetaItemDescriptor;
885
- }>;
993
+ clearEvents(options?: O): RestResponse<void>;
886
994
  /**
887
- * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
888
- * HTTP GET /model/valueDescriptors
889
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
995
+ * 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.
996
+ * Response code 200 - The requested page of syslog events
997
+ * HTTP GET /syslog/event
998
+ * Java method: org.openremote.model.syslog.SyslogResource.getEvents
890
999
  */
891
- getValueDescriptors(queryParams?: {
892
- parentId?: string;
893
- }, options?: O): RestResponse<{
894
- [index: string]: Model.ValueDescriptor;
895
- }>;
1000
+ getEvents(queryParams?: {
1001
+ level?: Model.SyslogLevel;
1002
+ per_page?: number;
1003
+ page?: number;
1004
+ from?: number;
1005
+ to?: number;
1006
+ category?: Model.SyslogCategory[];
1007
+ subCategory?: string[];
1008
+ }, options?: O): RestResponse<any>;
896
1009
  }
897
1010
  export declare class AssetResourceClient<O> {
898
1011
  protected httpClient: HttpClient<O>;
@@ -1034,119 +1147,6 @@ export declare class AssetResourceClient<O> {
1034
1147
  assetIds?: string[];
1035
1148
  }, options?: O): RestResponse<void>;
1036
1149
  }
1037
- export declare class AlarmResourceClient<O> {
1038
- protected httpClient: HttpClient<O>;
1039
- constructor(httpClient: HttpClient<O>);
1040
- /**
1041
- * 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.
1042
- * HTTP POST /alarm
1043
- * Java method: org.openremote.model.alarm.AlarmResource.createAlarm
1044
- */
1045
- createAlarm(alarm: Model.Alarm, queryParams?: {
1046
- assetIds?: string[];
1047
- }, options?: O): RestResponse<Model.SentAlarm>;
1048
- /**
1049
- * Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
1050
- * HTTP GET /alarm
1051
- * Java method: org.openremote.model.alarm.AlarmResource.getAlarms
1052
- */
1053
- getAlarms(queryParams?: {
1054
- realm?: string;
1055
- status?: Model.AlarmStatus;
1056
- assetId?: string;
1057
- assigneeId?: string;
1058
- }, options?: O): RestResponse<Model.SentAlarm[]>;
1059
- /**
1060
- * Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
1061
- * HTTP DELETE /alarm
1062
- * Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
1063
- */
1064
- removeAlarms(ids: number[], options?: O): RestResponse<void>;
1065
- /**
1066
- * Adds links between assets and one existing alarm.
1067
-
1068
- The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
1069
- every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
1070
- every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
1071
- containing mixed alarm IDs or realms are rejected as bad requests.
1072
-
1073
- Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
1074
- This operation does not remove existing links from the alarm.
1075
-
1076
- * HTTP PUT /alarm/assets
1077
- * Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
1078
- */
1079
- setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
1080
- /**
1081
- * Returns one alarm when its realm is active and accessible to the authenticated user.
1082
- * HTTP GET /alarm/{alarmId}
1083
- * Java method: org.openremote.model.alarm.AlarmResource.getAlarm
1084
- */
1085
- getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
1086
- /**
1087
- * Permanently removes one alarm after verifying access to its realm.
1088
- * HTTP DELETE /alarm/{alarmId}
1089
- * Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
1090
- */
1091
- removeAlarm(alarmId: number, options?: O): RestResponse<void>;
1092
- /**
1093
- * Updates the mutable state of an existing alarm after verifying access to its current realm.
1094
- * HTTP PUT /alarm/{alarmId}
1095
- * Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
1096
- */
1097
- updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
1098
- /**
1099
- * Returns links from the alarm to assets in the explicitly supplied accessible realm.
1100
- * HTTP GET /alarm/{alarmId}/assets
1101
- * Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
1102
- */
1103
- getAssetLinks(alarmId: number, queryParams?: {
1104
- realm?: string;
1105
- }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
1106
- }
1107
- export declare class GatewayClientResourceClient<O> {
1108
- protected httpClient: HttpClient<O>;
1109
- constructor(httpClient: HttpClient<O>);
1110
- /**
1111
- * Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
1112
- * HTTP DELETE /gateway/connection
1113
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
1114
- */
1115
- deleteConnections(queryParams?: {
1116
- realm?: string[];
1117
- }, options?: O): RestResponse<void>;
1118
- /**
1119
- * Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
1120
- * HTTP GET /gateway/connection
1121
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
1122
- */
1123
- getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
1124
- /**
1125
- * Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
1126
- * HTTP DELETE /gateway/connection/{realm}
1127
- * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
1128
- */
1129
- deleteConnection(realm: string, options?: O): RestResponse<void>;
1130
- /**
1131
- * 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.
1132
- * Response code 204 - No gateway connection is configured for the realm
1133
- * HTTP GET /gateway/connection/{realm}
1134
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
1135
- */
1136
- getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
1137
- /**
1138
- * 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.
1139
- * HTTP PUT /gateway/connection/{realm}
1140
- * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
1141
- */
1142
- setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
1143
- /**
1144
- * Returns the live connection state for the requested local realm.
1145
- * HTTP GET /gateway/status/{realm}
1146
- * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
1147
- */
1148
- getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
1149
- }
1150
1150
  export declare class AppResourceClient<O> {
1151
1151
  protected httpClient: HttpClient<O>;
1152
1152
  constructor(httpClient: HttpClient<O>);
@@ -1174,49 +1174,49 @@ export declare class AppResourceClient<O> {
1174
1174
  export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
1175
1175
  export declare class ApiClient {
1176
1176
  protected _statusResource: AxiosStatusResourceClient;
1177
- protected _dashboardResource: AxiosDashboardResourceClient;
1178
- protected _realmResource: AxiosRealmResourceClient;
1179
- protected _consoleResource: AxiosConsoleResourceClient;
1180
- protected _externalServiceResource: AxiosExternalServiceResourceClient;
1181
- protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
1182
- protected _syslogResource: AxiosSyslogResourceClient;
1177
+ protected _flowResource: AxiosFlowResourceClient;
1183
1178
  protected _configurationResource: AxiosConfigurationResourceClient;
1184
- protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
1185
1179
  protected _agentResource: AxiosAgentResourceClient;
1186
- protected _userResource: AxiosUserResourceClient;
1180
+ protected _alarmResource: AxiosAlarmResourceClient;
1187
1181
  protected _mapResource: AxiosMapResourceClient;
1188
- protected _provisioningResource: AxiosProvisioningResourceClient;
1189
- protected _flowResource: AxiosFlowResourceClient;
1190
- protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1182
+ protected _externalServiceResource: AxiosExternalServiceResourceClient;
1183
+ protected _consoleResource: AxiosConsoleResourceClient;
1191
1184
  protected _rulesResource: AxiosRulesResourceClient;
1192
- protected _notificationResource: AxiosNotificationResourceClient;
1185
+ protected _dashboardResource: AxiosDashboardResourceClient;
1193
1186
  protected _assetModelResource: AxiosAssetModelResourceClient;
1194
- protected _assetResource: AxiosAssetResourceClient;
1195
- protected _alarmResource: AxiosAlarmResourceClient;
1187
+ protected _userResource: AxiosUserResourceClient;
1188
+ protected _provisioningResource: AxiosProvisioningResourceClient;
1189
+ protected _notificationResource: AxiosNotificationResourceClient;
1190
+ protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1196
1191
  protected _gatewayClientResource: AxiosGatewayClientResourceClient;
1192
+ protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
1193
+ protected _realmResource: AxiosRealmResourceClient;
1194
+ protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
1195
+ protected _syslogResource: AxiosSyslogResourceClient;
1196
+ protected _assetResource: AxiosAssetResourceClient;
1197
1197
  protected _appResource: AxiosAppResourceClient;
1198
1198
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1199
1199
  get StatusResource(): AxiosStatusResourceClient;
1200
- get DashboardResource(): AxiosDashboardResourceClient;
1201
- get RealmResource(): AxiosRealmResourceClient;
1202
- get ConsoleResource(): AxiosConsoleResourceClient;
1203
- get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1204
- get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1205
- get SyslogResource(): AxiosSyslogResourceClient;
1200
+ get FlowResource(): AxiosFlowResourceClient;
1206
1201
  get ConfigurationResource(): AxiosConfigurationResourceClient;
1207
- get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
1208
1202
  get AgentResource(): AxiosAgentResourceClient;
1209
- get UserResource(): AxiosUserResourceClient;
1203
+ get AlarmResource(): AxiosAlarmResourceClient;
1210
1204
  get MapResource(): AxiosMapResourceClient;
1211
- get ProvisioningResource(): AxiosProvisioningResourceClient;
1212
- get FlowResource(): AxiosFlowResourceClient;
1213
- get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1205
+ get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1206
+ get ConsoleResource(): AxiosConsoleResourceClient;
1214
1207
  get RulesResource(): AxiosRulesResourceClient;
1215
- get NotificationResource(): AxiosNotificationResourceClient;
1208
+ get DashboardResource(): AxiosDashboardResourceClient;
1216
1209
  get AssetModelResource(): AxiosAssetModelResourceClient;
1217
- get AssetResource(): AxiosAssetResourceClient;
1218
- get AlarmResource(): AxiosAlarmResourceClient;
1210
+ get UserResource(): AxiosUserResourceClient;
1211
+ get ProvisioningResource(): AxiosProvisioningResourceClient;
1212
+ get NotificationResource(): AxiosNotificationResourceClient;
1213
+ get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1219
1214
  get GatewayClientResource(): AxiosGatewayClientResourceClient;
1215
+ get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
1216
+ get RealmResource(): AxiosRealmResourceClient;
1217
+ get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1218
+ get SyslogResource(): AxiosSyslogResourceClient;
1219
+ get AssetResource(): AxiosAssetResourceClient;
1220
1220
  get AppResource(): AxiosAppResourceClient;
1221
1221
  }
1222
1222
  import * as Axios from "axios";
@@ -1228,64 +1228,64 @@ declare module "axios" {
1228
1228
  export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1229
1229
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1230
1230
  }
1231
- export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1231
+ export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1232
1232
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1233
1233
  }
1234
- export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1234
+ export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1235
1235
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1236
1236
  }
1237
- export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1237
+ export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1238
1238
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1239
1239
  }
1240
- export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1240
+ export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1241
1241
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1242
1242
  }
1243
- export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1243
+ export declare class AxiosMapResourceClient extends MapResourceClient<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 AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1247
1247
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1248
1248
  }
1249
- export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1249
+ export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<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 AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1253
1253
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1254
1254
  }
1255
- export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1255
+ export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1256
1256
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1257
1257
  }
1258
- export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1258
+ export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1259
1259
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1260
1260
  }
1261
- export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1261
+ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1262
1262
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1263
1263
  }
1264
1264
  export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1265
1265
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1266
1266
  }
1267
- export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1267
+ export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1268
1268
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1269
1269
  }
1270
1270
  export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1271
1271
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1272
1272
  }
1273
- export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1273
+ export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1274
1274
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1275
1275
  }
1276
- export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1276
+ export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1277
1277
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1278
1278
  }
1279
- export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1279
+ export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1280
1280
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1281
1281
  }
1282
- export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1282
+ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<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 AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1286
1286
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1287
1287
  }
1288
- export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1288
+ export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1289
1289
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1290
1290
  }
1291
1291
  export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {