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