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