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