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