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