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