@openremote/rest 1.8.0-snapshot.20250729122510 → 1.8.0-snapshot.20250808124803
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 +428 -428
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,31 +9,24 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class FlowResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /flow
|
|
17
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
attributeRefs?: string;
|
|
21
|
-
fromTimestamp?: number;
|
|
22
|
-
toTimestamp?: number;
|
|
23
|
-
}, options?: O): RestResponse<any>;
|
|
19
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
24
20
|
/**
|
|
25
|
-
* HTTP GET /
|
|
26
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /flow/{name}
|
|
22
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
27
23
|
*/
|
|
28
|
-
|
|
29
|
-
assetId?: string;
|
|
30
|
-
attributeName?: string;
|
|
31
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
24
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
32
25
|
/**
|
|
33
|
-
* HTTP
|
|
34
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /flow/{type}
|
|
27
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
35
28
|
*/
|
|
36
|
-
|
|
29
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
37
30
|
}
|
|
38
31
|
export declare class AssetResourceClient<O> {
|
|
39
32
|
protected httpClient: HttpClient<O>;
|
|
@@ -139,102 +132,6 @@ export declare class AssetResourceClient<O> {
|
|
|
139
132
|
assetIds?: string[];
|
|
140
133
|
}, options?: O): RestResponse<void>;
|
|
141
134
|
}
|
|
142
|
-
export declare class AlarmResourceClient<O> {
|
|
143
|
-
protected httpClient: HttpClient<O>;
|
|
144
|
-
constructor(httpClient: HttpClient<O>);
|
|
145
|
-
/**
|
|
146
|
-
* HTTP POST /alarm
|
|
147
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
148
|
-
*/
|
|
149
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
150
|
-
assetIds?: string[];
|
|
151
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
152
|
-
/**
|
|
153
|
-
* HTTP GET /alarm
|
|
154
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
155
|
-
*/
|
|
156
|
-
getAlarms(queryParams?: {
|
|
157
|
-
realm?: string;
|
|
158
|
-
status?: Model.AlarmStatus;
|
|
159
|
-
assetId?: string;
|
|
160
|
-
assigneeId?: string;
|
|
161
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
162
|
-
/**
|
|
163
|
-
* HTTP DELETE /alarm
|
|
164
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
165
|
-
*/
|
|
166
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
167
|
-
/**
|
|
168
|
-
* HTTP PUT /alarm/assets
|
|
169
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
170
|
-
*/
|
|
171
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
172
|
-
/**
|
|
173
|
-
* HTTP GET /alarm/{alarmId}
|
|
174
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
175
|
-
*/
|
|
176
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
177
|
-
/**
|
|
178
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
179
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
180
|
-
*/
|
|
181
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
182
|
-
/**
|
|
183
|
-
* HTTP PUT /alarm/{alarmId}
|
|
184
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
185
|
-
*/
|
|
186
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
187
|
-
/**
|
|
188
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
189
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
190
|
-
*/
|
|
191
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
192
|
-
realm?: string;
|
|
193
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
194
|
-
}
|
|
195
|
-
export declare class ProvisioningResourceClient<O> {
|
|
196
|
-
protected httpClient: HttpClient<O>;
|
|
197
|
-
constructor(httpClient: HttpClient<O>);
|
|
198
|
-
/**
|
|
199
|
-
* HTTP POST /provisioning
|
|
200
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
201
|
-
*/
|
|
202
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
203
|
-
/**
|
|
204
|
-
* HTTP GET /provisioning
|
|
205
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
206
|
-
*/
|
|
207
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
208
|
-
/**
|
|
209
|
-
* HTTP DELETE /provisioning/{id}
|
|
210
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
211
|
-
*/
|
|
212
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
213
|
-
/**
|
|
214
|
-
* HTTP PUT /provisioning/{id}
|
|
215
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
216
|
-
*/
|
|
217
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
218
|
-
}
|
|
219
|
-
export declare class AppResourceClient<O> {
|
|
220
|
-
protected httpClient: HttpClient<O>;
|
|
221
|
-
constructor(httpClient: HttpClient<O>);
|
|
222
|
-
/**
|
|
223
|
-
* HTTP GET /apps
|
|
224
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
225
|
-
*/
|
|
226
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
227
|
-
/**
|
|
228
|
-
* HTTP GET /apps/consoleConfig
|
|
229
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
230
|
-
*/
|
|
231
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
232
|
-
/**
|
|
233
|
-
* HTTP GET /apps/info
|
|
234
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
235
|
-
*/
|
|
236
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
237
|
-
}
|
|
238
135
|
export declare class AssetModelResourceClient<O> {
|
|
239
136
|
protected httpClient: HttpClient<O>;
|
|
240
137
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -280,15 +177,6 @@ export declare class AssetModelResourceClient<O> {
|
|
|
280
177
|
[index: string]: Model.ValueDescriptor;
|
|
281
178
|
}>;
|
|
282
179
|
}
|
|
283
|
-
export declare class ConsoleResourceClient<O> {
|
|
284
|
-
protected httpClient: HttpClient<O>;
|
|
285
|
-
constructor(httpClient: HttpClient<O>);
|
|
286
|
-
/**
|
|
287
|
-
* HTTP POST /console/register
|
|
288
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
289
|
-
*/
|
|
290
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
291
|
-
}
|
|
292
180
|
export declare class SyslogResourceClient<O> {
|
|
293
181
|
protected httpClient: HttpClient<O>;
|
|
294
182
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -321,97 +209,39 @@ export declare class SyslogResourceClient<O> {
|
|
|
321
209
|
subCategory?: string[];
|
|
322
210
|
}, options?: O): RestResponse<any>;
|
|
323
211
|
}
|
|
324
|
-
export declare class
|
|
325
|
-
protected httpClient: HttpClient<O>;
|
|
326
|
-
constructor(httpClient: HttpClient<O>);
|
|
327
|
-
/**
|
|
328
|
-
* HTTP GET /flow
|
|
329
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
330
|
-
*/
|
|
331
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
332
|
-
/**
|
|
333
|
-
* HTTP GET /flow/{name}
|
|
334
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
335
|
-
*/
|
|
336
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
337
|
-
/**
|
|
338
|
-
* HTTP GET /flow/{type}
|
|
339
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
340
|
-
*/
|
|
341
|
-
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
342
|
-
}
|
|
343
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
212
|
+
export declare class RealmResourceClient<O> {
|
|
344
213
|
protected httpClient: HttpClient<O>;
|
|
345
214
|
constructor(httpClient: HttpClient<O>);
|
|
346
215
|
/**
|
|
347
|
-
* HTTP POST /
|
|
348
|
-
* Java method: org.openremote.model.
|
|
349
|
-
*/
|
|
350
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
351
|
-
/**
|
|
352
|
-
* HTTP DELETE /gateway/tunnel
|
|
353
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
354
|
-
*/
|
|
355
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
356
|
-
/**
|
|
357
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
358
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
359
|
-
*/
|
|
360
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
361
|
-
/**
|
|
362
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
363
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
364
|
-
*/
|
|
365
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
366
|
-
/**
|
|
367
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
368
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
216
|
+
* HTTP POST /realm
|
|
217
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
369
218
|
*/
|
|
370
|
-
|
|
371
|
-
}
|
|
372
|
-
export declare class AgentResourceClient<O> {
|
|
373
|
-
protected httpClient: HttpClient<O>;
|
|
374
|
-
constructor(httpClient: HttpClient<O>);
|
|
219
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
375
220
|
/**
|
|
376
|
-
* HTTP GET /
|
|
377
|
-
* Java method: org.openremote.model.
|
|
221
|
+
* HTTP GET /realm
|
|
222
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
378
223
|
*/
|
|
379
|
-
|
|
380
|
-
realm?: string;
|
|
381
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
224
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
382
225
|
/**
|
|
383
|
-
* HTTP
|
|
384
|
-
* Java method: org.openremote.model.
|
|
226
|
+
* HTTP GET /realm/accessible
|
|
227
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
385
228
|
*/
|
|
386
|
-
|
|
387
|
-
realm?: string;
|
|
388
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
229
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
389
230
|
/**
|
|
390
|
-
* HTTP
|
|
391
|
-
* Java method: org.openremote.model.
|
|
231
|
+
* HTTP DELETE /realm/{name}
|
|
232
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
392
233
|
*/
|
|
393
|
-
|
|
394
|
-
parentId?: string;
|
|
395
|
-
realm?: string;
|
|
396
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
397
|
-
}
|
|
398
|
-
export declare class StatusResourceClient<O> {
|
|
399
|
-
protected httpClient: HttpClient<O>;
|
|
400
|
-
constructor(httpClient: HttpClient<O>);
|
|
234
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
401
235
|
/**
|
|
402
|
-
* HTTP GET /
|
|
403
|
-
* Java method: org.openremote.model.
|
|
236
|
+
* HTTP GET /realm/{name}
|
|
237
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
404
238
|
*/
|
|
405
|
-
|
|
406
|
-
[index: string]: any;
|
|
407
|
-
}>;
|
|
239
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
408
240
|
/**
|
|
409
|
-
* HTTP
|
|
410
|
-
* Java method: org.openremote.model.
|
|
241
|
+
* HTTP PUT /realm/{name}
|
|
242
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
411
243
|
*/
|
|
412
|
-
|
|
413
|
-
[index: string]: any;
|
|
414
|
-
}>;
|
|
244
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
415
245
|
}
|
|
416
246
|
export declare class MapResourceClient<O> {
|
|
417
247
|
protected httpClient: HttpClient<O>;
|
|
@@ -466,32 +296,6 @@ export declare class MapResourceClient<O> {
|
|
|
466
296
|
[id: string]: unknown;
|
|
467
297
|
}>;
|
|
468
298
|
}
|
|
469
|
-
export declare class ConfigurationResourceClient<O> {
|
|
470
|
-
protected httpClient: HttpClient<O>;
|
|
471
|
-
constructor(httpClient: HttpClient<O>);
|
|
472
|
-
/**
|
|
473
|
-
* HTTP GET /configuration/manager
|
|
474
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
475
|
-
*/
|
|
476
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
477
|
-
/**
|
|
478
|
-
* HTTP PUT /configuration/manager
|
|
479
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
480
|
-
*/
|
|
481
|
-
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
482
|
-
/**
|
|
483
|
-
* HTTP POST /configuration/manager/file
|
|
484
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
485
|
-
*/
|
|
486
|
-
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
487
|
-
path?: string;
|
|
488
|
-
}, options?: O): RestResponse<string>;
|
|
489
|
-
/**
|
|
490
|
-
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
491
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
492
|
-
*/
|
|
493
|
-
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
494
|
-
}
|
|
495
299
|
export declare class GatewayClientResourceClient<O> {
|
|
496
300
|
protected httpClient: HttpClient<O>;
|
|
497
301
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -528,129 +332,170 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
528
332
|
*/
|
|
529
333
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
530
334
|
}
|
|
531
|
-
export declare class
|
|
335
|
+
export declare class DashboardResourceClient<O> {
|
|
532
336
|
protected httpClient: HttpClient<O>;
|
|
533
337
|
constructor(httpClient: HttpClient<O>);
|
|
534
338
|
/**
|
|
535
|
-
* HTTP
|
|
536
|
-
* Java method: org.openremote.model.
|
|
537
|
-
*/
|
|
538
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
539
|
-
/**
|
|
540
|
-
* HTTP POST /user/query
|
|
541
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
542
|
-
*/
|
|
543
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
544
|
-
/**
|
|
545
|
-
* HTTP PUT /user/request-password-reset
|
|
546
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
339
|
+
* HTTP POST /dashboard
|
|
340
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
547
341
|
*/
|
|
548
|
-
|
|
342
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
549
343
|
/**
|
|
550
|
-
* HTTP PUT /
|
|
551
|
-
* Java method: org.openremote.model.
|
|
344
|
+
* HTTP PUT /dashboard
|
|
345
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
552
346
|
*/
|
|
553
|
-
|
|
347
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
554
348
|
/**
|
|
555
|
-
* HTTP
|
|
556
|
-
* Java method: org.openremote.model.
|
|
349
|
+
* HTTP GET /dashboard/all/{realm}
|
|
350
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
557
351
|
*/
|
|
558
|
-
|
|
352
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
559
353
|
/**
|
|
560
|
-
* HTTP
|
|
561
|
-
* Java method: org.openremote.model.
|
|
354
|
+
* HTTP POST /dashboard/query
|
|
355
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
562
356
|
*/
|
|
563
|
-
|
|
357
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
564
358
|
/**
|
|
565
|
-
* HTTP
|
|
566
|
-
* Java method: org.openremote.model.
|
|
359
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
360
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
567
361
|
*/
|
|
568
|
-
|
|
362
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
569
363
|
/**
|
|
570
|
-
* HTTP GET /
|
|
571
|
-
* Java method: org.openremote.model.
|
|
364
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
365
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
572
366
|
*/
|
|
573
|
-
|
|
367
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
368
|
+
}
|
|
369
|
+
export declare class NotificationResourceClient<O> {
|
|
370
|
+
protected httpClient: HttpClient<O>;
|
|
371
|
+
constructor(httpClient: HttpClient<O>);
|
|
574
372
|
/**
|
|
575
|
-
* HTTP GET /
|
|
576
|
-
* Java method: org.openremote.model.
|
|
373
|
+
* HTTP GET /notification
|
|
374
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
577
375
|
*/
|
|
578
|
-
|
|
376
|
+
getNotifications(queryParams?: {
|
|
377
|
+
id?: number;
|
|
378
|
+
type?: string;
|
|
379
|
+
from?: number;
|
|
380
|
+
to?: number;
|
|
381
|
+
realmId?: string;
|
|
382
|
+
userId?: string;
|
|
383
|
+
assetId?: string;
|
|
384
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
579
385
|
/**
|
|
580
|
-
* HTTP
|
|
581
|
-
* Java method: org.openremote.model.
|
|
386
|
+
* HTTP DELETE /notification
|
|
387
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
582
388
|
*/
|
|
583
|
-
|
|
389
|
+
removeNotifications(queryParams?: {
|
|
390
|
+
id?: number;
|
|
391
|
+
type?: string;
|
|
392
|
+
from?: number;
|
|
393
|
+
to?: number;
|
|
394
|
+
realmId?: string;
|
|
395
|
+
userId?: string;
|
|
396
|
+
assetId?: string;
|
|
397
|
+
}, options?: O): RestResponse<void>;
|
|
584
398
|
/**
|
|
585
|
-
* HTTP
|
|
586
|
-
* Java method: org.openremote.model.
|
|
399
|
+
* HTTP POST /notification/alert
|
|
400
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
587
401
|
*/
|
|
588
|
-
|
|
402
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
589
403
|
/**
|
|
590
|
-
* HTTP
|
|
591
|
-
* Java method: org.openremote.model.
|
|
404
|
+
* HTTP DELETE /notification/{notificationId}
|
|
405
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
592
406
|
*/
|
|
593
|
-
|
|
407
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
594
408
|
/**
|
|
595
|
-
* HTTP PUT /
|
|
596
|
-
* Java method: org.openremote.model.
|
|
409
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
410
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
597
411
|
*/
|
|
598
|
-
|
|
412
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
413
|
+
targetId?: string;
|
|
414
|
+
}, options?: O): RestResponse<void>;
|
|
599
415
|
/**
|
|
600
|
-
* HTTP
|
|
601
|
-
* Java method: org.openremote.model.
|
|
416
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
417
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
602
418
|
*/
|
|
603
|
-
|
|
419
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
420
|
+
targetId?: string;
|
|
421
|
+
}, options?: O): RestResponse<void>;
|
|
422
|
+
}
|
|
423
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
424
|
+
protected httpClient: HttpClient<O>;
|
|
425
|
+
constructor(httpClient: HttpClient<O>);
|
|
604
426
|
/**
|
|
605
|
-
* HTTP
|
|
606
|
-
* Java method: org.openremote.model.
|
|
427
|
+
* HTTP GET /asset/datapoint/export
|
|
428
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
607
429
|
*/
|
|
608
|
-
|
|
430
|
+
getDatapointExport(queryParams?: {
|
|
431
|
+
attributeRefs?: string;
|
|
432
|
+
fromTimestamp?: number;
|
|
433
|
+
toTimestamp?: number;
|
|
434
|
+
}, options?: O): RestResponse<any>;
|
|
609
435
|
/**
|
|
610
|
-
* HTTP GET /
|
|
611
|
-
* Java method: org.openremote.model.
|
|
436
|
+
* HTTP GET /asset/datapoint/periods
|
|
437
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
612
438
|
*/
|
|
613
|
-
|
|
439
|
+
getDatapointPeriod(queryParams?: {
|
|
440
|
+
assetId?: string;
|
|
441
|
+
attributeName?: string;
|
|
442
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
614
443
|
/**
|
|
615
|
-
* HTTP
|
|
616
|
-
* Java method: org.openremote.model.
|
|
444
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
445
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
617
446
|
*/
|
|
618
|
-
|
|
447
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
448
|
+
}
|
|
449
|
+
export declare class ConsoleResourceClient<O> {
|
|
450
|
+
protected httpClient: HttpClient<O>;
|
|
451
|
+
constructor(httpClient: HttpClient<O>);
|
|
619
452
|
/**
|
|
620
|
-
* HTTP
|
|
621
|
-
* Java method: org.openremote.model.
|
|
453
|
+
* HTTP POST /console/register
|
|
454
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
622
455
|
*/
|
|
623
|
-
|
|
456
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
457
|
+
}
|
|
458
|
+
export declare class StatusResourceClient<O> {
|
|
459
|
+
protected httpClient: HttpClient<O>;
|
|
460
|
+
constructor(httpClient: HttpClient<O>);
|
|
624
461
|
/**
|
|
625
|
-
* HTTP
|
|
626
|
-
* Java method: org.openremote.model.
|
|
462
|
+
* HTTP GET /health
|
|
463
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
627
464
|
*/
|
|
628
|
-
|
|
465
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
466
|
+
[index: string]: any;
|
|
467
|
+
}>;
|
|
629
468
|
/**
|
|
630
|
-
* HTTP
|
|
631
|
-
* Java method: org.openremote.model.
|
|
469
|
+
* HTTP GET /info
|
|
470
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
632
471
|
*/
|
|
633
|
-
|
|
472
|
+
getInfo(options?: O): RestResponse<{
|
|
473
|
+
[index: string]: any;
|
|
474
|
+
}>;
|
|
475
|
+
}
|
|
476
|
+
export declare class ProvisioningResourceClient<O> {
|
|
477
|
+
protected httpClient: HttpClient<O>;
|
|
478
|
+
constructor(httpClient: HttpClient<O>);
|
|
634
479
|
/**
|
|
635
|
-
* HTTP
|
|
636
|
-
* Java method: org.openremote.model.
|
|
480
|
+
* HTTP POST /provisioning
|
|
481
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
637
482
|
*/
|
|
638
|
-
|
|
483
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
639
484
|
/**
|
|
640
|
-
* HTTP GET /
|
|
641
|
-
* Java method: org.openremote.model.
|
|
485
|
+
* HTTP GET /provisioning
|
|
486
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
642
487
|
*/
|
|
643
|
-
|
|
488
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
644
489
|
/**
|
|
645
|
-
* HTTP
|
|
646
|
-
* Java method: org.openremote.model.
|
|
490
|
+
* HTTP DELETE /provisioning/{id}
|
|
491
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
647
492
|
*/
|
|
648
|
-
|
|
493
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
649
494
|
/**
|
|
650
|
-
* HTTP
|
|
651
|
-
* Java method: org.openremote.model.
|
|
495
|
+
* HTTP PUT /provisioning/{id}
|
|
496
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
652
497
|
*/
|
|
653
|
-
|
|
498
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
654
499
|
}
|
|
655
500
|
export declare class RulesResourceClient<O> {
|
|
656
501
|
protected httpClient: HttpClient<O>;
|
|
@@ -760,6 +605,61 @@ export declare class RulesResourceClient<O> {
|
|
|
760
605
|
*/
|
|
761
606
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
762
607
|
}
|
|
608
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
609
|
+
protected httpClient: HttpClient<O>;
|
|
610
|
+
constructor(httpClient: HttpClient<O>);
|
|
611
|
+
/**
|
|
612
|
+
* HTTP POST /gateway/tunnel
|
|
613
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
614
|
+
*/
|
|
615
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
616
|
+
/**
|
|
617
|
+
* HTTP DELETE /gateway/tunnel
|
|
618
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
619
|
+
*/
|
|
620
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
621
|
+
/**
|
|
622
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
623
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
624
|
+
*/
|
|
625
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
626
|
+
/**
|
|
627
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
628
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
629
|
+
*/
|
|
630
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
631
|
+
/**
|
|
632
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
633
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
634
|
+
*/
|
|
635
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
636
|
+
}
|
|
637
|
+
export declare class AgentResourceClient<O> {
|
|
638
|
+
protected httpClient: HttpClient<O>;
|
|
639
|
+
constructor(httpClient: HttpClient<O>);
|
|
640
|
+
/**
|
|
641
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
642
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
643
|
+
*/
|
|
644
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
645
|
+
realm?: string;
|
|
646
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
647
|
+
/**
|
|
648
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
649
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
650
|
+
*/
|
|
651
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
652
|
+
realm?: string;
|
|
653
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
654
|
+
/**
|
|
655
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
656
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
657
|
+
*/
|
|
658
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
659
|
+
parentId?: string;
|
|
660
|
+
realm?: string;
|
|
661
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
662
|
+
}
|
|
763
663
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
764
664
|
protected httpClient: HttpClient<O>;
|
|
765
665
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -774,173 +674,273 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
774
674
|
*/
|
|
775
675
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
776
676
|
}
|
|
777
|
-
export declare class
|
|
677
|
+
export declare class AppResourceClient<O> {
|
|
778
678
|
protected httpClient: HttpClient<O>;
|
|
779
679
|
constructor(httpClient: HttpClient<O>);
|
|
780
680
|
/**
|
|
781
|
-
* HTTP
|
|
782
|
-
* Java method: org.openremote.model.
|
|
681
|
+
* HTTP GET /apps
|
|
682
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
783
683
|
*/
|
|
784
|
-
|
|
684
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
785
685
|
/**
|
|
786
|
-
* HTTP
|
|
787
|
-
* Java method: org.openremote.model.
|
|
686
|
+
* HTTP GET /apps/consoleConfig
|
|
687
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
788
688
|
*/
|
|
789
|
-
|
|
689
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
790
690
|
/**
|
|
791
|
-
* HTTP GET /
|
|
792
|
-
* Java method: org.openremote.model.
|
|
691
|
+
* HTTP GET /apps/info
|
|
692
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
793
693
|
*/
|
|
794
|
-
|
|
694
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
695
|
+
}
|
|
696
|
+
export declare class UserResourceClient<O> {
|
|
697
|
+
protected httpClient: HttpClient<O>;
|
|
698
|
+
constructor(httpClient: HttpClient<O>);
|
|
795
699
|
/**
|
|
796
|
-
* HTTP
|
|
797
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* HTTP PUT /user/locale
|
|
701
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
798
702
|
*/
|
|
799
|
-
|
|
703
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
800
704
|
/**
|
|
801
|
-
* HTTP
|
|
802
|
-
* Java method: org.openremote.model.
|
|
705
|
+
* HTTP POST /user/query
|
|
706
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
803
707
|
*/
|
|
804
|
-
|
|
708
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
805
709
|
/**
|
|
806
|
-
* HTTP
|
|
807
|
-
* Java method: org.openremote.model.
|
|
710
|
+
* HTTP PUT /user/request-password-reset
|
|
711
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
808
712
|
*/
|
|
809
|
-
|
|
810
|
-
}
|
|
811
|
-
export declare class RealmResourceClient<O> {
|
|
812
|
-
protected httpClient: HttpClient<O>;
|
|
813
|
-
constructor(httpClient: HttpClient<O>);
|
|
713
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
814
714
|
/**
|
|
815
|
-
* HTTP
|
|
816
|
-
* Java method: org.openremote.model.security.
|
|
715
|
+
* HTTP PUT /user/reset-password
|
|
716
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
817
717
|
*/
|
|
818
|
-
|
|
718
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
819
719
|
/**
|
|
820
|
-
* HTTP
|
|
821
|
-
* Java method: org.openremote.model.security.
|
|
720
|
+
* HTTP PUT /user/update
|
|
721
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
822
722
|
*/
|
|
823
|
-
|
|
723
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
824
724
|
/**
|
|
825
|
-
* HTTP GET /
|
|
826
|
-
* Java method: org.openremote.model.security.
|
|
725
|
+
* HTTP GET /user/user
|
|
726
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
827
727
|
*/
|
|
828
|
-
|
|
728
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
829
729
|
/**
|
|
830
|
-
* HTTP
|
|
831
|
-
* Java method: org.openremote.model.security.
|
|
730
|
+
* HTTP GET /user/userRealmRoles
|
|
731
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
832
732
|
*/
|
|
833
|
-
|
|
733
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
834
734
|
/**
|
|
835
|
-
* HTTP GET /
|
|
836
|
-
* Java method: org.openremote.model.security.
|
|
735
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
736
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
837
737
|
*/
|
|
838
|
-
|
|
738
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
839
739
|
/**
|
|
840
|
-
* HTTP
|
|
841
|
-
* Java method: org.openremote.model.security.
|
|
740
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
741
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
842
742
|
*/
|
|
843
|
-
|
|
743
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
744
|
+
/**
|
|
745
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
746
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
747
|
+
*/
|
|
748
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
749
|
+
/**
|
|
750
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
751
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
752
|
+
*/
|
|
753
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
754
|
+
/**
|
|
755
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
756
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
757
|
+
*/
|
|
758
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
759
|
+
/**
|
|
760
|
+
* HTTP PUT /user/{realm}/roles
|
|
761
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
762
|
+
*/
|
|
763
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
764
|
+
/**
|
|
765
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
766
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
767
|
+
*/
|
|
768
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
769
|
+
/**
|
|
770
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
771
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
772
|
+
*/
|
|
773
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
774
|
+
/**
|
|
775
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
776
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
777
|
+
*/
|
|
778
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
779
|
+
/**
|
|
780
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
781
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
782
|
+
*/
|
|
783
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
784
|
+
/**
|
|
785
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
786
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
787
|
+
*/
|
|
788
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
789
|
+
/**
|
|
790
|
+
* HTTP POST /user/{realm}/users
|
|
791
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
792
|
+
*/
|
|
793
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
794
|
+
/**
|
|
795
|
+
* HTTP PUT /user/{realm}/users
|
|
796
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
797
|
+
*/
|
|
798
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
799
|
+
/**
|
|
800
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
801
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
802
|
+
*/
|
|
803
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
804
|
+
/**
|
|
805
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
806
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
807
|
+
*/
|
|
808
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
809
|
+
/**
|
|
810
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
811
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
812
|
+
*/
|
|
813
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
814
|
+
/**
|
|
815
|
+
* HTTP GET /user/{realm}/{userId}
|
|
816
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
817
|
+
*/
|
|
818
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
844
819
|
}
|
|
845
|
-
export declare class
|
|
820
|
+
export declare class ConfigurationResourceClient<O> {
|
|
846
821
|
protected httpClient: HttpClient<O>;
|
|
847
822
|
constructor(httpClient: HttpClient<O>);
|
|
848
823
|
/**
|
|
849
|
-
* HTTP GET /
|
|
850
|
-
* Java method: org.openremote.model.
|
|
824
|
+
* HTTP GET /configuration/manager
|
|
825
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
851
826
|
*/
|
|
852
|
-
|
|
853
|
-
id?: number;
|
|
854
|
-
type?: string;
|
|
855
|
-
from?: number;
|
|
856
|
-
to?: number;
|
|
857
|
-
realmId?: string;
|
|
858
|
-
userId?: string;
|
|
859
|
-
assetId?: string;
|
|
860
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
827
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
861
828
|
/**
|
|
862
|
-
* HTTP
|
|
863
|
-
* Java method: org.openremote.model.
|
|
829
|
+
* HTTP PUT /configuration/manager
|
|
830
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
864
831
|
*/
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
832
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
833
|
+
/**
|
|
834
|
+
* HTTP POST /configuration/manager/file
|
|
835
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
836
|
+
*/
|
|
837
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
838
|
+
path?: string;
|
|
839
|
+
}, options?: O): RestResponse<string>;
|
|
840
|
+
/**
|
|
841
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
842
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
843
|
+
*/
|
|
844
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
845
|
+
}
|
|
846
|
+
export declare class AlarmResourceClient<O> {
|
|
847
|
+
protected httpClient: HttpClient<O>;
|
|
848
|
+
constructor(httpClient: HttpClient<O>);
|
|
849
|
+
/**
|
|
850
|
+
* HTTP POST /alarm
|
|
851
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
852
|
+
*/
|
|
853
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
854
|
+
assetIds?: string[];
|
|
855
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
856
|
+
/**
|
|
857
|
+
* HTTP GET /alarm
|
|
858
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
859
|
+
*/
|
|
860
|
+
getAlarms(queryParams?: {
|
|
861
|
+
realm?: string;
|
|
862
|
+
status?: Model.AlarmStatus;
|
|
872
863
|
assetId?: string;
|
|
873
|
-
|
|
864
|
+
assigneeId?: string;
|
|
865
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
874
866
|
/**
|
|
875
|
-
* HTTP
|
|
876
|
-
* Java method: org.openremote.model.
|
|
867
|
+
* HTTP DELETE /alarm
|
|
868
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
877
869
|
*/
|
|
878
|
-
|
|
870
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
879
871
|
/**
|
|
880
|
-
* HTTP
|
|
881
|
-
* Java method: org.openremote.model.
|
|
872
|
+
* HTTP PUT /alarm/assets
|
|
873
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
882
874
|
*/
|
|
883
|
-
|
|
875
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
884
876
|
/**
|
|
885
|
-
* HTTP
|
|
886
|
-
* Java method: org.openremote.model.
|
|
877
|
+
* HTTP GET /alarm/{alarmId}
|
|
878
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
887
879
|
*/
|
|
888
|
-
|
|
889
|
-
targetId?: string;
|
|
890
|
-
}, options?: O): RestResponse<void>;
|
|
880
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
891
881
|
/**
|
|
892
|
-
* HTTP
|
|
893
|
-
* Java method: org.openremote.model.
|
|
882
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
883
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
894
884
|
*/
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
885
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
886
|
+
/**
|
|
887
|
+
* HTTP PUT /alarm/{alarmId}
|
|
888
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
889
|
+
*/
|
|
890
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
891
|
+
/**
|
|
892
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
893
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
894
|
+
*/
|
|
895
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
896
|
+
realm?: string;
|
|
897
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
901
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
902
902
|
protected _assetResource: AxiosAssetResourceClient;
|
|
903
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
904
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
905
|
-
protected _appResource: AxiosAppResourceClient;
|
|
906
903
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
907
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
908
904
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
909
|
-
protected
|
|
910
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
911
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
912
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
905
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
913
906
|
protected _mapResource: AxiosMapResourceClient;
|
|
914
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
915
907
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
916
|
-
protected _userResource: AxiosUserResourceClient;
|
|
917
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
918
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
919
908
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
920
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
921
909
|
protected _notificationResource: AxiosNotificationResourceClient;
|
|
910
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
911
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
912
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
913
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
914
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
915
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
916
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
917
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
918
|
+
protected _appResource: AxiosAppResourceClient;
|
|
919
|
+
protected _userResource: AxiosUserResourceClient;
|
|
920
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
921
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
923
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
924
924
|
get AssetResource(): AxiosAssetResourceClient;
|
|
925
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
926
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
927
|
-
get AppResource(): AxiosAppResourceClient;
|
|
928
925
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
929
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
930
926
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
931
|
-
get
|
|
932
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
933
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
934
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
927
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
935
928
|
get MapResource(): AxiosMapResourceClient;
|
|
936
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
937
929
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
938
|
-
get UserResource(): AxiosUserResourceClient;
|
|
939
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
940
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
941
930
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
942
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
943
931
|
get NotificationResource(): AxiosNotificationResourceClient;
|
|
932
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
933
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
934
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
935
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
936
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
937
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
938
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
939
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
940
|
+
get AppResource(): AxiosAppResourceClient;
|
|
941
|
+
get UserResource(): AxiosUserResourceClient;
|
|
942
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
943
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
954
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
|
-
export declare class
|
|
978
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
984
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|