@openremote/rest 1.8.0 → 1.9.0-snapshot.20250825142142
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +471 -471
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,198 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP POST /gateway/tunnel
|
|
17
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
18
|
-
*/
|
|
19
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP DELETE /gateway/tunnel
|
|
22
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
23
|
-
*/
|
|
24
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
27
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
28
|
-
*/
|
|
29
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
30
|
-
/**
|
|
31
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
32
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
33
|
-
*/
|
|
34
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
35
|
-
/**
|
|
36
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
37
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
38
|
-
*/
|
|
39
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
40
|
-
}
|
|
41
|
-
export declare class ProvisioningResourceClient<O> {
|
|
42
|
-
protected httpClient: HttpClient<O>;
|
|
43
|
-
constructor(httpClient: HttpClient<O>);
|
|
44
|
-
/**
|
|
45
|
-
* HTTP POST /provisioning
|
|
46
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
47
|
-
*/
|
|
48
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
49
|
-
/**
|
|
50
|
-
* HTTP GET /provisioning
|
|
51
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
52
|
-
*/
|
|
53
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
54
|
-
/**
|
|
55
|
-
* HTTP DELETE /provisioning/{id}
|
|
56
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
57
|
-
*/
|
|
58
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
59
|
-
/**
|
|
60
|
-
* HTTP PUT /provisioning/{id}
|
|
61
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
62
|
-
*/
|
|
63
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
64
|
-
}
|
|
65
|
-
export declare class SyslogResourceClient<O> {
|
|
66
|
-
protected httpClient: HttpClient<O>;
|
|
67
|
-
constructor(httpClient: HttpClient<O>);
|
|
68
|
-
/**
|
|
69
|
-
* HTTP GET /syslog/config
|
|
70
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
71
|
-
*/
|
|
72
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
73
|
-
/**
|
|
74
|
-
* HTTP PUT /syslog/config
|
|
75
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
76
|
-
*/
|
|
77
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
78
|
-
/**
|
|
79
|
-
* HTTP DELETE /syslog/event
|
|
80
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
81
|
-
*/
|
|
82
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
83
|
-
/**
|
|
84
|
-
* HTTP GET /syslog/event
|
|
85
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
86
|
-
*/
|
|
87
|
-
getEvents(queryParams?: {
|
|
88
|
-
level?: Model.SyslogLevel;
|
|
89
|
-
per_page?: number;
|
|
90
|
-
page?: number;
|
|
91
|
-
from?: number;
|
|
92
|
-
to?: number;
|
|
93
|
-
category?: Model.SyslogCategory[];
|
|
94
|
-
subCategory?: string[];
|
|
95
|
-
}, options?: O): RestResponse<any>;
|
|
96
|
-
}
|
|
97
|
-
export declare class ConsoleResourceClient<O> {
|
|
98
|
-
protected httpClient: HttpClient<O>;
|
|
99
|
-
constructor(httpClient: HttpClient<O>);
|
|
100
|
-
/**
|
|
101
|
-
* HTTP POST /console/register
|
|
102
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
103
|
-
*/
|
|
104
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
105
|
-
}
|
|
106
|
-
export declare class AgentResourceClient<O> {
|
|
107
|
-
protected httpClient: HttpClient<O>;
|
|
108
|
-
constructor(httpClient: HttpClient<O>);
|
|
109
|
-
/**
|
|
110
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
111
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
112
|
-
*/
|
|
113
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
114
|
-
realm?: string;
|
|
115
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
116
|
-
/**
|
|
117
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
118
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
119
|
-
*/
|
|
120
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
121
|
-
realm?: string;
|
|
122
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
123
|
-
/**
|
|
124
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
125
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
126
|
-
*/
|
|
127
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
128
|
-
parentId?: string;
|
|
129
|
-
realm?: string;
|
|
130
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
131
|
-
}
|
|
132
|
-
export declare class AlarmResourceClient<O> {
|
|
133
|
-
protected httpClient: HttpClient<O>;
|
|
134
|
-
constructor(httpClient: HttpClient<O>);
|
|
135
|
-
/**
|
|
136
|
-
* HTTP POST /alarm
|
|
137
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
138
|
-
*/
|
|
139
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
140
|
-
assetIds?: string[];
|
|
141
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
142
|
-
/**
|
|
143
|
-
* HTTP GET /alarm
|
|
144
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
145
|
-
*/
|
|
146
|
-
getAlarms(queryParams?: {
|
|
147
|
-
realm?: string;
|
|
148
|
-
status?: Model.AlarmStatus;
|
|
149
|
-
assetId?: string;
|
|
150
|
-
assigneeId?: string;
|
|
151
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
152
|
-
/**
|
|
153
|
-
* HTTP DELETE /alarm
|
|
154
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
155
|
-
*/
|
|
156
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
157
|
-
/**
|
|
158
|
-
* HTTP PUT /alarm/assets
|
|
159
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
160
|
-
*/
|
|
161
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
162
|
-
/**
|
|
163
|
-
* HTTP GET /alarm/{alarmId}
|
|
164
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
165
|
-
*/
|
|
166
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
167
|
-
/**
|
|
168
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
169
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
170
|
-
*/
|
|
171
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
172
|
-
/**
|
|
173
|
-
* HTTP PUT /alarm/{alarmId}
|
|
174
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
175
|
-
*/
|
|
176
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
177
|
-
/**
|
|
178
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
179
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
180
|
-
*/
|
|
181
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
182
|
-
realm?: string;
|
|
183
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
184
|
-
}
|
|
185
|
-
export declare class FlowResourceClient<O> {
|
|
186
|
-
protected httpClient: HttpClient<O>;
|
|
187
|
-
constructor(httpClient: HttpClient<O>);
|
|
188
|
-
/**
|
|
189
|
-
* HTTP GET /flow
|
|
190
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
191
|
-
*/
|
|
192
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
193
|
-
/**
|
|
194
|
-
* HTTP GET /flow/{name}
|
|
195
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
196
|
-
*/
|
|
197
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
198
|
-
/**
|
|
199
|
-
* HTTP GET /flow/{type}
|
|
200
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
201
|
-
*/
|
|
202
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
203
|
-
}
|
|
204
12
|
export declare class RulesResourceClient<O> {
|
|
205
13
|
protected httpClient: HttpClient<O>;
|
|
206
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -309,57 +117,60 @@ export declare class RulesResourceClient<O> {
|
|
|
309
117
|
*/
|
|
310
118
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
311
119
|
}
|
|
312
|
-
export declare class
|
|
120
|
+
export declare class AlarmResourceClient<O> {
|
|
313
121
|
protected httpClient: HttpClient<O>;
|
|
314
122
|
constructor(httpClient: HttpClient<O>);
|
|
315
123
|
/**
|
|
316
|
-
* HTTP
|
|
317
|
-
* Java method: org.openremote.model.
|
|
124
|
+
* HTTP POST /alarm
|
|
125
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
318
126
|
*/
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
}, options?: O): RestResponse<
|
|
127
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
128
|
+
assetIds?: string[];
|
|
129
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
322
130
|
/**
|
|
323
|
-
* HTTP GET /
|
|
324
|
-
* Java method: org.openremote.model.
|
|
131
|
+
* HTTP GET /alarm
|
|
132
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
325
133
|
*/
|
|
326
|
-
|
|
134
|
+
getAlarms(queryParams?: {
|
|
135
|
+
realm?: string;
|
|
136
|
+
status?: Model.AlarmStatus;
|
|
137
|
+
assetId?: string;
|
|
138
|
+
assigneeId?: string;
|
|
139
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
327
140
|
/**
|
|
328
|
-
* HTTP DELETE /
|
|
329
|
-
* Java method: org.openremote.model.
|
|
141
|
+
* HTTP DELETE /alarm
|
|
142
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
330
143
|
*/
|
|
331
|
-
|
|
144
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
332
145
|
/**
|
|
333
|
-
* HTTP
|
|
334
|
-
* Java method: org.openremote.model.
|
|
146
|
+
* HTTP PUT /alarm/assets
|
|
147
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
335
148
|
*/
|
|
336
|
-
|
|
149
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
337
150
|
/**
|
|
338
|
-
* HTTP
|
|
339
|
-
* Java method: org.openremote.model.
|
|
151
|
+
* HTTP GET /alarm/{alarmId}
|
|
152
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
340
153
|
*/
|
|
341
|
-
|
|
154
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
342
155
|
/**
|
|
343
|
-
* HTTP
|
|
344
|
-
* Java method: org.openremote.model.
|
|
156
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
157
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
345
158
|
*/
|
|
346
|
-
|
|
347
|
-
}
|
|
348
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
349
|
-
protected httpClient: HttpClient<O>;
|
|
350
|
-
constructor(httpClient: HttpClient<O>);
|
|
159
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
351
160
|
/**
|
|
352
|
-
* HTTP
|
|
353
|
-
* Java method: org.openremote.model.
|
|
161
|
+
* HTTP PUT /alarm/{alarmId}
|
|
162
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
354
163
|
*/
|
|
355
|
-
|
|
164
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
356
165
|
/**
|
|
357
|
-
* HTTP
|
|
358
|
-
* Java method: org.openremote.model.
|
|
166
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
167
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
359
168
|
*/
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
169
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
170
|
+
realm?: string;
|
|
171
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
172
|
+
}
|
|
173
|
+
export declare class UserResourceClient<O> {
|
|
363
174
|
protected httpClient: HttpClient<O>;
|
|
364
175
|
constructor(httpClient: HttpClient<O>);
|
|
365
176
|
/**
|
|
@@ -517,154 +328,210 @@ export declare class DashboardResourceClient<O> {
|
|
|
517
328
|
*/
|
|
518
329
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
519
330
|
}
|
|
520
|
-
export declare class
|
|
331
|
+
export declare class FlowResourceClient<O> {
|
|
521
332
|
protected httpClient: HttpClient<O>;
|
|
522
333
|
constructor(httpClient: HttpClient<O>);
|
|
523
334
|
/**
|
|
524
|
-
* HTTP
|
|
525
|
-
* Java method: org.openremote.model.
|
|
335
|
+
* HTTP GET /flow
|
|
336
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
526
337
|
*/
|
|
527
|
-
|
|
338
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
528
339
|
/**
|
|
529
|
-
* HTTP
|
|
530
|
-
* Java method: org.openremote.model.
|
|
340
|
+
* HTTP GET /flow/{name}
|
|
341
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
531
342
|
*/
|
|
532
|
-
|
|
533
|
-
assetId?: string[];
|
|
534
|
-
}, options?: O): RestResponse<void>;
|
|
343
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
535
344
|
/**
|
|
536
|
-
* HTTP
|
|
537
|
-
* Java method: org.openremote.model.
|
|
345
|
+
* HTTP GET /flow/{type}
|
|
346
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
538
347
|
*/
|
|
539
|
-
|
|
348
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
349
|
+
}
|
|
350
|
+
export declare class NotificationResourceClient<O> {
|
|
351
|
+
protected httpClient: HttpClient<O>;
|
|
352
|
+
constructor(httpClient: HttpClient<O>);
|
|
540
353
|
/**
|
|
541
|
-
* HTTP
|
|
542
|
-
* Java method: org.openremote.model.
|
|
354
|
+
* HTTP GET /notification
|
|
355
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
543
356
|
*/
|
|
544
|
-
|
|
357
|
+
getNotifications(queryParams?: {
|
|
358
|
+
id?: number;
|
|
359
|
+
type?: string;
|
|
360
|
+
from?: number;
|
|
361
|
+
to?: number;
|
|
362
|
+
realmId?: string;
|
|
363
|
+
userId?: string;
|
|
364
|
+
assetId?: string;
|
|
365
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
545
366
|
/**
|
|
546
|
-
* HTTP DELETE /
|
|
547
|
-
* Java method: org.openremote.model.
|
|
367
|
+
* HTTP DELETE /notification
|
|
368
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
548
369
|
*/
|
|
549
|
-
|
|
550
|
-
|
|
370
|
+
removeNotifications(queryParams?: {
|
|
371
|
+
id?: number;
|
|
372
|
+
type?: string;
|
|
373
|
+
from?: number;
|
|
374
|
+
to?: number;
|
|
375
|
+
realmId?: string;
|
|
376
|
+
userId?: string;
|
|
377
|
+
assetId?: string;
|
|
551
378
|
}, options?: O): RestResponse<void>;
|
|
552
379
|
/**
|
|
553
|
-
* HTTP
|
|
554
|
-
* Java method: org.openremote.model.
|
|
555
|
-
*/
|
|
556
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
557
|
-
/**
|
|
558
|
-
* HTTP POST /asset/query
|
|
559
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
380
|
+
* HTTP POST /notification/alert
|
|
381
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
560
382
|
*/
|
|
561
|
-
|
|
383
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
562
384
|
/**
|
|
563
|
-
* HTTP
|
|
564
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP DELETE /notification/{notificationId}
|
|
386
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
565
387
|
*/
|
|
566
|
-
|
|
388
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
567
389
|
/**
|
|
568
|
-
* HTTP
|
|
569
|
-
* Java method: org.openremote.model.
|
|
390
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
391
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
570
392
|
*/
|
|
571
|
-
|
|
393
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
394
|
+
targetId?: string;
|
|
395
|
+
}, options?: O): RestResponse<void>;
|
|
572
396
|
/**
|
|
573
|
-
* HTTP
|
|
574
|
-
* Java method: org.openremote.model.
|
|
397
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
398
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
575
399
|
*/
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
400
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
401
|
+
targetId?: string;
|
|
402
|
+
}, options?: O): RestResponse<void>;
|
|
403
|
+
}
|
|
404
|
+
export declare class ConfigurationResourceClient<O> {
|
|
405
|
+
protected httpClient: HttpClient<O>;
|
|
406
|
+
constructor(httpClient: HttpClient<O>);
|
|
581
407
|
/**
|
|
582
|
-
* HTTP
|
|
583
|
-
* Java method: org.openremote.model.
|
|
408
|
+
* HTTP GET /configuration/manager
|
|
409
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
584
410
|
*/
|
|
585
|
-
|
|
411
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
586
412
|
/**
|
|
587
|
-
* HTTP
|
|
588
|
-
* Java method: org.openremote.model.
|
|
413
|
+
* HTTP PUT /configuration/manager
|
|
414
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
589
415
|
*/
|
|
590
|
-
|
|
416
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
591
417
|
/**
|
|
592
|
-
* HTTP
|
|
593
|
-
* Java method: org.openremote.model.
|
|
418
|
+
* HTTP POST /configuration/manager/file
|
|
419
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
594
420
|
*/
|
|
595
|
-
|
|
421
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
422
|
+
path?: string;
|
|
423
|
+
}, options?: O): RestResponse<string>;
|
|
596
424
|
/**
|
|
597
|
-
* HTTP GET /
|
|
598
|
-
* Java method: org.openremote.model.
|
|
425
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
426
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
599
427
|
*/
|
|
600
|
-
|
|
428
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
429
|
+
}
|
|
430
|
+
export declare class ProvisioningResourceClient<O> {
|
|
431
|
+
protected httpClient: HttpClient<O>;
|
|
432
|
+
constructor(httpClient: HttpClient<O>);
|
|
601
433
|
/**
|
|
602
|
-
* HTTP
|
|
603
|
-
* Java method: org.openremote.model.
|
|
434
|
+
* HTTP POST /provisioning
|
|
435
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
604
436
|
*/
|
|
605
|
-
|
|
437
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
606
438
|
/**
|
|
607
|
-
* HTTP
|
|
608
|
-
* Java method: org.openremote.model.
|
|
439
|
+
* HTTP GET /provisioning
|
|
440
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
609
441
|
*/
|
|
610
|
-
|
|
442
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
611
443
|
/**
|
|
612
|
-
* HTTP
|
|
613
|
-
* Java method: org.openremote.model.
|
|
444
|
+
* HTTP DELETE /provisioning/{id}
|
|
445
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
614
446
|
*/
|
|
615
|
-
|
|
447
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
616
448
|
/**
|
|
617
|
-
* HTTP PUT /
|
|
618
|
-
* Java method: org.openremote.model.
|
|
449
|
+
* HTTP PUT /provisioning/{id}
|
|
450
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
619
451
|
*/
|
|
620
|
-
|
|
621
|
-
assetIds?: string[];
|
|
622
|
-
}, options?: O): RestResponse<void>;
|
|
452
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
623
453
|
}
|
|
624
|
-
export declare class
|
|
454
|
+
export declare class MapResourceClient<O> {
|
|
625
455
|
protected httpClient: HttpClient<O>;
|
|
626
456
|
constructor(httpClient: HttpClient<O>);
|
|
627
457
|
/**
|
|
628
|
-
* HTTP GET /
|
|
629
|
-
* Java method: org.openremote.model.
|
|
458
|
+
* HTTP GET /map
|
|
459
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
630
460
|
*/
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
toTimestamp?: number;
|
|
635
|
-
}, options?: O): RestResponse<any>;
|
|
461
|
+
getSettings(options?: O): RestResponse<{
|
|
462
|
+
[id: string]: unknown;
|
|
463
|
+
}>;
|
|
636
464
|
/**
|
|
637
|
-
* HTTP
|
|
638
|
-
* Java method: org.openremote.model.
|
|
465
|
+
* HTTP PUT /map
|
|
466
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
639
467
|
*/
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
468
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
469
|
+
[id: string]: unknown;
|
|
470
|
+
}>;
|
|
644
471
|
/**
|
|
645
|
-
* HTTP
|
|
646
|
-
* Java method: org.openremote.model.
|
|
472
|
+
* HTTP DELETE /map/deleteMap
|
|
473
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
647
474
|
*/
|
|
648
|
-
|
|
475
|
+
deleteMap(options?: O): RestResponse<{
|
|
476
|
+
[id: string]: unknown;
|
|
477
|
+
}>;
|
|
478
|
+
/**
|
|
479
|
+
* HTTP GET /map/getCustomMapInfo
|
|
480
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
481
|
+
*/
|
|
482
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
483
|
+
[id: string]: unknown;
|
|
484
|
+
}>;
|
|
485
|
+
/**
|
|
486
|
+
* HTTP GET /map/js
|
|
487
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
488
|
+
*/
|
|
489
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
490
|
+
[id: string]: unknown;
|
|
491
|
+
}>;
|
|
492
|
+
/**
|
|
493
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
494
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
495
|
+
*/
|
|
496
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
497
|
+
/**
|
|
498
|
+
* HTTP POST /map/upload
|
|
499
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
500
|
+
*/
|
|
501
|
+
uploadMap(queryParams?: {
|
|
502
|
+
filename?: string;
|
|
503
|
+
}, options?: O): RestResponse<{
|
|
504
|
+
[id: string]: unknown;
|
|
505
|
+
}>;
|
|
649
506
|
}
|
|
650
|
-
export declare class
|
|
507
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
651
508
|
protected httpClient: HttpClient<O>;
|
|
652
509
|
constructor(httpClient: HttpClient<O>);
|
|
653
510
|
/**
|
|
654
|
-
* HTTP
|
|
655
|
-
* Java method: org.openremote.model.
|
|
511
|
+
* HTTP POST /gateway/tunnel
|
|
512
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
656
513
|
*/
|
|
657
|
-
|
|
514
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
658
515
|
/**
|
|
659
|
-
* HTTP
|
|
660
|
-
* Java method: org.openremote.model.
|
|
516
|
+
* HTTP DELETE /gateway/tunnel
|
|
517
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
661
518
|
*/
|
|
662
|
-
|
|
519
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
663
520
|
/**
|
|
664
|
-
* HTTP GET /
|
|
665
|
-
* Java method: org.openremote.model.
|
|
521
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
522
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
666
523
|
*/
|
|
667
|
-
|
|
524
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
525
|
+
/**
|
|
526
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
527
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
528
|
+
*/
|
|
529
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
530
|
+
/**
|
|
531
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
532
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
533
|
+
*/
|
|
534
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
668
535
|
}
|
|
669
536
|
export declare class AssetModelResourceClient<O> {
|
|
670
537
|
protected httpClient: HttpClient<O>;
|
|
@@ -711,23 +578,109 @@ export declare class AssetModelResourceClient<O> {
|
|
|
711
578
|
[index: string]: Model.ValueDescriptor;
|
|
712
579
|
}>;
|
|
713
580
|
}
|
|
714
|
-
export declare class
|
|
581
|
+
export declare class GatewayClientResourceClient<O> {
|
|
715
582
|
protected httpClient: HttpClient<O>;
|
|
716
583
|
constructor(httpClient: HttpClient<O>);
|
|
717
584
|
/**
|
|
718
|
-
* HTTP
|
|
719
|
-
* Java method: org.openremote.model.
|
|
585
|
+
* HTTP DELETE /gateway/connection
|
|
586
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
720
587
|
*/
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
}>;
|
|
588
|
+
deleteConnections(queryParams?: {
|
|
589
|
+
realm?: string[];
|
|
590
|
+
}, options?: O): RestResponse<void>;
|
|
724
591
|
/**
|
|
725
|
-
* HTTP GET /
|
|
726
|
-
* Java method: org.openremote.model.
|
|
592
|
+
* HTTP GET /gateway/connection
|
|
593
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
727
594
|
*/
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
595
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
596
|
+
/**
|
|
597
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
598
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
599
|
+
*/
|
|
600
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
601
|
+
/**
|
|
602
|
+
* HTTP GET /gateway/connection/{realm}
|
|
603
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
604
|
+
*/
|
|
605
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
606
|
+
/**
|
|
607
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
608
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
609
|
+
*/
|
|
610
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
611
|
+
/**
|
|
612
|
+
* HTTP GET /gateway/status/{realm}
|
|
613
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
614
|
+
*/
|
|
615
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
616
|
+
}
|
|
617
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
618
|
+
protected httpClient: HttpClient<O>;
|
|
619
|
+
constructor(httpClient: HttpClient<O>);
|
|
620
|
+
/**
|
|
621
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
622
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
623
|
+
*/
|
|
624
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
625
|
+
/**
|
|
626
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
627
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
628
|
+
*/
|
|
629
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
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: string, queryParams?: {
|
|
639
|
+
realm?: string;
|
|
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: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
646
|
+
realm?: string;
|
|
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: string, queryParams?: {
|
|
653
|
+
parentId?: string;
|
|
654
|
+
realm?: string;
|
|
655
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
656
|
+
}
|
|
657
|
+
export declare class ConsoleResourceClient<O> {
|
|
658
|
+
protected httpClient: HttpClient<O>;
|
|
659
|
+
constructor(httpClient: HttpClient<O>);
|
|
660
|
+
/**
|
|
661
|
+
* HTTP POST /console/register
|
|
662
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
663
|
+
*/
|
|
664
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
665
|
+
}
|
|
666
|
+
export declare class AppResourceClient<O> {
|
|
667
|
+
protected httpClient: HttpClient<O>;
|
|
668
|
+
constructor(httpClient: HttpClient<O>);
|
|
669
|
+
/**
|
|
670
|
+
* HTTP GET /apps
|
|
671
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
672
|
+
*/
|
|
673
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
674
|
+
/**
|
|
675
|
+
* HTTP GET /apps/consoleConfig
|
|
676
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
677
|
+
*/
|
|
678
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
679
|
+
/**
|
|
680
|
+
* HTTP GET /apps/info
|
|
681
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
682
|
+
*/
|
|
683
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
731
684
|
}
|
|
732
685
|
export declare class RealmResourceClient<O> {
|
|
733
686
|
protected httpClient: HttpClient<O>;
|
|
@@ -763,184 +716,231 @@ export declare class RealmResourceClient<O> {
|
|
|
763
716
|
*/
|
|
764
717
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
765
718
|
}
|
|
766
|
-
export declare class
|
|
719
|
+
export declare class StatusResourceClient<O> {
|
|
767
720
|
protected httpClient: HttpClient<O>;
|
|
768
721
|
constructor(httpClient: HttpClient<O>);
|
|
769
722
|
/**
|
|
770
|
-
* HTTP GET /
|
|
771
|
-
* Java method: org.openremote.model.
|
|
723
|
+
* HTTP GET /health
|
|
724
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
772
725
|
*/
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
from?: number;
|
|
777
|
-
to?: number;
|
|
778
|
-
realmId?: string;
|
|
779
|
-
userId?: string;
|
|
780
|
-
assetId?: string;
|
|
781
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
726
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
727
|
+
[index: string]: any;
|
|
728
|
+
}>;
|
|
782
729
|
/**
|
|
783
|
-
* HTTP
|
|
784
|
-
* Java method: org.openremote.model.
|
|
730
|
+
* HTTP GET /info
|
|
731
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
785
732
|
*/
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
733
|
+
getInfo(options?: O): RestResponse<{
|
|
734
|
+
[index: string]: any;
|
|
735
|
+
}>;
|
|
736
|
+
}
|
|
737
|
+
export declare class AssetResourceClient<O> {
|
|
738
|
+
protected httpClient: HttpClient<O>;
|
|
739
|
+
constructor(httpClient: HttpClient<O>);
|
|
740
|
+
/**
|
|
741
|
+
* HTTP POST /asset
|
|
742
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
743
|
+
*/
|
|
744
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
745
|
+
/**
|
|
746
|
+
* HTTP DELETE /asset
|
|
747
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
748
|
+
*/
|
|
749
|
+
delete(queryParams?: {
|
|
750
|
+
assetId?: string[];
|
|
794
751
|
}, options?: O): RestResponse<void>;
|
|
795
752
|
/**
|
|
796
|
-
* HTTP
|
|
797
|
-
* Java method: org.openremote.model.
|
|
753
|
+
* HTTP PUT /asset/attributes
|
|
754
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
798
755
|
*/
|
|
799
|
-
|
|
756
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
800
757
|
/**
|
|
801
|
-
* HTTP
|
|
802
|
-
* Java method: org.openremote.model.
|
|
758
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
759
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
803
760
|
*/
|
|
804
|
-
|
|
761
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
805
762
|
/**
|
|
806
|
-
* HTTP
|
|
807
|
-
* Java method: org.openremote.model.
|
|
763
|
+
* HTTP DELETE /asset/parent
|
|
764
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
808
765
|
*/
|
|
809
|
-
|
|
810
|
-
|
|
766
|
+
updateNoneParent(queryParams?: {
|
|
767
|
+
assetIds?: string[];
|
|
811
768
|
}, options?: O): RestResponse<void>;
|
|
812
769
|
/**
|
|
813
|
-
* HTTP
|
|
814
|
-
* Java method: org.openremote.model.
|
|
770
|
+
* HTTP GET /asset/partial/{assetId}
|
|
771
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
815
772
|
*/
|
|
816
|
-
|
|
817
|
-
targetId?: string;
|
|
818
|
-
}, options?: O): RestResponse<void>;
|
|
819
|
-
}
|
|
820
|
-
export declare class MapResourceClient<O> {
|
|
821
|
-
protected httpClient: HttpClient<O>;
|
|
822
|
-
constructor(httpClient: HttpClient<O>);
|
|
773
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
823
774
|
/**
|
|
824
|
-
* HTTP
|
|
825
|
-
* Java method: org.openremote.model.
|
|
775
|
+
* HTTP POST /asset/query
|
|
776
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
826
777
|
*/
|
|
827
|
-
|
|
828
|
-
[id: string]: unknown;
|
|
829
|
-
}>;
|
|
778
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
830
779
|
/**
|
|
831
|
-
* HTTP
|
|
832
|
-
* Java method: org.openremote.model.
|
|
780
|
+
* HTTP GET /asset/user/current
|
|
781
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
833
782
|
*/
|
|
834
|
-
|
|
835
|
-
[id: string]: unknown;
|
|
836
|
-
}>;
|
|
783
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
837
784
|
/**
|
|
838
|
-
* HTTP
|
|
839
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* HTTP POST /asset/user/link
|
|
786
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
840
787
|
*/
|
|
841
|
-
|
|
842
|
-
[id: string]: unknown;
|
|
843
|
-
}>;
|
|
788
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
844
789
|
/**
|
|
845
|
-
* HTTP GET /
|
|
846
|
-
* Java method: org.openremote.model.
|
|
790
|
+
* HTTP GET /asset/user/link
|
|
791
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
847
792
|
*/
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
793
|
+
getUserAssetLinks(queryParams?: {
|
|
794
|
+
realm?: string;
|
|
795
|
+
userId?: string;
|
|
796
|
+
assetId?: string;
|
|
797
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
851
798
|
/**
|
|
852
|
-
* HTTP
|
|
853
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP POST /asset/user/link/delete
|
|
800
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
854
801
|
*/
|
|
855
|
-
|
|
856
|
-
[id: string]: unknown;
|
|
857
|
-
}>;
|
|
802
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
858
803
|
/**
|
|
859
|
-
* HTTP
|
|
860
|
-
* Java method: org.openremote.model.
|
|
804
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
805
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
861
806
|
*/
|
|
862
|
-
|
|
807
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
863
808
|
/**
|
|
864
|
-
* HTTP
|
|
865
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
810
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
866
811
|
*/
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
812
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP GET /asset/{assetId}
|
|
815
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
816
|
+
*/
|
|
817
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP PUT /asset/{assetId}
|
|
820
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
821
|
+
*/
|
|
822
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
823
|
+
/**
|
|
824
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
825
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
826
|
+
*/
|
|
827
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
828
|
+
/**
|
|
829
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
830
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
831
|
+
*/
|
|
832
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
833
|
+
/**
|
|
834
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
835
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
836
|
+
*/
|
|
837
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
838
|
+
assetIds?: string[];
|
|
839
|
+
}, options?: O): RestResponse<void>;
|
|
872
840
|
}
|
|
873
|
-
export declare class
|
|
841
|
+
export declare class SyslogResourceClient<O> {
|
|
874
842
|
protected httpClient: HttpClient<O>;
|
|
875
843
|
constructor(httpClient: HttpClient<O>);
|
|
876
844
|
/**
|
|
877
|
-
* HTTP GET /
|
|
878
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* HTTP GET /syslog/config
|
|
846
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
879
847
|
*/
|
|
880
|
-
|
|
848
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
881
849
|
/**
|
|
882
|
-
* HTTP PUT /
|
|
883
|
-
* Java method: org.openremote.model.
|
|
850
|
+
* HTTP PUT /syslog/config
|
|
851
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
884
852
|
*/
|
|
885
|
-
|
|
853
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
886
854
|
/**
|
|
887
|
-
* HTTP
|
|
888
|
-
* Java method: org.openremote.model.
|
|
855
|
+
* HTTP DELETE /syslog/event
|
|
856
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
889
857
|
*/
|
|
890
|
-
|
|
891
|
-
path?: string;
|
|
892
|
-
}, options?: O): RestResponse<string>;
|
|
858
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
893
859
|
/**
|
|
894
|
-
* HTTP GET /
|
|
895
|
-
* Java method: org.openremote.model.
|
|
860
|
+
* HTTP GET /syslog/event
|
|
861
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
896
862
|
*/
|
|
897
|
-
|
|
863
|
+
getEvents(queryParams?: {
|
|
864
|
+
level?: Model.SyslogLevel;
|
|
865
|
+
per_page?: number;
|
|
866
|
+
page?: number;
|
|
867
|
+
from?: number;
|
|
868
|
+
to?: number;
|
|
869
|
+
category?: Model.SyslogCategory[];
|
|
870
|
+
subCategory?: string[];
|
|
871
|
+
}, options?: O): RestResponse<any>;
|
|
872
|
+
}
|
|
873
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
874
|
+
protected httpClient: HttpClient<O>;
|
|
875
|
+
constructor(httpClient: HttpClient<O>);
|
|
876
|
+
/**
|
|
877
|
+
* HTTP GET /asset/datapoint/export
|
|
878
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
879
|
+
*/
|
|
880
|
+
getDatapointExport(queryParams?: {
|
|
881
|
+
attributeRefs?: string;
|
|
882
|
+
fromTimestamp?: number;
|
|
883
|
+
toTimestamp?: number;
|
|
884
|
+
}, options?: O): RestResponse<any>;
|
|
885
|
+
/**
|
|
886
|
+
* HTTP GET /asset/datapoint/periods
|
|
887
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
888
|
+
*/
|
|
889
|
+
getDatapointPeriod(queryParams?: {
|
|
890
|
+
assetId?: string;
|
|
891
|
+
attributeName?: string;
|
|
892
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
893
|
+
/**
|
|
894
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
895
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
896
|
+
*/
|
|
897
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
902
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
903
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
904
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
905
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
901
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
906
902
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
903
|
+
protected _userResource: AxiosUserResourceClient;
|
|
904
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
907
905
|
protected _flowResource: AxiosFlowResourceClient;
|
|
908
|
-
protected
|
|
906
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
907
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
908
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
909
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
910
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
911
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
909
912
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
910
913
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
911
|
-
protected
|
|
912
|
-
protected
|
|
913
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
914
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
914
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
915
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
915
916
|
protected _appResource: AxiosAppResourceClient;
|
|
916
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
917
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
918
917
|
protected _realmResource: AxiosRealmResourceClient;
|
|
919
|
-
protected
|
|
920
|
-
protected
|
|
921
|
-
protected
|
|
918
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
919
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
920
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
921
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
924
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
925
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
926
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
927
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
923
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
928
924
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
925
|
+
get UserResource(): AxiosUserResourceClient;
|
|
926
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
929
927
|
get FlowResource(): AxiosFlowResourceClient;
|
|
930
|
-
get
|
|
928
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
929
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
930
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
931
|
+
get MapResource(): AxiosMapResourceClient;
|
|
932
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
933
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
931
934
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
932
935
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
933
|
-
get
|
|
934
|
-
get
|
|
935
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
936
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
936
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
937
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
937
938
|
get AppResource(): AxiosAppResourceClient;
|
|
938
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
939
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
940
939
|
get RealmResource(): AxiosRealmResourceClient;
|
|
941
|
-
get
|
|
942
|
-
get
|
|
943
|
-
get
|
|
940
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
941
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
942
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
943
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
|
-
export declare class
|
|
978
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|