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