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