@openremote/rest 1.30.0-snapshot.20260902122509 → 1.30.1

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