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