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