@openremote/rest 1.4.0-snapshot.20250310212521 → 1.4.0-snapshot.20250312084137
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.js +1 -1
- package/lib/restclient.d.ts +433 -433
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,29 +9,31 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AgentResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP GET /provisioning
|
|
22
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
16
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
17
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
23
18
|
*/
|
|
24
|
-
|
|
19
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
20
|
+
realm?: string;
|
|
21
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
25
22
|
/**
|
|
26
|
-
* HTTP
|
|
27
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
24
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
28
25
|
*/
|
|
29
|
-
|
|
26
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
27
|
+
realm?: string;
|
|
28
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
30
29
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
30
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
31
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
33
32
|
*/
|
|
34
|
-
|
|
33
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
34
|
+
parentId?: string;
|
|
35
|
+
realm?: string;
|
|
36
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
35
37
|
}
|
|
36
38
|
export declare class AlarmResourceClient<O> {
|
|
37
39
|
protected httpClient: HttpClient<O>;
|
|
@@ -86,230 +88,203 @@ export declare class AlarmResourceClient<O> {
|
|
|
86
88
|
realm?: string;
|
|
87
89
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
88
90
|
}
|
|
89
|
-
export declare class
|
|
91
|
+
export declare class NotificationResourceClient<O> {
|
|
90
92
|
protected httpClient: HttpClient<O>;
|
|
91
93
|
constructor(httpClient: HttpClient<O>);
|
|
92
94
|
/**
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
95
|
-
*/
|
|
96
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
97
|
-
/**
|
|
98
|
-
* HTTP POST /user/query
|
|
99
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
100
|
-
*/
|
|
101
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
102
|
-
/**
|
|
103
|
-
* HTTP GET /user/user
|
|
104
|
-
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
105
|
-
*/
|
|
106
|
-
getCurrent(options?: O): RestResponse<Model.User>;
|
|
107
|
-
/**
|
|
108
|
-
* HTTP GET /user/userRealmRoles
|
|
109
|
-
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
95
|
+
* HTTP GET /notification
|
|
96
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
110
97
|
*/
|
|
111
|
-
|
|
98
|
+
getNotifications(queryParams?: {
|
|
99
|
+
id?: number;
|
|
100
|
+
type?: string;
|
|
101
|
+
from?: number;
|
|
102
|
+
to?: number;
|
|
103
|
+
realmId?: string;
|
|
104
|
+
userId?: string;
|
|
105
|
+
assetId?: string;
|
|
106
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
112
107
|
/**
|
|
113
|
-
* HTTP
|
|
114
|
-
* Java method: org.openremote.model.
|
|
108
|
+
* HTTP DELETE /notification
|
|
109
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
115
110
|
*/
|
|
116
|
-
|
|
111
|
+
removeNotifications(queryParams?: {
|
|
112
|
+
id?: number;
|
|
113
|
+
type?: string;
|
|
114
|
+
from?: number;
|
|
115
|
+
to?: number;
|
|
116
|
+
realmId?: string;
|
|
117
|
+
userId?: string;
|
|
118
|
+
assetId?: string;
|
|
119
|
+
}, options?: O): RestResponse<void>;
|
|
117
120
|
/**
|
|
118
|
-
* HTTP
|
|
119
|
-
* Java method: org.openremote.model.
|
|
121
|
+
* HTTP POST /notification/alert
|
|
122
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
120
123
|
*/
|
|
121
|
-
|
|
124
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
122
125
|
/**
|
|
123
|
-
* HTTP
|
|
124
|
-
* Java method: org.openremote.model.
|
|
126
|
+
* HTTP DELETE /notification/{notificationId}
|
|
127
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
125
128
|
*/
|
|
126
|
-
|
|
129
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
127
130
|
/**
|
|
128
|
-
* HTTP PUT /
|
|
129
|
-
* Java method: org.openremote.model.
|
|
131
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
132
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
130
133
|
*/
|
|
131
|
-
|
|
134
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
135
|
+
targetId?: string;
|
|
136
|
+
}, options?: O): RestResponse<void>;
|
|
132
137
|
/**
|
|
133
|
-
* HTTP
|
|
134
|
-
* Java method: org.openremote.model.
|
|
138
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
139
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
135
140
|
*/
|
|
136
|
-
|
|
141
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
142
|
+
targetId?: string;
|
|
143
|
+
}, options?: O): RestResponse<void>;
|
|
144
|
+
}
|
|
145
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
146
|
+
protected httpClient: HttpClient<O>;
|
|
147
|
+
constructor(httpClient: HttpClient<O>);
|
|
137
148
|
/**
|
|
138
|
-
* HTTP GET /
|
|
139
|
-
* Java method: org.openremote.model.
|
|
149
|
+
* HTTP GET /asset/datapoint/export
|
|
150
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
140
151
|
*/
|
|
141
|
-
|
|
152
|
+
getDatapointExport(queryParams?: {
|
|
153
|
+
attributeRefs?: string;
|
|
154
|
+
fromTimestamp?: number;
|
|
155
|
+
toTimestamp?: number;
|
|
156
|
+
}, options?: O): RestResponse<any>;
|
|
142
157
|
/**
|
|
143
|
-
* HTTP
|
|
144
|
-
* Java method: org.openremote.model.
|
|
158
|
+
* HTTP GET /asset/datapoint/periods
|
|
159
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
145
160
|
*/
|
|
146
|
-
|
|
161
|
+
getDatapointPeriod(queryParams?: {
|
|
162
|
+
assetId?: string;
|
|
163
|
+
attributeName?: string;
|
|
164
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
147
165
|
/**
|
|
148
|
-
* HTTP
|
|
149
|
-
* Java method: org.openremote.model.
|
|
166
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
167
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
150
168
|
*/
|
|
151
|
-
|
|
169
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
170
|
+
}
|
|
171
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
172
|
+
protected httpClient: HttpClient<O>;
|
|
173
|
+
constructor(httpClient: HttpClient<O>);
|
|
152
174
|
/**
|
|
153
|
-
* HTTP
|
|
154
|
-
* Java method: org.openremote.model.
|
|
175
|
+
* HTTP POST /gateway/tunnel
|
|
176
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
155
177
|
*/
|
|
156
|
-
|
|
178
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
157
179
|
/**
|
|
158
|
-
* HTTP
|
|
159
|
-
* Java method: org.openremote.model.
|
|
180
|
+
* HTTP DELETE /gateway/tunnel
|
|
181
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
160
182
|
*/
|
|
161
|
-
|
|
183
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
162
184
|
/**
|
|
163
|
-
* HTTP
|
|
164
|
-
* Java method: org.openremote.model.
|
|
185
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
186
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
165
187
|
*/
|
|
166
|
-
|
|
188
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
167
189
|
/**
|
|
168
|
-
* HTTP GET /
|
|
169
|
-
* Java method: org.openremote.model.
|
|
190
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
191
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
170
192
|
*/
|
|
171
|
-
|
|
193
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
172
194
|
/**
|
|
173
|
-
* HTTP
|
|
174
|
-
* Java method: org.openremote.model.
|
|
195
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
196
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
175
197
|
*/
|
|
176
|
-
|
|
198
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
199
|
+
}
|
|
200
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
201
|
+
protected httpClient: HttpClient<O>;
|
|
202
|
+
constructor(httpClient: HttpClient<O>);
|
|
177
203
|
/**
|
|
178
|
-
* HTTP
|
|
179
|
-
* Java method: org.openremote.model.
|
|
204
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
205
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
180
206
|
*/
|
|
181
|
-
|
|
207
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
182
208
|
/**
|
|
183
|
-
* HTTP
|
|
184
|
-
* Java method: org.openremote.model.
|
|
209
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
210
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
185
211
|
*/
|
|
186
|
-
|
|
212
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
213
|
+
}
|
|
214
|
+
export declare class ConsoleResourceClient<O> {
|
|
215
|
+
protected httpClient: HttpClient<O>;
|
|
216
|
+
constructor(httpClient: HttpClient<O>);
|
|
187
217
|
/**
|
|
188
|
-
* HTTP
|
|
189
|
-
* Java method: org.openremote.model.
|
|
218
|
+
* HTTP POST /console/register
|
|
219
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
190
220
|
*/
|
|
191
|
-
|
|
221
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
222
|
+
}
|
|
223
|
+
export declare class SyslogResourceClient<O> {
|
|
224
|
+
protected httpClient: HttpClient<O>;
|
|
225
|
+
constructor(httpClient: HttpClient<O>);
|
|
192
226
|
/**
|
|
193
|
-
* HTTP
|
|
194
|
-
* Java method: org.openremote.model.
|
|
227
|
+
* HTTP GET /syslog/config
|
|
228
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
195
229
|
*/
|
|
196
|
-
|
|
230
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
197
231
|
/**
|
|
198
|
-
* HTTP
|
|
199
|
-
* Java method: org.openremote.model.
|
|
232
|
+
* HTTP PUT /syslog/config
|
|
233
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
200
234
|
*/
|
|
201
|
-
|
|
235
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
202
236
|
/**
|
|
203
|
-
* HTTP
|
|
204
|
-
* Java method: org.openremote.model.
|
|
237
|
+
* HTTP DELETE /syslog/event
|
|
238
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
205
239
|
*/
|
|
206
|
-
|
|
240
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
207
241
|
/**
|
|
208
|
-
* HTTP GET /
|
|
209
|
-
* Java method: org.openremote.model.
|
|
242
|
+
* HTTP GET /syslog/event
|
|
243
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
210
244
|
*/
|
|
211
|
-
|
|
245
|
+
getEvents(queryParams?: {
|
|
246
|
+
level?: Model.SyslogLevel;
|
|
247
|
+
per_page?: number;
|
|
248
|
+
page?: number;
|
|
249
|
+
from?: number;
|
|
250
|
+
to?: number;
|
|
251
|
+
category?: Model.SyslogCategory[];
|
|
252
|
+
subCategory?: string[];
|
|
253
|
+
}, options?: O): RestResponse<any>;
|
|
212
254
|
}
|
|
213
|
-
export declare class
|
|
255
|
+
export declare class RealmResourceClient<O> {
|
|
214
256
|
protected httpClient: HttpClient<O>;
|
|
215
257
|
constructor(httpClient: HttpClient<O>);
|
|
216
258
|
/**
|
|
217
|
-
* HTTP
|
|
218
|
-
* Java method: org.openremote.model.
|
|
259
|
+
* HTTP POST /realm
|
|
260
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
219
261
|
*/
|
|
220
|
-
|
|
262
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
221
263
|
/**
|
|
222
|
-
* HTTP
|
|
223
|
-
* Java method: org.openremote.model.
|
|
264
|
+
* HTTP GET /realm
|
|
265
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
224
266
|
*/
|
|
225
|
-
|
|
267
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
226
268
|
/**
|
|
227
|
-
* HTTP
|
|
228
|
-
* Java method: org.openremote.model.
|
|
269
|
+
* HTTP GET /realm/accessible
|
|
270
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
229
271
|
*/
|
|
230
|
-
|
|
231
|
-
path?: string;
|
|
232
|
-
}, options?: O): RestResponse<string>;
|
|
272
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
233
273
|
/**
|
|
234
|
-
* HTTP
|
|
235
|
-
* Java method: org.openremote.model.
|
|
274
|
+
* HTTP DELETE /realm/{name}
|
|
275
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
236
276
|
*/
|
|
237
|
-
|
|
238
|
-
}
|
|
239
|
-
export declare class MapResourceClient<O> {
|
|
240
|
-
protected httpClient: HttpClient<O>;
|
|
241
|
-
constructor(httpClient: HttpClient<O>);
|
|
242
|
-
/**
|
|
243
|
-
* HTTP GET /map
|
|
244
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
245
|
-
*/
|
|
246
|
-
getSettings(options?: O): RestResponse<{
|
|
247
|
-
[id: string]: unknown;
|
|
248
|
-
}>;
|
|
249
|
-
/**
|
|
250
|
-
* HTTP PUT /map
|
|
251
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
252
|
-
*/
|
|
253
|
-
saveSettings(mapConfig: {
|
|
254
|
-
[index: string]: Model.MapRealmConfig;
|
|
255
|
-
}, options?: O): RestResponse<any>;
|
|
256
|
-
/**
|
|
257
|
-
* HTTP GET /map/js
|
|
258
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
259
|
-
*/
|
|
260
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
261
|
-
[id: string]: unknown;
|
|
262
|
-
}>;
|
|
263
|
-
/**
|
|
264
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
265
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
266
|
-
*/
|
|
267
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
268
|
-
}
|
|
269
|
-
export declare class AssetModelResourceClient<O> {
|
|
270
|
-
protected httpClient: HttpClient<O>;
|
|
271
|
-
constructor(httpClient: HttpClient<O>);
|
|
272
|
-
/**
|
|
273
|
-
* HTTP GET /model/assetDescriptors
|
|
274
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
275
|
-
*/
|
|
276
|
-
getAssetDescriptors(queryParams?: {
|
|
277
|
-
parentId?: string;
|
|
278
|
-
parentType?: string;
|
|
279
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
280
|
-
/**
|
|
281
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
282
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
283
|
-
*/
|
|
284
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
285
|
-
parentId?: string;
|
|
286
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
287
|
-
/**
|
|
288
|
-
* HTTP GET /model/assetInfos
|
|
289
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
290
|
-
*/
|
|
291
|
-
getAssetInfos(queryParams?: {
|
|
292
|
-
parentId?: string;
|
|
293
|
-
parentType?: string;
|
|
294
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
277
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
295
278
|
/**
|
|
296
|
-
* HTTP GET /
|
|
297
|
-
* Java method: org.openremote.model.
|
|
279
|
+
* HTTP GET /realm/{name}
|
|
280
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
298
281
|
*/
|
|
299
|
-
|
|
300
|
-
parentId?: string;
|
|
301
|
-
}, options?: O): RestResponse<{
|
|
302
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
303
|
-
}>;
|
|
282
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
304
283
|
/**
|
|
305
|
-
* HTTP
|
|
306
|
-
* Java method: org.openremote.model.
|
|
284
|
+
* HTTP PUT /realm/{name}
|
|
285
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
307
286
|
*/
|
|
308
|
-
|
|
309
|
-
parentId?: string;
|
|
310
|
-
}, options?: O): RestResponse<{
|
|
311
|
-
[index: string]: Model.ValueDescriptor;
|
|
312
|
-
}>;
|
|
287
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
313
288
|
}
|
|
314
289
|
export declare class RulesResourceClient<O> {
|
|
315
290
|
protected httpClient: HttpClient<O>;
|
|
@@ -419,268 +394,225 @@ export declare class RulesResourceClient<O> {
|
|
|
419
394
|
*/
|
|
420
395
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
421
396
|
}
|
|
422
|
-
export declare class
|
|
397
|
+
export declare class FlowResourceClient<O> {
|
|
423
398
|
protected httpClient: HttpClient<O>;
|
|
424
399
|
constructor(httpClient: HttpClient<O>);
|
|
425
400
|
/**
|
|
426
|
-
* HTTP
|
|
427
|
-
* Java method: org.openremote.model.
|
|
401
|
+
* HTTP GET /flow
|
|
402
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
428
403
|
*/
|
|
429
|
-
|
|
404
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
430
405
|
/**
|
|
431
|
-
* HTTP
|
|
432
|
-
* Java method: org.openremote.model.
|
|
406
|
+
* HTTP GET /flow/{name}
|
|
407
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
433
408
|
*/
|
|
434
|
-
|
|
409
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
410
|
+
/**
|
|
411
|
+
* HTTP GET /flow/{type}
|
|
412
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
413
|
+
*/
|
|
414
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
435
415
|
}
|
|
436
|
-
export declare class
|
|
416
|
+
export declare class UserResourceClient<O> {
|
|
437
417
|
protected httpClient: HttpClient<O>;
|
|
438
418
|
constructor(httpClient: HttpClient<O>);
|
|
439
419
|
/**
|
|
440
|
-
* HTTP
|
|
441
|
-
* Java method: org.openremote.model.security.
|
|
420
|
+
* HTTP PUT /user/locale
|
|
421
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
442
422
|
*/
|
|
443
|
-
|
|
423
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
444
424
|
/**
|
|
445
|
-
* HTTP
|
|
446
|
-
* Java method: org.openremote.model.security.
|
|
425
|
+
* HTTP POST /user/query
|
|
426
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
447
427
|
*/
|
|
448
|
-
|
|
428
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
449
429
|
/**
|
|
450
|
-
* HTTP GET /
|
|
451
|
-
* Java method: org.openremote.model.security.
|
|
430
|
+
* HTTP GET /user/user
|
|
431
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
452
432
|
*/
|
|
453
|
-
|
|
433
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
454
434
|
/**
|
|
455
|
-
* HTTP
|
|
456
|
-
* Java method: org.openremote.model.security.
|
|
435
|
+
* HTTP GET /user/userRealmRoles
|
|
436
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
457
437
|
*/
|
|
458
|
-
|
|
438
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<Model.Role[]>;
|
|
459
439
|
/**
|
|
460
|
-
* HTTP GET /
|
|
461
|
-
* Java method: org.openremote.model.security.
|
|
440
|
+
* HTTP GET /user/userRoles
|
|
441
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRoles
|
|
462
442
|
*/
|
|
463
|
-
|
|
443
|
+
getCurrentUserRoles(options?: O): RestResponse<Model.Role[]>;
|
|
464
444
|
/**
|
|
465
|
-
* HTTP
|
|
466
|
-
* Java method: org.openremote.model.security.
|
|
445
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
446
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
467
447
|
*/
|
|
468
|
-
|
|
469
|
-
}
|
|
470
|
-
export declare class StatusResourceClient<O> {
|
|
471
|
-
protected httpClient: HttpClient<O>;
|
|
472
|
-
constructor(httpClient: HttpClient<O>);
|
|
448
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
473
449
|
/**
|
|
474
|
-
* HTTP GET /
|
|
475
|
-
* Java method: org.openremote.model.
|
|
450
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
451
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
476
452
|
*/
|
|
477
|
-
|
|
478
|
-
[index: string]: any;
|
|
479
|
-
}>;
|
|
453
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
480
454
|
/**
|
|
481
|
-
* HTTP
|
|
482
|
-
* Java method: org.openremote.model.
|
|
455
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
456
|
+
* Java method: org.openremote.model.security.UserResource.resetPassword
|
|
483
457
|
*/
|
|
484
|
-
|
|
485
|
-
[index: string]: any;
|
|
486
|
-
}>;
|
|
487
|
-
}
|
|
488
|
-
export declare class FlowResourceClient<O> {
|
|
489
|
-
protected httpClient: HttpClient<O>;
|
|
490
|
-
constructor(httpClient: HttpClient<O>);
|
|
458
|
+
resetPassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
491
459
|
/**
|
|
492
|
-
* HTTP GET /
|
|
493
|
-
* Java method: org.openremote.model.
|
|
460
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
461
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
494
462
|
*/
|
|
495
|
-
|
|
463
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
496
464
|
/**
|
|
497
|
-
* HTTP GET /
|
|
498
|
-
* Java method: org.openremote.model.
|
|
465
|
+
* HTTP GET /user/{realm}/roles
|
|
466
|
+
* Java method: org.openremote.model.security.UserResource.getRoles
|
|
499
467
|
*/
|
|
500
|
-
|
|
468
|
+
getRoles(realm: string, options?: O): RestResponse<Model.Role[]>;
|
|
501
469
|
/**
|
|
502
|
-
* HTTP
|
|
503
|
-
* Java method: org.openremote.model.
|
|
470
|
+
* HTTP PUT /user/{realm}/roles
|
|
471
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
504
472
|
*/
|
|
505
|
-
|
|
506
|
-
}
|
|
507
|
-
export declare class DashboardResourceClient<O> {
|
|
508
|
-
protected httpClient: HttpClient<O>;
|
|
509
|
-
constructor(httpClient: HttpClient<O>);
|
|
473
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
510
474
|
/**
|
|
511
|
-
* HTTP
|
|
512
|
-
* Java method: org.openremote.model.
|
|
475
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
476
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
513
477
|
*/
|
|
514
|
-
|
|
478
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
515
479
|
/**
|
|
516
|
-
* HTTP PUT /
|
|
517
|
-
* Java method: org.openremote.model.
|
|
480
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
481
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
518
482
|
*/
|
|
519
|
-
|
|
483
|
+
updateUserRealmRoles(realm: string, userId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
520
484
|
/**
|
|
521
|
-
* HTTP GET /
|
|
522
|
-
* Java method: org.openremote.model.
|
|
485
|
+
* HTTP GET /user/{realm}/userRoles/{userId}
|
|
486
|
+
* Java method: org.openremote.model.security.UserResource.getUserRoles
|
|
523
487
|
*/
|
|
524
|
-
|
|
488
|
+
getUserRoles(realm: string, userId: string, options?: O): RestResponse<Model.Role[]>;
|
|
525
489
|
/**
|
|
526
|
-
* HTTP
|
|
527
|
-
* Java method: org.openremote.model.
|
|
490
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}
|
|
491
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRoles
|
|
528
492
|
*/
|
|
529
|
-
|
|
493
|
+
updateUserRoles(realm: string, userId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
530
494
|
/**
|
|
531
|
-
* HTTP
|
|
532
|
-
* Java method: org.openremote.model.
|
|
495
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
496
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
533
497
|
*/
|
|
534
|
-
|
|
498
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
535
499
|
/**
|
|
536
|
-
* HTTP
|
|
537
|
-
* Java method: org.openremote.model.
|
|
500
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
501
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
538
502
|
*/
|
|
539
|
-
|
|
540
|
-
}
|
|
541
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
542
|
-
protected httpClient: HttpClient<O>;
|
|
543
|
-
constructor(httpClient: HttpClient<O>);
|
|
503
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
544
504
|
/**
|
|
545
|
-
* HTTP GET /
|
|
546
|
-
* Java method: org.openremote.model.
|
|
505
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
506
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
547
507
|
*/
|
|
548
|
-
|
|
549
|
-
attributeRefs?: string;
|
|
550
|
-
fromTimestamp?: number;
|
|
551
|
-
toTimestamp?: number;
|
|
552
|
-
}, options?: O): RestResponse<any>;
|
|
508
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
553
509
|
/**
|
|
554
|
-
* HTTP
|
|
555
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP POST /user/{realm}/users
|
|
511
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
556
512
|
*/
|
|
557
|
-
|
|
558
|
-
assetId?: string;
|
|
559
|
-
attributeName?: string;
|
|
560
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
513
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
561
514
|
/**
|
|
562
|
-
* HTTP
|
|
563
|
-
* Java method: org.openremote.model.
|
|
515
|
+
* HTTP PUT /user/{realm}/users
|
|
516
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
564
517
|
*/
|
|
565
|
-
|
|
566
|
-
}
|
|
567
|
-
export declare class AgentResourceClient<O> {
|
|
568
|
-
protected httpClient: HttpClient<O>;
|
|
569
|
-
constructor(httpClient: HttpClient<O>);
|
|
518
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
570
519
|
/**
|
|
571
|
-
* HTTP
|
|
572
|
-
* Java method: org.openremote.model.
|
|
520
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
521
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
573
522
|
*/
|
|
574
|
-
|
|
575
|
-
realm?: string;
|
|
576
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
523
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
577
524
|
/**
|
|
578
|
-
* HTTP
|
|
579
|
-
* Java method: org.openremote.model.
|
|
525
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
526
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
580
527
|
*/
|
|
581
|
-
|
|
582
|
-
realm?: string;
|
|
583
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
528
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
584
529
|
/**
|
|
585
|
-
* HTTP
|
|
586
|
-
* Java method: org.openremote.model.
|
|
530
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
531
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
587
532
|
*/
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
533
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
534
|
+
/**
|
|
535
|
+
* HTTP GET /user/{realm}/{userId}
|
|
536
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
537
|
+
*/
|
|
538
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
592
539
|
}
|
|
593
|
-
export declare class
|
|
540
|
+
export declare class AppResourceClient<O> {
|
|
594
541
|
protected httpClient: HttpClient<O>;
|
|
595
542
|
constructor(httpClient: HttpClient<O>);
|
|
596
543
|
/**
|
|
597
|
-
* HTTP GET /
|
|
598
|
-
* Java method: org.openremote.model.
|
|
544
|
+
* HTTP GET /apps
|
|
545
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
599
546
|
*/
|
|
600
|
-
|
|
601
|
-
id?: number;
|
|
602
|
-
type?: string;
|
|
603
|
-
from?: number;
|
|
604
|
-
to?: number;
|
|
605
|
-
realmId?: string;
|
|
606
|
-
userId?: string;
|
|
607
|
-
assetId?: string;
|
|
608
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
547
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
609
548
|
/**
|
|
610
|
-
* HTTP
|
|
611
|
-
* Java method: org.openremote.model.
|
|
549
|
+
* HTTP GET /apps/consoleConfig
|
|
550
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
612
551
|
*/
|
|
613
|
-
|
|
614
|
-
id?: number;
|
|
615
|
-
type?: string;
|
|
616
|
-
from?: number;
|
|
617
|
-
to?: number;
|
|
618
|
-
realmId?: string;
|
|
619
|
-
userId?: string;
|
|
620
|
-
assetId?: string;
|
|
621
|
-
}, options?: O): RestResponse<void>;
|
|
552
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
622
553
|
/**
|
|
623
|
-
* HTTP
|
|
624
|
-
* Java method: org.openremote.model.
|
|
554
|
+
* HTTP GET /apps/info
|
|
555
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
625
556
|
*/
|
|
626
|
-
|
|
557
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
558
|
+
}
|
|
559
|
+
export declare class ProvisioningResourceClient<O> {
|
|
560
|
+
protected httpClient: HttpClient<O>;
|
|
561
|
+
constructor(httpClient: HttpClient<O>);
|
|
627
562
|
/**
|
|
628
|
-
* HTTP
|
|
629
|
-
* Java method: org.openremote.model.
|
|
563
|
+
* HTTP POST /provisioning
|
|
564
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
630
565
|
*/
|
|
631
|
-
|
|
566
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
632
567
|
/**
|
|
633
|
-
* HTTP
|
|
634
|
-
* Java method: org.openremote.model.
|
|
568
|
+
* HTTP GET /provisioning
|
|
569
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
635
570
|
*/
|
|
636
|
-
|
|
637
|
-
targetId?: string;
|
|
638
|
-
}, options?: O): RestResponse<void>;
|
|
571
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
639
572
|
/**
|
|
640
|
-
* HTTP
|
|
641
|
-
* Java method: org.openremote.model.
|
|
573
|
+
* HTTP DELETE /provisioning/{id}
|
|
574
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
642
575
|
*/
|
|
643
|
-
|
|
644
|
-
targetId?: string;
|
|
645
|
-
}, options?: O): RestResponse<void>;
|
|
646
|
-
}
|
|
647
|
-
export declare class ConsoleResourceClient<O> {
|
|
648
|
-
protected httpClient: HttpClient<O>;
|
|
649
|
-
constructor(httpClient: HttpClient<O>);
|
|
576
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
650
577
|
/**
|
|
651
|
-
* HTTP
|
|
652
|
-
* Java method: org.openremote.model.
|
|
578
|
+
* HTTP PUT /provisioning/{id}
|
|
579
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
653
580
|
*/
|
|
654
|
-
|
|
581
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
655
582
|
}
|
|
656
|
-
export declare class
|
|
583
|
+
export declare class DashboardResourceClient<O> {
|
|
657
584
|
protected httpClient: HttpClient<O>;
|
|
658
585
|
constructor(httpClient: HttpClient<O>);
|
|
659
586
|
/**
|
|
660
|
-
* HTTP POST /
|
|
661
|
-
* Java method: org.openremote.model.
|
|
587
|
+
* HTTP POST /dashboard
|
|
588
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
662
589
|
*/
|
|
663
|
-
|
|
590
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
664
591
|
/**
|
|
665
|
-
* HTTP
|
|
666
|
-
* Java method: org.openremote.model.
|
|
592
|
+
* HTTP PUT /dashboard
|
|
593
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
667
594
|
*/
|
|
668
|
-
|
|
595
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
669
596
|
/**
|
|
670
|
-
* HTTP GET /
|
|
671
|
-
* Java method: org.openremote.model.
|
|
597
|
+
* HTTP GET /dashboard/all/{realm}
|
|
598
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
672
599
|
*/
|
|
673
|
-
|
|
600
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
674
601
|
/**
|
|
675
|
-
* HTTP
|
|
676
|
-
* Java method: org.openremote.model.
|
|
602
|
+
* HTTP POST /dashboard/query
|
|
603
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
677
604
|
*/
|
|
678
|
-
|
|
605
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
679
606
|
/**
|
|
680
|
-
* HTTP
|
|
681
|
-
* Java method: org.openremote.model.
|
|
607
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
608
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
682
609
|
*/
|
|
683
|
-
|
|
610
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
611
|
+
/**
|
|
612
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
613
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
614
|
+
*/
|
|
615
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
684
616
|
}
|
|
685
617
|
export declare class GatewayClientResourceClient<O> {
|
|
686
618
|
protected httpClient: HttpClient<O>;
|
|
@@ -718,6 +650,54 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
718
650
|
*/
|
|
719
651
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
720
652
|
}
|
|
653
|
+
export declare class MapResourceClient<O> {
|
|
654
|
+
protected httpClient: HttpClient<O>;
|
|
655
|
+
constructor(httpClient: HttpClient<O>);
|
|
656
|
+
/**
|
|
657
|
+
* HTTP GET /map
|
|
658
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
659
|
+
*/
|
|
660
|
+
getSettings(options?: O): RestResponse<{
|
|
661
|
+
[id: string]: unknown;
|
|
662
|
+
}>;
|
|
663
|
+
/**
|
|
664
|
+
* HTTP PUT /map
|
|
665
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
666
|
+
*/
|
|
667
|
+
saveSettings(mapConfig: {
|
|
668
|
+
[index: string]: Model.MapRealmConfig;
|
|
669
|
+
}, options?: O): RestResponse<any>;
|
|
670
|
+
/**
|
|
671
|
+
* HTTP GET /map/js
|
|
672
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
673
|
+
*/
|
|
674
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
675
|
+
[id: string]: unknown;
|
|
676
|
+
}>;
|
|
677
|
+
/**
|
|
678
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
679
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
680
|
+
*/
|
|
681
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
682
|
+
}
|
|
683
|
+
export declare class StatusResourceClient<O> {
|
|
684
|
+
protected httpClient: HttpClient<O>;
|
|
685
|
+
constructor(httpClient: HttpClient<O>);
|
|
686
|
+
/**
|
|
687
|
+
* HTTP GET /health
|
|
688
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
689
|
+
*/
|
|
690
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
691
|
+
[index: string]: any;
|
|
692
|
+
}>;
|
|
693
|
+
/**
|
|
694
|
+
* HTTP GET /info
|
|
695
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
696
|
+
*/
|
|
697
|
+
getInfo(options?: O): RestResponse<{
|
|
698
|
+
[index: string]: any;
|
|
699
|
+
}>;
|
|
700
|
+
}
|
|
721
701
|
export declare class AssetResourceClient<O> {
|
|
722
702
|
protected httpClient: HttpClient<O>;
|
|
723
703
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -822,102 +802,122 @@ export declare class AssetResourceClient<O> {
|
|
|
822
802
|
assetIds?: string[];
|
|
823
803
|
}, options?: O): RestResponse<void>;
|
|
824
804
|
}
|
|
825
|
-
export declare class
|
|
805
|
+
export declare class AssetModelResourceClient<O> {
|
|
826
806
|
protected httpClient: HttpClient<O>;
|
|
827
807
|
constructor(httpClient: HttpClient<O>);
|
|
828
808
|
/**
|
|
829
|
-
* HTTP GET /
|
|
830
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP GET /model/assetDescriptors
|
|
810
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
831
811
|
*/
|
|
832
|
-
|
|
812
|
+
getAssetDescriptors(queryParams?: {
|
|
813
|
+
parentId?: string;
|
|
814
|
+
parentType?: string;
|
|
815
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
833
816
|
/**
|
|
834
|
-
* HTTP GET /
|
|
835
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
818
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
836
819
|
*/
|
|
837
|
-
|
|
820
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
821
|
+
parentId?: string;
|
|
822
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
838
823
|
/**
|
|
839
|
-
* HTTP GET /
|
|
840
|
-
* Java method: org.openremote.model.
|
|
824
|
+
* HTTP GET /model/assetInfos
|
|
825
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
841
826
|
*/
|
|
842
|
-
|
|
827
|
+
getAssetInfos(queryParams?: {
|
|
828
|
+
parentId?: string;
|
|
829
|
+
parentType?: string;
|
|
830
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
831
|
+
/**
|
|
832
|
+
* HTTP GET /model/metaItemDescriptors
|
|
833
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
834
|
+
*/
|
|
835
|
+
getMetaItemDescriptors(queryParams?: {
|
|
836
|
+
parentId?: string;
|
|
837
|
+
}, options?: O): RestResponse<{
|
|
838
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
839
|
+
}>;
|
|
840
|
+
/**
|
|
841
|
+
* HTTP GET /model/valueDescriptors
|
|
842
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
843
|
+
*/
|
|
844
|
+
getValueDescriptors(queryParams?: {
|
|
845
|
+
parentId?: string;
|
|
846
|
+
}, options?: O): RestResponse<{
|
|
847
|
+
[index: string]: Model.ValueDescriptor;
|
|
848
|
+
}>;
|
|
843
849
|
}
|
|
844
|
-
export declare class
|
|
850
|
+
export declare class ConfigurationResourceClient<O> {
|
|
845
851
|
protected httpClient: HttpClient<O>;
|
|
846
852
|
constructor(httpClient: HttpClient<O>);
|
|
847
853
|
/**
|
|
848
|
-
* HTTP GET /
|
|
849
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP GET /configuration/manager
|
|
855
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
850
856
|
*/
|
|
851
|
-
|
|
857
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
852
858
|
/**
|
|
853
|
-
* HTTP PUT /
|
|
854
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP PUT /configuration/manager
|
|
860
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
855
861
|
*/
|
|
856
|
-
|
|
862
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
857
863
|
/**
|
|
858
|
-
* HTTP
|
|
859
|
-
* Java method: org.openremote.model.
|
|
864
|
+
* HTTP POST /configuration/manager/file
|
|
865
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
860
866
|
*/
|
|
861
|
-
|
|
867
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
868
|
+
path?: string;
|
|
869
|
+
}, options?: O): RestResponse<string>;
|
|
862
870
|
/**
|
|
863
|
-
* HTTP GET /
|
|
864
|
-
* Java method: org.openremote.model.
|
|
871
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
872
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
865
873
|
*/
|
|
866
|
-
|
|
867
|
-
level?: Model.SyslogLevel;
|
|
868
|
-
per_page?: number;
|
|
869
|
-
page?: number;
|
|
870
|
-
from?: number;
|
|
871
|
-
to?: number;
|
|
872
|
-
category?: Model.SyslogCategory[];
|
|
873
|
-
subCategory?: string[];
|
|
874
|
-
}, options?: O): RestResponse<any>;
|
|
874
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
878
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
879
879
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
880
|
-
protected
|
|
881
|
-
protected
|
|
882
|
-
protected
|
|
883
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
884
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
880
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
881
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
882
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
885
883
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
884
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
885
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
886
886
|
protected _realmResource: AxiosRealmResourceClient;
|
|
887
|
-
protected
|
|
887
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
888
888
|
protected _flowResource: AxiosFlowResourceClient;
|
|
889
|
+
protected _userResource: AxiosUserResourceClient;
|
|
890
|
+
protected _appResource: AxiosAppResourceClient;
|
|
891
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
889
892
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
890
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
891
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
892
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
893
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
894
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
895
893
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
894
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
895
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
896
896
|
protected _assetResource: AxiosAssetResourceClient;
|
|
897
|
-
protected
|
|
898
|
-
protected
|
|
897
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
898
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
900
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
901
901
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
902
|
-
get
|
|
903
|
-
get
|
|
904
|
-
get
|
|
905
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
906
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
902
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
903
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
904
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
907
905
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
906
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
907
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
908
908
|
get RealmResource(): AxiosRealmResourceClient;
|
|
909
|
-
get
|
|
909
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
910
910
|
get FlowResource(): AxiosFlowResourceClient;
|
|
911
|
+
get UserResource(): AxiosUserResourceClient;
|
|
912
|
+
get AppResource(): AxiosAppResourceClient;
|
|
913
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
911
914
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
912
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
913
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
914
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
915
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
916
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
917
915
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
916
|
+
get MapResource(): AxiosMapResourceClient;
|
|
917
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
918
918
|
get AssetResource(): AxiosAssetResourceClient;
|
|
919
|
-
get
|
|
920
|
-
get
|
|
919
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
920
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
931
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
952
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
958
|
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
982
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|