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