@openremote/rest 1.0.2 → 1.2.0-snapshot.20240512155932

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.
@@ -0,0 +1,869 @@
1
+ import * as Model from "@openremote/model";
2
+ export interface HttpClient<O> {
3
+ request<R>(requestConfig: {
4
+ method: string;
5
+ url: string;
6
+ queryParams?: any;
7
+ data?: any;
8
+ copyFn?: (data: R) => R;
9
+ options?: O;
10
+ }): RestResponse<R>;
11
+ }
12
+ export declare class DashboardResourceClient<O> {
13
+ protected httpClient: HttpClient<O>;
14
+ constructor(httpClient: HttpClient<O>);
15
+ /**
16
+ * HTTP POST /dashboard
17
+ * Java method: org.openremote.model.dashboard.DashboardResource.create
18
+ */
19
+ create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
20
+ /**
21
+ * HTTP PUT /dashboard
22
+ * Java method: org.openremote.model.dashboard.DashboardResource.update
23
+ */
24
+ update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
25
+ /**
26
+ * HTTP GET /dashboard/all/{realm}
27
+ * Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
28
+ */
29
+ getAllRealmDashboards(realm: any, options?: O): RestResponse<Model.Dashboard[]>;
30
+ /**
31
+ * HTTP DELETE /dashboard/{realm}/{dashboardId}
32
+ * Java method: org.openremote.model.dashboard.DashboardResource.delete
33
+ */
34
+ delete(realm: any, dashboardId: any, options?: O): RestResponse<void>;
35
+ /**
36
+ * HTTP GET /dashboard/{realm}/{dashboardId}
37
+ * Java method: org.openremote.model.dashboard.DashboardResource.get
38
+ */
39
+ get(realm: any, dashboardId: any, options?: O): RestResponse<Model.Dashboard>;
40
+ }
41
+ export declare class UserResourceClient<O> {
42
+ protected httpClient: HttpClient<O>;
43
+ constructor(httpClient: HttpClient<O>);
44
+ /**
45
+ * HTTP POST /user/query
46
+ * Java method: org.openremote.model.security.UserResource.query
47
+ */
48
+ query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
49
+ /**
50
+ * HTTP GET /user/user
51
+ * Java method: org.openremote.model.security.UserResource.getCurrent
52
+ */
53
+ getCurrent(options?: O): RestResponse<Model.User>;
54
+ /**
55
+ * HTTP GET /user/userRealmRoles
56
+ * Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
57
+ */
58
+ getCurrentUserRealmRoles(options?: O): RestResponse<Model.Role[]>;
59
+ /**
60
+ * HTTP GET /user/userRoles
61
+ * Java method: org.openremote.model.security.UserResource.getCurrentUserRoles
62
+ */
63
+ getCurrentUserRoles(options?: O): RestResponse<Model.Role[]>;
64
+ /**
65
+ * HTTP GET /user/userRoles/{clientId}
66
+ * Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
67
+ */
68
+ getCurrentUserClientRoles(clientId: any, options?: O): RestResponse<Model.Role[]>;
69
+ /**
70
+ * HTTP GET /user/{realm}/disconnect/{sessionID}
71
+ * Java method: org.openremote.model.security.UserResource.disconnectUserSession
72
+ */
73
+ disconnectUserSession(realm: any, sessionID: any, options?: O): RestResponse<void>;
74
+ /**
75
+ * HTTP PUT /user/{realm}/reset-password/{userId}
76
+ * Java method: org.openremote.model.security.UserResource.resetPassword
77
+ */
78
+ resetPassword(realm: any, userId: any, credential: Model.Credential, options?: O): RestResponse<void>;
79
+ /**
80
+ * HTTP GET /user/{realm}/reset-secret/{userId}
81
+ * Java method: org.openremote.model.security.UserResource.resetSecret
82
+ */
83
+ resetSecret(realm: any, userId: any, options?: O): RestResponse<any>;
84
+ /**
85
+ * HTTP GET /user/{realm}/roles
86
+ * Java method: org.openremote.model.security.UserResource.getRoles
87
+ */
88
+ getRoles(realm: any, options?: O): RestResponse<Model.Role[]>;
89
+ /**
90
+ * HTTP PUT /user/{realm}/roles
91
+ * Java method: org.openremote.model.security.UserResource.updateRoles
92
+ */
93
+ updateRoles(realm: any, roles: Model.Role[], options?: O): RestResponse<void>;
94
+ /**
95
+ * HTTP GET /user/{realm}/userRealmRoles/{userId}
96
+ * Java method: org.openremote.model.security.UserResource.getUserRealmRoles
97
+ */
98
+ getUserRealmRoles(realm: any, userId: any, options?: O): RestResponse<Model.Role[]>;
99
+ /**
100
+ * HTTP PUT /user/{realm}/userRealmRoles/{userId}
101
+ * Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
102
+ */
103
+ updateUserRealmRoles(realm: any, userId: any, roles: Model.Role[], options?: O): RestResponse<void>;
104
+ /**
105
+ * HTTP GET /user/{realm}/userRoles/{userId}
106
+ * Java method: org.openremote.model.security.UserResource.getUserRoles
107
+ */
108
+ getUserRoles(realm: any, userId: any, options?: O): RestResponse<Model.Role[]>;
109
+ /**
110
+ * HTTP PUT /user/{realm}/userRoles/{userId}
111
+ * Java method: org.openremote.model.security.UserResource.updateUserRoles
112
+ */
113
+ updateUserRoles(realm: any, userId: any, roles: Model.Role[], options?: O): RestResponse<void>;
114
+ /**
115
+ * HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
116
+ * Java method: org.openremote.model.security.UserResource.getUserClientRoles
117
+ */
118
+ getUserClientRoles(realm: any, userId: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
119
+ /**
120
+ * HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
121
+ * Java method: org.openremote.model.security.UserResource.updateUserClientRoles
122
+ */
123
+ updateUserClientRoles(realm: any, userId: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
124
+ /**
125
+ * HTTP GET /user/{realm}/userSessions/{userId}
126
+ * Java method: org.openremote.model.security.UserResource.getUserSessions
127
+ */
128
+ getUserSessions(realm: any, userId: any, options?: O): RestResponse<Model.UserSession[]>;
129
+ /**
130
+ * HTTP POST /user/{realm}/users
131
+ * Java method: org.openremote.model.security.UserResource.create
132
+ */
133
+ create(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
134
+ /**
135
+ * HTTP PUT /user/{realm}/users
136
+ * Java method: org.openremote.model.security.UserResource.update
137
+ */
138
+ update(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
139
+ /**
140
+ * HTTP DELETE /user/{realm}/users/{userId}
141
+ * Java method: org.openremote.model.security.UserResource.delete
142
+ */
143
+ delete(realm: any, userId: any, options?: O): RestResponse<void>;
144
+ /**
145
+ * HTTP GET /user/{realm}/{clientId}/roles
146
+ * Java method: org.openremote.model.security.UserResource.getClientRoles
147
+ */
148
+ getClientRoles(realm: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
149
+ /**
150
+ * HTTP PUT /user/{realm}/{clientId}/roles
151
+ * Java method: org.openremote.model.security.UserResource.updateClientRoles
152
+ */
153
+ updateClientRoles(realm: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
154
+ /**
155
+ * HTTP GET /user/{realm}/{userId}
156
+ * Java method: org.openremote.model.security.UserResource.get
157
+ */
158
+ get(realm: any, userId: any, options?: O): RestResponse<Model.User>;
159
+ }
160
+ export declare class SyslogResourceClient<O> {
161
+ protected httpClient: HttpClient<O>;
162
+ constructor(httpClient: HttpClient<O>);
163
+ /**
164
+ * HTTP GET /syslog/config
165
+ * Java method: org.openremote.model.syslog.SyslogResource.getConfig
166
+ */
167
+ getConfig(options?: O): RestResponse<Model.SyslogConfig>;
168
+ /**
169
+ * HTTP PUT /syslog/config
170
+ * Java method: org.openremote.model.syslog.SyslogResource.updateConfig
171
+ */
172
+ updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
173
+ /**
174
+ * HTTP DELETE /syslog/event
175
+ * Java method: org.openremote.model.syslog.SyslogResource.clearEvents
176
+ */
177
+ clearEvents(options?: O): RestResponse<void>;
178
+ /**
179
+ * HTTP GET /syslog/event
180
+ * Java method: org.openremote.model.syslog.SyslogResource.getEvents
181
+ */
182
+ getEvents(queryParams?: {
183
+ level?: Model.SyslogLevel;
184
+ per_page?: any;
185
+ page?: any;
186
+ from?: any;
187
+ to?: any;
188
+ category?: Model.SyslogCategory[];
189
+ subCategory?: any[];
190
+ }, options?: O): RestResponse<any>;
191
+ }
192
+ export declare class ProvisioningResourceClient<O> {
193
+ protected httpClient: HttpClient<O>;
194
+ constructor(httpClient: HttpClient<O>);
195
+ /**
196
+ * HTTP POST /provisioning
197
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
198
+ */
199
+ createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
200
+ /**
201
+ * HTTP GET /provisioning
202
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
203
+ */
204
+ getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
205
+ /**
206
+ * HTTP DELETE /provisioning/{id}
207
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
208
+ */
209
+ deleteProvisioningConfig(id: any, options?: O): RestResponse<void>;
210
+ /**
211
+ * HTTP PUT /provisioning/{id}
212
+ * Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
213
+ */
214
+ updateProvisioningConfig(id: any, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
215
+ }
216
+ export declare class AssetModelResourceClient<O> {
217
+ protected httpClient: HttpClient<O>;
218
+ constructor(httpClient: HttpClient<O>);
219
+ /**
220
+ * HTTP GET /model/assetDescriptors
221
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
222
+ */
223
+ getAssetDescriptors(queryParams?: {
224
+ parentId?: any;
225
+ parentType?: any;
226
+ }, options?: O): RestResponse<Model.AssetDescriptor[]>;
227
+ /**
228
+ * HTTP GET /model/assetInfo/{assetType}
229
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
230
+ */
231
+ getAssetInfo(assetType: any, queryParams?: {
232
+ parentId?: any;
233
+ }, options?: O): RestResponse<Model.AssetTypeInfo>;
234
+ /**
235
+ * HTTP GET /model/assetInfos
236
+ * Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
237
+ */
238
+ getAssetInfos(queryParams?: {
239
+ parentId?: any;
240
+ parentType?: any;
241
+ }, options?: O): RestResponse<Model.AssetTypeInfo[]>;
242
+ /**
243
+ * HTTP GET /model/metaItemDescriptors
244
+ * Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
245
+ */
246
+ getMetaItemDescriptors(queryParams?: {
247
+ parentId?: any;
248
+ }, options?: O): RestResponse<{
249
+ [index: string]: Model.MetaItemDescriptor;
250
+ }>;
251
+ /**
252
+ * HTTP GET /model/valueDescriptors
253
+ * Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
254
+ */
255
+ getValueDescriptors(queryParams?: {
256
+ parentId?: any;
257
+ }, options?: O): RestResponse<{
258
+ [index: string]: Model.ValueDescriptor;
259
+ }>;
260
+ }
261
+ export declare class NotificationResourceClient<O> {
262
+ protected httpClient: HttpClient<O>;
263
+ constructor(httpClient: HttpClient<O>);
264
+ /**
265
+ * HTTP GET /notification
266
+ * Java method: org.openremote.model.notification.NotificationResource.getNotifications
267
+ */
268
+ getNotifications(queryParams?: {
269
+ id?: any;
270
+ type?: any;
271
+ from?: any;
272
+ to?: any;
273
+ realmId?: any;
274
+ userId?: any;
275
+ assetId?: any;
276
+ }, options?: O): RestResponse<Model.SentNotification[]>;
277
+ /**
278
+ * HTTP DELETE /notification
279
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotifications
280
+ */
281
+ removeNotifications(queryParams?: {
282
+ id?: any;
283
+ type?: any;
284
+ from?: any;
285
+ to?: any;
286
+ realmId?: any;
287
+ userId?: any;
288
+ assetId?: any;
289
+ }, options?: O): RestResponse<void>;
290
+ /**
291
+ * HTTP POST /notification/alert
292
+ * Java method: org.openremote.model.notification.NotificationResource.sendNotification
293
+ */
294
+ sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
295
+ /**
296
+ * HTTP DELETE /notification/{notificationId}
297
+ * Java method: org.openremote.model.notification.NotificationResource.removeNotification
298
+ */
299
+ removeNotification(notificationId: any, options?: O): RestResponse<void>;
300
+ /**
301
+ * HTTP PUT /notification/{notificationId}/acknowledged
302
+ * Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
303
+ */
304
+ notificationAcknowledged(notificationId: any, acknowledgement: any, queryParams?: {
305
+ targetId?: any;
306
+ }, options?: O): RestResponse<void>;
307
+ /**
308
+ * HTTP PUT /notification/{notificationId}/delivered
309
+ * Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
310
+ */
311
+ notificationDelivered(notificationId: any, queryParams?: {
312
+ targetId?: any;
313
+ }, options?: O): RestResponse<void>;
314
+ }
315
+ export declare class GatewayClientResourceClient<O> {
316
+ protected httpClient: HttpClient<O>;
317
+ constructor(httpClient: HttpClient<O>);
318
+ /**
319
+ * HTTP DELETE /gateway/connection
320
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
321
+ */
322
+ deleteConnections(queryParams?: {
323
+ realm?: any[];
324
+ }, options?: O): RestResponse<void>;
325
+ /**
326
+ * HTTP GET /gateway/connection
327
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
328
+ */
329
+ getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
330
+ /**
331
+ * HTTP DELETE /gateway/connection/{realm}
332
+ * Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
333
+ */
334
+ deleteConnection(realm: any, options?: O): RestResponse<void>;
335
+ /**
336
+ * HTTP GET /gateway/connection/{realm}
337
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
338
+ */
339
+ getConnection(realm: any, options?: O): RestResponse<Model.GatewayConnection>;
340
+ /**
341
+ * HTTP PUT /gateway/connection/{realm}
342
+ * Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
343
+ */
344
+ setConnection(realm: any, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
345
+ /**
346
+ * HTTP GET /gateway/status/{realm}
347
+ * Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
348
+ */
349
+ getConnectionStatus(realm: any, options?: O): RestResponse<Model.ConnectionStatus>;
350
+ }
351
+ export declare class AssetDatapointResourceClient<O> {
352
+ protected httpClient: HttpClient<O>;
353
+ constructor(httpClient: HttpClient<O>);
354
+ /**
355
+ * HTTP GET /asset/datapoint/export
356
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
357
+ */
358
+ getDatapointExport(queryParams?: {
359
+ attributeRefs?: any;
360
+ fromTimestamp?: number;
361
+ toTimestamp?: number;
362
+ }, options?: O): RestResponse<any>;
363
+ /**
364
+ * HTTP GET /asset/datapoint/periods
365
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
366
+ */
367
+ getDatapointPeriod(queryParams?: {
368
+ assetId?: any;
369
+ attributeName?: any;
370
+ }, options?: O): RestResponse<Model.DatapointPeriod>;
371
+ /**
372
+ * HTTP POST /asset/datapoint/{assetId}/{attributeName}
373
+ * Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
374
+ */
375
+ getDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
376
+ }
377
+ export declare class AssetResourceClient<O> {
378
+ protected httpClient: HttpClient<O>;
379
+ constructor(httpClient: HttpClient<O>);
380
+ /**
381
+ * HTTP POST /asset
382
+ * Java method: org.openremote.model.asset.AssetResource.create
383
+ */
384
+ create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
385
+ /**
386
+ * HTTP DELETE /asset
387
+ * Java method: org.openremote.model.asset.AssetResource.delete
388
+ */
389
+ delete(queryParams?: {
390
+ assetId?: any[];
391
+ }, options?: O): RestResponse<void>;
392
+ /**
393
+ * HTTP PUT /asset/attributes
394
+ * Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
395
+ */
396
+ writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
397
+ /**
398
+ * HTTP DELETE /asset/parent
399
+ * Java method: org.openremote.model.asset.AssetResource.updateNoneParent
400
+ */
401
+ updateNoneParent(queryParams?: {
402
+ assetIds?: any[];
403
+ }, options?: O): RestResponse<void>;
404
+ /**
405
+ * HTTP GET /asset/partial/{assetId}
406
+ * Java method: org.openremote.model.asset.AssetResource.getPartial
407
+ */
408
+ getPartial(assetId: any, options?: O): RestResponse<Model.Asset>;
409
+ /**
410
+ * HTTP POST /asset/query
411
+ * Java method: org.openremote.model.asset.AssetResource.queryAssets
412
+ */
413
+ queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
414
+ /**
415
+ * HTTP GET /asset/user/current
416
+ * Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
417
+ */
418
+ getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
419
+ /**
420
+ * HTTP POST /asset/user/link
421
+ * Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
422
+ */
423
+ createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
424
+ /**
425
+ * HTTP GET /asset/user/link
426
+ * Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
427
+ */
428
+ getUserAssetLinks(queryParams?: {
429
+ realm?: any;
430
+ userId?: any;
431
+ assetId?: any;
432
+ }, options?: O): RestResponse<Model.UserAssetLink[]>;
433
+ /**
434
+ * HTTP POST /asset/user/link/delete
435
+ * Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
436
+ */
437
+ deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
438
+ /**
439
+ * HTTP DELETE /asset/user/link/{realm}/{userId}
440
+ * Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
441
+ */
442
+ deleteAllUserAssetLinks(realm: any, userId: any, options?: O): RestResponse<void>;
443
+ /**
444
+ * HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
445
+ * Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
446
+ */
447
+ deleteUserAssetLink(realm: any, userId: any, assetId: any, options?: O): RestResponse<void>;
448
+ /**
449
+ * HTTP GET /asset/{assetId}
450
+ * Java method: org.openremote.model.asset.AssetResource.get
451
+ */
452
+ get(assetId: any, options?: O): RestResponse<Model.Asset>;
453
+ /**
454
+ * HTTP PUT /asset/{assetId}
455
+ * Java method: org.openremote.model.asset.AssetResource.update
456
+ */
457
+ update(assetId: any, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
458
+ /**
459
+ * Write to a single attribute
460
+ * HTTP PUT /asset/{assetId}/attribute/{attributeName}
461
+ * Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
462
+ */
463
+ writeAttributeValue(assetId: any, attributeName: any, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
464
+ /**
465
+ * HTTP PUT /asset/{parentAssetId}/child
466
+ * Java method: org.openremote.model.asset.AssetResource.updateParent
467
+ */
468
+ updateParent(parentAssetId: any, queryParams?: {
469
+ assetIds?: any[];
470
+ }, options?: O): RestResponse<void>;
471
+ }
472
+ export declare class AppResourceClient<O> {
473
+ protected httpClient: HttpClient<O>;
474
+ constructor(httpClient: HttpClient<O>);
475
+ /**
476
+ * HTTP GET /apps
477
+ * Java method: org.openremote.model.apps.AppResource.getApps
478
+ */
479
+ getApps(options?: O): RestResponse<any[]>;
480
+ /**
481
+ * HTTP GET /apps/consoleConfig
482
+ * Java method: org.openremote.model.apps.AppResource.getConsoleConfig
483
+ */
484
+ getConsoleConfig(options?: O): RestResponse<any>;
485
+ /**
486
+ * HTTP GET /apps/info
487
+ * Java method: org.openremote.model.apps.AppResource.getAppInfos
488
+ */
489
+ getAppInfos(options?: O): RestResponse<any>;
490
+ }
491
+ export declare class MapResourceClient<O> {
492
+ protected httpClient: HttpClient<O>;
493
+ constructor(httpClient: HttpClient<O>);
494
+ /**
495
+ * HTTP GET /map
496
+ * Java method: org.openremote.model.map.MapResource.getSettings
497
+ */
498
+ getSettings(options?: O): RestResponse<{
499
+ [id: string]: any;
500
+ }>;
501
+ /**
502
+ * HTTP PUT /map
503
+ * Java method: org.openremote.model.map.MapResource.saveSettings
504
+ */
505
+ saveSettings(mapConfig: {
506
+ [index: string]: Model.MapRealmConfig;
507
+ }, options?: O): RestResponse<any>;
508
+ /**
509
+ * HTTP GET /map/js
510
+ * Java method: org.openremote.model.map.MapResource.getSettingsJs
511
+ */
512
+ getSettingsJs(options?: O): RestResponse<{
513
+ [id: string]: any;
514
+ }>;
515
+ /**
516
+ * HTTP GET /map/tile/{zoom}/{column}/{row}
517
+ * Java method: org.openremote.model.map.MapResource.getTile
518
+ */
519
+ getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
520
+ }
521
+ export declare class ConsoleResourceClient<O> {
522
+ protected httpClient: HttpClient<O>;
523
+ constructor(httpClient: HttpClient<O>);
524
+ /**
525
+ * HTTP POST /console/register
526
+ * Java method: org.openremote.model.console.ConsoleResource.register
527
+ */
528
+ register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
529
+ }
530
+ export declare class StatusResourceClient<O> {
531
+ protected httpClient: HttpClient<O>;
532
+ constructor(httpClient: HttpClient<O>);
533
+ /**
534
+ * HTTP GET /health
535
+ * Java method: org.openremote.model.system.StatusResource.getHealthStatus
536
+ */
537
+ getHealthStatus(options?: O): RestResponse<{
538
+ [index: string]: any;
539
+ }>;
540
+ /**
541
+ * HTTP GET /info
542
+ * Java method: org.openremote.model.system.StatusResource.getInfo
543
+ */
544
+ getInfo(options?: O): RestResponse<{
545
+ [index: string]: any;
546
+ }>;
547
+ }
548
+ export declare class RealmResourceClient<O> {
549
+ protected httpClient: HttpClient<O>;
550
+ constructor(httpClient: HttpClient<O>);
551
+ /**
552
+ * HTTP POST /realm
553
+ * Java method: org.openremote.model.security.RealmResource.create
554
+ */
555
+ create(realm: Model.Realm, options?: O): RestResponse<void>;
556
+ /**
557
+ * HTTP GET /realm
558
+ * Java method: org.openremote.model.security.RealmResource.getAll
559
+ */
560
+ getAll(options?: O): RestResponse<Model.Realm[]>;
561
+ /**
562
+ * HTTP GET /realm/accessible
563
+ * Java method: org.openremote.model.security.RealmResource.getAccessible
564
+ */
565
+ getAccessible(options?: O): RestResponse<Model.Realm[]>;
566
+ /**
567
+ * HTTP DELETE /realm/{name}
568
+ * Java method: org.openremote.model.security.RealmResource.delete
569
+ */
570
+ delete(name: any, options?: O): RestResponse<void>;
571
+ /**
572
+ * HTTP GET /realm/{name}
573
+ * Java method: org.openremote.model.security.RealmResource.get
574
+ */
575
+ get(name: any, options?: O): RestResponse<Model.Realm>;
576
+ /**
577
+ * HTTP PUT /realm/{name}
578
+ * Java method: org.openremote.model.security.RealmResource.update
579
+ */
580
+ update(name: any, realm: Model.Realm, options?: O): RestResponse<void>;
581
+ }
582
+ export declare class FlowResourceClient<O> {
583
+ protected httpClient: HttpClient<O>;
584
+ constructor(httpClient: HttpClient<O>);
585
+ /**
586
+ * HTTP GET /flow
587
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
588
+ */
589
+ getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
590
+ /**
591
+ * HTTP GET /flow/{name}
592
+ * Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
593
+ */
594
+ getNodeDefinition(name: any, options?: O): RestResponse<Model.Node>;
595
+ /**
596
+ * HTTP GET /flow/{type}
597
+ * Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
598
+ */
599
+ getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
600
+ }
601
+ export declare class AssetPredictedDatapointResourceClient<O> {
602
+ protected httpClient: HttpClient<O>;
603
+ constructor(httpClient: HttpClient<O>);
604
+ /**
605
+ * HTTP POST /asset/predicted/{assetId}/{attributeName}
606
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
607
+ */
608
+ getPredictedDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
609
+ /**
610
+ * HTTP PUT /asset/predicted/{assetId}/{attributeName}
611
+ * Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
612
+ */
613
+ writePredictedDatapoints(assetId: any, attributeName: any, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
614
+ }
615
+ export declare class ConfigurationResourceClient<O> {
616
+ protected httpClient: HttpClient<O>;
617
+ constructor(httpClient: HttpClient<O>);
618
+ /**
619
+ * HTTP PUT /configuration/manager
620
+ * Java method: org.openremote.model.manager.ConfigurationResource.update
621
+ */
622
+ update(managerConfiguration: any, options?: O): RestResponse<any>;
623
+ /**
624
+ * HTTP POST /configuration/manager/file
625
+ * Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
626
+ */
627
+ fileUpload(fileInfo: Model.FileInfo, queryParams?: {
628
+ path?: any;
629
+ }, options?: O): RestResponse<any>;
630
+ }
631
+ export declare class AgentResourceClient<O> {
632
+ protected httpClient: HttpClient<O>;
633
+ constructor(httpClient: HttpClient<O>);
634
+ /**
635
+ * HTTP GET /agent/assetDiscovery/{agentId}
636
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
637
+ */
638
+ doProtocolAssetDiscovery(agentId: any, queryParams?: {
639
+ realm?: any;
640
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
641
+ /**
642
+ * HTTP POST /agent/assetImport/{agentId}
643
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
644
+ */
645
+ doProtocolAssetImport(agentId: any, fileInfo: Model.FileInfo, queryParams?: {
646
+ realm?: any;
647
+ }, options?: O): RestResponse<Model.AssetTreeNode[]>;
648
+ /**
649
+ * HTTP GET /agent/instanceDiscovery/{agentType}
650
+ * Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
651
+ */
652
+ doProtocolInstanceDiscovery(agentType: any, queryParams?: {
653
+ parentId?: any;
654
+ realm?: any;
655
+ }, options?: O): RestResponse<Model.Agent[]>;
656
+ }
657
+ export declare class RulesResourceClient<O> {
658
+ protected httpClient: HttpClient<O>;
659
+ constructor(httpClient: HttpClient<O>);
660
+ /**
661
+ * HTTP POST /rules
662
+ * Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
663
+ */
664
+ createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
665
+ /**
666
+ * HTTP GET /rules
667
+ * Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
668
+ */
669
+ getGlobalRulesets(queryParams?: {
670
+ language?: Model.RulesetLang[];
671
+ fullyPopulate?: boolean;
672
+ }, options?: O): RestResponse<Model.GlobalRuleset[]>;
673
+ /**
674
+ * HTTP POST /rules/asset
675
+ * Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
676
+ */
677
+ createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
678
+ /**
679
+ * HTTP GET /rules/asset/for/{assetId}
680
+ * Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
681
+ */
682
+ getAssetRulesets(assetId: any, queryParams?: {
683
+ language?: Model.RulesetLang[];
684
+ fullyPopulate?: boolean;
685
+ }, options?: O): RestResponse<Model.AssetRuleset[]>;
686
+ /**
687
+ * HTTP DELETE /rules/asset/{id}
688
+ * Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
689
+ */
690
+ deleteAssetRuleset(id: any, options?: O): RestResponse<void>;
691
+ /**
692
+ * HTTP GET /rules/asset/{id}
693
+ * Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
694
+ */
695
+ getAssetRuleset(id: any, options?: O): RestResponse<Model.AssetRuleset>;
696
+ /**
697
+ * HTTP PUT /rules/asset/{id}
698
+ * Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
699
+ */
700
+ updateAssetRuleset(id: any, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
701
+ /**
702
+ * HTTP GET /rules/geofences/{assetId}
703
+ * Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
704
+ */
705
+ getAssetGeofences(assetId: any, options?: O): RestResponse<Model.GeofenceDefinition[]>;
706
+ /**
707
+ * HTTP GET /rules/info/asset/{assetId}
708
+ * Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
709
+ */
710
+ getAssetEngineInfo(assetId: any, options?: O): RestResponse<Model.RulesEngineInfo>;
711
+ /**
712
+ * HTTP GET /rules/info/global
713
+ * Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
714
+ */
715
+ getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
716
+ /**
717
+ * HTTP GET /rules/info/realm/{realm}
718
+ * Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
719
+ */
720
+ getRealmEngineInfo(realm: any, options?: O): RestResponse<Model.RulesEngineInfo>;
721
+ /**
722
+ * HTTP POST /rules/realm
723
+ * Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
724
+ */
725
+ createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
726
+ /**
727
+ * HTTP GET /rules/realm/for/{realm}
728
+ * Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
729
+ */
730
+ getRealmRulesets(realm: any, queryParams?: {
731
+ language?: Model.RulesetLang[];
732
+ fullyPopulate?: boolean;
733
+ }, options?: O): RestResponse<Model.RealmRuleset[]>;
734
+ /**
735
+ * HTTP DELETE /rules/realm/{id}
736
+ * Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
737
+ */
738
+ deleteRealmRuleset(id: any, options?: O): RestResponse<void>;
739
+ /**
740
+ * HTTP GET /rules/realm/{id}
741
+ * Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
742
+ */
743
+ getRealmRuleset(id: any, options?: O): RestResponse<Model.RealmRuleset>;
744
+ /**
745
+ * HTTP PUT /rules/realm/{id}
746
+ * Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
747
+ */
748
+ updateRealmRuleset(id: any, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
749
+ /**
750
+ * HTTP DELETE /rules/{id}
751
+ * Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
752
+ */
753
+ deleteGlobalRuleset(id: any, options?: O): RestResponse<void>;
754
+ /**
755
+ * HTTP GET /rules/{id}
756
+ * Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
757
+ */
758
+ getGlobalRuleset(id: any, options?: O): RestResponse<Model.GlobalRuleset>;
759
+ /**
760
+ * HTTP PUT /rules/{id}
761
+ * Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
762
+ */
763
+ updateGlobalRuleset(id: any, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
764
+ }
765
+ export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
766
+ export declare class ApiClient {
767
+ protected _dashboardResource: AxiosDashboardResourceClient;
768
+ protected _userResource: AxiosUserResourceClient;
769
+ protected _syslogResource: AxiosSyslogResourceClient;
770
+ protected _provisioningResource: AxiosProvisioningResourceClient;
771
+ protected _assetModelResource: AxiosAssetModelResourceClient;
772
+ protected _notificationResource: AxiosNotificationResourceClient;
773
+ protected _gatewayClientResource: AxiosGatewayClientResourceClient;
774
+ protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
775
+ protected _assetResource: AxiosAssetResourceClient;
776
+ protected _appResource: AxiosAppResourceClient;
777
+ protected _mapResource: AxiosMapResourceClient;
778
+ protected _consoleResource: AxiosConsoleResourceClient;
779
+ protected _statusResource: AxiosStatusResourceClient;
780
+ protected _realmResource: AxiosRealmResourceClient;
781
+ protected _flowResource: AxiosFlowResourceClient;
782
+ protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
783
+ protected _configurationResource: AxiosConfigurationResourceClient;
784
+ protected _agentResource: AxiosAgentResourceClient;
785
+ protected _rulesResource: AxiosRulesResourceClient;
786
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
787
+ get DashboardResource(): AxiosDashboardResourceClient;
788
+ get UserResource(): AxiosUserResourceClient;
789
+ get SyslogResource(): AxiosSyslogResourceClient;
790
+ get ProvisioningResource(): AxiosProvisioningResourceClient;
791
+ get AssetModelResource(): AxiosAssetModelResourceClient;
792
+ get NotificationResource(): AxiosNotificationResourceClient;
793
+ get GatewayClientResource(): AxiosGatewayClientResourceClient;
794
+ get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
795
+ get AssetResource(): AxiosAssetResourceClient;
796
+ get AppResource(): AxiosAppResourceClient;
797
+ get MapResource(): AxiosMapResourceClient;
798
+ get ConsoleResource(): AxiosConsoleResourceClient;
799
+ get StatusResource(): AxiosStatusResourceClient;
800
+ get RealmResource(): AxiosRealmResourceClient;
801
+ get FlowResource(): AxiosFlowResourceClient;
802
+ get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
803
+ get ConfigurationResource(): AxiosConfigurationResourceClient;
804
+ get AgentResource(): AxiosAgentResourceClient;
805
+ get RulesResource(): AxiosRulesResourceClient;
806
+ }
807
+ import * as Axios from "axios";
808
+ declare module "axios" {
809
+ interface GenericAxiosResponse<R> extends Axios.AxiosResponse {
810
+ data: R;
811
+ }
812
+ }
813
+ export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
814
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
815
+ }
816
+ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
817
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
818
+ }
819
+ export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
820
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
821
+ }
822
+ export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
823
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
824
+ }
825
+ export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
826
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
827
+ }
828
+ export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
829
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
830
+ }
831
+ export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
832
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
833
+ }
834
+ export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
835
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
836
+ }
837
+ export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
838
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
839
+ }
840
+ export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
841
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
842
+ }
843
+ export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
844
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
845
+ }
846
+ export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
847
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
848
+ }
849
+ export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
850
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
851
+ }
852
+ export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
853
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
854
+ }
855
+ export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
856
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
857
+ }
858
+ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
859
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
860
+ }
861
+ export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
862
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
863
+ }
864
+ export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
865
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
866
+ }
867
+ export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
868
+ constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
869
+ }