@openremote/rest 1.0.2 → 1.2.0-snapshot.20240512154942

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