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