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