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