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