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