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