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