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