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