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