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