@openremote/rest 1.33.0 → 1.34.0-snapshot.20261027165134

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