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