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