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