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