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