@openremote/rest 1.29.0-snapshot.20260810073600 → 1.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,6 +9,46 @@ export interface HttpClient<O> {
9
9
  options?: O;
10
10
  }): RestResponse<R>;
11
11
  }
12
+ export declare class DashboardResourceClient<O> {
13
+ protected httpClient: HttpClient<O>;
14
+ constructor(httpClient: HttpClient<O>);
15
+ /**
16
+ * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
17
+ * HTTP POST /dashboard
18
+ * Java method: org.openremote.model.dashboard.DashboardResource.create
19
+ */
20
+ create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
21
+ /**
22
+ * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
23
+ * HTTP PUT /dashboard
24
+ * Java method: org.openremote.model.dashboard.DashboardResource.update
25
+ */
26
+ update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
27
+ /**
28
+ * Returns dashboards visible to the caller in the requested realm. Anonymous callers receive public dashboards only; authenticated access also depends on roles, ownership, and linked assets.
29
+ * HTTP GET /dashboard/all/{realm}
30
+ * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
31
+ */
32
+ getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
33
+ /**
34
+ * Executes a dashboard query after constraining it to the caller's realm, roles, ownership, and asset access. A missing body uses the request realm and default visibility rules.
35
+ * HTTP POST /dashboard/query
36
+ * Java method: org.openremote.model.dashboard.DashboardResource.query
37
+ */
38
+ query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
39
+ /**
40
+ * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
41
+ * HTTP DELETE /dashboard/{realm}/{dashboardId}
42
+ * Java method: org.openremote.model.dashboard.DashboardResource.delete
43
+ */
44
+ delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
45
+ /**
46
+ * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
47
+ * HTTP GET /dashboard/{realm}/{dashboardId}
48
+ * Java method: org.openremote.model.dashboard.DashboardResource.get
49
+ */
50
+ get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
51
+ }
12
52
  export declare class RulesResourceClient<O> {
13
53
  protected httpClient: HttpClient<O>;
14
54
  constructor(httpClient: HttpClient<O>);
@@ -139,165 +179,222 @@ export declare class RulesResourceClient<O> {
139
179
  */
140
180
  updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
141
181
  }
142
- export declare class AssetResourceClient<O> {
182
+ export declare class GatewayServiceResourceClient<O> {
143
183
  protected httpClient: HttpClient<O>;
144
184
  constructor(httpClient: HttpClient<O>);
145
185
  /**
146
- * 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.
147
- * HTTP POST /asset
148
- * Java method: org.openremote.model.asset.AssetResource.create
186
+ * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
187
+ * Response code 417 - The gateway could not establish the requested tunnel
188
+ * HTTP POST /gateway/tunnel
189
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
149
190
  */
150
- create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
191
+ startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
151
192
  /**
152
- * Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
153
- * HTTP DELETE /asset
154
- * Java method: org.openremote.model.asset.AssetResource.delete
193
+ * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
194
+ * HTTP DELETE /gateway/tunnel
195
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
155
196
  */
156
- delete(queryParams?: {
157
- assetId?: string[];
158
- }, options?: O): RestResponse<void>;
197
+ stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
159
198
  /**
160
- * 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.
161
- * HTTP PUT /asset/attributes
162
- * Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
199
+ * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
200
+ * HTTP GET /gateway/tunnel/{realm}
201
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
163
202
  */
164
- writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
203
+ getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
165
204
  /**
166
- * 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.
167
- * HTTP PUT /asset/attributes/timestamp
168
- * Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
205
+ * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
206
+ * HTTP GET /gateway/tunnel/{realm}/{id}
207
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
169
208
  */
170
- writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
209
+ getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
171
210
  /**
172
- * Returns only the number of assets matching an AssetQuery after applying the caller's realm, public, and linked-asset access constraints.
173
- * HTTP POST /asset/count
174
- * Java method: org.openremote.model.asset.AssetResource.queryCount
211
+ * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
212
+ * Response code 204 - No active tunnel matches the requested endpoint
213
+ * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
214
+ * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
175
215
  */
176
- queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
216
+ getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
217
+ }
218
+ export declare class AssetPredictedDatapointResourceClient<O> {
219
+ protected httpClient: HttpClient<O>;
220
+ constructor(httpClient: HttpClient<O>);
177
221
  /**
178
- * Clears the parent reference of every asset listed in repeated assetIds query parameters.
179
- * HTTP DELETE /asset/parent
180
- * Java method: org.openremote.model.asset.AssetResource.updateNoneParent
222
+ * 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.
223
+ * HTTP POST /asset/predicted/{assetId}/{attributeName}
224
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
181
225
  */
182
- updateNoneParent(queryParams?: {
183
- assetIds?: string[];
184
- }, options?: O): RestResponse<void>;
226
+ getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
185
227
  /**
186
- * Returns the asset identity and properties without loading attributes or path data. The same access rules as getAsset apply.
187
- * HTTP GET /asset/partial/{assetId}
188
- * Java method: org.openremote.model.asset.AssetResource.getPartial
228
+ * 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.
229
+ * HTTP PUT /asset/predicted/{assetId}/{attributeName}
230
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
189
231
  */
190
- getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
232
+ writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
233
+ }
234
+ export declare class ExternalServiceResourceClient<O> {
235
+ protected httpClient: HttpClient<O>;
236
+ constructor(httpClient: HttpClient<O>);
191
237
  /**
192
- * 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.
193
- * HTTP POST /asset/query
194
- * Java method: org.openremote.model.asset.AssetResource.queryAssets
238
+ * Returns all active realm-scoped service registrations for an active realm accessible to the caller.
239
+ * Response code 200 - List of registered external services
240
+ * HTTP GET /service
241
+ * Java method: org.openremote.model.services.ExternalServiceResource.getServices
195
242
  */
196
- queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
243
+ getServices(queryParams?: {
244
+ realm?: string;
245
+ }, options?: O): RestResponse<Model.ExternalService[]>;
197
246
  /**
198
- * Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
199
- * HTTP POST /asset/tree
200
- * Java method: org.openremote.model.asset.AssetResource.queryAssetTree
247
+ * 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.
248
+ * Response code 200 - Service registered successfully
249
+ * Response code 400 - Invalid external service object
250
+ * Response code 409 - ExternalService instance already registered
251
+ * HTTP POST /service
252
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerService
201
253
  */
202
- queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
254
+ registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
203
255
  /**
204
- * 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.
205
- * HTTP GET /asset/user/current
206
- * Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
256
+ * Returns active registrations marked as globally available across realms.
257
+ * Response code 200 - List of registered external services
258
+ * HTTP GET /service/global
259
+ * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
207
260
  */
208
- getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
261
+ getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
209
262
  /**
210
- * 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.
211
- * HTTP POST /asset/user/link
212
- * Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
263
+ * Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
264
+ * Response code 200 - Service registered successfully
265
+ * Response code 400 - Invalid external service object
266
+ * Response code 409 - ExternalService instance already registered
267
+ * HTTP POST /service/global
268
+ * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
213
269
  */
214
- createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
270
+ registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
215
271
  /**
216
- * 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.
217
- * HTTP GET /asset/user/link
218
- * Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
272
+ * Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
273
+ * Response code 204 - Service deregistered successfully
274
+ * Response code 404 - Service instance not found
275
+ * HTTP DELETE /service/{serviceId}/{instanceId}
276
+ * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
219
277
  */
220
- getUserAssetLinks(queryParams?: {
221
- realm?: string;
222
- userId?: string;
223
- assetId?: string;
224
- }, options?: O): RestResponse<Model.UserAssetLink[]>;
278
+ deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
225
279
  /**
226
- * Removes all supplied links. Every item must identify the same realm and user.
227
- * HTTP POST /asset/user/link/delete
228
- * Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
280
+ * Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
281
+ * Response code 200 - ExternalService retrieved successfully
282
+ * Response code 404 - ExternalService not found
283
+ * HTTP GET /service/{serviceId}/{instanceId}
284
+ * Java method: org.openremote.model.services.ExternalServiceResource.getService
229
285
  */
230
- deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
286
+ getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
231
287
  /**
232
- * Removes every asset link belonging to the user in the requested realm.
233
- * HTTP DELETE /asset/user/link/{realm}/{userId}
234
- * Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
288
+ * 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.
289
+ * Response code 204 - Heartbeat sent successfully
290
+ * Response code 404 - Service instance not found
291
+ * HTTP PUT /service/{serviceId}/{instanceId}
292
+ * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
235
293
  */
236
- deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
294
+ heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
295
+ }
296
+ export declare class AssetModelResourceClient<O> {
297
+ protected httpClient: HttpClient<O>;
298
+ constructor(httpClient: HttpClient<O>);
237
299
  /**
238
- * Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
239
- * HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
240
- * Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
300
+ * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
301
+ * HTTP GET /model/assetDescriptors
302
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
241
303
  */
242
- deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
304
+ getAssetDescriptors(queryParams?: {
305
+ parentId?: string;
306
+ parentType?: string;
307
+ }, options?: O): RestResponse<Model.AssetDescriptor[]>;
243
308
  /**
244
- * Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
245
- * HTTP GET /asset/{assetId}
246
- * Java method: org.openremote.model.asset.AssetResource.get
309
+ * 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.
310
+ * Response code 204 - No model information is available for the requested asset type
311
+ * HTTP GET /model/assetInfo/{assetType}
312
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
247
313
  */
248
- get(assetId: string, options?: O): RestResponse<Model.Asset>;
314
+ getAssetInfo(assetType: string, queryParams?: {
315
+ parentId?: string;
316
+ }, options?: O): RestResponse<Model.AssetTypeInfo>;
249
317
  /**
250
- * 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.
251
- * HTTP PUT /asset/{assetId}
252
- * Java method: org.openremote.model.asset.AssetResource.update
318
+ * 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.
319
+ * HTTP GET /model/assetInfos
320
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
253
321
  */
254
- update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
322
+ getAssetInfos(queryParams?: {
323
+ parentId?: string;
324
+ parentType?: string;
325
+ }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
255
326
  /**
256
- * 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.
257
- * Response code 400 - The attribute write failed
258
- * Response code 406 - The supplied value is not valid for the attribute
259
- * Response code 429 - The attribute event queue is full; retry the write later
260
- * HTTP PUT /asset/{assetId}/attribute/{attributeName}
261
- * Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
327
+ * 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.
328
+ * Response code 200 - The current JSON Schema
329
+ * Response code 304 - The supplied ETag still identifies the current schema
330
+ * HTTP GET /model/getValueDescriptorSchema
331
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
262
332
  */
263
- writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
333
+ getValueDescriptorSchema(queryParams?: {
334
+ name?: string;
335
+ }, options?: O): RestResponse<any>;
264
336
  /**
265
- * Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
266
- * Response code 400 - The attribute write failed
267
- * Response code 406 - The supplied value is not valid for the attribute
268
- * Response code 429 - The attribute event queue is full; retry the write later
269
- * HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
270
- * Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
337
+ * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
338
+ * HTTP GET /model/metaItemDescriptors
339
+ * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
271
340
  */
272
- writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
341
+ getMetaItemDescriptors(queryParams?: {
342
+ parentId?: string;
343
+ }, options?: O): RestResponse<{
344
+ [index: string]: Model.MetaItemDescriptor;
345
+ }>;
273
346
  /**
274
- * Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
275
- * HTTP PUT /asset/{parentAssetId}/child
276
- * Java method: org.openremote.model.asset.AssetResource.updateParent
347
+ * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
348
+ * HTTP GET /model/valueDescriptors
349
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
277
350
  */
278
- updateParent(parentAssetId: string, queryParams?: {
279
- assetIds?: string[];
280
- }, options?: O): RestResponse<void>;
351
+ getValueDescriptors(queryParams?: {
352
+ parentId?: string;
353
+ }, options?: O): RestResponse<{
354
+ [index: string]: Model.ValueDescriptor;
355
+ }>;
281
356
  }
282
- export declare class StatusResourceClient<O> {
357
+ export declare class RealmResourceClient<O> {
283
358
  protected httpClient: HttpClient<O>;
284
359
  constructor(httpClient: HttpClient<O>);
285
360
  /**
286
- * Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
287
- * HTTP GET /health
288
- * Java method: org.openremote.model.system.StatusResource.getHealthStatus
361
+ * Creates and configures a realm in the identity provider. This operation is restricted to a super user.
362
+ * HTTP POST /realm
363
+ * Java method: org.openremote.model.security.RealmResource.create
289
364
  */
290
- getHealthStatus(options?: O): RestResponse<{
291
- [index: string]: any;
292
- }>;
365
+ create(realm: Model.Realm, options?: O): RestResponse<void>;
293
366
  /**
294
- * Returns public bootstrap information, including the Manager version and identity-provider URL.
295
- * HTTP GET /info
296
- * Java method: org.openremote.model.system.StatusResource.getInfo
367
+ * Returns complete realm records from the identity provider. This operation is restricted to a super user.
368
+ * HTTP GET /realm
369
+ * Java method: org.openremote.model.security.RealmResource.getAll
297
370
  */
298
- getInfo(options?: O): RestResponse<{
299
- [index: string]: any;
300
- }>;
371
+ getAll(options?: O): RestResponse<Model.Realm[]>;
372
+ /**
373
+ * Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
374
+ * HTTP GET /realm/accessible
375
+ * Java method: org.openremote.model.security.RealmResource.getAccessible
376
+ */
377
+ getAccessible(options?: O): RestResponse<Model.Realm[]>;
378
+ /**
379
+ * Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
380
+ * Response code 405 - The master realm cannot be deleted
381
+ * HTTP DELETE /realm/{name}
382
+ * Java method: org.openremote.model.security.RealmResource.delete
383
+ */
384
+ delete(name: string, options?: O): RestResponse<void>;
385
+ /**
386
+ * 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.
387
+ * HTTP GET /realm/{name}
388
+ * Java method: org.openremote.model.security.RealmResource.get
389
+ */
390
+ get(name: string, options?: O): RestResponse<Model.Realm>;
391
+ /**
392
+ * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
393
+ * Response code 405 - The requested mutation is not allowed for the master realm
394
+ * HTTP PUT /realm/{name}
395
+ * Java method: org.openremote.model.security.RealmResource.update
396
+ */
397
+ update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
301
398
  }
302
399
  export declare class AlarmResourceClient<O> {
303
400
  protected httpClient: HttpClient<O>;
@@ -369,77 +466,157 @@ This operation does not remove existing links from the alarm.
369
466
  realm?: string;
370
467
  }, options?: O): RestResponse<Model.AlarmAssetLink[]>;
371
468
  }
372
- export declare class ConsoleResourceClient<O> {
469
+ export declare class FlowResourceClient<O> {
373
470
  protected httpClient: HttpClient<O>;
374
471
  constructor(httpClient: HttpClient<O>);
375
472
  /**
376
- * 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.
377
- * HTTP POST /console/register
378
- * Java method: org.openremote.model.console.ConsoleResource.register
473
+ * Returns every supported flow node definition except the internal LOG_OUTPUT node.
474
+ * HTTP GET /flow
475
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
379
476
  */
380
- register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
477
+ getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
478
+ /**
479
+ * Resolves one flow node definition by its model name.
480
+ * HTTP GET /flow/{name}
481
+ * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
482
+ */
483
+ getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
484
+ /**
485
+ * Returns supported flow node definitions whose category matches the requested node type.
486
+ * HTTP GET /flow/{type}
487
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
488
+ */
489
+ getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
381
490
  }
382
- export declare class AssetModelResourceClient<O> {
491
+ export declare class ProvisioningResourceClient<O> {
383
492
  protected httpClient: HttpClient<O>;
384
493
  constructor(httpClient: HttpClient<O>);
385
494
  /**
386
- * Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
387
- * HTTP GET /model/assetDescriptors
388
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
495
+ * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
496
+ * HTTP POST /provisioning
497
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
389
498
  */
390
- getAssetDescriptors(queryParams?: {
391
- parentId?: string;
392
- parentType?: string;
393
- }, options?: O): RestResponse<Model.AssetDescriptor[]>;
499
+ createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
394
500
  /**
395
- * 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.
396
- * Response code 204 - No model information is available for the requested asset type
397
- * HTTP GET /model/assetInfo/{assetType}
398
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
501
+ * Returns every provisioning configuration. This operation is restricted to a super administrator.
502
+ * HTTP GET /provisioning
503
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
399
504
  */
400
- getAssetInfo(assetType: string, queryParams?: {
401
- parentId?: string;
402
- }, options?: O): RestResponse<Model.AssetTypeInfo>;
505
+ getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
403
506
  /**
404
- * 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.
405
- * HTTP GET /model/assetInfos
406
- * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
507
+ * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
508
+ * HTTP DELETE /provisioning/{id}
509
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
407
510
  */
408
- getAssetInfos(queryParams?: {
409
- parentId?: string;
410
- parentType?: string;
411
- }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
511
+ deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
412
512
  /**
413
- * 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.
414
- * Response code 200 - The current JSON Schema
415
- * Response code 304 - The supplied ETag still identifies the current schema
416
- * HTTP GET /model/getValueDescriptorSchema
417
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
513
+ * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
514
+ * HTTP PUT /provisioning/{id}
515
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
418
516
  */
419
- getValueDescriptorSchema(queryParams?: {
420
- name?: string;
421
- }, options?: O): RestResponse<any>;
517
+ updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
518
+ }
519
+ export declare class MapResourceClient<O> {
520
+ protected httpClient: HttpClient<O>;
521
+ constructor(httpClient: HttpClient<O>);
422
522
  /**
423
- * Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
424
- * HTTP GET /model/metaItemDescriptors
425
- * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
523
+ * Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
524
+ * HTTP GET /map
525
+ * Java method: org.openremote.model.map.MapResource.getSettings
426
526
  */
427
- getMetaItemDescriptors(queryParams?: {
428
- parentId?: string;
429
- }, options?: O): RestResponse<{
430
- [index: string]: Model.MetaItemDescriptor;
527
+ getSettings(options?: O): RestResponse<{
528
+ [id: string]: unknown;
431
529
  }>;
432
530
  /**
433
- * Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
434
- * HTTP GET /model/valueDescriptors
435
- * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
531
+ * Stores the map configuration and returns the resulting public MapLibre settings.
532
+ * HTTP PUT /map
533
+ * Java method: org.openremote.model.map.MapResource.saveSettings
436
534
  */
437
- getValueDescriptors(queryParams?: {
438
- parentId?: string;
535
+ saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
536
+ [id: string]: unknown;
537
+ }>;
538
+ /**
539
+ * Deletes the installed custom MBTiles database and returns the fallback public map settings.
540
+ * HTTP DELETE /map/deleteMap
541
+ * Java method: org.openremote.model.map.MapResource.deleteMap
542
+ */
543
+ deleteMap(options?: O): RestResponse<{
544
+ [id: string]: unknown;
545
+ }>;
546
+ /**
547
+ * Reports whether custom MBTiles data is installed and the maximum accepted upload size.
548
+ * HTTP GET /map/getCustomMapInfo
549
+ * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
550
+ */
551
+ getCustomMapInfo(options?: O): RestResponse<{
552
+ [id: string]: unknown;
553
+ }>;
554
+ /**
555
+ * Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
556
+ * Response code 200 - Gzip-compressed vector tile
557
+ * Response code 204 - No tile exists at the requested coordinates
558
+ * HTTP GET /map/tile/{zoom}/{column}/{row}
559
+ * Java method: org.openremote.model.map.MapResource.getTile
560
+ */
561
+ getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
562
+ /**
563
+ * Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
564
+ * HTTP POST /map/upload
565
+ * Java method: org.openremote.model.map.MapResource.uploadMap
566
+ */
567
+ uploadMap(queryParams?: {
568
+ filename?: string;
439
569
  }, options?: O): RestResponse<{
440
- [index: string]: Model.ValueDescriptor;
570
+ [id: string]: unknown;
441
571
  }>;
442
572
  }
573
+ export declare class ConsoleResourceClient<O> {
574
+ protected httpClient: HttpClient<O>;
575
+ constructor(httpClient: HttpClient<O>);
576
+ /**
577
+ * 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.
578
+ * HTTP POST /console/register
579
+ * Java method: org.openremote.model.console.ConsoleResource.register
580
+ */
581
+ register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
582
+ }
583
+ export declare class SyslogResourceClient<O> {
584
+ protected httpClient: HttpClient<O>;
585
+ constructor(httpClient: HttpClient<O>);
586
+ /**
587
+ * Returns the current log-storage and retention configuration.
588
+ * HTTP GET /syslog/config
589
+ * Java method: org.openremote.model.syslog.SyslogResource.getConfig
590
+ */
591
+ getConfig(options?: O): RestResponse<Model.SyslogConfig>;
592
+ /**
593
+ * Validates and applies log-storage and retention settings.
594
+ * HTTP PUT /syslog/config
595
+ * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
596
+ */
597
+ updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
598
+ /**
599
+ * Permanently removes all events from the configured syslog storage.
600
+ * HTTP DELETE /syslog/event
601
+ * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
602
+ */
603
+ clearEvents(options?: O): RestResponse<void>;
604
+ /**
605
+ * 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.
606
+ * Response code 200 - The requested page of syslog events
607
+ * HTTP GET /syslog/event
608
+ * Java method: org.openremote.model.syslog.SyslogResource.getEvents
609
+ */
610
+ getEvents(queryParams?: {
611
+ level?: Model.SyslogLevel;
612
+ per_page?: number;
613
+ page?: number;
614
+ from?: number;
615
+ to?: number;
616
+ category?: Model.SyslogCategory[];
617
+ subCategory?: string[];
618
+ }, options?: O): RestResponse<any>;
619
+ }
443
620
  export declare class GatewayClientResourceClient<O> {
444
621
  protected httpClient: HttpClient<O>;
445
622
  constructor(httpClient: HttpClient<O>);
@@ -483,190 +660,26 @@ export declare class GatewayClientResourceClient<O> {
483
660
  */
484
661
  getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
485
662
  }
486
- export declare class AppResourceClient<O> {
663
+ export declare class StatusResourceClient<O> {
487
664
  protected httpClient: HttpClient<O>;
488
665
  constructor(httpClient: HttpClient<O>);
489
666
  /**
490
- * Returns the identifiers of applications installed in the Manager web root.
491
- * HTTP GET /apps
492
- * Java method: org.openremote.model.apps.AppResource.getApps
667
+ * Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
668
+ * HTTP GET /health
669
+ * Java method: org.openremote.model.system.StatusResource.getHealthStatus
493
670
  */
494
- getApps(options?: O): RestResponse<string[]>;
671
+ getHealthStatus(options?: O): RestResponse<{
672
+ [index: string]: any;
673
+ }>;
495
674
  /**
496
- * Loads the public console_config.json document used to configure console clients before sign-in.
497
- * HTTP GET /apps/consoleConfig
498
- * Java method: org.openremote.model.apps.AppResource.getConsoleConfig
675
+ * Returns public bootstrap information, including the Manager version and identity-provider URL.
676
+ * HTTP GET /info
677
+ * Java method: org.openremote.model.system.StatusResource.getInfo
499
678
  */
500
- getConsoleConfig(options?: O): RestResponse<any>;
501
- /**
502
- * Loads each installed application's info.json file and returns the documents keyed by application identifier.
503
- * HTTP GET /apps/info
504
- * Java method: org.openremote.model.apps.AppResource.getAppInfos
505
- */
506
- getAppInfos(options?: O): RestResponse<{
679
+ getInfo(options?: O): RestResponse<{
507
680
  [index: string]: any;
508
681
  }>;
509
682
  }
510
- export declare class ConfigurationResourceClient<O> {
511
- protected httpClient: HttpClient<O>;
512
- constructor(httpClient: HttpClient<O>);
513
- /**
514
- * Returns the public Manager application configuration used by clients before and after authentication.
515
- * HTTP GET /configuration/manager
516
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
517
- */
518
- getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
519
- /**
520
- * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
521
- * HTTP PUT /configuration/manager
522
- * Java method: org.openremote.model.manager.ConfigurationResource.update
523
- */
524
- update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
525
- /**
526
- * Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
527
- * HTTP POST /configuration/manager/file
528
- * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
529
- */
530
- fileUpload(fileInfo: Model.FileInfo, queryParams?: {
531
- path?: string;
532
- }, options?: O): RestResponse<string>;
533
- /**
534
- * Streams a previously uploaded configuration image using its detected media type.
535
- * Response code 200 - The image file
536
- * HTTP GET /configuration/manager/image/{filename: .+}
537
- * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
538
- */
539
- getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
540
- }
541
- export declare class GatewayServiceResourceClient<O> {
542
- protected httpClient: HttpClient<O>;
543
- constructor(httpClient: HttpClient<O>);
544
- /**
545
- * Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
546
- * Response code 417 - The gateway could not establish the requested tunnel
547
- * HTTP POST /gateway/tunnel
548
- * Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
549
- */
550
- startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
551
- /**
552
- * Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
553
- * HTTP DELETE /gateway/tunnel
554
- * Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
555
- */
556
- stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
557
- /**
558
- * Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
559
- * HTTP GET /gateway/tunnel/{realm}
560
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
561
- */
562
- getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
563
- /**
564
- * Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
565
- * HTTP GET /gateway/tunnel/{realm}/{id}
566
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
567
- */
568
- getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
569
- /**
570
- * Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
571
- * Response code 204 - No active tunnel matches the requested endpoint
572
- * HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
573
- * Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
574
- */
575
- getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
576
- }
577
- export declare class AssetDatapointResourceClient<O> {
578
- protected httpClient: HttpClient<O>;
579
- constructor(httpClient: HttpClient<O>);
580
- /**
581
- * 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.
582
- * Response code 200 - A ZIP archive containing the exported data
583
- * HTTP GET /asset/datapoint/export
584
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
585
- */
586
- getDatapointExport(queryParams?: {
587
- attributeRefs?: string;
588
- fromTimestamp?: number;
589
- toTimestamp?: number;
590
- format?: Model.DatapointExportFormat;
591
- }, options?: O): RestResponse<any>;
592
- /**
593
- * 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.
594
- * HTTP GET /asset/datapoint/periods
595
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
596
- */
597
- getDatapointPeriod(queryParams?: {
598
- assetId?: string;
599
- attributeName?: string;
600
- }, options?: O): RestResponse<Model.DatapointPeriod>;
601
- /**
602
- * 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.
603
- * HTTP POST /asset/datapoint/{assetId}/{attributeName}
604
- * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
605
- */
606
- getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
607
- }
608
- export declare class ExternalServiceResourceClient<O> {
609
- protected httpClient: HttpClient<O>;
610
- constructor(httpClient: HttpClient<O>);
611
- /**
612
- * Returns all active realm-scoped service registrations for an active realm accessible to the caller.
613
- * Response code 200 - List of registered external services
614
- * HTTP GET /service
615
- * Java method: org.openremote.model.services.ExternalServiceResource.getServices
616
- */
617
- getServices(queryParams?: {
618
- realm?: string;
619
- }, options?: O): RestResponse<Model.ExternalService[]>;
620
- /**
621
- * 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.
622
- * Response code 200 - Service registered successfully
623
- * Response code 400 - Invalid external service object
624
- * Response code 409 - ExternalService instance already registered
625
- * HTTP POST /service
626
- * Java method: org.openremote.model.services.ExternalServiceResource.registerService
627
- */
628
- registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
629
- /**
630
- * Returns active registrations marked as globally available across realms.
631
- * Response code 200 - List of registered external services
632
- * HTTP GET /service/global
633
- * Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
634
- */
635
- getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
636
- /**
637
- * Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
638
- * Response code 200 - Service registered successfully
639
- * Response code 400 - Invalid external service object
640
- * Response code 409 - ExternalService instance already registered
641
- * HTTP POST /service/global
642
- * Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
643
- */
644
- registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
645
- /**
646
- * Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
647
- * Response code 204 - Service deregistered successfully
648
- * Response code 404 - Service instance not found
649
- * HTTP DELETE /service/{serviceId}/{instanceId}
650
- * Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
651
- */
652
- deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
653
- /**
654
- * Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
655
- * Response code 200 - ExternalService retrieved successfully
656
- * Response code 404 - ExternalService not found
657
- * HTTP GET /service/{serviceId}/{instanceId}
658
- * Java method: org.openremote.model.services.ExternalServiceResource.getService
659
- */
660
- getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
661
- /**
662
- * 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.
663
- * Response code 204 - Heartbeat sent successfully
664
- * Response code 404 - Service instance not found
665
- * HTTP PUT /service/{serviceId}/{instanceId}
666
- * Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
667
- */
668
- heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
669
- }
670
683
  export declare class UserResourceClient<O> {
671
684
  protected httpClient: HttpClient<O>;
672
685
  constructor(httpClient: HttpClient<O>);
@@ -819,21 +832,67 @@ export declare class UserResourceClient<O> {
819
832
  */
820
833
  get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
821
834
  }
822
- export declare class AssetPredictedDatapointResourceClient<O> {
835
+ export declare class ConfigurationResourceClient<O> {
823
836
  protected httpClient: HttpClient<O>;
824
837
  constructor(httpClient: HttpClient<O>);
825
838
  /**
826
- * 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.
827
- * HTTP POST /asset/predicted/{assetId}/{attributeName}
828
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
839
+ * Returns the public Manager application configuration used by clients before and after authentication.
840
+ * HTTP GET /configuration/manager
841
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
829
842
  */
830
- getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
843
+ getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
831
844
  /**
832
- * 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.
833
- * HTTP PUT /asset/predicted/{assetId}/{attributeName}
834
- * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
845
+ * Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
846
+ * HTTP PUT /configuration/manager
847
+ * Java method: org.openremote.model.manager.ConfigurationResource.update
835
848
  */
836
- writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
849
+ update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
850
+ /**
851
+ * Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
852
+ * HTTP POST /configuration/manager/file
853
+ * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
854
+ */
855
+ fileUpload(fileInfo: Model.FileInfo, queryParams?: {
856
+ path?: string;
857
+ }, options?: O): RestResponse<string>;
858
+ /**
859
+ * Streams a previously uploaded configuration image using its detected media type.
860
+ * Response code 200 - The image file
861
+ * HTTP GET /configuration/manager/image/{filename: .+}
862
+ * Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
863
+ */
864
+ getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
865
+ }
866
+ export declare class AssetDatapointResourceClient<O> {
867
+ protected httpClient: HttpClient<O>;
868
+ constructor(httpClient: HttpClient<O>);
869
+ /**
870
+ * 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.
871
+ * Response code 200 - A ZIP archive containing the exported data
872
+ * HTTP GET /asset/datapoint/export
873
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
874
+ */
875
+ getDatapointExport(queryParams?: {
876
+ attributeRefs?: string;
877
+ fromTimestamp?: number;
878
+ toTimestamp?: number;
879
+ format?: Model.DatapointExportFormat;
880
+ }, options?: O): RestResponse<any>;
881
+ /**
882
+ * 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.
883
+ * HTTP GET /asset/datapoint/periods
884
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
885
+ */
886
+ getDatapointPeriod(queryParams?: {
887
+ assetId?: string;
888
+ attributeName?: string;
889
+ }, options?: O): RestResponse<Model.DatapointPeriod>;
890
+ /**
891
+ * 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.
892
+ * HTTP POST /asset/datapoint/{assetId}/{attributeName}
893
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
894
+ */
895
+ getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
837
896
  }
838
897
  export declare class AgentResourceClient<O> {
839
898
  protected httpClient: HttpClient<O>;
@@ -945,276 +1004,217 @@ export declare class NotificationResourceClient<O> {
945
1004
  targetId?: string;
946
1005
  }, options?: O): RestResponse<void>;
947
1006
  }
948
- export declare class SyslogResourceClient<O> {
1007
+ export declare class AppResourceClient<O> {
949
1008
  protected httpClient: HttpClient<O>;
950
1009
  constructor(httpClient: HttpClient<O>);
951
1010
  /**
952
- * Returns the current log-storage and retention configuration.
953
- * HTTP GET /syslog/config
954
- * Java method: org.openremote.model.syslog.SyslogResource.getConfig
1011
+ * Returns the identifiers of applications installed in the Manager web root.
1012
+ * HTTP GET /apps
1013
+ * Java method: org.openremote.model.apps.AppResource.getApps
955
1014
  */
956
- getConfig(options?: O): RestResponse<Model.SyslogConfig>;
1015
+ getApps(options?: O): RestResponse<string[]>;
957
1016
  /**
958
- * Validates and applies log-storage and retention settings.
959
- * HTTP PUT /syslog/config
960
- * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
1017
+ * Loads the public console_config.json document used to configure console clients before sign-in.
1018
+ * HTTP GET /apps/consoleConfig
1019
+ * Java method: org.openremote.model.apps.AppResource.getConsoleConfig
961
1020
  */
962
- updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
1021
+ getConsoleConfig(options?: O): RestResponse<any>;
963
1022
  /**
964
- * Permanently removes all events from the configured syslog storage.
965
- * HTTP DELETE /syslog/event
966
- * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
1023
+ * Loads each installed application's info.json file and returns the documents keyed by application identifier.
1024
+ * HTTP GET /apps/info
1025
+ * Java method: org.openremote.model.apps.AppResource.getAppInfos
967
1026
  */
968
- clearEvents(options?: O): RestResponse<void>;
969
- /**
970
- * 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.
971
- * Response code 200 - The requested page of syslog events
972
- * HTTP GET /syslog/event
973
- * Java method: org.openremote.model.syslog.SyslogResource.getEvents
974
- */
975
- getEvents(queryParams?: {
976
- level?: Model.SyslogLevel;
977
- per_page?: number;
978
- page?: number;
979
- from?: number;
980
- to?: number;
981
- category?: Model.SyslogCategory[];
982
- subCategory?: string[];
983
- }, options?: O): RestResponse<any>;
1027
+ getAppInfos(options?: O): RestResponse<{
1028
+ [index: string]: any;
1029
+ }>;
984
1030
  }
985
- export declare class RealmResourceClient<O> {
1031
+ export declare class AssetResourceClient<O> {
986
1032
  protected httpClient: HttpClient<O>;
987
1033
  constructor(httpClient: HttpClient<O>);
988
1034
  /**
989
- * Creates and configures a realm in the identity provider. This operation is restricted to a super user.
990
- * HTTP POST /realm
991
- * Java method: org.openremote.model.security.RealmResource.create
992
- */
993
- create(realm: Model.Realm, options?: O): RestResponse<void>;
994
- /**
995
- * Returns complete realm records from the identity provider. This operation is restricted to a super user.
996
- * HTTP GET /realm
997
- * Java method: org.openremote.model.security.RealmResource.getAll
998
- */
999
- getAll(options?: O): RestResponse<Model.Realm[]>;
1000
- /**
1001
- * Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
1002
- * HTTP GET /realm/accessible
1003
- * Java method: org.openremote.model.security.RealmResource.getAccessible
1004
- */
1005
- getAccessible(options?: O): RestResponse<Model.Realm[]>;
1006
- /**
1007
- * Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
1008
- * Response code 405 - The master realm cannot be deleted
1009
- * HTTP DELETE /realm/{name}
1010
- * Java method: org.openremote.model.security.RealmResource.delete
1011
- */
1012
- delete(name: string, options?: O): RestResponse<void>;
1013
- /**
1014
- * 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.
1015
- * HTTP GET /realm/{name}
1016
- * Java method: org.openremote.model.security.RealmResource.get
1017
- */
1018
- get(name: string, options?: O): RestResponse<Model.Realm>;
1019
- /**
1020
- * Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
1021
- * Response code 405 - The requested mutation is not allowed for the master realm
1022
- * HTTP PUT /realm/{name}
1023
- * Java method: org.openremote.model.security.RealmResource.update
1035
+ * 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.
1036
+ * HTTP POST /asset
1037
+ * Java method: org.openremote.model.asset.AssetResource.create
1024
1038
  */
1025
- update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
1026
- }
1027
- export declare class FlowResourceClient<O> {
1028
- protected httpClient: HttpClient<O>;
1029
- constructor(httpClient: HttpClient<O>);
1039
+ create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
1030
1040
  /**
1031
- * Returns every supported flow node definition except the internal LOG_OUTPUT node.
1032
- * HTTP GET /flow
1033
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
1041
+ * Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
1042
+ * HTTP DELETE /asset
1043
+ * Java method: org.openremote.model.asset.AssetResource.delete
1034
1044
  */
1035
- getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
1045
+ delete(queryParams?: {
1046
+ assetId?: string[];
1047
+ }, options?: O): RestResponse<void>;
1036
1048
  /**
1037
- * Resolves one flow node definition by its model name.
1038
- * HTTP GET /flow/{name}
1039
- * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
1049
+ * 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.
1050
+ * HTTP PUT /asset/attributes
1051
+ * Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
1040
1052
  */
1041
- getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
1053
+ writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
1042
1054
  /**
1043
- * Returns supported flow node definitions whose category matches the requested node type.
1044
- * HTTP GET /flow/{type}
1045
- * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
1055
+ * 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.
1056
+ * HTTP PUT /asset/attributes/timestamp
1057
+ * Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
1046
1058
  */
1047
- getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
1048
- }
1049
- export declare class ProvisioningResourceClient<O> {
1050
- protected httpClient: HttpClient<O>;
1051
- constructor(httpClient: HttpClient<O>);
1059
+ writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
1052
1060
  /**
1053
- * Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
1054
- * HTTP POST /provisioning
1055
- * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
1061
+ * Returns only the number of assets matching an AssetQuery after applying the caller's realm, public, and linked-asset access constraints.
1062
+ * HTTP POST /asset/count
1063
+ * Java method: org.openremote.model.asset.AssetResource.queryCount
1056
1064
  */
1057
- createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
1065
+ queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
1058
1066
  /**
1059
- * Returns every provisioning configuration. This operation is restricted to a super administrator.
1060
- * HTTP GET /provisioning
1061
- * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
1067
+ * Clears the parent reference of every asset listed in repeated assetIds query parameters.
1068
+ * HTTP DELETE /asset/parent
1069
+ * Java method: org.openremote.model.asset.AssetResource.updateNoneParent
1062
1070
  */
1063
- getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
1071
+ updateNoneParent(queryParams?: {
1072
+ assetIds?: string[];
1073
+ }, options?: O): RestResponse<void>;
1064
1074
  /**
1065
- * Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
1066
- * HTTP DELETE /provisioning/{id}
1067
- * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
1075
+ * Returns the asset identity and properties without loading attributes or path data. The same access rules as getAsset apply.
1076
+ * HTTP GET /asset/partial/{assetId}
1077
+ * Java method: org.openremote.model.asset.AssetResource.getPartial
1068
1078
  */
1069
- deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
1079
+ getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
1070
1080
  /**
1071
- * Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
1072
- * HTTP PUT /provisioning/{id}
1073
- * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
1081
+ * 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.
1082
+ * HTTP POST /asset/query
1083
+ * Java method: org.openremote.model.asset.AssetResource.queryAssets
1074
1084
  */
1075
- updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
1076
- }
1077
- export declare class MapResourceClient<O> {
1078
- protected httpClient: HttpClient<O>;
1079
- constructor(httpClient: HttpClient<O>);
1085
+ queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
1080
1086
  /**
1081
- * Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
1082
- * HTTP GET /map
1083
- * Java method: org.openremote.model.map.MapResource.getSettings
1087
+ * Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
1088
+ * HTTP POST /asset/tree
1089
+ * Java method: org.openremote.model.asset.AssetResource.queryAssetTree
1084
1090
  */
1085
- getSettings(options?: O): RestResponse<{
1086
- [id: string]: unknown;
1087
- }>;
1091
+ queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
1088
1092
  /**
1089
- * Stores the map configuration and returns the resulting public MapLibre settings.
1090
- * HTTP PUT /map
1091
- * Java method: org.openremote.model.map.MapResource.saveSettings
1093
+ * 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.
1094
+ * HTTP GET /asset/user/current
1095
+ * Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
1092
1096
  */
1093
- saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
1094
- [id: string]: unknown;
1095
- }>;
1097
+ getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
1096
1098
  /**
1097
- * Deletes the installed custom MBTiles database and returns the fallback public map settings.
1098
- * HTTP DELETE /map/deleteMap
1099
- * Java method: org.openremote.model.map.MapResource.deleteMap
1099
+ * 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.
1100
+ * HTTP POST /asset/user/link
1101
+ * Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
1100
1102
  */
1101
- deleteMap(options?: O): RestResponse<{
1102
- [id: string]: unknown;
1103
- }>;
1103
+ createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
1104
1104
  /**
1105
- * Reports whether custom MBTiles data is installed and the maximum accepted upload size.
1106
- * HTTP GET /map/getCustomMapInfo
1107
- * Java method: org.openremote.model.map.MapResource.getCustomMapInfo
1105
+ * 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.
1106
+ * HTTP GET /asset/user/link
1107
+ * Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
1108
1108
  */
1109
- getCustomMapInfo(options?: O): RestResponse<{
1110
- [id: string]: unknown;
1111
- }>;
1109
+ getUserAssetLinks(queryParams?: {
1110
+ realm?: string;
1111
+ userId?: string;
1112
+ assetId?: string;
1113
+ }, options?: O): RestResponse<Model.UserAssetLink[]>;
1112
1114
  /**
1113
- * Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
1114
- * Response code 200 - Gzip-compressed vector tile
1115
- * Response code 204 - No tile exists at the requested coordinates
1116
- * HTTP GET /map/tile/{zoom}/{column}/{row}
1117
- * Java method: org.openremote.model.map.MapResource.getTile
1115
+ * Removes all supplied links. Every item must identify the same realm and user.
1116
+ * HTTP POST /asset/user/link/delete
1117
+ * Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
1118
1118
  */
1119
- getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
1119
+ deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
1120
1120
  /**
1121
- * Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
1122
- * HTTP POST /map/upload
1123
- * Java method: org.openremote.model.map.MapResource.uploadMap
1121
+ * Removes every asset link belonging to the user in the requested realm.
1122
+ * HTTP DELETE /asset/user/link/{realm}/{userId}
1123
+ * Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
1124
1124
  */
1125
- uploadMap(queryParams?: {
1126
- filename?: string;
1127
- }, options?: O): RestResponse<{
1128
- [id: string]: unknown;
1129
- }>;
1130
- }
1131
- export declare class DashboardResourceClient<O> {
1132
- protected httpClient: HttpClient<O>;
1133
- constructor(httpClient: HttpClient<O>);
1125
+ deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
1134
1126
  /**
1135
- * Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
1136
- * HTTP POST /dashboard
1137
- * Java method: org.openremote.model.dashboard.DashboardResource.create
1127
+ * Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
1128
+ * HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
1129
+ * Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
1138
1130
  */
1139
- create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
1131
+ deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
1140
1132
  /**
1141
- * Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
1142
- * HTTP PUT /dashboard
1143
- * Java method: org.openremote.model.dashboard.DashboardResource.update
1133
+ * Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
1134
+ * HTTP GET /asset/{assetId}
1135
+ * Java method: org.openremote.model.asset.AssetResource.get
1144
1136
  */
1145
- update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
1137
+ get(assetId: string, options?: O): RestResponse<Model.Asset>;
1146
1138
  /**
1147
- * Returns dashboards visible to the caller in the requested realm. Anonymous callers receive public dashboards only; authenticated access also depends on roles, ownership, and linked assets.
1148
- * HTTP GET /dashboard/all/{realm}
1149
- * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
1139
+ * 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.
1140
+ * HTTP PUT /asset/{assetId}
1141
+ * Java method: org.openremote.model.asset.AssetResource.update
1150
1142
  */
1151
- getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
1143
+ update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
1152
1144
  /**
1153
- * Executes a dashboard query after constraining it to the caller's realm, roles, ownership, and asset access. A missing body uses the request realm and default visibility rules.
1154
- * HTTP POST /dashboard/query
1155
- * Java method: org.openremote.model.dashboard.DashboardResource.query
1145
+ * 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.
1146
+ * Response code 400 - The attribute write failed
1147
+ * Response code 406 - The supplied value is not valid for the attribute
1148
+ * Response code 429 - The attribute event queue is full; retry the write later
1149
+ * HTTP PUT /asset/{assetId}/attribute/{attributeName}
1150
+ * Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
1156
1151
  */
1157
- query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
1152
+ writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
1158
1153
  /**
1159
- * Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
1160
- * HTTP DELETE /dashboard/{realm}/{dashboardId}
1161
- * Java method: org.openremote.model.dashboard.DashboardResource.delete
1154
+ * Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
1155
+ * Response code 400 - The attribute write failed
1156
+ * Response code 406 - The supplied value is not valid for the attribute
1157
+ * Response code 429 - The attribute event queue is full; retry the write later
1158
+ * HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
1159
+ * Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
1162
1160
  */
1163
- delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
1161
+ writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
1164
1162
  /**
1165
- * Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
1166
- * HTTP GET /dashboard/{realm}/{dashboardId}
1167
- * Java method: org.openremote.model.dashboard.DashboardResource.get
1163
+ * Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
1164
+ * HTTP PUT /asset/{parentAssetId}/child
1165
+ * Java method: org.openremote.model.asset.AssetResource.updateParent
1168
1166
  */
1169
- get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
1167
+ updateParent(parentAssetId: string, queryParams?: {
1168
+ assetIds?: string[];
1169
+ }, options?: O): RestResponse<void>;
1170
1170
  }
1171
1171
  export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
1172
1172
  export declare class ApiClient {
1173
+ protected _dashboardResource: AxiosDashboardResourceClient;
1173
1174
  protected _rulesResource: AxiosRulesResourceClient;
1174
- protected _assetResource: AxiosAssetResourceClient;
1175
- protected _statusResource: AxiosStatusResourceClient;
1175
+ protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1176
+ protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
1177
+ protected _externalServiceResource: AxiosExternalServiceResourceClient;
1178
+ protected _assetModelResource: AxiosAssetModelResourceClient;
1179
+ protected _realmResource: AxiosRealmResourceClient;
1176
1180
  protected _alarmResource: AxiosAlarmResourceClient;
1181
+ protected _flowResource: AxiosFlowResourceClient;
1182
+ protected _provisioningResource: AxiosProvisioningResourceClient;
1183
+ protected _mapResource: AxiosMapResourceClient;
1177
1184
  protected _consoleResource: AxiosConsoleResourceClient;
1178
- protected _assetModelResource: AxiosAssetModelResourceClient;
1185
+ protected _syslogResource: AxiosSyslogResourceClient;
1179
1186
  protected _gatewayClientResource: AxiosGatewayClientResourceClient;
1180
- protected _appResource: AxiosAppResourceClient;
1187
+ protected _statusResource: AxiosStatusResourceClient;
1188
+ protected _userResource: AxiosUserResourceClient;
1181
1189
  protected _configurationResource: AxiosConfigurationResourceClient;
1182
- protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
1183
1190
  protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
1184
- protected _externalServiceResource: AxiosExternalServiceResourceClient;
1185
- protected _userResource: AxiosUserResourceClient;
1186
- protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
1187
1191
  protected _agentResource: AxiosAgentResourceClient;
1188
1192
  protected _notificationResource: AxiosNotificationResourceClient;
1189
- protected _syslogResource: AxiosSyslogResourceClient;
1190
- protected _realmResource: AxiosRealmResourceClient;
1191
- protected _flowResource: AxiosFlowResourceClient;
1192
- protected _provisioningResource: AxiosProvisioningResourceClient;
1193
- protected _mapResource: AxiosMapResourceClient;
1194
- protected _dashboardResource: AxiosDashboardResourceClient;
1193
+ protected _appResource: AxiosAppResourceClient;
1194
+ protected _assetResource: AxiosAssetResourceClient;
1195
1195
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1196
+ get DashboardResource(): AxiosDashboardResourceClient;
1196
1197
  get RulesResource(): AxiosRulesResourceClient;
1197
- get AssetResource(): AxiosAssetResourceClient;
1198
- get StatusResource(): AxiosStatusResourceClient;
1198
+ get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1199
+ get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1200
+ get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1201
+ get AssetModelResource(): AxiosAssetModelResourceClient;
1202
+ get RealmResource(): AxiosRealmResourceClient;
1199
1203
  get AlarmResource(): AxiosAlarmResourceClient;
1204
+ get FlowResource(): AxiosFlowResourceClient;
1205
+ get ProvisioningResource(): AxiosProvisioningResourceClient;
1206
+ get MapResource(): AxiosMapResourceClient;
1200
1207
  get ConsoleResource(): AxiosConsoleResourceClient;
1201
- get AssetModelResource(): AxiosAssetModelResourceClient;
1208
+ get SyslogResource(): AxiosSyslogResourceClient;
1202
1209
  get GatewayClientResource(): AxiosGatewayClientResourceClient;
1203
- get AppResource(): AxiosAppResourceClient;
1210
+ get StatusResource(): AxiosStatusResourceClient;
1211
+ get UserResource(): AxiosUserResourceClient;
1204
1212
  get ConfigurationResource(): AxiosConfigurationResourceClient;
1205
- get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
1206
1213
  get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
1207
- get ExternalServiceResource(): AxiosExternalServiceResourceClient;
1208
- get UserResource(): AxiosUserResourceClient;
1209
- get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
1210
1214
  get AgentResource(): AxiosAgentResourceClient;
1211
1215
  get NotificationResource(): AxiosNotificationResourceClient;
1212
- get SyslogResource(): AxiosSyslogResourceClient;
1213
- get RealmResource(): AxiosRealmResourceClient;
1214
- get FlowResource(): AxiosFlowResourceClient;
1215
- get ProvisioningResource(): AxiosProvisioningResourceClient;
1216
- get MapResource(): AxiosMapResourceClient;
1217
- get DashboardResource(): AxiosDashboardResourceClient;
1216
+ get AppResource(): AxiosAppResourceClient;
1217
+ get AssetResource(): AxiosAssetResourceClient;
1218
1218
  }
1219
1219
  import * as Axios from "axios";
1220
1220
  declare module "axios" {
@@ -1222,70 +1222,70 @@ declare module "axios" {
1222
1222
  data: R;
1223
1223
  }
1224
1224
  }
1225
- export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1225
+ export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1226
1226
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1227
1227
  }
1228
- export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1228
+ export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
1229
1229
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1230
1230
  }
1231
- export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1231
+ export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1232
1232
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1233
1233
  }
1234
- export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1234
+ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1235
1235
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1236
1236
  }
1237
- export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1237
+ export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1238
1238
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1239
1239
  }
1240
1240
  export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
1241
1241
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1242
1242
  }
1243
- export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1243
+ export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1244
1244
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1245
1245
  }
1246
- export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1246
+ export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
1247
1247
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1248
1248
  }
1249
- export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1249
+ export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1250
1250
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1251
1251
  }
1252
- export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
1252
+ export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1253
1253
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1254
1254
  }
1255
- export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1255
+ export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1256
1256
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1257
1257
  }
1258
- export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
1258
+ export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
1259
1259
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1260
1260
  }
1261
- export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1261
+ export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1262
1262
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1263
1263
  }
1264
- export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
1264
+ export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
1265
1265
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1266
1266
  }
1267
- export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1267
+ export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
1268
1268
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1269
1269
  }
1270
- export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1270
+ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
1271
1271
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1272
1272
  }
1273
- export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
1273
+ export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
1274
1274
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1275
1275
  }
1276
- export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
1276
+ export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
1277
1277
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1278
1278
  }
1279
- export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
1279
+ export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
1280
1280
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1281
1281
  }
1282
- export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
1282
+ export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
1283
1283
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1284
1284
  }
1285
- export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
1285
+ export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
1286
1286
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1287
1287
  }
1288
- export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
1288
+ export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
1289
1289
  constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
1290
1290
  }
1291
1291
  //# sourceMappingURL=restclient.d.ts.map