@openremote/rest 1.13.0-snapshot.20251219142144 → 1.13.0-snapshot.20251223090643
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 +461 -461
- package/lib/restclient.d.ts.map +1 -1
- 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,6 +9,42 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class GatewayClientResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP DELETE /gateway/connection
|
|
17
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
18
|
+
*/
|
|
19
|
+
deleteConnections(queryParams?: {
|
|
20
|
+
realm?: string[];
|
|
21
|
+
}, options?: O): RestResponse<void>;
|
|
22
|
+
/**
|
|
23
|
+
* HTTP GET /gateway/connection
|
|
24
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
25
|
+
*/
|
|
26
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
27
|
+
/**
|
|
28
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
30
|
+
*/
|
|
31
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
32
|
+
/**
|
|
33
|
+
* HTTP GET /gateway/connection/{realm}
|
|
34
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
35
|
+
*/
|
|
36
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
37
|
+
/**
|
|
38
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
39
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
40
|
+
*/
|
|
41
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
42
|
+
/**
|
|
43
|
+
* HTTP GET /gateway/status/{realm}
|
|
44
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
45
|
+
*/
|
|
46
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
47
|
+
}
|
|
12
48
|
export declare class AssetResourceClient<O> {
|
|
13
49
|
protected httpClient: HttpClient<O>;
|
|
14
50
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -118,45 +154,101 @@ export declare class AssetResourceClient<O> {
|
|
|
118
154
|
assetIds?: string[];
|
|
119
155
|
}, options?: O): RestResponse<void>;
|
|
120
156
|
}
|
|
121
|
-
export declare class
|
|
157
|
+
export declare class FlowResourceClient<O> {
|
|
122
158
|
protected httpClient: HttpClient<O>;
|
|
123
159
|
constructor(httpClient: HttpClient<O>);
|
|
124
160
|
/**
|
|
125
|
-
* HTTP
|
|
126
|
-
* Java method: org.openremote.model.
|
|
161
|
+
* HTTP GET /flow
|
|
162
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
127
163
|
*/
|
|
128
|
-
|
|
164
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
129
165
|
/**
|
|
130
|
-
* HTTP
|
|
131
|
-
* Java method: org.openremote.model.
|
|
166
|
+
* HTTP GET /flow/{name}
|
|
167
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
132
168
|
*/
|
|
133
|
-
|
|
169
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
170
|
+
/**
|
|
171
|
+
* HTTP GET /flow/{type}
|
|
172
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
173
|
+
*/
|
|
174
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
134
175
|
}
|
|
135
|
-
export declare class
|
|
176
|
+
export declare class ProvisioningResourceClient<O> {
|
|
136
177
|
protected httpClient: HttpClient<O>;
|
|
137
178
|
constructor(httpClient: HttpClient<O>);
|
|
138
179
|
/**
|
|
139
|
-
* HTTP
|
|
140
|
-
* Java method: org.openremote.model.
|
|
180
|
+
* HTTP POST /provisioning
|
|
181
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
141
182
|
*/
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
183
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
184
|
+
/**
|
|
185
|
+
* HTTP GET /provisioning
|
|
186
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
187
|
+
*/
|
|
188
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
189
|
+
/**
|
|
190
|
+
* HTTP DELETE /provisioning/{id}
|
|
191
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
192
|
+
*/
|
|
193
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
194
|
+
/**
|
|
195
|
+
* HTTP PUT /provisioning/{id}
|
|
196
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
197
|
+
*/
|
|
198
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
199
|
+
}
|
|
200
|
+
export declare class AssetModelResourceClient<O> {
|
|
201
|
+
protected httpClient: HttpClient<O>;
|
|
202
|
+
constructor(httpClient: HttpClient<O>);
|
|
203
|
+
/**
|
|
204
|
+
* HTTP GET /model/assetDescriptors
|
|
205
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
206
|
+
*/
|
|
207
|
+
getAssetDescriptors(queryParams?: {
|
|
208
|
+
parentId?: string;
|
|
209
|
+
parentType?: string;
|
|
210
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
211
|
+
/**
|
|
212
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
213
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
214
|
+
*/
|
|
215
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
216
|
+
parentId?: string;
|
|
217
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
218
|
+
/**
|
|
219
|
+
* HTTP GET /model/assetInfos
|
|
220
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
221
|
+
*/
|
|
222
|
+
getAssetInfos(queryParams?: {
|
|
223
|
+
parentId?: string;
|
|
224
|
+
parentType?: string;
|
|
225
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
226
|
+
/**
|
|
227
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
228
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
229
|
+
*/
|
|
230
|
+
getValueDescriptorSchema(queryParams?: {
|
|
231
|
+
name?: string;
|
|
232
|
+
hash?: string;
|
|
146
233
|
}, options?: O): RestResponse<any>;
|
|
147
234
|
/**
|
|
148
|
-
* HTTP GET /
|
|
149
|
-
* Java method: org.openremote.model.
|
|
235
|
+
* HTTP GET /model/metaItemDescriptors
|
|
236
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
150
237
|
*/
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
238
|
+
getMetaItemDescriptors(queryParams?: {
|
|
239
|
+
parentId?: string;
|
|
240
|
+
}, options?: O): RestResponse<{
|
|
241
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
242
|
+
}>;
|
|
155
243
|
/**
|
|
156
|
-
* HTTP
|
|
157
|
-
* Java method: org.openremote.model.
|
|
244
|
+
* HTTP GET /model/valueDescriptors
|
|
245
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
158
246
|
*/
|
|
159
|
-
|
|
247
|
+
getValueDescriptors(queryParams?: {
|
|
248
|
+
parentId?: string;
|
|
249
|
+
}, options?: O): RestResponse<{
|
|
250
|
+
[index: string]: Model.ValueDescriptor;
|
|
251
|
+
}>;
|
|
160
252
|
}
|
|
161
253
|
export declare class MapResourceClient<O> {
|
|
162
254
|
protected httpClient: HttpClient<O>;
|
|
@@ -211,6 +303,15 @@ export declare class MapResourceClient<O> {
|
|
|
211
303
|
[id: string]: unknown;
|
|
212
304
|
}>;
|
|
213
305
|
}
|
|
306
|
+
export declare class ConsoleResourceClient<O> {
|
|
307
|
+
protected httpClient: HttpClient<O>;
|
|
308
|
+
constructor(httpClient: HttpClient<O>);
|
|
309
|
+
/**
|
|
310
|
+
* HTTP POST /console/register
|
|
311
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
312
|
+
*/
|
|
313
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
314
|
+
}
|
|
214
315
|
export declare class AppResourceClient<O> {
|
|
215
316
|
protected httpClient: HttpClient<O>;
|
|
216
317
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -230,189 +331,169 @@ export declare class AppResourceClient<O> {
|
|
|
230
331
|
*/
|
|
231
332
|
getAppInfos(options?: O): RestResponse<any>;
|
|
232
333
|
}
|
|
233
|
-
export declare class
|
|
334
|
+
export declare class StatusResourceClient<O> {
|
|
234
335
|
protected httpClient: HttpClient<O>;
|
|
235
336
|
constructor(httpClient: HttpClient<O>);
|
|
236
337
|
/**
|
|
237
|
-
* HTTP GET /
|
|
238
|
-
* Java method: org.openremote.model.
|
|
239
|
-
*/
|
|
240
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
241
|
-
/**
|
|
242
|
-
* HTTP PUT /syslog/config
|
|
243
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
244
|
-
*/
|
|
245
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
246
|
-
/**
|
|
247
|
-
* HTTP DELETE /syslog/event
|
|
248
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
338
|
+
* HTTP GET /health
|
|
339
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
249
340
|
*/
|
|
250
|
-
|
|
341
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
342
|
+
[index: string]: any;
|
|
343
|
+
}>;
|
|
251
344
|
/**
|
|
252
|
-
* HTTP GET /
|
|
253
|
-
* Java method: org.openremote.model.
|
|
345
|
+
* HTTP GET /info
|
|
346
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
254
347
|
*/
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
page?: number;
|
|
259
|
-
from?: number;
|
|
260
|
-
to?: number;
|
|
261
|
-
category?: Model.SyslogCategory[];
|
|
262
|
-
subCategory?: string[];
|
|
263
|
-
}, options?: O): RestResponse<any>;
|
|
348
|
+
getInfo(options?: O): RestResponse<{
|
|
349
|
+
[index: string]: any;
|
|
350
|
+
}>;
|
|
264
351
|
}
|
|
265
|
-
export declare class
|
|
352
|
+
export declare class RealmResourceClient<O> {
|
|
266
353
|
protected httpClient: HttpClient<O>;
|
|
267
354
|
constructor(httpClient: HttpClient<O>);
|
|
268
355
|
/**
|
|
269
|
-
* HTTP POST /
|
|
270
|
-
* Java method: org.openremote.model.
|
|
271
|
-
*/
|
|
272
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
273
|
-
/**
|
|
274
|
-
* HTTP GET /rules
|
|
275
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
356
|
+
* HTTP POST /realm
|
|
357
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
276
358
|
*/
|
|
277
|
-
|
|
278
|
-
language?: Model.RulesetLang[];
|
|
279
|
-
fullyPopulate?: boolean;
|
|
280
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
359
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
281
360
|
/**
|
|
282
|
-
* HTTP
|
|
283
|
-
* Java method: org.openremote.model.
|
|
361
|
+
* HTTP GET /realm
|
|
362
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
284
363
|
*/
|
|
285
|
-
|
|
364
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
286
365
|
/**
|
|
287
|
-
* HTTP GET /
|
|
288
|
-
* Java method: org.openremote.model.
|
|
366
|
+
* HTTP GET /realm/accessible
|
|
367
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
289
368
|
*/
|
|
290
|
-
|
|
291
|
-
language?: Model.RulesetLang[];
|
|
292
|
-
fullyPopulate?: boolean;
|
|
293
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
369
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
294
370
|
/**
|
|
295
|
-
* HTTP DELETE /
|
|
296
|
-
* Java method: org.openremote.model.
|
|
371
|
+
* HTTP DELETE /realm/{name}
|
|
372
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
297
373
|
*/
|
|
298
|
-
|
|
374
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
299
375
|
/**
|
|
300
|
-
* HTTP GET /
|
|
301
|
-
* Java method: org.openremote.model.
|
|
376
|
+
* HTTP GET /realm/{name}
|
|
377
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
302
378
|
*/
|
|
303
|
-
|
|
379
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
304
380
|
/**
|
|
305
|
-
* HTTP PUT /
|
|
306
|
-
* Java method: org.openremote.model.
|
|
381
|
+
* HTTP PUT /realm/{name}
|
|
382
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
307
383
|
*/
|
|
308
|
-
|
|
384
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
385
|
+
}
|
|
386
|
+
export declare class NotificationResourceClient<O> {
|
|
387
|
+
protected httpClient: HttpClient<O>;
|
|
388
|
+
constructor(httpClient: HttpClient<O>);
|
|
309
389
|
/**
|
|
310
|
-
* HTTP GET /
|
|
311
|
-
* Java method: org.openremote.model.
|
|
390
|
+
* HTTP GET /notification
|
|
391
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
312
392
|
*/
|
|
313
|
-
|
|
393
|
+
getNotifications(queryParams?: {
|
|
394
|
+
id?: number;
|
|
395
|
+
type?: string;
|
|
396
|
+
from?: number;
|
|
397
|
+
to?: number;
|
|
398
|
+
realmId?: string;
|
|
399
|
+
userId?: string;
|
|
400
|
+
assetId?: string;
|
|
401
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
314
402
|
/**
|
|
315
|
-
* HTTP
|
|
316
|
-
* Java method: org.openremote.model.
|
|
403
|
+
* HTTP DELETE /notification
|
|
404
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
317
405
|
*/
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
*/
|
|
328
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
329
|
-
/**
|
|
330
|
-
* HTTP POST /rules/realm
|
|
331
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
332
|
-
*/
|
|
333
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
406
|
+
removeNotifications(queryParams?: {
|
|
407
|
+
id?: number;
|
|
408
|
+
type?: string;
|
|
409
|
+
from?: number;
|
|
410
|
+
to?: number;
|
|
411
|
+
realmId?: string;
|
|
412
|
+
userId?: string;
|
|
413
|
+
assetId?: string;
|
|
414
|
+
}, options?: O): RestResponse<void>;
|
|
334
415
|
/**
|
|
335
|
-
* HTTP
|
|
336
|
-
* Java method: org.openremote.model.
|
|
416
|
+
* HTTP POST /notification/alert
|
|
417
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
337
418
|
*/
|
|
338
|
-
|
|
339
|
-
language?: Model.RulesetLang[];
|
|
340
|
-
fullyPopulate?: boolean;
|
|
341
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
419
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
342
420
|
/**
|
|
343
|
-
* HTTP DELETE /
|
|
344
|
-
* Java method: org.openremote.model.
|
|
421
|
+
* HTTP DELETE /notification/{notificationId}
|
|
422
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
345
423
|
*/
|
|
346
|
-
|
|
424
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
347
425
|
/**
|
|
348
|
-
* HTTP
|
|
349
|
-
* Java method: org.openremote.model.
|
|
426
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
427
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
350
428
|
*/
|
|
351
|
-
|
|
429
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
430
|
+
targetId?: string;
|
|
431
|
+
}, options?: O): RestResponse<void>;
|
|
352
432
|
/**
|
|
353
|
-
* HTTP PUT /
|
|
354
|
-
* Java method: org.openremote.model.
|
|
433
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
434
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
355
435
|
*/
|
|
356
|
-
|
|
436
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
437
|
+
targetId?: string;
|
|
438
|
+
}, options?: O): RestResponse<void>;
|
|
439
|
+
}
|
|
440
|
+
export declare class AgentResourceClient<O> {
|
|
441
|
+
protected httpClient: HttpClient<O>;
|
|
442
|
+
constructor(httpClient: HttpClient<O>);
|
|
357
443
|
/**
|
|
358
|
-
* HTTP
|
|
359
|
-
* Java method: org.openremote.model.
|
|
444
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
445
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
360
446
|
*/
|
|
361
|
-
|
|
447
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
448
|
+
realm?: string;
|
|
449
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
362
450
|
/**
|
|
363
|
-
* HTTP
|
|
364
|
-
* Java method: org.openremote.model.
|
|
451
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
452
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
365
453
|
*/
|
|
366
|
-
|
|
454
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
455
|
+
realm?: string;
|
|
456
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
367
457
|
/**
|
|
368
|
-
* HTTP
|
|
369
|
-
* Java method: org.openremote.model.
|
|
458
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
459
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
370
460
|
*/
|
|
371
|
-
|
|
461
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
462
|
+
parentId?: string;
|
|
463
|
+
realm?: string;
|
|
464
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
372
465
|
}
|
|
373
|
-
export declare class
|
|
466
|
+
export declare class SyslogResourceClient<O> {
|
|
374
467
|
protected httpClient: HttpClient<O>;
|
|
375
468
|
constructor(httpClient: HttpClient<O>);
|
|
376
469
|
/**
|
|
377
|
-
* HTTP GET /
|
|
378
|
-
* Java method: org.openremote.model.
|
|
379
|
-
*/
|
|
380
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
381
|
-
/**
|
|
382
|
-
* HTTP PUT /configuration/manager
|
|
383
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
384
|
-
*/
|
|
385
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
386
|
-
/**
|
|
387
|
-
* HTTP POST /configuration/manager/file
|
|
388
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
470
|
+
* HTTP GET /syslog/config
|
|
471
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
389
472
|
*/
|
|
390
|
-
|
|
391
|
-
path?: string;
|
|
392
|
-
}, options?: O): RestResponse<string>;
|
|
473
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
393
474
|
/**
|
|
394
|
-
* HTTP
|
|
395
|
-
* Java method: org.openremote.model.
|
|
475
|
+
* HTTP PUT /syslog/config
|
|
476
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
396
477
|
*/
|
|
397
|
-
|
|
398
|
-
}
|
|
399
|
-
export declare class StatusResourceClient<O> {
|
|
400
|
-
protected httpClient: HttpClient<O>;
|
|
401
|
-
constructor(httpClient: HttpClient<O>);
|
|
478
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
402
479
|
/**
|
|
403
|
-
* HTTP
|
|
404
|
-
* Java method: org.openremote.model.
|
|
480
|
+
* HTTP DELETE /syslog/event
|
|
481
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
405
482
|
*/
|
|
406
|
-
|
|
407
|
-
[index: string]: any;
|
|
408
|
-
}>;
|
|
483
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
409
484
|
/**
|
|
410
|
-
* HTTP GET /
|
|
411
|
-
* Java method: org.openremote.model.
|
|
485
|
+
* HTTP GET /syslog/event
|
|
486
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
412
487
|
*/
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
488
|
+
getEvents(queryParams?: {
|
|
489
|
+
level?: Model.SyslogLevel;
|
|
490
|
+
per_page?: number;
|
|
491
|
+
page?: number;
|
|
492
|
+
from?: number;
|
|
493
|
+
to?: number;
|
|
494
|
+
category?: Model.SyslogCategory[];
|
|
495
|
+
subCategory?: string[];
|
|
496
|
+
}, options?: O): RestResponse<any>;
|
|
416
497
|
}
|
|
417
498
|
export declare class GatewayServiceResourceClient<O> {
|
|
418
499
|
protected httpClient: HttpClient<O>;
|
|
@@ -443,234 +524,240 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
443
524
|
*/
|
|
444
525
|
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
445
526
|
}
|
|
446
|
-
export declare class
|
|
527
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
447
528
|
protected httpClient: HttpClient<O>;
|
|
448
529
|
constructor(httpClient: HttpClient<O>);
|
|
449
530
|
/**
|
|
450
|
-
* HTTP POST /
|
|
451
|
-
* Java method: org.openremote.model.
|
|
531
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
532
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
452
533
|
*/
|
|
453
|
-
|
|
454
|
-
assetIds?: string[];
|
|
455
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
534
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
456
535
|
/**
|
|
457
|
-
* HTTP
|
|
458
|
-
* Java method: org.openremote.model.
|
|
536
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
537
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
459
538
|
*/
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
539
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
540
|
+
}
|
|
541
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
542
|
+
protected httpClient: HttpClient<O>;
|
|
543
|
+
constructor(httpClient: HttpClient<O>);
|
|
544
|
+
/**
|
|
545
|
+
* HTTP GET /asset/datapoint/export
|
|
546
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
547
|
+
*/
|
|
548
|
+
getDatapointExport(queryParams?: {
|
|
549
|
+
attributeRefs?: string;
|
|
550
|
+
fromTimestamp?: number;
|
|
551
|
+
toTimestamp?: number;
|
|
552
|
+
}, options?: O): RestResponse<any>;
|
|
553
|
+
/**
|
|
554
|
+
* HTTP GET /asset/datapoint/periods
|
|
555
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
556
|
+
*/
|
|
557
|
+
getDatapointPeriod(queryParams?: {
|
|
463
558
|
assetId?: string;
|
|
464
|
-
|
|
465
|
-
}, options?: O): RestResponse<Model.
|
|
559
|
+
attributeName?: string;
|
|
560
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
466
561
|
/**
|
|
467
|
-
* HTTP
|
|
468
|
-
* Java method: org.openremote.model.
|
|
562
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
563
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
469
564
|
*/
|
|
470
|
-
|
|
565
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
566
|
+
}
|
|
567
|
+
export declare class DashboardResourceClient<O> {
|
|
568
|
+
protected httpClient: HttpClient<O>;
|
|
569
|
+
constructor(httpClient: HttpClient<O>);
|
|
471
570
|
/**
|
|
472
|
-
* HTTP
|
|
473
|
-
* Java method: org.openremote.model.
|
|
571
|
+
* HTTP POST /dashboard
|
|
572
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
474
573
|
*/
|
|
475
|
-
|
|
574
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
476
575
|
/**
|
|
477
|
-
* HTTP
|
|
478
|
-
* Java method: org.openremote.model.
|
|
576
|
+
* HTTP PUT /dashboard
|
|
577
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
479
578
|
*/
|
|
480
|
-
|
|
579
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
481
580
|
/**
|
|
482
|
-
* HTTP
|
|
483
|
-
* Java method: org.openremote.model.
|
|
581
|
+
* HTTP GET /dashboard/all/{realm}
|
|
582
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
484
583
|
*/
|
|
485
|
-
|
|
584
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
486
585
|
/**
|
|
487
|
-
* HTTP
|
|
488
|
-
* Java method: org.openremote.model.
|
|
586
|
+
* HTTP POST /dashboard/query
|
|
587
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
489
588
|
*/
|
|
490
|
-
|
|
589
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
491
590
|
/**
|
|
492
|
-
* HTTP
|
|
493
|
-
* Java method: org.openremote.model.
|
|
591
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
592
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
494
593
|
*/
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
594
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
595
|
+
/**
|
|
596
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
597
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
598
|
+
*/
|
|
599
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
498
600
|
}
|
|
499
|
-
export declare class
|
|
601
|
+
export declare class RulesResourceClient<O> {
|
|
500
602
|
protected httpClient: HttpClient<O>;
|
|
501
603
|
constructor(httpClient: HttpClient<O>);
|
|
502
604
|
/**
|
|
503
|
-
* HTTP POST /
|
|
504
|
-
* Java method: org.openremote.model.
|
|
605
|
+
* HTTP POST /rules
|
|
606
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
505
607
|
*/
|
|
506
|
-
|
|
608
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
507
609
|
/**
|
|
508
|
-
* HTTP GET /
|
|
509
|
-
* Java method: org.openremote.model.
|
|
610
|
+
* HTTP GET /rules
|
|
611
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
510
612
|
*/
|
|
511
|
-
|
|
613
|
+
getGlobalRulesets(queryParams?: {
|
|
614
|
+
language?: Model.RulesetLang[];
|
|
615
|
+
fullyPopulate?: boolean;
|
|
616
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
512
617
|
/**
|
|
513
|
-
* HTTP
|
|
514
|
-
* Java method: org.openremote.model.
|
|
618
|
+
* HTTP POST /rules/asset
|
|
619
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
515
620
|
*/
|
|
516
|
-
|
|
621
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
517
622
|
/**
|
|
518
|
-
* HTTP
|
|
519
|
-
* Java method: org.openremote.model.
|
|
623
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
624
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
520
625
|
*/
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
constructor(httpClient: HttpClient<O>);
|
|
626
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
627
|
+
language?: Model.RulesetLang[];
|
|
628
|
+
fullyPopulate?: boolean;
|
|
629
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
526
630
|
/**
|
|
527
|
-
* HTTP
|
|
528
|
-
* Java method: org.openremote.model.
|
|
631
|
+
* HTTP DELETE /rules/asset/{id}
|
|
632
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
529
633
|
*/
|
|
530
|
-
|
|
531
|
-
id?: number;
|
|
532
|
-
type?: string;
|
|
533
|
-
from?: number;
|
|
534
|
-
to?: number;
|
|
535
|
-
realmId?: string;
|
|
536
|
-
userId?: string;
|
|
537
|
-
assetId?: string;
|
|
538
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
634
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
539
635
|
/**
|
|
540
|
-
* HTTP
|
|
541
|
-
* Java method: org.openremote.model.
|
|
636
|
+
* HTTP GET /rules/asset/{id}
|
|
637
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
542
638
|
*/
|
|
543
|
-
|
|
544
|
-
id?: number;
|
|
545
|
-
type?: string;
|
|
546
|
-
from?: number;
|
|
547
|
-
to?: number;
|
|
548
|
-
realmId?: string;
|
|
549
|
-
userId?: string;
|
|
550
|
-
assetId?: string;
|
|
551
|
-
}, options?: O): RestResponse<void>;
|
|
639
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
552
640
|
/**
|
|
553
|
-
* HTTP
|
|
554
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP PUT /rules/asset/{id}
|
|
642
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
555
643
|
*/
|
|
556
|
-
|
|
644
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
557
645
|
/**
|
|
558
|
-
* HTTP
|
|
559
|
-
* Java method: org.openremote.model.
|
|
646
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
647
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
560
648
|
*/
|
|
561
|
-
|
|
649
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
562
650
|
/**
|
|
563
|
-
* HTTP
|
|
564
|
-
* Java method: org.openremote.model.
|
|
651
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
652
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
565
653
|
*/
|
|
566
|
-
|
|
567
|
-
targetId?: string;
|
|
568
|
-
}, options?: O): RestResponse<void>;
|
|
654
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
569
655
|
/**
|
|
570
|
-
* HTTP
|
|
571
|
-
* Java method: org.openremote.model.
|
|
656
|
+
* HTTP GET /rules/info/global
|
|
657
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
572
658
|
*/
|
|
573
|
-
|
|
574
|
-
targetId?: string;
|
|
575
|
-
}, options?: O): RestResponse<void>;
|
|
576
|
-
}
|
|
577
|
-
export declare class GatewayClientResourceClient<O> {
|
|
578
|
-
protected httpClient: HttpClient<O>;
|
|
579
|
-
constructor(httpClient: HttpClient<O>);
|
|
659
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
580
660
|
/**
|
|
581
|
-
* HTTP
|
|
582
|
-
* Java method: org.openremote.model.
|
|
661
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
662
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
583
663
|
*/
|
|
584
|
-
|
|
585
|
-
realm?: string[];
|
|
586
|
-
}, options?: O): RestResponse<void>;
|
|
664
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
587
665
|
/**
|
|
588
|
-
* HTTP
|
|
589
|
-
* Java method: org.openremote.model.
|
|
666
|
+
* HTTP POST /rules/realm
|
|
667
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
590
668
|
*/
|
|
591
|
-
|
|
669
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
592
670
|
/**
|
|
593
|
-
* HTTP
|
|
594
|
-
* Java method: org.openremote.model.
|
|
671
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
672
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
595
673
|
*/
|
|
596
|
-
|
|
674
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
675
|
+
language?: Model.RulesetLang[];
|
|
676
|
+
fullyPopulate?: boolean;
|
|
677
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
597
678
|
/**
|
|
598
|
-
* HTTP
|
|
599
|
-
* Java method: org.openremote.model.
|
|
679
|
+
* HTTP DELETE /rules/realm/{id}
|
|
680
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
600
681
|
*/
|
|
601
|
-
|
|
682
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
602
683
|
/**
|
|
603
|
-
* HTTP
|
|
604
|
-
* Java method: org.openremote.model.
|
|
684
|
+
* HTTP GET /rules/realm/{id}
|
|
685
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
605
686
|
*/
|
|
606
|
-
|
|
687
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
607
688
|
/**
|
|
608
|
-
* HTTP
|
|
609
|
-
* Java method: org.openremote.model.
|
|
689
|
+
* HTTP PUT /rules/realm/{id}
|
|
690
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
610
691
|
*/
|
|
611
|
-
|
|
612
|
-
}
|
|
613
|
-
export declare class DashboardResourceClient<O> {
|
|
614
|
-
protected httpClient: HttpClient<O>;
|
|
615
|
-
constructor(httpClient: HttpClient<O>);
|
|
692
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
616
693
|
/**
|
|
617
|
-
* HTTP
|
|
618
|
-
* Java method: org.openremote.model.
|
|
694
|
+
* HTTP DELETE /rules/{id}
|
|
695
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
619
696
|
*/
|
|
620
|
-
|
|
697
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
621
698
|
/**
|
|
622
|
-
* HTTP
|
|
623
|
-
* Java method: org.openremote.model.
|
|
699
|
+
* HTTP GET /rules/{id}
|
|
700
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
624
701
|
*/
|
|
625
|
-
|
|
702
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
626
703
|
/**
|
|
627
|
-
* HTTP
|
|
628
|
-
* Java method: org.openremote.model.
|
|
704
|
+
* HTTP PUT /rules/{id}
|
|
705
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
629
706
|
*/
|
|
630
|
-
|
|
707
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
708
|
+
}
|
|
709
|
+
export declare class AlarmResourceClient<O> {
|
|
710
|
+
protected httpClient: HttpClient<O>;
|
|
711
|
+
constructor(httpClient: HttpClient<O>);
|
|
631
712
|
/**
|
|
632
|
-
* HTTP POST /
|
|
633
|
-
* Java method: org.openremote.model.
|
|
713
|
+
* HTTP POST /alarm
|
|
714
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
634
715
|
*/
|
|
635
|
-
|
|
716
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
717
|
+
assetIds?: string[];
|
|
718
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
636
719
|
/**
|
|
637
|
-
* HTTP
|
|
638
|
-
* Java method: org.openremote.model.
|
|
720
|
+
* HTTP GET /alarm
|
|
721
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
639
722
|
*/
|
|
640
|
-
|
|
723
|
+
getAlarms(queryParams?: {
|
|
724
|
+
realm?: string;
|
|
725
|
+
status?: Model.AlarmStatus;
|
|
726
|
+
assetId?: string;
|
|
727
|
+
assigneeId?: string;
|
|
728
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
729
|
+
/**
|
|
730
|
+
* HTTP DELETE /alarm
|
|
731
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
732
|
+
*/
|
|
733
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
641
734
|
/**
|
|
642
|
-
* HTTP
|
|
643
|
-
* Java method: org.openremote.model.
|
|
735
|
+
* HTTP PUT /alarm/assets
|
|
736
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
644
737
|
*/
|
|
645
|
-
|
|
646
|
-
}
|
|
647
|
-
export declare class FlowResourceClient<O> {
|
|
648
|
-
protected httpClient: HttpClient<O>;
|
|
649
|
-
constructor(httpClient: HttpClient<O>);
|
|
738
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
650
739
|
/**
|
|
651
|
-
* HTTP GET /
|
|
652
|
-
* Java method: org.openremote.model.
|
|
740
|
+
* HTTP GET /alarm/{alarmId}
|
|
741
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
653
742
|
*/
|
|
654
|
-
|
|
743
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
655
744
|
/**
|
|
656
|
-
* HTTP
|
|
657
|
-
* Java method: org.openremote.model.
|
|
745
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
746
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
658
747
|
*/
|
|
659
|
-
|
|
748
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
660
749
|
/**
|
|
661
|
-
* HTTP
|
|
662
|
-
* Java method: org.openremote.model.
|
|
750
|
+
* HTTP PUT /alarm/{alarmId}
|
|
751
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
663
752
|
*/
|
|
664
|
-
|
|
665
|
-
}
|
|
666
|
-
export declare class ConsoleResourceClient<O> {
|
|
667
|
-
protected httpClient: HttpClient<O>;
|
|
668
|
-
constructor(httpClient: HttpClient<O>);
|
|
753
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
669
754
|
/**
|
|
670
|
-
* HTTP
|
|
671
|
-
* Java method: org.openremote.model.
|
|
755
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
756
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
672
757
|
*/
|
|
673
|
-
|
|
758
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
759
|
+
realm?: string;
|
|
760
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
674
761
|
}
|
|
675
762
|
export declare class ExternalServiceResourceClient<O> {
|
|
676
763
|
protected httpClient: HttpClient<O>;
|
|
@@ -727,32 +814,6 @@ export declare class ExternalServiceResourceClient<O> {
|
|
|
727
814
|
*/
|
|
728
815
|
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
729
816
|
}
|
|
730
|
-
export declare class AgentResourceClient<O> {
|
|
731
|
-
protected httpClient: HttpClient<O>;
|
|
732
|
-
constructor(httpClient: HttpClient<O>);
|
|
733
|
-
/**
|
|
734
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
735
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
736
|
-
*/
|
|
737
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
738
|
-
realm?: string;
|
|
739
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
740
|
-
/**
|
|
741
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
742
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
743
|
-
*/
|
|
744
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
745
|
-
realm?: string;
|
|
746
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
747
|
-
/**
|
|
748
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
749
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
750
|
-
*/
|
|
751
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
752
|
-
parentId?: string;
|
|
753
|
-
realm?: string;
|
|
754
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
755
|
-
}
|
|
756
817
|
export declare class UserResourceClient<O> {
|
|
757
818
|
protected httpClient: HttpClient<O>;
|
|
758
819
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -877,140 +938,79 @@ export declare class UserResourceClient<O> {
|
|
|
877
938
|
*/
|
|
878
939
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
879
940
|
}
|
|
880
|
-
export declare class
|
|
881
|
-
protected httpClient: HttpClient<O>;
|
|
882
|
-
constructor(httpClient: HttpClient<O>);
|
|
883
|
-
/**
|
|
884
|
-
* HTTP POST /realm
|
|
885
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
886
|
-
*/
|
|
887
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
888
|
-
/**
|
|
889
|
-
* HTTP GET /realm
|
|
890
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
891
|
-
*/
|
|
892
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
893
|
-
/**
|
|
894
|
-
* HTTP GET /realm/accessible
|
|
895
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
896
|
-
*/
|
|
897
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
898
|
-
/**
|
|
899
|
-
* HTTP DELETE /realm/{name}
|
|
900
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
901
|
-
*/
|
|
902
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
903
|
-
/**
|
|
904
|
-
* HTTP GET /realm/{name}
|
|
905
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
906
|
-
*/
|
|
907
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
908
|
-
/**
|
|
909
|
-
* HTTP PUT /realm/{name}
|
|
910
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
911
|
-
*/
|
|
912
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
913
|
-
}
|
|
914
|
-
export declare class AssetModelResourceClient<O> {
|
|
941
|
+
export declare class ConfigurationResourceClient<O> {
|
|
915
942
|
protected httpClient: HttpClient<O>;
|
|
916
943
|
constructor(httpClient: HttpClient<O>);
|
|
917
944
|
/**
|
|
918
|
-
* HTTP GET /
|
|
919
|
-
* Java method: org.openremote.model.
|
|
920
|
-
*/
|
|
921
|
-
getAssetDescriptors(queryParams?: {
|
|
922
|
-
parentId?: string;
|
|
923
|
-
parentType?: string;
|
|
924
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
925
|
-
/**
|
|
926
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
927
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
928
|
-
*/
|
|
929
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
930
|
-
parentId?: string;
|
|
931
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
932
|
-
/**
|
|
933
|
-
* HTTP GET /model/assetInfos
|
|
934
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
945
|
+
* HTTP GET /configuration/manager
|
|
946
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
935
947
|
*/
|
|
936
|
-
|
|
937
|
-
parentId?: string;
|
|
938
|
-
parentType?: string;
|
|
939
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
948
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
940
949
|
/**
|
|
941
|
-
* HTTP
|
|
942
|
-
* Java method: org.openremote.model.
|
|
950
|
+
* HTTP PUT /configuration/manager
|
|
951
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
943
952
|
*/
|
|
944
|
-
|
|
945
|
-
name?: string;
|
|
946
|
-
hash?: string;
|
|
947
|
-
}, options?: O): RestResponse<any>;
|
|
953
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
948
954
|
/**
|
|
949
|
-
* HTTP
|
|
950
|
-
* Java method: org.openremote.model.
|
|
955
|
+
* HTTP POST /configuration/manager/file
|
|
956
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
951
957
|
*/
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
}, options?: O): RestResponse<
|
|
955
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
956
|
-
}>;
|
|
958
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
959
|
+
path?: string;
|
|
960
|
+
}, options?: O): RestResponse<string>;
|
|
957
961
|
/**
|
|
958
|
-
* HTTP GET /
|
|
959
|
-
* Java method: org.openremote.model.
|
|
962
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
963
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
960
964
|
*/
|
|
961
|
-
|
|
962
|
-
parentId?: string;
|
|
963
|
-
}, options?: O): RestResponse<{
|
|
964
|
-
[index: string]: Model.ValueDescriptor;
|
|
965
|
-
}>;
|
|
965
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
966
966
|
}
|
|
967
967
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
968
968
|
export declare class ApiClient {
|
|
969
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
969
970
|
protected _assetResource: AxiosAssetResourceClient;
|
|
970
|
-
protected
|
|
971
|
-
protected
|
|
971
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
972
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
973
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
972
974
|
protected _mapResource: AxiosMapResourceClient;
|
|
975
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
973
976
|
protected _appResource: AxiosAppResourceClient;
|
|
974
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
975
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
976
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
977
977
|
protected _statusResource: AxiosStatusResourceClient;
|
|
978
|
-
protected
|
|
979
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
980
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
978
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
981
979
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
982
|
-
protected
|
|
980
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
981
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
982
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
983
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
984
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
983
985
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
984
|
-
protected
|
|
985
|
-
protected
|
|
986
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
987
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
986
988
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
987
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
988
989
|
protected _userResource: AxiosUserResourceClient;
|
|
989
|
-
protected
|
|
990
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
990
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
992
993
|
get AssetResource(): AxiosAssetResourceClient;
|
|
993
|
-
get
|
|
994
|
-
get
|
|
994
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
995
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
996
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
995
997
|
get MapResource(): AxiosMapResourceClient;
|
|
998
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
996
999
|
get AppResource(): AxiosAppResourceClient;
|
|
997
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
998
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
999
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1000
1000
|
get StatusResource(): AxiosStatusResourceClient;
|
|
1001
|
-
get
|
|
1002
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1003
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1001
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1004
1002
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1005
|
-
get
|
|
1003
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1004
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1005
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1006
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1007
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1006
1008
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1007
|
-
get
|
|
1008
|
-
get
|
|
1009
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1010
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1009
1011
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1010
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1011
1012
|
get UserResource(): AxiosUserResourceClient;
|
|
1012
|
-
get
|
|
1013
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1013
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1014
1014
|
}
|
|
1015
1015
|
import * as Axios from "axios";
|
|
1016
1016
|
declare module "axios" {
|
|
@@ -1018,70 +1018,70 @@ declare module "axios" {
|
|
|
1018
1018
|
data: R;
|
|
1019
1019
|
}
|
|
1020
1020
|
}
|
|
1021
|
-
export declare class
|
|
1021
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1022
1022
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1023
1023
|
}
|
|
1024
|
-
export declare class
|
|
1024
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1025
1025
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1026
1026
|
}
|
|
1027
|
-
export declare class
|
|
1027
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1028
1028
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1029
1029
|
}
|
|
1030
|
-
export declare class
|
|
1030
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1031
1031
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1032
1032
|
}
|
|
1033
|
-
export declare class
|
|
1033
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1034
1034
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1035
1035
|
}
|
|
1036
|
-
export declare class
|
|
1036
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1037
1037
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1038
1038
|
}
|
|
1039
|
-
export declare class
|
|
1039
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1040
1040
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1041
1041
|
}
|
|
1042
|
-
export declare class
|
|
1042
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1043
1043
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1044
1044
|
}
|
|
1045
1045
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1046
1046
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1047
1047
|
}
|
|
1048
|
-
export declare class
|
|
1048
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1049
1049
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1050
1050
|
}
|
|
1051
|
-
export declare class
|
|
1051
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1052
1052
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1053
1053
|
}
|
|
1054
|
-
export declare class
|
|
1054
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1055
1055
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1056
1056
|
}
|
|
1057
|
-
export declare class
|
|
1057
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1058
1058
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1059
1059
|
}
|
|
1060
|
-
export declare class
|
|
1060
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1061
1061
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1062
1062
|
}
|
|
1063
|
-
export declare class
|
|
1063
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
1064
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1065
1065
|
}
|
|
1066
|
-
export declare class
|
|
1066
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1067
1067
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1068
1068
|
}
|
|
1069
|
-
export declare class
|
|
1069
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1070
1070
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1071
1071
|
}
|
|
1072
|
-
export declare class
|
|
1072
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
1073
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1074
1074
|
}
|
|
1075
|
-
export declare class
|
|
1075
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1076
1076
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1077
1077
|
}
|
|
1078
|
-
export declare class
|
|
1078
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1079
1079
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1080
1080
|
}
|
|
1081
|
-
export declare class
|
|
1081
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1082
1082
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1083
1083
|
}
|
|
1084
|
-
export declare class
|
|
1084
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1085
1085
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1086
1086
|
}
|
|
1087
1087
|
//# sourceMappingURL=restclient.d.ts.map
|