@openremote/rest 1.10.0-snapshot.20251023131754 → 1.10.0-snapshot.20251023140106
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 +410 -410
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -133,6 +133,121 @@ export declare class UserResourceClient<O> {
|
|
|
133
133
|
*/
|
|
134
134
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
135
135
|
}
|
|
136
|
+
export declare class ConsoleResourceClient<O> {
|
|
137
|
+
protected httpClient: HttpClient<O>;
|
|
138
|
+
constructor(httpClient: HttpClient<O>);
|
|
139
|
+
/**
|
|
140
|
+
* HTTP POST /console/register
|
|
141
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
142
|
+
*/
|
|
143
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
144
|
+
}
|
|
145
|
+
export declare class FlowResourceClient<O> {
|
|
146
|
+
protected httpClient: HttpClient<O>;
|
|
147
|
+
constructor(httpClient: HttpClient<O>);
|
|
148
|
+
/**
|
|
149
|
+
* HTTP GET /flow
|
|
150
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
151
|
+
*/
|
|
152
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
153
|
+
/**
|
|
154
|
+
* HTTP GET /flow/{name}
|
|
155
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
156
|
+
*/
|
|
157
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
158
|
+
/**
|
|
159
|
+
* HTTP GET /flow/{type}
|
|
160
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
161
|
+
*/
|
|
162
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
163
|
+
}
|
|
164
|
+
export declare class SyslogResourceClient<O> {
|
|
165
|
+
protected httpClient: HttpClient<O>;
|
|
166
|
+
constructor(httpClient: HttpClient<O>);
|
|
167
|
+
/**
|
|
168
|
+
* HTTP GET /syslog/config
|
|
169
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
170
|
+
*/
|
|
171
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
172
|
+
/**
|
|
173
|
+
* HTTP PUT /syslog/config
|
|
174
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
175
|
+
*/
|
|
176
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
177
|
+
/**
|
|
178
|
+
* HTTP DELETE /syslog/event
|
|
179
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
180
|
+
*/
|
|
181
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
182
|
+
/**
|
|
183
|
+
* HTTP GET /syslog/event
|
|
184
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
185
|
+
*/
|
|
186
|
+
getEvents(queryParams?: {
|
|
187
|
+
level?: Model.SyslogLevel;
|
|
188
|
+
per_page?: number;
|
|
189
|
+
page?: number;
|
|
190
|
+
from?: number;
|
|
191
|
+
to?: number;
|
|
192
|
+
category?: Model.SyslogCategory[];
|
|
193
|
+
subCategory?: string[];
|
|
194
|
+
}, options?: O): RestResponse<any>;
|
|
195
|
+
}
|
|
196
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
197
|
+
protected httpClient: HttpClient<O>;
|
|
198
|
+
constructor(httpClient: HttpClient<O>);
|
|
199
|
+
/**
|
|
200
|
+
* Response code 200 - List of registered external services
|
|
201
|
+
* HTTP GET /service
|
|
202
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
203
|
+
*/
|
|
204
|
+
getServices(queryParams?: {
|
|
205
|
+
realm?: string;
|
|
206
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
207
|
+
/**
|
|
208
|
+
* Response code 200 - Service registered successfully
|
|
209
|
+
* Response code 400 - Invalid external service object
|
|
210
|
+
* Response code 409 - ExternalService instance already registered
|
|
211
|
+
* HTTP POST /service
|
|
212
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
213
|
+
*/
|
|
214
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
215
|
+
/**
|
|
216
|
+
* Response code 200 - List of registered external services
|
|
217
|
+
* HTTP GET /service/global
|
|
218
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
219
|
+
*/
|
|
220
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
221
|
+
/**
|
|
222
|
+
* Response code 200 - Service registered successfully
|
|
223
|
+
* Response code 400 - Invalid external service object
|
|
224
|
+
* Response code 409 - ExternalService instance already registered
|
|
225
|
+
* HTTP POST /service/global
|
|
226
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
227
|
+
*/
|
|
228
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
229
|
+
/**
|
|
230
|
+
* Response code 204 - Service deregistered successfully
|
|
231
|
+
* Response code 404 - Service instance not found
|
|
232
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
233
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
234
|
+
*/
|
|
235
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
236
|
+
/**
|
|
237
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
238
|
+
* Response code 404 - ExternalService not found
|
|
239
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
240
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
241
|
+
*/
|
|
242
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
243
|
+
/**
|
|
244
|
+
* Response code 204 - Heartbeat sent successfully
|
|
245
|
+
* Response code 404 - Service instance not found
|
|
246
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
247
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
248
|
+
*/
|
|
249
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
250
|
+
}
|
|
136
251
|
export declare class RulesResourceClient<O> {
|
|
137
252
|
protected httpClient: HttpClient<O>;
|
|
138
253
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -241,117 +356,176 @@ export declare class RulesResourceClient<O> {
|
|
|
241
356
|
*/
|
|
242
357
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
243
358
|
}
|
|
244
|
-
export declare class
|
|
359
|
+
export declare class ConfigurationResourceClient<O> {
|
|
245
360
|
protected httpClient: HttpClient<O>;
|
|
246
361
|
constructor(httpClient: HttpClient<O>);
|
|
247
362
|
/**
|
|
248
|
-
* HTTP
|
|
249
|
-
* Java method: org.openremote.model.
|
|
363
|
+
* HTTP GET /configuration/manager
|
|
364
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
250
365
|
*/
|
|
251
|
-
|
|
366
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
252
367
|
/**
|
|
253
|
-
* HTTP PUT /
|
|
254
|
-
* Java method: org.openremote.model.
|
|
368
|
+
* HTTP PUT /configuration/manager
|
|
369
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
255
370
|
*/
|
|
256
|
-
|
|
371
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
372
|
+
/**
|
|
373
|
+
* HTTP POST /configuration/manager/file
|
|
374
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
375
|
+
*/
|
|
376
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
377
|
+
path?: string;
|
|
378
|
+
}, options?: O): RestResponse<string>;
|
|
379
|
+
/**
|
|
380
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
381
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
382
|
+
*/
|
|
383
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
257
384
|
}
|
|
258
|
-
export declare class
|
|
385
|
+
export declare class StatusResourceClient<O> {
|
|
259
386
|
protected httpClient: HttpClient<O>;
|
|
260
387
|
constructor(httpClient: HttpClient<O>);
|
|
261
388
|
/**
|
|
262
|
-
* HTTP GET /
|
|
263
|
-
* Java method: org.openremote.model.
|
|
264
|
-
*/
|
|
265
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
266
|
-
/**
|
|
267
|
-
* HTTP GET /apps/consoleConfig
|
|
268
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
389
|
+
* HTTP GET /health
|
|
390
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
269
391
|
*/
|
|
270
|
-
|
|
392
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
393
|
+
[index: string]: any;
|
|
394
|
+
}>;
|
|
271
395
|
/**
|
|
272
|
-
* HTTP GET /
|
|
273
|
-
* Java method: org.openremote.model.
|
|
396
|
+
* HTTP GET /info
|
|
397
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
274
398
|
*/
|
|
275
|
-
|
|
399
|
+
getInfo(options?: O): RestResponse<{
|
|
400
|
+
[index: string]: any;
|
|
401
|
+
}>;
|
|
276
402
|
}
|
|
277
|
-
export declare class
|
|
403
|
+
export declare class MapResourceClient<O> {
|
|
278
404
|
protected httpClient: HttpClient<O>;
|
|
279
405
|
constructor(httpClient: HttpClient<O>);
|
|
280
406
|
/**
|
|
281
|
-
* HTTP
|
|
282
|
-
* Java method: org.openremote.model.
|
|
407
|
+
* HTTP GET /map
|
|
408
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
283
409
|
*/
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
}
|
|
410
|
+
getSettings(options?: O): RestResponse<{
|
|
411
|
+
[id: string]: unknown;
|
|
412
|
+
}>;
|
|
287
413
|
/**
|
|
288
|
-
* HTTP
|
|
289
|
-
* Java method: org.openremote.model.
|
|
414
|
+
* HTTP PUT /map
|
|
415
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
290
416
|
*/
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
assetId?: string;
|
|
295
|
-
assigneeId?: string;
|
|
296
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
417
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
418
|
+
[id: string]: unknown;
|
|
419
|
+
}>;
|
|
297
420
|
/**
|
|
298
|
-
* HTTP DELETE /
|
|
299
|
-
* Java method: org.openremote.model.
|
|
421
|
+
* HTTP DELETE /map/deleteMap
|
|
422
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
300
423
|
*/
|
|
301
|
-
|
|
424
|
+
deleteMap(options?: O): RestResponse<{
|
|
425
|
+
[id: string]: unknown;
|
|
426
|
+
}>;
|
|
302
427
|
/**
|
|
303
|
-
* HTTP
|
|
304
|
-
* Java method: org.openremote.model.
|
|
428
|
+
* HTTP GET /map/getCustomMapInfo
|
|
429
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
305
430
|
*/
|
|
306
|
-
|
|
431
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
432
|
+
[id: string]: unknown;
|
|
433
|
+
}>;
|
|
307
434
|
/**
|
|
308
|
-
* HTTP GET /
|
|
309
|
-
* Java method: org.openremote.model.
|
|
435
|
+
* HTTP GET /map/js
|
|
436
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
310
437
|
*/
|
|
311
|
-
|
|
438
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
439
|
+
[id: string]: unknown;
|
|
440
|
+
}>;
|
|
312
441
|
/**
|
|
313
|
-
* HTTP
|
|
314
|
-
* Java method: org.openremote.model.
|
|
442
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
443
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
315
444
|
*/
|
|
316
|
-
|
|
445
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
317
446
|
/**
|
|
318
|
-
* HTTP
|
|
319
|
-
* Java method: org.openremote.model.
|
|
447
|
+
* HTTP POST /map/upload
|
|
448
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
320
449
|
*/
|
|
321
|
-
|
|
450
|
+
uploadMap(queryParams?: {
|
|
451
|
+
filename?: string;
|
|
452
|
+
}, options?: O): RestResponse<{
|
|
453
|
+
[id: string]: unknown;
|
|
454
|
+
}>;
|
|
455
|
+
}
|
|
456
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
457
|
+
protected httpClient: HttpClient<O>;
|
|
458
|
+
constructor(httpClient: HttpClient<O>);
|
|
322
459
|
/**
|
|
323
|
-
* HTTP
|
|
324
|
-
* Java method: org.openremote.model.
|
|
460
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
461
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
325
462
|
*/
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
463
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
464
|
+
/**
|
|
465
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
466
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
467
|
+
*/
|
|
468
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
329
469
|
}
|
|
330
|
-
export declare class
|
|
470
|
+
export declare class DashboardResourceClient<O> {
|
|
331
471
|
protected httpClient: HttpClient<O>;
|
|
332
472
|
constructor(httpClient: HttpClient<O>);
|
|
333
473
|
/**
|
|
334
|
-
* HTTP
|
|
335
|
-
* Java method: org.openremote.model.
|
|
474
|
+
* HTTP POST /dashboard
|
|
475
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
336
476
|
*/
|
|
337
|
-
|
|
477
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
338
478
|
/**
|
|
339
|
-
* HTTP PUT /
|
|
340
|
-
* Java method: org.openremote.model.
|
|
479
|
+
* HTTP PUT /dashboard
|
|
480
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
341
481
|
*/
|
|
342
|
-
update(
|
|
482
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
343
483
|
/**
|
|
344
|
-
* HTTP
|
|
345
|
-
* Java method: org.openremote.model.
|
|
484
|
+
* HTTP GET /dashboard/all/{realm}
|
|
485
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
346
486
|
*/
|
|
347
|
-
|
|
348
|
-
path?: string;
|
|
349
|
-
}, options?: O): RestResponse<string>;
|
|
487
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
350
488
|
/**
|
|
351
|
-
* HTTP
|
|
352
|
-
* Java method: org.openremote.model.
|
|
489
|
+
* HTTP POST /dashboard/query
|
|
490
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
353
491
|
*/
|
|
354
|
-
|
|
492
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
493
|
+
/**
|
|
494
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
495
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
496
|
+
*/
|
|
497
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
498
|
+
/**
|
|
499
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
500
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
501
|
+
*/
|
|
502
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
503
|
+
}
|
|
504
|
+
export declare class AgentResourceClient<O> {
|
|
505
|
+
protected httpClient: HttpClient<O>;
|
|
506
|
+
constructor(httpClient: HttpClient<O>);
|
|
507
|
+
/**
|
|
508
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
509
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
510
|
+
*/
|
|
511
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
512
|
+
realm?: string;
|
|
513
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
514
|
+
/**
|
|
515
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
516
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
517
|
+
*/
|
|
518
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
519
|
+
realm?: string;
|
|
520
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
521
|
+
/**
|
|
522
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
523
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
524
|
+
*/
|
|
525
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
526
|
+
parentId?: string;
|
|
527
|
+
realm?: string;
|
|
528
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
355
529
|
}
|
|
356
530
|
export declare class AssetDatapointResourceClient<O> {
|
|
357
531
|
protected httpClient: HttpClient<O>;
|
|
@@ -379,92 +553,92 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
379
553
|
*/
|
|
380
554
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
381
555
|
}
|
|
382
|
-
export declare class
|
|
556
|
+
export declare class AlarmResourceClient<O> {
|
|
383
557
|
protected httpClient: HttpClient<O>;
|
|
384
558
|
constructor(httpClient: HttpClient<O>);
|
|
385
559
|
/**
|
|
386
|
-
* HTTP
|
|
387
|
-
* Java method: org.openremote.model.
|
|
560
|
+
* HTTP POST /alarm
|
|
561
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
388
562
|
*/
|
|
389
|
-
|
|
563
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
564
|
+
assetIds?: string[];
|
|
565
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
390
566
|
/**
|
|
391
|
-
* HTTP
|
|
392
|
-
* Java method: org.openremote.model.
|
|
567
|
+
* HTTP GET /alarm
|
|
568
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
393
569
|
*/
|
|
394
|
-
|
|
570
|
+
getAlarms(queryParams?: {
|
|
571
|
+
realm?: string;
|
|
572
|
+
status?: Model.AlarmStatus;
|
|
573
|
+
assetId?: string;
|
|
574
|
+
assigneeId?: string;
|
|
575
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
395
576
|
/**
|
|
396
|
-
* HTTP DELETE /
|
|
397
|
-
* Java method: org.openremote.model.
|
|
577
|
+
* HTTP DELETE /alarm
|
|
578
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
398
579
|
*/
|
|
399
|
-
|
|
580
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
400
581
|
/**
|
|
401
|
-
* HTTP
|
|
402
|
-
* Java method: org.openremote.model.
|
|
582
|
+
* HTTP PUT /alarm/assets
|
|
583
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
403
584
|
*/
|
|
404
|
-
|
|
405
|
-
level?: Model.SyslogLevel;
|
|
406
|
-
per_page?: number;
|
|
407
|
-
page?: number;
|
|
408
|
-
from?: number;
|
|
409
|
-
to?: number;
|
|
410
|
-
category?: Model.SyslogCategory[];
|
|
411
|
-
subCategory?: string[];
|
|
412
|
-
}, options?: O): RestResponse<any>;
|
|
413
|
-
}
|
|
414
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
415
|
-
protected httpClient: HttpClient<O>;
|
|
416
|
-
constructor(httpClient: HttpClient<O>);
|
|
585
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
417
586
|
/**
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
587
|
+
* HTTP GET /alarm/{alarmId}
|
|
588
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
421
589
|
*/
|
|
422
|
-
|
|
590
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
591
|
+
/**
|
|
592
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
593
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
594
|
+
*/
|
|
595
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
596
|
+
/**
|
|
597
|
+
* HTTP PUT /alarm/{alarmId}
|
|
598
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
599
|
+
*/
|
|
600
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
601
|
+
/**
|
|
602
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
603
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
604
|
+
*/
|
|
605
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
423
606
|
realm?: string;
|
|
424
|
-
}, options?: O): RestResponse<Model.
|
|
607
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
608
|
+
}
|
|
609
|
+
export declare class RealmResourceClient<O> {
|
|
610
|
+
protected httpClient: HttpClient<O>;
|
|
611
|
+
constructor(httpClient: HttpClient<O>);
|
|
425
612
|
/**
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
* Response code 409 - ExternalService instance already registered
|
|
429
|
-
* HTTP POST /service
|
|
430
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
613
|
+
* HTTP POST /realm
|
|
614
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
431
615
|
*/
|
|
432
|
-
|
|
616
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
433
617
|
/**
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
618
|
+
* HTTP GET /realm
|
|
619
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
437
620
|
*/
|
|
438
|
-
|
|
621
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
439
622
|
/**
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
* Response code 409 - ExternalService instance already registered
|
|
443
|
-
* HTTP POST /service/global
|
|
444
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
623
|
+
* HTTP GET /realm/accessible
|
|
624
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
445
625
|
*/
|
|
446
|
-
|
|
626
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
447
627
|
/**
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
451
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
628
|
+
* HTTP DELETE /realm/{name}
|
|
629
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
452
630
|
*/
|
|
453
|
-
|
|
631
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
454
632
|
/**
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
458
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
633
|
+
* HTTP GET /realm/{name}
|
|
634
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
459
635
|
*/
|
|
460
|
-
|
|
636
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
461
637
|
/**
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
465
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
638
|
+
* HTTP PUT /realm/{name}
|
|
639
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
466
640
|
*/
|
|
467
|
-
|
|
641
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
468
642
|
}
|
|
469
643
|
export declare class ProvisioningResourceClient<O> {
|
|
470
644
|
protected httpClient: HttpClient<O>;
|
|
@@ -519,66 +693,6 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
519
693
|
*/
|
|
520
694
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
521
695
|
}
|
|
522
|
-
export declare class DashboardResourceClient<O> {
|
|
523
|
-
protected httpClient: HttpClient<O>;
|
|
524
|
-
constructor(httpClient: HttpClient<O>);
|
|
525
|
-
/**
|
|
526
|
-
* HTTP POST /dashboard
|
|
527
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
528
|
-
*/
|
|
529
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
530
|
-
/**
|
|
531
|
-
* HTTP PUT /dashboard
|
|
532
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
533
|
-
*/
|
|
534
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
535
|
-
/**
|
|
536
|
-
* HTTP GET /dashboard/all/{realm}
|
|
537
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
538
|
-
*/
|
|
539
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
540
|
-
/**
|
|
541
|
-
* HTTP POST /dashboard/query
|
|
542
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
543
|
-
*/
|
|
544
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
545
|
-
/**
|
|
546
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
547
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
548
|
-
*/
|
|
549
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
550
|
-
/**
|
|
551
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
552
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
553
|
-
*/
|
|
554
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
555
|
-
}
|
|
556
|
-
export declare class AgentResourceClient<O> {
|
|
557
|
-
protected httpClient: HttpClient<O>;
|
|
558
|
-
constructor(httpClient: HttpClient<O>);
|
|
559
|
-
/**
|
|
560
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
561
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
562
|
-
*/
|
|
563
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
564
|
-
realm?: string;
|
|
565
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
566
|
-
/**
|
|
567
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
568
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
569
|
-
*/
|
|
570
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
571
|
-
realm?: string;
|
|
572
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
573
|
-
/**
|
|
574
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
575
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
576
|
-
*/
|
|
577
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
578
|
-
parentId?: string;
|
|
579
|
-
realm?: string;
|
|
580
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
581
|
-
}
|
|
582
696
|
export declare class AssetResourceClient<O> {
|
|
583
697
|
protected httpClient: HttpClient<O>;
|
|
584
698
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -677,140 +791,89 @@ export declare class AssetResourceClient<O> {
|
|
|
677
791
|
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
678
792
|
/**
|
|
679
793
|
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
680
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
681
|
-
*/
|
|
682
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
683
|
-
/**
|
|
684
|
-
* HTTP PUT /asset/{parentAssetId}/child
|
|
685
|
-
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
686
|
-
*/
|
|
687
|
-
updateParent(parentAssetId: string, queryParams?: {
|
|
688
|
-
assetIds?: string[];
|
|
689
|
-
}, options?: O): RestResponse<void>;
|
|
690
|
-
}
|
|
691
|
-
export declare class FlowResourceClient<O> {
|
|
692
|
-
protected httpClient: HttpClient<O>;
|
|
693
|
-
constructor(httpClient: HttpClient<O>);
|
|
694
|
-
/**
|
|
695
|
-
* HTTP GET /flow
|
|
696
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
697
|
-
*/
|
|
698
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
699
|
-
/**
|
|
700
|
-
* HTTP GET /flow/{name}
|
|
701
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
702
|
-
*/
|
|
703
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
704
|
-
/**
|
|
705
|
-
* HTTP GET /flow/{type}
|
|
706
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
707
|
-
*/
|
|
708
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
709
|
-
}
|
|
710
|
-
export declare class StatusResourceClient<O> {
|
|
711
|
-
protected httpClient: HttpClient<O>;
|
|
712
|
-
constructor(httpClient: HttpClient<O>);
|
|
713
|
-
/**
|
|
714
|
-
* HTTP GET /health
|
|
715
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
716
|
-
*/
|
|
717
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
718
|
-
[index: string]: any;
|
|
719
|
-
}>;
|
|
720
|
-
/**
|
|
721
|
-
* HTTP GET /info
|
|
722
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
723
|
-
*/
|
|
724
|
-
getInfo(options?: O): RestResponse<{
|
|
725
|
-
[index: string]: any;
|
|
726
|
-
}>;
|
|
727
|
-
}
|
|
728
|
-
export declare class MapResourceClient<O> {
|
|
729
|
-
protected httpClient: HttpClient<O>;
|
|
730
|
-
constructor(httpClient: HttpClient<O>);
|
|
731
|
-
/**
|
|
732
|
-
* HTTP GET /map
|
|
733
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
734
|
-
*/
|
|
735
|
-
getSettings(options?: O): RestResponse<{
|
|
736
|
-
[id: string]: unknown;
|
|
737
|
-
}>;
|
|
738
|
-
/**
|
|
739
|
-
* HTTP PUT /map
|
|
740
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
741
|
-
*/
|
|
742
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
743
|
-
[id: string]: unknown;
|
|
744
|
-
}>;
|
|
745
|
-
/**
|
|
746
|
-
* HTTP DELETE /map/deleteMap
|
|
747
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
748
|
-
*/
|
|
749
|
-
deleteMap(options?: O): RestResponse<{
|
|
750
|
-
[id: string]: unknown;
|
|
751
|
-
}>;
|
|
794
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
795
|
+
*/
|
|
796
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
752
797
|
/**
|
|
753
|
-
* HTTP
|
|
754
|
-
* Java method: org.openremote.model.
|
|
798
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
799
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
755
800
|
*/
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
}>;
|
|
801
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
802
|
+
assetIds?: string[];
|
|
803
|
+
}, options?: O): RestResponse<void>;
|
|
804
|
+
}
|
|
805
|
+
export declare class AppResourceClient<O> {
|
|
806
|
+
protected httpClient: HttpClient<O>;
|
|
807
|
+
constructor(httpClient: HttpClient<O>);
|
|
759
808
|
/**
|
|
760
|
-
* HTTP GET /
|
|
761
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP GET /apps
|
|
810
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
762
811
|
*/
|
|
763
|
-
|
|
764
|
-
[id: string]: unknown;
|
|
765
|
-
}>;
|
|
812
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
766
813
|
/**
|
|
767
|
-
* HTTP GET /
|
|
768
|
-
* Java method: org.openremote.model.
|
|
814
|
+
* HTTP GET /apps/consoleConfig
|
|
815
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
769
816
|
*/
|
|
770
|
-
|
|
817
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
771
818
|
/**
|
|
772
|
-
* HTTP
|
|
773
|
-
* Java method: org.openremote.model.
|
|
819
|
+
* HTTP GET /apps/info
|
|
820
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
774
821
|
*/
|
|
775
|
-
|
|
776
|
-
filename?: string;
|
|
777
|
-
}, options?: O): RestResponse<{
|
|
778
|
-
[id: string]: unknown;
|
|
779
|
-
}>;
|
|
822
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
780
823
|
}
|
|
781
|
-
export declare class
|
|
824
|
+
export declare class NotificationResourceClient<O> {
|
|
782
825
|
protected httpClient: HttpClient<O>;
|
|
783
826
|
constructor(httpClient: HttpClient<O>);
|
|
784
827
|
/**
|
|
785
|
-
* HTTP
|
|
786
|
-
* Java method: org.openremote.model.
|
|
828
|
+
* HTTP GET /notification
|
|
829
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
787
830
|
*/
|
|
788
|
-
|
|
831
|
+
getNotifications(queryParams?: {
|
|
832
|
+
id?: number;
|
|
833
|
+
type?: string;
|
|
834
|
+
from?: number;
|
|
835
|
+
to?: number;
|
|
836
|
+
realmId?: string;
|
|
837
|
+
userId?: string;
|
|
838
|
+
assetId?: string;
|
|
839
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
789
840
|
/**
|
|
790
|
-
* HTTP
|
|
791
|
-
* Java method: org.openremote.model.
|
|
841
|
+
* HTTP DELETE /notification
|
|
842
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
792
843
|
*/
|
|
793
|
-
|
|
844
|
+
removeNotifications(queryParams?: {
|
|
845
|
+
id?: number;
|
|
846
|
+
type?: string;
|
|
847
|
+
from?: number;
|
|
848
|
+
to?: number;
|
|
849
|
+
realmId?: string;
|
|
850
|
+
userId?: string;
|
|
851
|
+
assetId?: string;
|
|
852
|
+
}, options?: O): RestResponse<void>;
|
|
794
853
|
/**
|
|
795
|
-
* HTTP
|
|
796
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP POST /notification/alert
|
|
855
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
797
856
|
*/
|
|
798
|
-
|
|
857
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
799
858
|
/**
|
|
800
|
-
* HTTP DELETE /
|
|
801
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP DELETE /notification/{notificationId}
|
|
860
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
802
861
|
*/
|
|
803
|
-
|
|
862
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
804
863
|
/**
|
|
805
|
-
* HTTP
|
|
806
|
-
* Java method: org.openremote.model.
|
|
864
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
865
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
807
866
|
*/
|
|
808
|
-
|
|
867
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
868
|
+
targetId?: string;
|
|
869
|
+
}, options?: O): RestResponse<void>;
|
|
809
870
|
/**
|
|
810
|
-
* HTTP PUT /
|
|
811
|
-
* Java method: org.openremote.model.
|
|
871
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
872
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
812
873
|
*/
|
|
813
|
-
|
|
874
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
875
|
+
targetId?: string;
|
|
876
|
+
}, options?: O): RestResponse<void>;
|
|
814
877
|
}
|
|
815
878
|
export declare class AssetModelResourceClient<O> {
|
|
816
879
|
protected httpClient: HttpClient<O>;
|
|
@@ -901,116 +964,53 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
901
964
|
*/
|
|
902
965
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
903
966
|
}
|
|
904
|
-
export declare class ConsoleResourceClient<O> {
|
|
905
|
-
protected httpClient: HttpClient<O>;
|
|
906
|
-
constructor(httpClient: HttpClient<O>);
|
|
907
|
-
/**
|
|
908
|
-
* HTTP POST /console/register
|
|
909
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
910
|
-
*/
|
|
911
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
912
|
-
}
|
|
913
|
-
export declare class NotificationResourceClient<O> {
|
|
914
|
-
protected httpClient: HttpClient<O>;
|
|
915
|
-
constructor(httpClient: HttpClient<O>);
|
|
916
|
-
/**
|
|
917
|
-
* HTTP GET /notification
|
|
918
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
919
|
-
*/
|
|
920
|
-
getNotifications(queryParams?: {
|
|
921
|
-
id?: number;
|
|
922
|
-
type?: string;
|
|
923
|
-
from?: number;
|
|
924
|
-
to?: number;
|
|
925
|
-
realmId?: string;
|
|
926
|
-
userId?: string;
|
|
927
|
-
assetId?: string;
|
|
928
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
929
|
-
/**
|
|
930
|
-
* HTTP DELETE /notification
|
|
931
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
932
|
-
*/
|
|
933
|
-
removeNotifications(queryParams?: {
|
|
934
|
-
id?: number;
|
|
935
|
-
type?: string;
|
|
936
|
-
from?: number;
|
|
937
|
-
to?: number;
|
|
938
|
-
realmId?: string;
|
|
939
|
-
userId?: string;
|
|
940
|
-
assetId?: string;
|
|
941
|
-
}, options?: O): RestResponse<void>;
|
|
942
|
-
/**
|
|
943
|
-
* HTTP POST /notification/alert
|
|
944
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
945
|
-
*/
|
|
946
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
947
|
-
/**
|
|
948
|
-
* HTTP DELETE /notification/{notificationId}
|
|
949
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
950
|
-
*/
|
|
951
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
952
|
-
/**
|
|
953
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
954
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
955
|
-
*/
|
|
956
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
957
|
-
targetId?: string;
|
|
958
|
-
}, options?: O): RestResponse<void>;
|
|
959
|
-
/**
|
|
960
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
961
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
962
|
-
*/
|
|
963
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
964
|
-
targetId?: string;
|
|
965
|
-
}, options?: O): RestResponse<void>;
|
|
966
|
-
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
969
|
protected _userResource: AxiosUserResourceClient;
|
|
970
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
971
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
972
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
973
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
970
974
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
971
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
972
|
-
protected _appResource: AxiosAppResourceClient;
|
|
973
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
974
975
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
976
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
977
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
978
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
979
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
980
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
975
981
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
976
|
-
protected
|
|
977
|
-
protected
|
|
982
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
983
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
978
984
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
979
985
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
980
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
981
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
982
986
|
protected _assetResource: AxiosAssetResourceClient;
|
|
983
|
-
protected
|
|
984
|
-
protected
|
|
985
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
986
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
987
|
+
protected _appResource: AxiosAppResourceClient;
|
|
988
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
987
989
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
988
990
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
989
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
990
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
get UserResource(): AxiosUserResourceClient;
|
|
993
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
994
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
995
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
996
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
993
997
|
get RulesResource(): AxiosRulesResourceClient;
|
|
994
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
995
|
-
get AppResource(): AxiosAppResourceClient;
|
|
996
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
997
998
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
999
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1000
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1001
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1002
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1003
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
998
1004
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
999
|
-
get
|
|
1000
|
-
get
|
|
1005
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1006
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1001
1007
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1002
1008
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1003
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1004
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1005
1009
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1006
|
-
get
|
|
1007
|
-
get
|
|
1008
|
-
get MapResource(): AxiosMapResourceClient;
|
|
1009
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1010
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1011
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1010
1012
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1011
1013
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1012
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1013
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1021,34 +1021,31 @@ declare module "axios" {
|
|
|
1021
1021
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1025
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
|
-
}
|
|
1027
|
-
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1024
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1026
|
}
|
|
1030
|
-
export declare class
|
|
1027
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1029
|
}
|
|
1033
|
-
export declare class
|
|
1030
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1032
|
}
|
|
1036
|
-
export declare class
|
|
1033
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1035
|
}
|
|
1039
|
-
export declare class
|
|
1036
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1038
|
}
|
|
1042
|
-
export declare class
|
|
1039
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1041
|
}
|
|
1045
|
-
export declare class
|
|
1042
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1044
|
}
|
|
1048
|
-
export declare class
|
|
1045
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1047
|
}
|
|
1051
|
-
export declare class
|
|
1048
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1050
|
}
|
|
1054
1051
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1057,30 +1054,33 @@ export declare class AxiosDashboardResourceClient extends DashboardResourceClien
|
|
|
1057
1054
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1056
|
}
|
|
1060
|
-
export declare class
|
|
1057
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1059
|
}
|
|
1063
|
-
export declare class
|
|
1060
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1062
|
}
|
|
1066
|
-
export declare class
|
|
1063
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1065
|
}
|
|
1069
|
-
export declare class
|
|
1066
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1068
|
}
|
|
1072
|
-
export declare class
|
|
1069
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1071
|
}
|
|
1075
|
-
export declare class
|
|
1072
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1074
|
}
|
|
1078
|
-
export declare class
|
|
1075
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1077
|
}
|
|
1081
|
-
export declare class
|
|
1078
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1080
|
}
|
|
1084
|
-
export declare class
|
|
1081
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
|
+
}
|
|
1084
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|