@openremote/rest 1.8.0-snapshot.20250820125434 → 1.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +471 -471
- 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,25 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class AppResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /apps
|
|
17
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
18
|
-
*/
|
|
19
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP GET /apps/consoleConfig
|
|
22
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
23
|
-
*/
|
|
24
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP GET /apps/info
|
|
27
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
28
|
-
*/
|
|
29
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
30
|
-
}
|
|
31
12
|
export declare class UserResourceClient<O> {
|
|
32
13
|
protected httpClient: HttpClient<O>;
|
|
33
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -152,241 +133,248 @@ export declare class UserResourceClient<O> {
|
|
|
152
133
|
*/
|
|
153
134
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
154
135
|
}
|
|
155
|
-
export declare class
|
|
136
|
+
export declare class SyslogResourceClient<O> {
|
|
156
137
|
protected httpClient: HttpClient<O>;
|
|
157
138
|
constructor(httpClient: HttpClient<O>);
|
|
158
139
|
/**
|
|
159
|
-
* HTTP
|
|
160
|
-
* Java method: org.openremote.model.
|
|
161
|
-
*/
|
|
162
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
163
|
-
/**
|
|
164
|
-
* HTTP DELETE /gateway/tunnel
|
|
165
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
140
|
+
* HTTP GET /syslog/config
|
|
141
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
166
142
|
*/
|
|
167
|
-
|
|
143
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
168
144
|
/**
|
|
169
|
-
* HTTP
|
|
170
|
-
* Java method: org.openremote.model.
|
|
145
|
+
* HTTP PUT /syslog/config
|
|
146
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
171
147
|
*/
|
|
172
|
-
|
|
148
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
173
149
|
/**
|
|
174
|
-
* HTTP
|
|
175
|
-
* Java method: org.openremote.model.
|
|
150
|
+
* HTTP DELETE /syslog/event
|
|
151
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
176
152
|
*/
|
|
177
|
-
|
|
153
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
178
154
|
/**
|
|
179
|
-
* HTTP GET /
|
|
180
|
-
* Java method: org.openremote.model.
|
|
155
|
+
* HTTP GET /syslog/event
|
|
156
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
181
157
|
*/
|
|
182
|
-
|
|
158
|
+
getEvents(queryParams?: {
|
|
159
|
+
level?: Model.SyslogLevel;
|
|
160
|
+
per_page?: number;
|
|
161
|
+
page?: number;
|
|
162
|
+
from?: number;
|
|
163
|
+
to?: number;
|
|
164
|
+
category?: Model.SyslogCategory[];
|
|
165
|
+
subCategory?: string[];
|
|
166
|
+
}, options?: O): RestResponse<any>;
|
|
183
167
|
}
|
|
184
|
-
export declare class
|
|
168
|
+
export declare class AgentResourceClient<O> {
|
|
185
169
|
protected httpClient: HttpClient<O>;
|
|
186
170
|
constructor(httpClient: HttpClient<O>);
|
|
187
171
|
/**
|
|
188
|
-
* HTTP
|
|
189
|
-
* Java method: org.openremote.model.
|
|
172
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
173
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
190
174
|
*/
|
|
191
|
-
|
|
175
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
176
|
+
realm?: string;
|
|
177
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
192
178
|
/**
|
|
193
|
-
* HTTP
|
|
194
|
-
* Java method: org.openremote.model.
|
|
179
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
180
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
195
181
|
*/
|
|
196
|
-
|
|
182
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
183
|
+
realm?: string;
|
|
184
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
197
185
|
/**
|
|
198
|
-
* HTTP GET /
|
|
199
|
-
* Java method: org.openremote.model.
|
|
186
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
187
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
200
188
|
*/
|
|
201
|
-
|
|
189
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
190
|
+
parentId?: string;
|
|
191
|
+
realm?: string;
|
|
192
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
193
|
+
}
|
|
194
|
+
export declare class StatusResourceClient<O> {
|
|
195
|
+
protected httpClient: HttpClient<O>;
|
|
196
|
+
constructor(httpClient: HttpClient<O>);
|
|
202
197
|
/**
|
|
203
|
-
* HTTP
|
|
204
|
-
* Java method: org.openremote.model.
|
|
198
|
+
* HTTP GET /health
|
|
199
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
205
200
|
*/
|
|
206
|
-
|
|
201
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
202
|
+
[index: string]: any;
|
|
203
|
+
}>;
|
|
207
204
|
/**
|
|
208
|
-
* HTTP GET /
|
|
209
|
-
* Java method: org.openremote.model.
|
|
205
|
+
* HTTP GET /info
|
|
206
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
210
207
|
*/
|
|
211
|
-
|
|
208
|
+
getInfo(options?: O): RestResponse<{
|
|
209
|
+
[index: string]: any;
|
|
210
|
+
}>;
|
|
211
|
+
}
|
|
212
|
+
export declare class ConsoleResourceClient<O> {
|
|
213
|
+
protected httpClient: HttpClient<O>;
|
|
214
|
+
constructor(httpClient: HttpClient<O>);
|
|
212
215
|
/**
|
|
213
|
-
* HTTP
|
|
214
|
-
* Java method: org.openremote.model.
|
|
216
|
+
* HTTP POST /console/register
|
|
217
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
215
218
|
*/
|
|
216
|
-
|
|
219
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
217
220
|
}
|
|
218
|
-
export declare class
|
|
221
|
+
export declare class DashboardResourceClient<O> {
|
|
219
222
|
protected httpClient: HttpClient<O>;
|
|
220
223
|
constructor(httpClient: HttpClient<O>);
|
|
221
224
|
/**
|
|
222
|
-
* HTTP
|
|
223
|
-
* Java method: org.openremote.model.
|
|
225
|
+
* HTTP POST /dashboard
|
|
226
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
224
227
|
*/
|
|
225
|
-
|
|
226
|
-
id?: number;
|
|
227
|
-
type?: string;
|
|
228
|
-
from?: number;
|
|
229
|
-
to?: number;
|
|
230
|
-
realmId?: string;
|
|
231
|
-
userId?: string;
|
|
232
|
-
assetId?: string;
|
|
233
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
228
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
234
229
|
/**
|
|
235
|
-
* HTTP
|
|
236
|
-
* Java method: org.openremote.model.
|
|
230
|
+
* HTTP PUT /dashboard
|
|
231
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
237
232
|
*/
|
|
238
|
-
|
|
239
|
-
id?: number;
|
|
240
|
-
type?: string;
|
|
241
|
-
from?: number;
|
|
242
|
-
to?: number;
|
|
243
|
-
realmId?: string;
|
|
244
|
-
userId?: string;
|
|
245
|
-
assetId?: string;
|
|
246
|
-
}, options?: O): RestResponse<void>;
|
|
233
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
247
234
|
/**
|
|
248
|
-
* HTTP
|
|
249
|
-
* Java method: org.openremote.model.
|
|
235
|
+
* HTTP GET /dashboard/all/{realm}
|
|
236
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
250
237
|
*/
|
|
251
|
-
|
|
238
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
252
239
|
/**
|
|
253
|
-
* HTTP
|
|
254
|
-
* Java method: org.openremote.model.
|
|
240
|
+
* HTTP POST /dashboard/query
|
|
241
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
255
242
|
*/
|
|
256
|
-
|
|
243
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
257
244
|
/**
|
|
258
|
-
* HTTP
|
|
259
|
-
* Java method: org.openremote.model.
|
|
245
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
246
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
260
247
|
*/
|
|
261
|
-
|
|
262
|
-
targetId?: string;
|
|
263
|
-
}, options?: O): RestResponse<void>;
|
|
248
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
264
249
|
/**
|
|
265
|
-
* HTTP
|
|
266
|
-
* Java method: org.openremote.model.
|
|
250
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
251
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
267
252
|
*/
|
|
268
|
-
|
|
269
|
-
targetId?: string;
|
|
270
|
-
}, options?: O): RestResponse<void>;
|
|
253
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
271
254
|
}
|
|
272
|
-
export declare class
|
|
255
|
+
export declare class ConfigurationResourceClient<O> {
|
|
273
256
|
protected httpClient: HttpClient<O>;
|
|
274
257
|
constructor(httpClient: HttpClient<O>);
|
|
275
258
|
/**
|
|
276
|
-
* HTTP GET /
|
|
277
|
-
* Java method: org.openremote.model.
|
|
259
|
+
* HTTP GET /configuration/manager
|
|
260
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
278
261
|
*/
|
|
279
|
-
|
|
280
|
-
attributeRefs?: string;
|
|
281
|
-
fromTimestamp?: number;
|
|
282
|
-
toTimestamp?: number;
|
|
283
|
-
}, options?: O): RestResponse<any>;
|
|
262
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
284
263
|
/**
|
|
285
|
-
* HTTP
|
|
286
|
-
* Java method: org.openremote.model.
|
|
264
|
+
* HTTP PUT /configuration/manager
|
|
265
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
287
266
|
*/
|
|
288
|
-
|
|
289
|
-
assetId?: string;
|
|
290
|
-
attributeName?: string;
|
|
291
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
267
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
292
268
|
/**
|
|
293
|
-
* HTTP POST /
|
|
294
|
-
* Java method: org.openremote.model.
|
|
269
|
+
* HTTP POST /configuration/manager/file
|
|
270
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
295
271
|
*/
|
|
296
|
-
|
|
272
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
273
|
+
path?: string;
|
|
274
|
+
}, options?: O): RestResponse<string>;
|
|
275
|
+
/**
|
|
276
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
277
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
278
|
+
*/
|
|
279
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
297
280
|
}
|
|
298
|
-
export declare class
|
|
281
|
+
export declare class AssetModelResourceClient<O> {
|
|
299
282
|
protected httpClient: HttpClient<O>;
|
|
300
283
|
constructor(httpClient: HttpClient<O>);
|
|
301
284
|
/**
|
|
302
|
-
* HTTP GET /
|
|
303
|
-
* Java method: org.openremote.model.
|
|
285
|
+
* HTTP GET /model/assetDescriptors
|
|
286
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
304
287
|
*/
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
288
|
+
getAssetDescriptors(queryParams?: {
|
|
289
|
+
parentId?: string;
|
|
290
|
+
parentType?: string;
|
|
291
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
308
292
|
/**
|
|
309
|
-
* HTTP
|
|
310
|
-
* Java method: org.openremote.model.
|
|
293
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
294
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
311
295
|
*/
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
}>;
|
|
296
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
297
|
+
parentId?: string;
|
|
298
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
315
299
|
/**
|
|
316
|
-
* HTTP
|
|
317
|
-
* Java method: org.openremote.model.
|
|
300
|
+
* HTTP GET /model/assetInfos
|
|
301
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
318
302
|
*/
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
303
|
+
getAssetInfos(queryParams?: {
|
|
304
|
+
parentId?: string;
|
|
305
|
+
parentType?: string;
|
|
306
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
322
307
|
/**
|
|
323
|
-
* HTTP GET /
|
|
324
|
-
* Java method: org.openremote.model.
|
|
308
|
+
* HTTP GET /model/metaItemDescriptors
|
|
309
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
325
310
|
*/
|
|
326
|
-
|
|
327
|
-
|
|
311
|
+
getMetaItemDescriptors(queryParams?: {
|
|
312
|
+
parentId?: string;
|
|
313
|
+
}, options?: O): RestResponse<{
|
|
314
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
328
315
|
}>;
|
|
329
316
|
/**
|
|
330
|
-
* HTTP GET /
|
|
331
|
-
* Java method: org.openremote.model.
|
|
317
|
+
* HTTP GET /model/valueDescriptors
|
|
318
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
332
319
|
*/
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
}>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
338
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
339
|
-
*/
|
|
340
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
341
|
-
/**
|
|
342
|
-
* HTTP POST /map/upload
|
|
343
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
344
|
-
*/
|
|
345
|
-
uploadMap(queryParams?: {
|
|
346
|
-
filename?: string;
|
|
320
|
+
getValueDescriptors(queryParams?: {
|
|
321
|
+
parentId?: string;
|
|
347
322
|
}, options?: O): RestResponse<{
|
|
348
|
-
[
|
|
323
|
+
[index: string]: Model.ValueDescriptor;
|
|
349
324
|
}>;
|
|
350
325
|
}
|
|
351
|
-
export declare class
|
|
326
|
+
export declare class AlarmResourceClient<O> {
|
|
352
327
|
protected httpClient: HttpClient<O>;
|
|
353
328
|
constructor(httpClient: HttpClient<O>);
|
|
354
329
|
/**
|
|
355
|
-
* HTTP POST /
|
|
356
|
-
* Java method: org.openremote.model.
|
|
330
|
+
* HTTP POST /alarm
|
|
331
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
357
332
|
*/
|
|
358
|
-
|
|
333
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
334
|
+
assetIds?: string[];
|
|
335
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
359
336
|
/**
|
|
360
|
-
* HTTP
|
|
361
|
-
* Java method: org.openremote.model.
|
|
337
|
+
* HTTP GET /alarm
|
|
338
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
362
339
|
*/
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
340
|
+
getAlarms(queryParams?: {
|
|
341
|
+
realm?: string;
|
|
342
|
+
status?: Model.AlarmStatus;
|
|
343
|
+
assetId?: string;
|
|
344
|
+
assigneeId?: string;
|
|
345
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
368
346
|
/**
|
|
369
|
-
* HTTP
|
|
370
|
-
* Java method: org.openremote.model.
|
|
347
|
+
* HTTP DELETE /alarm
|
|
348
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
371
349
|
*/
|
|
372
|
-
|
|
373
|
-
realm?: string;
|
|
374
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
350
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
375
351
|
/**
|
|
376
|
-
* HTTP
|
|
377
|
-
* Java method: org.openremote.model.
|
|
352
|
+
* HTTP PUT /alarm/assets
|
|
353
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
378
354
|
*/
|
|
379
|
-
|
|
380
|
-
realm?: string;
|
|
381
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
355
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
382
356
|
/**
|
|
383
|
-
* HTTP GET /
|
|
384
|
-
* Java method: org.openremote.model.
|
|
357
|
+
* HTTP GET /alarm/{alarmId}
|
|
358
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
385
359
|
*/
|
|
386
|
-
|
|
387
|
-
|
|
360
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
361
|
+
/**
|
|
362
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
363
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
364
|
+
*/
|
|
365
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
366
|
+
/**
|
|
367
|
+
* HTTP PUT /alarm/{alarmId}
|
|
368
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
369
|
+
*/
|
|
370
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
371
|
+
/**
|
|
372
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
373
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
374
|
+
*/
|
|
375
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
388
376
|
realm?: string;
|
|
389
|
-
}, options?: O): RestResponse<Model.
|
|
377
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
390
378
|
}
|
|
391
379
|
export declare class FlowResourceClient<O> {
|
|
392
380
|
protected httpClient: HttpClient<O>;
|
|
@@ -407,6 +395,32 @@ export declare class FlowResourceClient<O> {
|
|
|
407
395
|
*/
|
|
408
396
|
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
409
397
|
}
|
|
398
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
399
|
+
protected httpClient: HttpClient<O>;
|
|
400
|
+
constructor(httpClient: HttpClient<O>);
|
|
401
|
+
/**
|
|
402
|
+
* HTTP GET /asset/datapoint/export
|
|
403
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
404
|
+
*/
|
|
405
|
+
getDatapointExport(queryParams?: {
|
|
406
|
+
attributeRefs?: string;
|
|
407
|
+
fromTimestamp?: number;
|
|
408
|
+
toTimestamp?: number;
|
|
409
|
+
}, options?: O): RestResponse<any>;
|
|
410
|
+
/**
|
|
411
|
+
* HTTP GET /asset/datapoint/periods
|
|
412
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
413
|
+
*/
|
|
414
|
+
getDatapointPeriod(queryParams?: {
|
|
415
|
+
assetId?: string;
|
|
416
|
+
attributeName?: string;
|
|
417
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
418
|
+
/**
|
|
419
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
420
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
421
|
+
*/
|
|
422
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
423
|
+
}
|
|
410
424
|
export declare class AssetResourceClient<O> {
|
|
411
425
|
protected httpClient: HttpClient<O>;
|
|
412
426
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -511,129 +525,282 @@ export declare class AssetResourceClient<O> {
|
|
|
511
525
|
assetIds?: string[];
|
|
512
526
|
}, options?: O): RestResponse<void>;
|
|
513
527
|
}
|
|
514
|
-
export declare class
|
|
528
|
+
export declare class ProvisioningResourceClient<O> {
|
|
515
529
|
protected httpClient: HttpClient<O>;
|
|
516
530
|
constructor(httpClient: HttpClient<O>);
|
|
517
531
|
/**
|
|
518
|
-
* HTTP
|
|
519
|
-
* Java method: org.openremote.model.
|
|
532
|
+
* HTTP POST /provisioning
|
|
533
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
520
534
|
*/
|
|
521
|
-
|
|
535
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
522
536
|
/**
|
|
523
|
-
* HTTP
|
|
524
|
-
* Java method: org.openremote.model.
|
|
537
|
+
* HTTP GET /provisioning
|
|
538
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
525
539
|
*/
|
|
526
|
-
|
|
540
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
527
541
|
/**
|
|
528
|
-
* HTTP DELETE /
|
|
529
|
-
* Java method: org.openremote.model.
|
|
542
|
+
* HTTP DELETE /provisioning/{id}
|
|
543
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
530
544
|
*/
|
|
531
|
-
|
|
545
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
532
546
|
/**
|
|
533
|
-
* HTTP
|
|
534
|
-
* Java method: org.openremote.model.
|
|
547
|
+
* HTTP PUT /provisioning/{id}
|
|
548
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
535
549
|
*/
|
|
536
|
-
|
|
537
|
-
level?: Model.SyslogLevel;
|
|
538
|
-
per_page?: number;
|
|
539
|
-
page?: number;
|
|
540
|
-
from?: number;
|
|
541
|
-
to?: number;
|
|
542
|
-
category?: Model.SyslogCategory[];
|
|
543
|
-
subCategory?: string[];
|
|
544
|
-
}, options?: O): RestResponse<any>;
|
|
550
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
545
551
|
}
|
|
546
|
-
export declare class
|
|
552
|
+
export declare class MapResourceClient<O> {
|
|
547
553
|
protected httpClient: HttpClient<O>;
|
|
548
554
|
constructor(httpClient: HttpClient<O>);
|
|
549
555
|
/**
|
|
550
|
-
* HTTP
|
|
551
|
-
* Java method: org.openremote.model.
|
|
552
|
-
*/
|
|
553
|
-
deleteConnections(queryParams?: {
|
|
554
|
-
realm?: string[];
|
|
555
|
-
}, options?: O): RestResponse<void>;
|
|
556
|
-
/**
|
|
557
|
-
* HTTP GET /gateway/connection
|
|
558
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
556
|
+
* HTTP GET /map
|
|
557
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
559
558
|
*/
|
|
560
|
-
|
|
559
|
+
getSettings(options?: O): RestResponse<{
|
|
560
|
+
[id: string]: unknown;
|
|
561
|
+
}>;
|
|
561
562
|
/**
|
|
562
|
-
* HTTP
|
|
563
|
-
* Java method: org.openremote.model.
|
|
563
|
+
* HTTP PUT /map
|
|
564
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
564
565
|
*/
|
|
565
|
-
|
|
566
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
567
|
+
[id: string]: unknown;
|
|
568
|
+
}>;
|
|
566
569
|
/**
|
|
567
|
-
* HTTP
|
|
568
|
-
* Java method: org.openremote.model.
|
|
570
|
+
* HTTP DELETE /map/deleteMap
|
|
571
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
569
572
|
*/
|
|
570
|
-
|
|
573
|
+
deleteMap(options?: O): RestResponse<{
|
|
574
|
+
[id: string]: unknown;
|
|
575
|
+
}>;
|
|
571
576
|
/**
|
|
572
|
-
* HTTP
|
|
573
|
-
* Java method: org.openremote.model.
|
|
577
|
+
* HTTP GET /map/getCustomMapInfo
|
|
578
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
574
579
|
*/
|
|
575
|
-
|
|
580
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
581
|
+
[id: string]: unknown;
|
|
582
|
+
}>;
|
|
576
583
|
/**
|
|
577
|
-
* HTTP GET /
|
|
578
|
-
* Java method: org.openremote.model.
|
|
584
|
+
* HTTP GET /map/js
|
|
585
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
579
586
|
*/
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
protected httpClient: HttpClient<O>;
|
|
584
|
-
constructor(httpClient: HttpClient<O>);
|
|
587
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
588
|
+
[id: string]: unknown;
|
|
589
|
+
}>;
|
|
585
590
|
/**
|
|
586
|
-
* HTTP GET /
|
|
587
|
-
* Java method: org.openremote.model.
|
|
591
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
592
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
588
593
|
*/
|
|
589
|
-
|
|
590
|
-
[index: string]: any;
|
|
591
|
-
}>;
|
|
594
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
592
595
|
/**
|
|
593
|
-
* HTTP
|
|
594
|
-
* Java method: org.openremote.model.
|
|
596
|
+
* HTTP POST /map/upload
|
|
597
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
595
598
|
*/
|
|
596
|
-
|
|
597
|
-
|
|
599
|
+
uploadMap(queryParams?: {
|
|
600
|
+
filename?: string;
|
|
601
|
+
}, options?: O): RestResponse<{
|
|
602
|
+
[id: string]: unknown;
|
|
598
603
|
}>;
|
|
599
604
|
}
|
|
600
|
-
export declare class
|
|
605
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
601
606
|
protected httpClient: HttpClient<O>;
|
|
602
607
|
constructor(httpClient: HttpClient<O>);
|
|
603
608
|
/**
|
|
604
|
-
* HTTP POST /
|
|
605
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* HTTP POST /gateway/tunnel
|
|
610
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
606
611
|
*/
|
|
607
|
-
|
|
612
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
608
613
|
/**
|
|
609
|
-
* HTTP
|
|
610
|
-
* Java method: org.openremote.model.
|
|
614
|
+
* HTTP DELETE /gateway/tunnel
|
|
615
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
611
616
|
*/
|
|
612
|
-
|
|
617
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
613
618
|
/**
|
|
614
|
-
* HTTP
|
|
615
|
-
* Java method: org.openremote.model.
|
|
619
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
620
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
616
621
|
*/
|
|
617
|
-
|
|
622
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
618
623
|
/**
|
|
619
|
-
* HTTP
|
|
620
|
-
* Java method: org.openremote.model.
|
|
624
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
625
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
621
626
|
*/
|
|
622
|
-
|
|
627
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
628
|
+
/**
|
|
629
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
630
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
631
|
+
*/
|
|
632
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
623
633
|
}
|
|
624
|
-
export declare class
|
|
634
|
+
export declare class NotificationResourceClient<O> {
|
|
625
635
|
protected httpClient: HttpClient<O>;
|
|
626
636
|
constructor(httpClient: HttpClient<O>);
|
|
627
637
|
/**
|
|
628
|
-
* HTTP
|
|
629
|
-
* Java method: org.openremote.model.
|
|
630
|
-
*/
|
|
631
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
632
|
-
/**
|
|
633
|
-
* HTTP GET /rules
|
|
634
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
638
|
+
* HTTP GET /notification
|
|
639
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
635
640
|
*/
|
|
636
|
-
|
|
641
|
+
getNotifications(queryParams?: {
|
|
642
|
+
id?: number;
|
|
643
|
+
type?: string;
|
|
644
|
+
from?: number;
|
|
645
|
+
to?: number;
|
|
646
|
+
realmId?: string;
|
|
647
|
+
userId?: string;
|
|
648
|
+
assetId?: string;
|
|
649
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
650
|
+
/**
|
|
651
|
+
* HTTP DELETE /notification
|
|
652
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
653
|
+
*/
|
|
654
|
+
removeNotifications(queryParams?: {
|
|
655
|
+
id?: number;
|
|
656
|
+
type?: string;
|
|
657
|
+
from?: number;
|
|
658
|
+
to?: number;
|
|
659
|
+
realmId?: string;
|
|
660
|
+
userId?: string;
|
|
661
|
+
assetId?: string;
|
|
662
|
+
}, options?: O): RestResponse<void>;
|
|
663
|
+
/**
|
|
664
|
+
* HTTP POST /notification/alert
|
|
665
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
666
|
+
*/
|
|
667
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
668
|
+
/**
|
|
669
|
+
* HTTP DELETE /notification/{notificationId}
|
|
670
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
671
|
+
*/
|
|
672
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
673
|
+
/**
|
|
674
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
675
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
676
|
+
*/
|
|
677
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
678
|
+
targetId?: string;
|
|
679
|
+
}, options?: O): RestResponse<void>;
|
|
680
|
+
/**
|
|
681
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
682
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
683
|
+
*/
|
|
684
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
685
|
+
targetId?: string;
|
|
686
|
+
}, options?: O): RestResponse<void>;
|
|
687
|
+
}
|
|
688
|
+
export declare class AppResourceClient<O> {
|
|
689
|
+
protected httpClient: HttpClient<O>;
|
|
690
|
+
constructor(httpClient: HttpClient<O>);
|
|
691
|
+
/**
|
|
692
|
+
* HTTP GET /apps
|
|
693
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
694
|
+
*/
|
|
695
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
696
|
+
/**
|
|
697
|
+
* HTTP GET /apps/consoleConfig
|
|
698
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
699
|
+
*/
|
|
700
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
701
|
+
/**
|
|
702
|
+
* HTTP GET /apps/info
|
|
703
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
704
|
+
*/
|
|
705
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
706
|
+
}
|
|
707
|
+
export declare class GatewayClientResourceClient<O> {
|
|
708
|
+
protected httpClient: HttpClient<O>;
|
|
709
|
+
constructor(httpClient: HttpClient<O>);
|
|
710
|
+
/**
|
|
711
|
+
* HTTP DELETE /gateway/connection
|
|
712
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
713
|
+
*/
|
|
714
|
+
deleteConnections(queryParams?: {
|
|
715
|
+
realm?: string[];
|
|
716
|
+
}, options?: O): RestResponse<void>;
|
|
717
|
+
/**
|
|
718
|
+
* HTTP GET /gateway/connection
|
|
719
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
720
|
+
*/
|
|
721
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
722
|
+
/**
|
|
723
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
724
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
725
|
+
*/
|
|
726
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
727
|
+
/**
|
|
728
|
+
* HTTP GET /gateway/connection/{realm}
|
|
729
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
730
|
+
*/
|
|
731
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
732
|
+
/**
|
|
733
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
734
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
735
|
+
*/
|
|
736
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
737
|
+
/**
|
|
738
|
+
* HTTP GET /gateway/status/{realm}
|
|
739
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
740
|
+
*/
|
|
741
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
742
|
+
}
|
|
743
|
+
export declare class RealmResourceClient<O> {
|
|
744
|
+
protected httpClient: HttpClient<O>;
|
|
745
|
+
constructor(httpClient: HttpClient<O>);
|
|
746
|
+
/**
|
|
747
|
+
* HTTP POST /realm
|
|
748
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
749
|
+
*/
|
|
750
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
751
|
+
/**
|
|
752
|
+
* HTTP GET /realm
|
|
753
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
754
|
+
*/
|
|
755
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
756
|
+
/**
|
|
757
|
+
* HTTP GET /realm/accessible
|
|
758
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
759
|
+
*/
|
|
760
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
761
|
+
/**
|
|
762
|
+
* HTTP DELETE /realm/{name}
|
|
763
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
764
|
+
*/
|
|
765
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
766
|
+
/**
|
|
767
|
+
* HTTP GET /realm/{name}
|
|
768
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
769
|
+
*/
|
|
770
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
771
|
+
/**
|
|
772
|
+
* HTTP PUT /realm/{name}
|
|
773
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
774
|
+
*/
|
|
775
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
776
|
+
}
|
|
777
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
778
|
+
protected httpClient: HttpClient<O>;
|
|
779
|
+
constructor(httpClient: HttpClient<O>);
|
|
780
|
+
/**
|
|
781
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
782
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
783
|
+
*/
|
|
784
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
785
|
+
/**
|
|
786
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
787
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
788
|
+
*/
|
|
789
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
790
|
+
}
|
|
791
|
+
export declare class RulesResourceClient<O> {
|
|
792
|
+
protected httpClient: HttpClient<O>;
|
|
793
|
+
constructor(httpClient: HttpClient<O>);
|
|
794
|
+
/**
|
|
795
|
+
* HTTP POST /rules
|
|
796
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
797
|
+
*/
|
|
798
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
799
|
+
/**
|
|
800
|
+
* HTTP GET /rules
|
|
801
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
802
|
+
*/
|
|
803
|
+
getGlobalRulesets(queryParams?: {
|
|
637
804
|
language?: Model.RulesetLang[];
|
|
638
805
|
fullyPopulate?: boolean;
|
|
639
806
|
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
@@ -729,218 +896,51 @@ export declare class RulesResourceClient<O> {
|
|
|
729
896
|
*/
|
|
730
897
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
731
898
|
}
|
|
732
|
-
export declare class ConsoleResourceClient<O> {
|
|
733
|
-
protected httpClient: HttpClient<O>;
|
|
734
|
-
constructor(httpClient: HttpClient<O>);
|
|
735
|
-
/**
|
|
736
|
-
* HTTP POST /console/register
|
|
737
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
738
|
-
*/
|
|
739
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
740
|
-
}
|
|
741
|
-
export declare class AssetModelResourceClient<O> {
|
|
742
|
-
protected httpClient: HttpClient<O>;
|
|
743
|
-
constructor(httpClient: HttpClient<O>);
|
|
744
|
-
/**
|
|
745
|
-
* HTTP GET /model/assetDescriptors
|
|
746
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
747
|
-
*/
|
|
748
|
-
getAssetDescriptors(queryParams?: {
|
|
749
|
-
parentId?: string;
|
|
750
|
-
parentType?: string;
|
|
751
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
752
|
-
/**
|
|
753
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
754
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
755
|
-
*/
|
|
756
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
757
|
-
parentId?: string;
|
|
758
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
759
|
-
/**
|
|
760
|
-
* HTTP GET /model/assetInfos
|
|
761
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
762
|
-
*/
|
|
763
|
-
getAssetInfos(queryParams?: {
|
|
764
|
-
parentId?: string;
|
|
765
|
-
parentType?: string;
|
|
766
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
767
|
-
/**
|
|
768
|
-
* HTTP GET /model/metaItemDescriptors
|
|
769
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
770
|
-
*/
|
|
771
|
-
getMetaItemDescriptors(queryParams?: {
|
|
772
|
-
parentId?: string;
|
|
773
|
-
}, options?: O): RestResponse<{
|
|
774
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
775
|
-
}>;
|
|
776
|
-
/**
|
|
777
|
-
* HTTP GET /model/valueDescriptors
|
|
778
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
779
|
-
*/
|
|
780
|
-
getValueDescriptors(queryParams?: {
|
|
781
|
-
parentId?: string;
|
|
782
|
-
}, options?: O): RestResponse<{
|
|
783
|
-
[index: string]: Model.ValueDescriptor;
|
|
784
|
-
}>;
|
|
785
|
-
}
|
|
786
|
-
export declare class AlarmResourceClient<O> {
|
|
787
|
-
protected httpClient: HttpClient<O>;
|
|
788
|
-
constructor(httpClient: HttpClient<O>);
|
|
789
|
-
/**
|
|
790
|
-
* HTTP POST /alarm
|
|
791
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
792
|
-
*/
|
|
793
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
794
|
-
assetIds?: string[];
|
|
795
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
796
|
-
/**
|
|
797
|
-
* HTTP GET /alarm
|
|
798
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
799
|
-
*/
|
|
800
|
-
getAlarms(queryParams?: {
|
|
801
|
-
realm?: string;
|
|
802
|
-
status?: Model.AlarmStatus;
|
|
803
|
-
assetId?: string;
|
|
804
|
-
assigneeId?: string;
|
|
805
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
806
|
-
/**
|
|
807
|
-
* HTTP DELETE /alarm
|
|
808
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
809
|
-
*/
|
|
810
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
811
|
-
/**
|
|
812
|
-
* HTTP PUT /alarm/assets
|
|
813
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
814
|
-
*/
|
|
815
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
816
|
-
/**
|
|
817
|
-
* HTTP GET /alarm/{alarmId}
|
|
818
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
819
|
-
*/
|
|
820
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
821
|
-
/**
|
|
822
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
823
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
824
|
-
*/
|
|
825
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
826
|
-
/**
|
|
827
|
-
* HTTP PUT /alarm/{alarmId}
|
|
828
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
829
|
-
*/
|
|
830
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
831
|
-
/**
|
|
832
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
833
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
834
|
-
*/
|
|
835
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
836
|
-
realm?: string;
|
|
837
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
838
|
-
}
|
|
839
|
-
export declare class DashboardResourceClient<O> {
|
|
840
|
-
protected httpClient: HttpClient<O>;
|
|
841
|
-
constructor(httpClient: HttpClient<O>);
|
|
842
|
-
/**
|
|
843
|
-
* HTTP POST /dashboard
|
|
844
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
845
|
-
*/
|
|
846
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
847
|
-
/**
|
|
848
|
-
* HTTP PUT /dashboard
|
|
849
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
850
|
-
*/
|
|
851
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
852
|
-
/**
|
|
853
|
-
* HTTP GET /dashboard/all/{realm}
|
|
854
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
855
|
-
*/
|
|
856
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
857
|
-
/**
|
|
858
|
-
* HTTP POST /dashboard/query
|
|
859
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
860
|
-
*/
|
|
861
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
862
|
-
/**
|
|
863
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
864
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
865
|
-
*/
|
|
866
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
867
|
-
/**
|
|
868
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
869
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
870
|
-
*/
|
|
871
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
872
|
-
}
|
|
873
|
-
export declare class ConfigurationResourceClient<O> {
|
|
874
|
-
protected httpClient: HttpClient<O>;
|
|
875
|
-
constructor(httpClient: HttpClient<O>);
|
|
876
|
-
/**
|
|
877
|
-
* HTTP GET /configuration/manager
|
|
878
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
879
|
-
*/
|
|
880
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
881
|
-
/**
|
|
882
|
-
* HTTP PUT /configuration/manager
|
|
883
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
884
|
-
*/
|
|
885
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
886
|
-
/**
|
|
887
|
-
* HTTP POST /configuration/manager/file
|
|
888
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
889
|
-
*/
|
|
890
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
891
|
-
path?: string;
|
|
892
|
-
}, options?: O): RestResponse<string>;
|
|
893
|
-
/**
|
|
894
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
895
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
896
|
-
*/
|
|
897
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
898
|
-
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected _appResource: AxiosAppResourceClient;
|
|
902
901
|
protected _userResource: AxiosUserResourceClient;
|
|
903
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
904
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
905
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
906
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
907
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
908
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
909
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
910
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
911
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
912
902
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
913
|
-
protected
|
|
903
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
914
904
|
protected _statusResource: AxiosStatusResourceClient;
|
|
915
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
916
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
917
905
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
918
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
919
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
920
906
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
921
907
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
908
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
909
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
910
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
911
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
912
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
913
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
914
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
915
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
916
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
917
|
+
protected _appResource: AxiosAppResourceClient;
|
|
918
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
919
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
920
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
921
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get AppResource(): AxiosAppResourceClient;
|
|
924
923
|
get UserResource(): AxiosUserResourceClient;
|
|
925
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
926
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
927
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
928
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
929
|
-
get MapResource(): AxiosMapResourceClient;
|
|
930
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
931
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
932
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
933
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
934
924
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
935
|
-
get
|
|
925
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
936
926
|
get StatusResource(): AxiosStatusResourceClient;
|
|
937
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
938
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
939
927
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
940
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
941
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
942
928
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
943
929
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
930
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
931
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
932
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
933
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
934
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
935
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
936
|
+
get MapResource(): AxiosMapResourceClient;
|
|
937
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
938
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
939
|
+
get AppResource(): AxiosAppResourceClient;
|
|
940
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
941
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
942
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
943
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
978
|
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|