@openremote/rest 1.12.0-snapshot.20251212165311 → 1.12.0-snapshot.20251215123037
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.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +598 -598
- package/lib/restclient.d.ts.map +1 -1
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +1 -1
package/lib/restclient.d.ts
CHANGED
|
@@ -9,93 +9,56 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class SyslogResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP GET /realm
|
|
22
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
23
|
-
*/
|
|
24
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP GET /realm/accessible
|
|
27
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
16
|
+
* HTTP GET /syslog/config
|
|
17
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
28
18
|
*/
|
|
29
|
-
|
|
19
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
30
20
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /syslog/config
|
|
22
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
33
23
|
*/
|
|
34
|
-
|
|
24
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
35
25
|
/**
|
|
36
|
-
* HTTP
|
|
37
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP DELETE /syslog/event
|
|
27
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
38
28
|
*/
|
|
39
|
-
|
|
29
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
40
30
|
/**
|
|
41
|
-
* HTTP
|
|
42
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP GET /syslog/event
|
|
32
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
43
33
|
*/
|
|
44
|
-
|
|
34
|
+
getEvents(queryParams?: {
|
|
35
|
+
level?: Model.SyslogLevel;
|
|
36
|
+
per_page?: number;
|
|
37
|
+
page?: number;
|
|
38
|
+
from?: number;
|
|
39
|
+
to?: number;
|
|
40
|
+
category?: Model.SyslogCategory[];
|
|
41
|
+
subCategory?: string[];
|
|
42
|
+
}, options?: O): RestResponse<any>;
|
|
45
43
|
}
|
|
46
|
-
export declare class
|
|
44
|
+
export declare class FlowResourceClient<O> {
|
|
47
45
|
protected httpClient: HttpClient<O>;
|
|
48
46
|
constructor(httpClient: HttpClient<O>);
|
|
49
47
|
/**
|
|
50
|
-
* HTTP GET /
|
|
51
|
-
* Java method: org.openremote.model.
|
|
52
|
-
*/
|
|
53
|
-
getNotifications(queryParams?: {
|
|
54
|
-
id?: number;
|
|
55
|
-
type?: string;
|
|
56
|
-
from?: number;
|
|
57
|
-
to?: number;
|
|
58
|
-
realmId?: string;
|
|
59
|
-
userId?: string;
|
|
60
|
-
assetId?: string;
|
|
61
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
62
|
-
/**
|
|
63
|
-
* HTTP DELETE /notification
|
|
64
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
65
|
-
*/
|
|
66
|
-
removeNotifications(queryParams?: {
|
|
67
|
-
id?: number;
|
|
68
|
-
type?: string;
|
|
69
|
-
from?: number;
|
|
70
|
-
to?: number;
|
|
71
|
-
realmId?: string;
|
|
72
|
-
userId?: string;
|
|
73
|
-
assetId?: string;
|
|
74
|
-
}, options?: O): RestResponse<void>;
|
|
75
|
-
/**
|
|
76
|
-
* HTTP POST /notification/alert
|
|
77
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
78
|
-
*/
|
|
79
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
80
|
-
/**
|
|
81
|
-
* HTTP DELETE /notification/{notificationId}
|
|
82
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
48
|
+
* HTTP GET /flow
|
|
49
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
83
50
|
*/
|
|
84
|
-
|
|
51
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
85
52
|
/**
|
|
86
|
-
* HTTP
|
|
87
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* HTTP GET /flow/{name}
|
|
54
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
88
55
|
*/
|
|
89
|
-
|
|
90
|
-
targetId?: string;
|
|
91
|
-
}, options?: O): RestResponse<void>;
|
|
56
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
92
57
|
/**
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
58
|
+
* HTTP GET /flow/{type}
|
|
59
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
95
60
|
*/
|
|
96
|
-
|
|
97
|
-
targetId?: string;
|
|
98
|
-
}, options?: O): RestResponse<void>;
|
|
61
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
99
62
|
}
|
|
100
63
|
export declare class DashboardResourceClient<O> {
|
|
101
64
|
protected httpClient: HttpClient<O>;
|
|
@@ -131,268 +94,139 @@ export declare class DashboardResourceClient<O> {
|
|
|
131
94
|
*/
|
|
132
95
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
133
96
|
}
|
|
134
|
-
export declare class
|
|
97
|
+
export declare class ConfigurationResourceClient<O> {
|
|
135
98
|
protected httpClient: HttpClient<O>;
|
|
136
99
|
constructor(httpClient: HttpClient<O>);
|
|
137
100
|
/**
|
|
138
|
-
* HTTP
|
|
139
|
-
* Java method: org.openremote.model.
|
|
140
|
-
*/
|
|
141
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
142
|
-
/**
|
|
143
|
-
* HTTP DELETE /gateway/tunnel
|
|
144
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
101
|
+
* HTTP GET /configuration/manager
|
|
102
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
145
103
|
*/
|
|
146
|
-
|
|
104
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
147
105
|
/**
|
|
148
|
-
* HTTP
|
|
149
|
-
* Java method: org.openremote.model.
|
|
106
|
+
* HTTP PUT /configuration/manager
|
|
107
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
150
108
|
*/
|
|
151
|
-
|
|
109
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
152
110
|
/**
|
|
153
|
-
* HTTP
|
|
154
|
-
* Java method: org.openremote.model.
|
|
111
|
+
* HTTP POST /configuration/manager/file
|
|
112
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
155
113
|
*/
|
|
156
|
-
|
|
114
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
115
|
+
path?: string;
|
|
116
|
+
}, options?: O): RestResponse<string>;
|
|
157
117
|
/**
|
|
158
|
-
* HTTP GET /
|
|
159
|
-
* Java method: org.openremote.model.
|
|
118
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
119
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
160
120
|
*/
|
|
161
|
-
|
|
121
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
162
122
|
}
|
|
163
|
-
export declare class
|
|
123
|
+
export declare class RulesResourceClient<O> {
|
|
164
124
|
protected httpClient: HttpClient<O>;
|
|
165
125
|
constructor(httpClient: HttpClient<O>);
|
|
166
126
|
/**
|
|
167
|
-
* HTTP
|
|
168
|
-
* Java method: org.openremote.model.
|
|
127
|
+
* HTTP POST /rules
|
|
128
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
169
129
|
*/
|
|
170
|
-
|
|
130
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
171
131
|
/**
|
|
172
|
-
* HTTP GET /
|
|
173
|
-
* Java method: org.openremote.model.
|
|
132
|
+
* HTTP GET /rules
|
|
133
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
174
134
|
*/
|
|
175
|
-
|
|
135
|
+
getGlobalRulesets(queryParams?: {
|
|
136
|
+
language?: Model.RulesetLang[];
|
|
137
|
+
fullyPopulate?: boolean;
|
|
138
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
176
139
|
/**
|
|
177
|
-
* HTTP
|
|
178
|
-
* Java method: org.openremote.model.
|
|
140
|
+
* HTTP POST /rules/asset
|
|
141
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
179
142
|
*/
|
|
180
|
-
|
|
181
|
-
}
|
|
182
|
-
export declare class AlarmResourceClient<O> {
|
|
183
|
-
protected httpClient: HttpClient<O>;
|
|
184
|
-
constructor(httpClient: HttpClient<O>);
|
|
143
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
185
144
|
/**
|
|
186
|
-
* HTTP
|
|
187
|
-
* Java method: org.openremote.model.
|
|
145
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
146
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
188
147
|
*/
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
148
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
149
|
+
language?: Model.RulesetLang[];
|
|
150
|
+
fullyPopulate?: boolean;
|
|
151
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
192
152
|
/**
|
|
193
|
-
* HTTP
|
|
194
|
-
* Java method: org.openremote.model.
|
|
153
|
+
* HTTP DELETE /rules/asset/{id}
|
|
154
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
195
155
|
*/
|
|
196
|
-
|
|
197
|
-
realm?: string;
|
|
198
|
-
status?: Model.AlarmStatus;
|
|
199
|
-
assetId?: string;
|
|
200
|
-
assigneeId?: string;
|
|
201
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
156
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
202
157
|
/**
|
|
203
|
-
* HTTP
|
|
204
|
-
* Java method: org.openremote.model.
|
|
158
|
+
* HTTP GET /rules/asset/{id}
|
|
159
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
205
160
|
*/
|
|
206
|
-
|
|
161
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
207
162
|
/**
|
|
208
|
-
* HTTP PUT /
|
|
209
|
-
* Java method: org.openremote.model.
|
|
163
|
+
* HTTP PUT /rules/asset/{id}
|
|
164
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
210
165
|
*/
|
|
211
|
-
|
|
166
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
212
167
|
/**
|
|
213
|
-
* HTTP GET /
|
|
214
|
-
* Java method: org.openremote.model.
|
|
168
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
169
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
215
170
|
*/
|
|
216
|
-
|
|
171
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
217
172
|
/**
|
|
218
|
-
* HTTP
|
|
219
|
-
* Java method: org.openremote.model.
|
|
173
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
174
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
220
175
|
*/
|
|
221
|
-
|
|
176
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
222
177
|
/**
|
|
223
|
-
* HTTP
|
|
224
|
-
* Java method: org.openremote.model.
|
|
178
|
+
* HTTP GET /rules/info/global
|
|
179
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
225
180
|
*/
|
|
226
|
-
|
|
181
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
227
182
|
/**
|
|
228
|
-
* HTTP GET /
|
|
229
|
-
* Java method: org.openremote.model.
|
|
183
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
184
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
230
185
|
*/
|
|
231
|
-
|
|
232
|
-
realm?: string;
|
|
233
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
234
|
-
}
|
|
235
|
-
export declare class ProvisioningResourceClient<O> {
|
|
236
|
-
protected httpClient: HttpClient<O>;
|
|
237
|
-
constructor(httpClient: HttpClient<O>);
|
|
186
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
238
187
|
/**
|
|
239
|
-
* HTTP POST /
|
|
240
|
-
* Java method: org.openremote.model.
|
|
188
|
+
* HTTP POST /rules/realm
|
|
189
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
241
190
|
*/
|
|
242
|
-
|
|
191
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
243
192
|
/**
|
|
244
|
-
* HTTP GET /
|
|
245
|
-
* Java method: org.openremote.model.
|
|
193
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
194
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
246
195
|
*/
|
|
247
|
-
|
|
196
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
197
|
+
language?: Model.RulesetLang[];
|
|
198
|
+
fullyPopulate?: boolean;
|
|
199
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
248
200
|
/**
|
|
249
|
-
* HTTP DELETE /
|
|
250
|
-
* Java method: org.openremote.model.
|
|
201
|
+
* HTTP DELETE /rules/realm/{id}
|
|
202
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
251
203
|
*/
|
|
252
|
-
|
|
204
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
253
205
|
/**
|
|
254
|
-
* HTTP
|
|
255
|
-
* Java method: org.openremote.model.
|
|
206
|
+
* HTTP GET /rules/realm/{id}
|
|
207
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
256
208
|
*/
|
|
257
|
-
|
|
258
|
-
}
|
|
259
|
-
export declare class UserResourceClient<O> {
|
|
260
|
-
protected httpClient: HttpClient<O>;
|
|
261
|
-
constructor(httpClient: HttpClient<O>);
|
|
209
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
262
210
|
/**
|
|
263
|
-
* HTTP PUT /
|
|
264
|
-
* Java method: org.openremote.model.
|
|
265
|
-
*/
|
|
266
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
267
|
-
/**
|
|
268
|
-
* HTTP POST /user/query
|
|
269
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
270
|
-
*/
|
|
271
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
272
|
-
/**
|
|
273
|
-
* HTTP PUT /user/request-password-reset
|
|
274
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
275
|
-
*/
|
|
276
|
-
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
277
|
-
/**
|
|
278
|
-
* HTTP PUT /user/reset-password
|
|
279
|
-
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
280
|
-
*/
|
|
281
|
-
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
282
|
-
/**
|
|
283
|
-
* HTTP PUT /user/update
|
|
284
|
-
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
285
|
-
*/
|
|
286
|
-
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
287
|
-
/**
|
|
288
|
-
* HTTP GET /user/user
|
|
289
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
290
|
-
*/
|
|
291
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP GET /user/userRealmRoles
|
|
294
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
295
|
-
*/
|
|
296
|
-
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
297
|
-
/**
|
|
298
|
-
* HTTP GET /user/userRoles/{clientId}
|
|
299
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
300
|
-
*/
|
|
301
|
-
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
302
|
-
/**
|
|
303
|
-
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
304
|
-
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
305
|
-
*/
|
|
306
|
-
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
307
|
-
/**
|
|
308
|
-
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
309
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
310
|
-
*/
|
|
311
|
-
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
312
|
-
/**
|
|
313
|
-
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
314
|
-
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
315
|
-
*/
|
|
316
|
-
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
317
|
-
/**
|
|
318
|
-
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
319
|
-
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
320
|
-
*/
|
|
321
|
-
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
322
|
-
/**
|
|
323
|
-
* HTTP PUT /user/{realm}/roles
|
|
324
|
-
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
325
|
-
*/
|
|
326
|
-
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
327
|
-
/**
|
|
328
|
-
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
329
|
-
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
330
|
-
*/
|
|
331
|
-
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
332
|
-
/**
|
|
333
|
-
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
334
|
-
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
335
|
-
*/
|
|
336
|
-
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
337
|
-
/**
|
|
338
|
-
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
339
|
-
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
340
|
-
*/
|
|
341
|
-
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
342
|
-
/**
|
|
343
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
344
|
-
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
345
|
-
*/
|
|
346
|
-
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
347
|
-
/**
|
|
348
|
-
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
349
|
-
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
350
|
-
*/
|
|
351
|
-
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
352
|
-
/**
|
|
353
|
-
* HTTP POST /user/{realm}/users
|
|
354
|
-
* Java method: org.openremote.model.security.UserResource.create
|
|
355
|
-
*/
|
|
356
|
-
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
357
|
-
/**
|
|
358
|
-
* HTTP PUT /user/{realm}/users
|
|
359
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
360
|
-
*/
|
|
361
|
-
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
362
|
-
/**
|
|
363
|
-
* HTTP DELETE /user/{realm}/users/{userId}
|
|
364
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
365
|
-
*/
|
|
366
|
-
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
367
|
-
/**
|
|
368
|
-
* HTTP GET /user/{realm}/{clientId}/roles
|
|
369
|
-
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
370
|
-
*/
|
|
371
|
-
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
372
|
-
/**
|
|
373
|
-
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
374
|
-
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
211
|
+
* HTTP PUT /rules/realm/{id}
|
|
212
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
375
213
|
*/
|
|
376
|
-
|
|
214
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
377
215
|
/**
|
|
378
|
-
* HTTP
|
|
379
|
-
* Java method: org.openremote.model.
|
|
216
|
+
* HTTP DELETE /rules/{id}
|
|
217
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
380
218
|
*/
|
|
381
|
-
|
|
382
|
-
}
|
|
383
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
384
|
-
protected httpClient: HttpClient<O>;
|
|
385
|
-
constructor(httpClient: HttpClient<O>);
|
|
219
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
386
220
|
/**
|
|
387
|
-
* HTTP
|
|
388
|
-
* Java method: org.openremote.model.
|
|
221
|
+
* HTTP GET /rules/{id}
|
|
222
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
389
223
|
*/
|
|
390
|
-
|
|
224
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
391
225
|
/**
|
|
392
|
-
* HTTP PUT /
|
|
393
|
-
* Java method: org.openremote.model.
|
|
226
|
+
* HTTP PUT /rules/{id}
|
|
227
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
394
228
|
*/
|
|
395
|
-
|
|
229
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
396
230
|
}
|
|
397
231
|
export declare class AssetResourceClient<O> {
|
|
398
232
|
protected httpClient: HttpClient<O>;
|
|
@@ -503,93 +337,113 @@ export declare class AssetResourceClient<O> {
|
|
|
503
337
|
assetIds?: string[];
|
|
504
338
|
}, options?: O): RestResponse<void>;
|
|
505
339
|
}
|
|
506
|
-
export declare class
|
|
340
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
507
341
|
protected httpClient: HttpClient<O>;
|
|
508
342
|
constructor(httpClient: HttpClient<O>);
|
|
509
343
|
/**
|
|
510
|
-
*
|
|
511
|
-
*
|
|
344
|
+
* Response code 200 - List of registered external services
|
|
345
|
+
* HTTP GET /service
|
|
346
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
512
347
|
*/
|
|
513
|
-
|
|
348
|
+
getServices(queryParams?: {
|
|
349
|
+
realm?: string;
|
|
350
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
514
351
|
/**
|
|
515
|
-
*
|
|
516
|
-
*
|
|
352
|
+
* Response code 200 - Service registered successfully
|
|
353
|
+
* Response code 400 - Invalid external service object
|
|
354
|
+
* Response code 409 - ExternalService instance already registered
|
|
355
|
+
* HTTP POST /service
|
|
356
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
517
357
|
*/
|
|
518
|
-
|
|
358
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
519
359
|
/**
|
|
520
|
-
*
|
|
521
|
-
*
|
|
360
|
+
* Response code 200 - List of registered external services
|
|
361
|
+
* HTTP GET /service/global
|
|
362
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
522
363
|
*/
|
|
523
|
-
|
|
524
|
-
path?: string;
|
|
525
|
-
}, options?: O): RestResponse<string>;
|
|
364
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
526
365
|
/**
|
|
527
|
-
*
|
|
528
|
-
*
|
|
366
|
+
* Response code 200 - Service registered successfully
|
|
367
|
+
* Response code 400 - Invalid external service object
|
|
368
|
+
* Response code 409 - ExternalService instance already registered
|
|
369
|
+
* HTTP POST /service/global
|
|
370
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
529
371
|
*/
|
|
530
|
-
|
|
531
|
-
}
|
|
532
|
-
export declare class ConsoleResourceClient<O> {
|
|
533
|
-
protected httpClient: HttpClient<O>;
|
|
534
|
-
constructor(httpClient: HttpClient<O>);
|
|
372
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
535
373
|
/**
|
|
536
|
-
*
|
|
537
|
-
*
|
|
374
|
+
* Response code 204 - Service deregistered successfully
|
|
375
|
+
* Response code 404 - Service instance not found
|
|
376
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
377
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
538
378
|
*/
|
|
539
|
-
|
|
379
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
380
|
+
/**
|
|
381
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
382
|
+
* Response code 404 - ExternalService not found
|
|
383
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
384
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
385
|
+
*/
|
|
386
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
387
|
+
/**
|
|
388
|
+
* Response code 204 - Heartbeat sent successfully
|
|
389
|
+
* Response code 404 - Service instance not found
|
|
390
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
391
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
392
|
+
*/
|
|
393
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
540
394
|
}
|
|
541
|
-
export declare class
|
|
395
|
+
export declare class AlarmResourceClient<O> {
|
|
542
396
|
protected httpClient: HttpClient<O>;
|
|
543
397
|
constructor(httpClient: HttpClient<O>);
|
|
544
398
|
/**
|
|
545
|
-
* HTTP
|
|
546
|
-
* Java method: org.openremote.model.
|
|
399
|
+
* HTTP POST /alarm
|
|
400
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
547
401
|
*/
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
402
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
403
|
+
assetIds?: string[];
|
|
404
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
552
405
|
/**
|
|
553
|
-
* HTTP GET /
|
|
554
|
-
* Java method: org.openremote.model.
|
|
406
|
+
* HTTP GET /alarm
|
|
407
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
555
408
|
*/
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
409
|
+
getAlarms(queryParams?: {
|
|
410
|
+
realm?: string;
|
|
411
|
+
status?: Model.AlarmStatus;
|
|
412
|
+
assetId?: string;
|
|
413
|
+
assigneeId?: string;
|
|
414
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
559
415
|
/**
|
|
560
|
-
* HTTP
|
|
561
|
-
* Java method: org.openremote.model.
|
|
416
|
+
* HTTP DELETE /alarm
|
|
417
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
562
418
|
*/
|
|
563
|
-
|
|
564
|
-
parentId?: string;
|
|
565
|
-
parentType?: string;
|
|
566
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
419
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
567
420
|
/**
|
|
568
|
-
* HTTP
|
|
569
|
-
* Java method: org.openremote.model.
|
|
421
|
+
* HTTP PUT /alarm/assets
|
|
422
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
570
423
|
*/
|
|
571
|
-
|
|
572
|
-
name?: string;
|
|
573
|
-
hash?: string;
|
|
574
|
-
}, options?: O): RestResponse<any>;
|
|
424
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
575
425
|
/**
|
|
576
|
-
* HTTP GET /
|
|
577
|
-
* Java method: org.openremote.model.
|
|
426
|
+
* HTTP GET /alarm/{alarmId}
|
|
427
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
578
428
|
*/
|
|
579
|
-
|
|
580
|
-
parentId?: string;
|
|
581
|
-
}, options?: O): RestResponse<{
|
|
582
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
583
|
-
}>;
|
|
429
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
584
430
|
/**
|
|
585
|
-
* HTTP
|
|
586
|
-
* Java method: org.openremote.model.
|
|
431
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
432
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
587
433
|
*/
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
434
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
435
|
+
/**
|
|
436
|
+
* HTTP PUT /alarm/{alarmId}
|
|
437
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
438
|
+
*/
|
|
439
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
440
|
+
/**
|
|
441
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
442
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
443
|
+
*/
|
|
444
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
445
|
+
realm?: string;
|
|
446
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
593
447
|
}
|
|
594
448
|
export declare class GatewayClientResourceClient<O> {
|
|
595
449
|
protected httpClient: HttpClient<O>;
|
|
@@ -627,116 +481,112 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
627
481
|
*/
|
|
628
482
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
629
483
|
}
|
|
630
|
-
export declare class
|
|
484
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
631
485
|
protected httpClient: HttpClient<O>;
|
|
632
486
|
constructor(httpClient: HttpClient<O>);
|
|
633
487
|
/**
|
|
634
|
-
* HTTP
|
|
635
|
-
* Java method: org.openremote.model.
|
|
488
|
+
* HTTP POST /gateway/tunnel
|
|
489
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
636
490
|
*/
|
|
637
|
-
|
|
638
|
-
realm?: string;
|
|
639
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
491
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
640
492
|
/**
|
|
641
|
-
* HTTP
|
|
642
|
-
* Java method: org.openremote.model.
|
|
493
|
+
* HTTP DELETE /gateway/tunnel
|
|
494
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
643
495
|
*/
|
|
644
|
-
|
|
645
|
-
realm?: string;
|
|
646
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
496
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
647
497
|
/**
|
|
648
|
-
* HTTP GET /
|
|
649
|
-
* Java method: org.openremote.model.
|
|
498
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
499
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
650
500
|
*/
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
501
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
502
|
+
/**
|
|
503
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
504
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
505
|
+
*/
|
|
506
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
507
|
+
/**
|
|
508
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
509
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
510
|
+
*/
|
|
511
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
655
512
|
}
|
|
656
|
-
export declare class
|
|
513
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
657
514
|
protected httpClient: HttpClient<O>;
|
|
658
515
|
constructor(httpClient: HttpClient<O>);
|
|
659
516
|
/**
|
|
660
|
-
* HTTP GET /
|
|
661
|
-
* Java method: org.openremote.model.
|
|
517
|
+
* HTTP GET /asset/datapoint/export
|
|
518
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
662
519
|
*/
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
520
|
+
getDatapointExport(queryParams?: {
|
|
521
|
+
attributeRefs?: string;
|
|
522
|
+
fromTimestamp?: number;
|
|
523
|
+
toTimestamp?: number;
|
|
524
|
+
}, options?: O): RestResponse<any>;
|
|
666
525
|
/**
|
|
667
|
-
* HTTP
|
|
668
|
-
* Java method: org.openremote.model.
|
|
526
|
+
* HTTP GET /asset/datapoint/periods
|
|
527
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
669
528
|
*/
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
529
|
+
getDatapointPeriod(queryParams?: {
|
|
530
|
+
assetId?: string;
|
|
531
|
+
attributeName?: string;
|
|
532
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
673
533
|
/**
|
|
674
|
-
* HTTP
|
|
675
|
-
* Java method: org.openremote.model.
|
|
534
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
535
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
676
536
|
*/
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
537
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
538
|
+
}
|
|
539
|
+
export declare class ConsoleResourceClient<O> {
|
|
540
|
+
protected httpClient: HttpClient<O>;
|
|
541
|
+
constructor(httpClient: HttpClient<O>);
|
|
680
542
|
/**
|
|
681
|
-
* HTTP
|
|
682
|
-
* Java method: org.openremote.model.
|
|
543
|
+
* HTTP POST /console/register
|
|
544
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
683
545
|
*/
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
546
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
547
|
+
}
|
|
548
|
+
export declare class ProvisioningResourceClient<O> {
|
|
549
|
+
protected httpClient: HttpClient<O>;
|
|
550
|
+
constructor(httpClient: HttpClient<O>);
|
|
687
551
|
/**
|
|
688
|
-
* HTTP
|
|
689
|
-
* Java method: org.openremote.model.
|
|
552
|
+
* HTTP POST /provisioning
|
|
553
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
690
554
|
*/
|
|
691
|
-
|
|
692
|
-
[id: string]: unknown;
|
|
693
|
-
}>;
|
|
555
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
694
556
|
/**
|
|
695
|
-
* HTTP GET /
|
|
696
|
-
* Java method: org.openremote.model.
|
|
557
|
+
* HTTP GET /provisioning
|
|
558
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
697
559
|
*/
|
|
698
|
-
|
|
560
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
699
561
|
/**
|
|
700
|
-
* HTTP
|
|
701
|
-
* Java method: org.openremote.model.
|
|
562
|
+
* HTTP DELETE /provisioning/{id}
|
|
563
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
702
564
|
*/
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
565
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
566
|
+
/**
|
|
567
|
+
* HTTP PUT /provisioning/{id}
|
|
568
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
569
|
+
*/
|
|
570
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
708
571
|
}
|
|
709
|
-
export declare class
|
|
572
|
+
export declare class AppResourceClient<O> {
|
|
710
573
|
protected httpClient: HttpClient<O>;
|
|
711
574
|
constructor(httpClient: HttpClient<O>);
|
|
712
575
|
/**
|
|
713
|
-
* HTTP GET /
|
|
714
|
-
* Java method: org.openremote.model.
|
|
715
|
-
*/
|
|
716
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
717
|
-
/**
|
|
718
|
-
* HTTP PUT /syslog/config
|
|
719
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
576
|
+
* HTTP GET /apps
|
|
577
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
720
578
|
*/
|
|
721
|
-
|
|
579
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
722
580
|
/**
|
|
723
|
-
* HTTP
|
|
724
|
-
* Java method: org.openremote.model.
|
|
581
|
+
* HTTP GET /apps/consoleConfig
|
|
582
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
725
583
|
*/
|
|
726
|
-
|
|
584
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
727
585
|
/**
|
|
728
|
-
* HTTP GET /
|
|
729
|
-
* Java method: org.openremote.model.
|
|
586
|
+
* HTTP GET /apps/info
|
|
587
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
730
588
|
*/
|
|
731
|
-
|
|
732
|
-
level?: Model.SyslogLevel;
|
|
733
|
-
per_page?: number;
|
|
734
|
-
page?: number;
|
|
735
|
-
from?: number;
|
|
736
|
-
to?: number;
|
|
737
|
-
category?: Model.SyslogCategory[];
|
|
738
|
-
subCategory?: string[];
|
|
739
|
-
}, options?: O): RestResponse<any>;
|
|
589
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
740
590
|
}
|
|
741
591
|
export declare class StatusResourceClient<O> {
|
|
742
592
|
protected httpClient: HttpClient<O>;
|
|
@@ -756,261 +606,411 @@ export declare class StatusResourceClient<O> {
|
|
|
756
606
|
[index: string]: any;
|
|
757
607
|
}>;
|
|
758
608
|
}
|
|
759
|
-
export declare class
|
|
609
|
+
export declare class RealmResourceClient<O> {
|
|
760
610
|
protected httpClient: HttpClient<O>;
|
|
761
611
|
constructor(httpClient: HttpClient<O>);
|
|
762
612
|
/**
|
|
763
|
-
* HTTP
|
|
764
|
-
* Java method: org.openremote.model.
|
|
613
|
+
* HTTP POST /realm
|
|
614
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
765
615
|
*/
|
|
766
|
-
|
|
616
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
767
617
|
/**
|
|
768
|
-
* HTTP GET /
|
|
769
|
-
* Java method: org.openremote.model.
|
|
618
|
+
* HTTP GET /realm
|
|
619
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
770
620
|
*/
|
|
771
|
-
|
|
621
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
772
622
|
/**
|
|
773
|
-
* HTTP GET /
|
|
774
|
-
* Java method: org.openremote.model.
|
|
623
|
+
* HTTP GET /realm/accessible
|
|
624
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
775
625
|
*/
|
|
776
|
-
|
|
626
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
627
|
+
/**
|
|
628
|
+
* HTTP DELETE /realm/{name}
|
|
629
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
630
|
+
*/
|
|
631
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
632
|
+
/**
|
|
633
|
+
* HTTP GET /realm/{name}
|
|
634
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
635
|
+
*/
|
|
636
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
637
|
+
/**
|
|
638
|
+
* HTTP PUT /realm/{name}
|
|
639
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
640
|
+
*/
|
|
641
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
777
642
|
}
|
|
778
|
-
export declare class
|
|
643
|
+
export declare class AgentResourceClient<O> {
|
|
779
644
|
protected httpClient: HttpClient<O>;
|
|
780
645
|
constructor(httpClient: HttpClient<O>);
|
|
781
646
|
/**
|
|
782
|
-
* HTTP GET /
|
|
783
|
-
* Java method: org.openremote.model.
|
|
647
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
648
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
784
649
|
*/
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
toTimestamp?: number;
|
|
789
|
-
}, options?: O): RestResponse<any>;
|
|
650
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
651
|
+
realm?: string;
|
|
652
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
790
653
|
/**
|
|
791
|
-
* HTTP
|
|
792
|
-
* Java method: org.openremote.model.
|
|
654
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
655
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
793
656
|
*/
|
|
794
|
-
|
|
657
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
658
|
+
realm?: string;
|
|
659
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
660
|
+
/**
|
|
661
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
662
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
663
|
+
*/
|
|
664
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
665
|
+
parentId?: string;
|
|
666
|
+
realm?: string;
|
|
667
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
668
|
+
}
|
|
669
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
670
|
+
protected httpClient: HttpClient<O>;
|
|
671
|
+
constructor(httpClient: HttpClient<O>);
|
|
672
|
+
/**
|
|
673
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
674
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
675
|
+
*/
|
|
676
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
677
|
+
/**
|
|
678
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
679
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
680
|
+
*/
|
|
681
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
682
|
+
}
|
|
683
|
+
export declare class NotificationResourceClient<O> {
|
|
684
|
+
protected httpClient: HttpClient<O>;
|
|
685
|
+
constructor(httpClient: HttpClient<O>);
|
|
686
|
+
/**
|
|
687
|
+
* HTTP GET /notification
|
|
688
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
689
|
+
*/
|
|
690
|
+
getNotifications(queryParams?: {
|
|
691
|
+
id?: number;
|
|
692
|
+
type?: string;
|
|
693
|
+
from?: number;
|
|
694
|
+
to?: number;
|
|
695
|
+
realmId?: string;
|
|
696
|
+
userId?: string;
|
|
795
697
|
assetId?: string;
|
|
796
|
-
|
|
797
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
698
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
798
699
|
/**
|
|
799
|
-
* HTTP
|
|
800
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* HTTP DELETE /notification
|
|
701
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
801
702
|
*/
|
|
802
|
-
|
|
703
|
+
removeNotifications(queryParams?: {
|
|
704
|
+
id?: number;
|
|
705
|
+
type?: string;
|
|
706
|
+
from?: number;
|
|
707
|
+
to?: number;
|
|
708
|
+
realmId?: string;
|
|
709
|
+
userId?: string;
|
|
710
|
+
assetId?: string;
|
|
711
|
+
}, options?: O): RestResponse<void>;
|
|
712
|
+
/**
|
|
713
|
+
* HTTP POST /notification/alert
|
|
714
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
715
|
+
*/
|
|
716
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
717
|
+
/**
|
|
718
|
+
* HTTP DELETE /notification/{notificationId}
|
|
719
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
720
|
+
*/
|
|
721
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
722
|
+
/**
|
|
723
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
724
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
725
|
+
*/
|
|
726
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
727
|
+
targetId?: string;
|
|
728
|
+
}, options?: O): RestResponse<void>;
|
|
729
|
+
/**
|
|
730
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
731
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
732
|
+
*/
|
|
733
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
734
|
+
targetId?: string;
|
|
735
|
+
}, options?: O): RestResponse<void>;
|
|
803
736
|
}
|
|
804
|
-
export declare class
|
|
737
|
+
export declare class AssetModelResourceClient<O> {
|
|
805
738
|
protected httpClient: HttpClient<O>;
|
|
806
739
|
constructor(httpClient: HttpClient<O>);
|
|
807
740
|
/**
|
|
808
|
-
* HTTP
|
|
809
|
-
* Java method: org.openremote.model.
|
|
741
|
+
* HTTP GET /model/assetDescriptors
|
|
742
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
810
743
|
*/
|
|
811
|
-
|
|
744
|
+
getAssetDescriptors(queryParams?: {
|
|
745
|
+
parentId?: string;
|
|
746
|
+
parentType?: string;
|
|
747
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
812
748
|
/**
|
|
813
|
-
* HTTP GET /
|
|
814
|
-
* Java method: org.openremote.model.
|
|
749
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
750
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
815
751
|
*/
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
752
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
753
|
+
parentId?: string;
|
|
754
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
820
755
|
/**
|
|
821
|
-
* HTTP
|
|
822
|
-
* Java method: org.openremote.model.
|
|
756
|
+
* HTTP GET /model/assetInfos
|
|
757
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
823
758
|
*/
|
|
824
|
-
|
|
759
|
+
getAssetInfos(queryParams?: {
|
|
760
|
+
parentId?: string;
|
|
761
|
+
parentType?: string;
|
|
762
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
825
763
|
/**
|
|
826
|
-
* HTTP GET /
|
|
827
|
-
* Java method: org.openremote.model.
|
|
764
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
765
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
828
766
|
*/
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
}, options?: O): RestResponse<
|
|
767
|
+
getValueDescriptorSchema(queryParams?: {
|
|
768
|
+
name?: string;
|
|
769
|
+
hash?: string;
|
|
770
|
+
}, options?: O): RestResponse<any>;
|
|
833
771
|
/**
|
|
834
|
-
* HTTP
|
|
835
|
-
* Java method: org.openremote.model.
|
|
772
|
+
* HTTP GET /model/metaItemDescriptors
|
|
773
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
836
774
|
*/
|
|
837
|
-
|
|
775
|
+
getMetaItemDescriptors(queryParams?: {
|
|
776
|
+
parentId?: string;
|
|
777
|
+
}, options?: O): RestResponse<{
|
|
778
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
779
|
+
}>;
|
|
838
780
|
/**
|
|
839
|
-
* HTTP GET /
|
|
840
|
-
* Java method: org.openremote.model.
|
|
781
|
+
* HTTP GET /model/valueDescriptors
|
|
782
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
841
783
|
*/
|
|
842
|
-
|
|
784
|
+
getValueDescriptors(queryParams?: {
|
|
785
|
+
parentId?: string;
|
|
786
|
+
}, options?: O): RestResponse<{
|
|
787
|
+
[index: string]: Model.ValueDescriptor;
|
|
788
|
+
}>;
|
|
789
|
+
}
|
|
790
|
+
export declare class UserResourceClient<O> {
|
|
791
|
+
protected httpClient: HttpClient<O>;
|
|
792
|
+
constructor(httpClient: HttpClient<O>);
|
|
843
793
|
/**
|
|
844
|
-
* HTTP PUT /
|
|
845
|
-
* Java method: org.openremote.model.
|
|
794
|
+
* HTTP PUT /user/locale
|
|
795
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
796
|
+
*/
|
|
797
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
798
|
+
/**
|
|
799
|
+
* HTTP POST /user/query
|
|
800
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
801
|
+
*/
|
|
802
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
803
|
+
/**
|
|
804
|
+
* HTTP PUT /user/request-password-reset
|
|
805
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
806
|
+
*/
|
|
807
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
808
|
+
/**
|
|
809
|
+
* HTTP PUT /user/reset-password
|
|
810
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
811
|
+
*/
|
|
812
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP PUT /user/update
|
|
815
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
816
|
+
*/
|
|
817
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP GET /user/user
|
|
820
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
821
|
+
*/
|
|
822
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
823
|
+
/**
|
|
824
|
+
* HTTP GET /user/userRealmRoles
|
|
825
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
826
|
+
*/
|
|
827
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
828
|
+
/**
|
|
829
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
830
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
831
|
+
*/
|
|
832
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
833
|
+
/**
|
|
834
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
835
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
836
|
+
*/
|
|
837
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
838
|
+
/**
|
|
839
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
840
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
841
|
+
*/
|
|
842
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
843
|
+
/**
|
|
844
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
845
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
846
|
+
*/
|
|
847
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
848
|
+
/**
|
|
849
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
850
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
846
851
|
*/
|
|
847
|
-
|
|
852
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
848
853
|
/**
|
|
849
|
-
* HTTP
|
|
850
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP PUT /user/{realm}/roles
|
|
855
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
851
856
|
*/
|
|
852
|
-
|
|
857
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
853
858
|
/**
|
|
854
|
-
* HTTP GET /
|
|
855
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
860
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
856
861
|
*/
|
|
857
|
-
|
|
862
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
858
863
|
/**
|
|
859
|
-
* HTTP
|
|
860
|
-
* Java method: org.openremote.model.
|
|
864
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
865
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
861
866
|
*/
|
|
862
|
-
|
|
867
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
863
868
|
/**
|
|
864
|
-
* HTTP GET /
|
|
865
|
-
* Java method: org.openremote.model.
|
|
869
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
870
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
866
871
|
*/
|
|
867
|
-
|
|
872
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
868
873
|
/**
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
875
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
871
876
|
*/
|
|
872
|
-
|
|
877
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
873
878
|
/**
|
|
874
|
-
* HTTP GET /
|
|
875
|
-
* Java method: org.openremote.model.
|
|
879
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
880
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
876
881
|
*/
|
|
877
|
-
|
|
878
|
-
language?: Model.RulesetLang[];
|
|
879
|
-
fullyPopulate?: boolean;
|
|
880
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
882
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
881
883
|
/**
|
|
882
|
-
* HTTP
|
|
883
|
-
* Java method: org.openremote.model.
|
|
884
|
+
* HTTP POST /user/{realm}/users
|
|
885
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
884
886
|
*/
|
|
885
|
-
|
|
887
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
886
888
|
/**
|
|
887
|
-
* HTTP
|
|
888
|
-
* Java method: org.openremote.model.
|
|
889
|
+
* HTTP PUT /user/{realm}/users
|
|
890
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
889
891
|
*/
|
|
890
|
-
|
|
892
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
891
893
|
/**
|
|
892
|
-
* HTTP
|
|
893
|
-
* Java method: org.openremote.model.
|
|
894
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
895
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
894
896
|
*/
|
|
895
|
-
|
|
897
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
896
898
|
/**
|
|
897
|
-
* HTTP
|
|
898
|
-
* Java method: org.openremote.model.
|
|
899
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
900
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
899
901
|
*/
|
|
900
|
-
|
|
902
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
901
903
|
/**
|
|
902
|
-
* HTTP
|
|
903
|
-
* Java method: org.openremote.model.
|
|
904
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
905
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
904
906
|
*/
|
|
905
|
-
|
|
907
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
906
908
|
/**
|
|
907
|
-
* HTTP
|
|
908
|
-
* Java method: org.openremote.model.
|
|
909
|
+
* HTTP GET /user/{realm}/{userId}
|
|
910
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
909
911
|
*/
|
|
910
|
-
|
|
912
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
911
913
|
}
|
|
912
|
-
export declare class
|
|
914
|
+
export declare class MapResourceClient<O> {
|
|
913
915
|
protected httpClient: HttpClient<O>;
|
|
914
916
|
constructor(httpClient: HttpClient<O>);
|
|
915
917
|
/**
|
|
916
|
-
*
|
|
917
|
-
*
|
|
918
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
918
|
+
* HTTP GET /map
|
|
919
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
919
920
|
*/
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
}
|
|
921
|
+
getSettings(options?: O): RestResponse<{
|
|
922
|
+
[id: string]: unknown;
|
|
923
|
+
}>;
|
|
923
924
|
/**
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
* Response code 409 - ExternalService instance already registered
|
|
927
|
-
* HTTP POST /service
|
|
928
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
925
|
+
* HTTP PUT /map
|
|
926
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
929
927
|
*/
|
|
930
|
-
|
|
928
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
929
|
+
[id: string]: unknown;
|
|
930
|
+
}>;
|
|
931
931
|
/**
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
932
|
+
* HTTP DELETE /map/deleteMap
|
|
933
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
935
934
|
*/
|
|
936
|
-
|
|
935
|
+
deleteMap(options?: O): RestResponse<{
|
|
936
|
+
[id: string]: unknown;
|
|
937
|
+
}>;
|
|
937
938
|
/**
|
|
938
|
-
*
|
|
939
|
-
*
|
|
940
|
-
* Response code 409 - ExternalService instance already registered
|
|
941
|
-
* HTTP POST /service/global
|
|
942
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
939
|
+
* HTTP GET /map/getCustomMapInfo
|
|
940
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
943
941
|
*/
|
|
944
|
-
|
|
942
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
943
|
+
[id: string]: unknown;
|
|
944
|
+
}>;
|
|
945
945
|
/**
|
|
946
|
-
*
|
|
947
|
-
*
|
|
948
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
949
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
946
|
+
* HTTP GET /map/js
|
|
947
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
950
948
|
*/
|
|
951
|
-
|
|
949
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
950
|
+
[id: string]: unknown;
|
|
951
|
+
}>;
|
|
952
952
|
/**
|
|
953
|
-
*
|
|
954
|
-
*
|
|
955
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
956
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
953
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
954
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
957
955
|
*/
|
|
958
|
-
|
|
956
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
959
957
|
/**
|
|
960
|
-
*
|
|
961
|
-
*
|
|
962
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
963
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
958
|
+
* HTTP POST /map/upload
|
|
959
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
964
960
|
*/
|
|
965
|
-
|
|
961
|
+
uploadMap(queryParams?: {
|
|
962
|
+
filename?: string;
|
|
963
|
+
}, options?: O): RestResponse<{
|
|
964
|
+
[id: string]: unknown;
|
|
965
|
+
}>;
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
-
protected
|
|
970
|
-
protected
|
|
969
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
970
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
971
971
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
972
|
-
protected
|
|
973
|
-
protected
|
|
972
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
973
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
974
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
975
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
974
976
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
977
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
978
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
979
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
980
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
975
981
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
976
|
-
protected
|
|
982
|
+
protected _appResource: AxiosAppResourceClient;
|
|
983
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
984
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
985
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
977
986
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
978
|
-
protected
|
|
979
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
980
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
987
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
981
988
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
982
|
-
protected
|
|
983
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
989
|
+
protected _userResource: AxiosUserResourceClient;
|
|
984
990
|
protected _mapResource: AxiosMapResourceClient;
|
|
985
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
986
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
987
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
988
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
989
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
990
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
-
get
|
|
993
|
-
get
|
|
992
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
993
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
994
994
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
995
|
-
get
|
|
996
|
-
get
|
|
995
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
996
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
997
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
998
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
997
999
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1000
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1001
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1002
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1003
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
998
1004
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
999
|
-
get
|
|
1005
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1006
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1007
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1008
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1000
1009
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1001
|
-
get
|
|
1002
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1003
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1010
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1004
1011
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1005
|
-
get
|
|
1006
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1012
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1007
1013
|
get MapResource(): AxiosMapResourceClient;
|
|
1008
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1009
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1010
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1011
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1012
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1013
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1018,70 +1018,70 @@ declare module "axios" {
|
|
|
1018
1018
|
data: R;
|
|
1019
1019
|
}
|
|
1020
1020
|
}
|
|
1021
|
-
export declare class
|
|
1021
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
1027
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
|
-
export declare class
|
|
1030
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1033
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1035
|
}
|
|
1036
|
-
export declare class
|
|
1036
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1038
|
}
|
|
1039
|
-
export declare class
|
|
1039
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1041
|
}
|
|
1042
|
-
export declare class
|
|
1042
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1044
|
}
|
|
1045
|
-
export declare class
|
|
1045
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1047
|
}
|
|
1048
|
-
export declare class
|
|
1048
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1050
|
}
|
|
1051
|
-
export declare class
|
|
1051
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1053
|
}
|
|
1054
1054
|
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1056
|
}
|
|
1057
|
-
export declare class
|
|
1057
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1059
|
}
|
|
1060
|
-
export declare class
|
|
1060
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1062
|
}
|
|
1063
|
-
export declare class
|
|
1063
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1065
|
}
|
|
1066
|
-
export declare class
|
|
1066
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1068
|
}
|
|
1069
|
-
export declare class
|
|
1069
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1071
|
}
|
|
1072
|
-
export declare class
|
|
1072
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1074
|
}
|
|
1075
|
-
export declare class
|
|
1075
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1077
|
}
|
|
1078
|
-
export declare class
|
|
1078
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1080
|
}
|
|
1081
|
-
export declare class
|
|
1081
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1083
|
}
|
|
1084
|
-
export declare class
|
|
1084
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|
|
1087
1087
|
//# sourceMappingURL=restclient.d.ts.map
|