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