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