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