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