@openremote/rest 1.7.0-snapshot.20250707100509 → 1.7.0
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.js +1 -1
- package/lib/restclient.d.ts +453 -453
- 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,68 +9,24 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP POST /gateway/tunnel
|
|
17
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
18
|
-
*/
|
|
19
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
20
|
-
/**
|
|
21
|
-
* HTTP DELETE /gateway/tunnel
|
|
22
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
23
|
-
*/
|
|
24
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
25
|
-
/**
|
|
26
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
27
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
28
|
-
*/
|
|
29
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
30
|
-
/**
|
|
31
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
32
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
33
|
-
*/
|
|
34
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
35
|
-
/**
|
|
36
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
37
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
38
|
-
*/
|
|
39
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
40
|
-
}
|
|
41
|
-
export declare class RealmResourceClient<O> {
|
|
12
|
+
export declare class AppResourceClient<O> {
|
|
42
13
|
protected httpClient: HttpClient<O>;
|
|
43
14
|
constructor(httpClient: HttpClient<O>);
|
|
44
15
|
/**
|
|
45
|
-
* HTTP
|
|
46
|
-
* Java method: org.openremote.model.
|
|
47
|
-
*/
|
|
48
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
49
|
-
/**
|
|
50
|
-
* HTTP GET /realm
|
|
51
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
52
|
-
*/
|
|
53
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
54
|
-
/**
|
|
55
|
-
* HTTP GET /realm/accessible
|
|
56
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
57
|
-
*/
|
|
58
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
59
|
-
/**
|
|
60
|
-
* HTTP DELETE /realm/{name}
|
|
61
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
16
|
+
* HTTP GET /apps
|
|
17
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
62
18
|
*/
|
|
63
|
-
|
|
19
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
64
20
|
/**
|
|
65
|
-
* HTTP GET /
|
|
66
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /apps/consoleConfig
|
|
22
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
67
23
|
*/
|
|
68
|
-
|
|
24
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
69
25
|
/**
|
|
70
|
-
* HTTP
|
|
71
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP GET /apps/info
|
|
27
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
72
28
|
*/
|
|
73
|
-
|
|
29
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
74
30
|
}
|
|
75
31
|
export declare class MapResourceClient<O> {
|
|
76
32
|
protected httpClient: HttpClient<O>;
|
|
@@ -125,156 +81,175 @@ export declare class MapResourceClient<O> {
|
|
|
125
81
|
[id: string]: unknown;
|
|
126
82
|
}>;
|
|
127
83
|
}
|
|
128
|
-
export declare class
|
|
84
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
129
85
|
protected httpClient: HttpClient<O>;
|
|
130
86
|
constructor(httpClient: HttpClient<O>);
|
|
131
87
|
/**
|
|
132
|
-
* HTTP
|
|
133
|
-
* Java method: org.openremote.model.
|
|
134
|
-
*/
|
|
135
|
-
getDatapointExport(queryParams?: {
|
|
136
|
-
attributeRefs?: string;
|
|
137
|
-
fromTimestamp?: number;
|
|
138
|
-
toTimestamp?: number;
|
|
139
|
-
}, options?: O): RestResponse<any>;
|
|
140
|
-
/**
|
|
141
|
-
* HTTP GET /asset/datapoint/periods
|
|
142
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
143
|
-
*/
|
|
144
|
-
getDatapointPeriod(queryParams?: {
|
|
145
|
-
assetId?: string;
|
|
146
|
-
attributeName?: string;
|
|
147
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
148
|
-
/**
|
|
149
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
150
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
88
|
+
* HTTP POST /gateway/tunnel
|
|
89
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
151
90
|
*/
|
|
152
|
-
|
|
153
|
-
}
|
|
154
|
-
export declare class ConfigurationResourceClient<O> {
|
|
155
|
-
protected httpClient: HttpClient<O>;
|
|
156
|
-
constructor(httpClient: HttpClient<O>);
|
|
91
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
157
92
|
/**
|
|
158
|
-
* HTTP
|
|
159
|
-
* Java method: org.openremote.model.
|
|
93
|
+
* HTTP DELETE /gateway/tunnel
|
|
94
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
160
95
|
*/
|
|
161
|
-
|
|
96
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
162
97
|
/**
|
|
163
|
-
* HTTP
|
|
164
|
-
* Java method: org.openremote.model.
|
|
98
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
99
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
165
100
|
*/
|
|
166
|
-
|
|
101
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
167
102
|
/**
|
|
168
|
-
* HTTP
|
|
169
|
-
* Java method: org.openremote.model.
|
|
103
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
104
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
170
105
|
*/
|
|
171
|
-
|
|
172
|
-
path?: string;
|
|
173
|
-
}, options?: O): RestResponse<string>;
|
|
106
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
174
107
|
/**
|
|
175
|
-
* HTTP GET /
|
|
176
|
-
* Java method: org.openremote.model.
|
|
108
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
109
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
177
110
|
*/
|
|
178
|
-
|
|
111
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
179
112
|
}
|
|
180
|
-
export declare class
|
|
113
|
+
export declare class AssetModelResourceClient<O> {
|
|
181
114
|
protected httpClient: HttpClient<O>;
|
|
182
115
|
constructor(httpClient: HttpClient<O>);
|
|
183
116
|
/**
|
|
184
|
-
* HTTP
|
|
185
|
-
* Java method: org.openremote.model.
|
|
186
|
-
*/
|
|
187
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
188
|
-
/**
|
|
189
|
-
* HTTP PUT /dashboard
|
|
190
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
117
|
+
* HTTP GET /model/assetDescriptors
|
|
118
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
191
119
|
*/
|
|
192
|
-
|
|
120
|
+
getAssetDescriptors(queryParams?: {
|
|
121
|
+
parentId?: string;
|
|
122
|
+
parentType?: string;
|
|
123
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
193
124
|
/**
|
|
194
|
-
* HTTP GET /
|
|
195
|
-
* Java method: org.openremote.model.
|
|
125
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
126
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
196
127
|
*/
|
|
197
|
-
|
|
128
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
129
|
+
parentId?: string;
|
|
130
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
198
131
|
/**
|
|
199
|
-
* HTTP
|
|
200
|
-
* Java method: org.openremote.model.
|
|
132
|
+
* HTTP GET /model/assetInfos
|
|
133
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
201
134
|
*/
|
|
202
|
-
|
|
135
|
+
getAssetInfos(queryParams?: {
|
|
136
|
+
parentId?: string;
|
|
137
|
+
parentType?: string;
|
|
138
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
203
139
|
/**
|
|
204
|
-
* HTTP
|
|
205
|
-
* Java method: org.openremote.model.
|
|
140
|
+
* HTTP GET /model/metaItemDescriptors
|
|
141
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
206
142
|
*/
|
|
207
|
-
|
|
143
|
+
getMetaItemDescriptors(queryParams?: {
|
|
144
|
+
parentId?: string;
|
|
145
|
+
}, options?: O): RestResponse<{
|
|
146
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
147
|
+
}>;
|
|
208
148
|
/**
|
|
209
|
-
* HTTP GET /
|
|
210
|
-
* Java method: org.openremote.model.
|
|
149
|
+
* HTTP GET /model/valueDescriptors
|
|
150
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
211
151
|
*/
|
|
212
|
-
|
|
152
|
+
getValueDescriptors(queryParams?: {
|
|
153
|
+
parentId?: string;
|
|
154
|
+
}, options?: O): RestResponse<{
|
|
155
|
+
[index: string]: Model.ValueDescriptor;
|
|
156
|
+
}>;
|
|
213
157
|
}
|
|
214
|
-
export declare class
|
|
158
|
+
export declare class AlarmResourceClient<O> {
|
|
215
159
|
protected httpClient: HttpClient<O>;
|
|
216
160
|
constructor(httpClient: HttpClient<O>);
|
|
217
161
|
/**
|
|
218
|
-
* HTTP
|
|
219
|
-
* Java method: org.openremote.model.
|
|
162
|
+
* HTTP POST /alarm
|
|
163
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
220
164
|
*/
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
from?: number;
|
|
225
|
-
to?: number;
|
|
226
|
-
realmId?: string;
|
|
227
|
-
userId?: string;
|
|
228
|
-
assetId?: string;
|
|
229
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
165
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
166
|
+
assetIds?: string[];
|
|
167
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
230
168
|
/**
|
|
231
|
-
* HTTP
|
|
232
|
-
* Java method: org.openremote.model.
|
|
169
|
+
* HTTP GET /alarm
|
|
170
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
233
171
|
*/
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
from?: number;
|
|
238
|
-
to?: number;
|
|
239
|
-
realmId?: string;
|
|
240
|
-
userId?: string;
|
|
172
|
+
getAlarms(queryParams?: {
|
|
173
|
+
realm?: string;
|
|
174
|
+
status?: Model.AlarmStatus;
|
|
241
175
|
assetId?: string;
|
|
242
|
-
|
|
176
|
+
assigneeId?: string;
|
|
177
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
243
178
|
/**
|
|
244
|
-
* HTTP
|
|
245
|
-
* Java method: org.openremote.model.
|
|
179
|
+
* HTTP DELETE /alarm
|
|
180
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
246
181
|
*/
|
|
247
|
-
|
|
182
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
248
183
|
/**
|
|
249
|
-
* HTTP
|
|
250
|
-
* Java method: org.openremote.model.
|
|
184
|
+
* HTTP PUT /alarm/assets
|
|
185
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
251
186
|
*/
|
|
252
|
-
|
|
187
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
253
188
|
/**
|
|
254
|
-
* HTTP
|
|
255
|
-
* Java method: org.openremote.model.
|
|
189
|
+
* HTTP GET /alarm/{alarmId}
|
|
190
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
256
191
|
*/
|
|
257
|
-
|
|
258
|
-
targetId?: string;
|
|
259
|
-
}, options?: O): RestResponse<void>;
|
|
192
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
260
193
|
/**
|
|
261
|
-
* HTTP
|
|
262
|
-
* Java method: org.openremote.model.
|
|
194
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
195
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
263
196
|
*/
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
197
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
198
|
+
/**
|
|
199
|
+
* HTTP PUT /alarm/{alarmId}
|
|
200
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
201
|
+
*/
|
|
202
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
203
|
+
/**
|
|
204
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
205
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
206
|
+
*/
|
|
207
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
208
|
+
realm?: string;
|
|
209
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
267
210
|
}
|
|
268
|
-
export declare class
|
|
211
|
+
export declare class SyslogResourceClient<O> {
|
|
269
212
|
protected httpClient: HttpClient<O>;
|
|
270
213
|
constructor(httpClient: HttpClient<O>);
|
|
271
214
|
/**
|
|
272
|
-
* HTTP
|
|
273
|
-
* Java method: org.openremote.model.
|
|
215
|
+
* HTTP GET /syslog/config
|
|
216
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
274
217
|
*/
|
|
275
|
-
|
|
218
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
276
219
|
/**
|
|
277
|
-
* HTTP
|
|
220
|
+
* HTTP PUT /syslog/config
|
|
221
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
222
|
+
*/
|
|
223
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
224
|
+
/**
|
|
225
|
+
* HTTP DELETE /syslog/event
|
|
226
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
227
|
+
*/
|
|
228
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
229
|
+
/**
|
|
230
|
+
* HTTP GET /syslog/event
|
|
231
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
232
|
+
*/
|
|
233
|
+
getEvents(queryParams?: {
|
|
234
|
+
level?: Model.SyslogLevel;
|
|
235
|
+
per_page?: number;
|
|
236
|
+
page?: number;
|
|
237
|
+
from?: number;
|
|
238
|
+
to?: number;
|
|
239
|
+
category?: Model.SyslogCategory[];
|
|
240
|
+
subCategory?: string[];
|
|
241
|
+
}, options?: O): RestResponse<any>;
|
|
242
|
+
}
|
|
243
|
+
export declare class AssetResourceClient<O> {
|
|
244
|
+
protected httpClient: HttpClient<O>;
|
|
245
|
+
constructor(httpClient: HttpClient<O>);
|
|
246
|
+
/**
|
|
247
|
+
* HTTP POST /asset
|
|
248
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
249
|
+
*/
|
|
250
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
251
|
+
/**
|
|
252
|
+
* HTTP DELETE /asset
|
|
278
253
|
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
279
254
|
*/
|
|
280
255
|
delete(queryParams?: {
|
|
@@ -369,25 +344,6 @@ export declare class AssetResourceClient<O> {
|
|
|
369
344
|
assetIds?: string[];
|
|
370
345
|
}, options?: O): RestResponse<void>;
|
|
371
346
|
}
|
|
372
|
-
export declare class AppResourceClient<O> {
|
|
373
|
-
protected httpClient: HttpClient<O>;
|
|
374
|
-
constructor(httpClient: HttpClient<O>);
|
|
375
|
-
/**
|
|
376
|
-
* HTTP GET /apps
|
|
377
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
378
|
-
*/
|
|
379
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
380
|
-
/**
|
|
381
|
-
* HTTP GET /apps/consoleConfig
|
|
382
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
383
|
-
*/
|
|
384
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
385
|
-
/**
|
|
386
|
-
* HTTP GET /apps/info
|
|
387
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
388
|
-
*/
|
|
389
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
390
|
-
}
|
|
391
347
|
export declare class UserResourceClient<O> {
|
|
392
348
|
protected httpClient: HttpClient<O>;
|
|
393
349
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -492,158 +448,109 @@ export declare class UserResourceClient<O> {
|
|
|
492
448
|
*/
|
|
493
449
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
494
450
|
}
|
|
495
|
-
export declare class
|
|
451
|
+
export declare class RealmResourceClient<O> {
|
|
496
452
|
protected httpClient: HttpClient<O>;
|
|
497
453
|
constructor(httpClient: HttpClient<O>);
|
|
498
454
|
/**
|
|
499
|
-
* HTTP
|
|
500
|
-
* Java method: org.openremote.model.
|
|
455
|
+
* HTTP POST /realm
|
|
456
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
501
457
|
*/
|
|
502
|
-
|
|
503
|
-
parentId?: string;
|
|
504
|
-
parentType?: string;
|
|
505
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
458
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
506
459
|
/**
|
|
507
|
-
* HTTP GET /
|
|
508
|
-
* Java method: org.openremote.model.
|
|
460
|
+
* HTTP GET /realm
|
|
461
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
509
462
|
*/
|
|
510
|
-
|
|
511
|
-
parentId?: string;
|
|
512
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
463
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
513
464
|
/**
|
|
514
|
-
* HTTP GET /
|
|
515
|
-
* Java method: org.openremote.model.
|
|
465
|
+
* HTTP GET /realm/accessible
|
|
466
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
516
467
|
*/
|
|
517
|
-
|
|
518
|
-
parentId?: string;
|
|
519
|
-
parentType?: string;
|
|
520
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
468
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
521
469
|
/**
|
|
522
|
-
* HTTP
|
|
523
|
-
* Java method: org.openremote.model.
|
|
470
|
+
* HTTP DELETE /realm/{name}
|
|
471
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
524
472
|
*/
|
|
525
|
-
|
|
526
|
-
parentId?: string;
|
|
527
|
-
}, options?: O): RestResponse<{
|
|
528
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
529
|
-
}>;
|
|
473
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
530
474
|
/**
|
|
531
|
-
* HTTP GET /
|
|
532
|
-
* Java method: org.openremote.model.
|
|
475
|
+
* HTTP GET /realm/{name}
|
|
476
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
533
477
|
*/
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
478
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
479
|
+
/**
|
|
480
|
+
* HTTP PUT /realm/{name}
|
|
481
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
482
|
+
*/
|
|
483
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
539
484
|
}
|
|
540
|
-
export declare class
|
|
485
|
+
export declare class GatewayClientResourceClient<O> {
|
|
541
486
|
protected httpClient: HttpClient<O>;
|
|
542
487
|
constructor(httpClient: HttpClient<O>);
|
|
543
488
|
/**
|
|
544
|
-
* HTTP
|
|
545
|
-
* Java method: org.openremote.model.
|
|
546
|
-
*/
|
|
547
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
548
|
-
/**
|
|
549
|
-
* HTTP GET /rules
|
|
550
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
551
|
-
*/
|
|
552
|
-
getGlobalRulesets(queryParams?: {
|
|
553
|
-
language?: Model.RulesetLang[];
|
|
554
|
-
fullyPopulate?: boolean;
|
|
555
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
556
|
-
/**
|
|
557
|
-
* HTTP POST /rules/asset
|
|
558
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
559
|
-
*/
|
|
560
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
561
|
-
/**
|
|
562
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
563
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
564
|
-
*/
|
|
565
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
566
|
-
language?: Model.RulesetLang[];
|
|
567
|
-
fullyPopulate?: boolean;
|
|
568
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
569
|
-
/**
|
|
570
|
-
* HTTP DELETE /rules/asset/{id}
|
|
571
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
572
|
-
*/
|
|
573
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
574
|
-
/**
|
|
575
|
-
* HTTP GET /rules/asset/{id}
|
|
576
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
577
|
-
*/
|
|
578
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
579
|
-
/**
|
|
580
|
-
* HTTP PUT /rules/asset/{id}
|
|
581
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
582
|
-
*/
|
|
583
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
584
|
-
/**
|
|
585
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
586
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
489
|
+
* HTTP DELETE /gateway/connection
|
|
490
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
587
491
|
*/
|
|
588
|
-
|
|
492
|
+
deleteConnections(queryParams?: {
|
|
493
|
+
realm?: string[];
|
|
494
|
+
}, options?: O): RestResponse<void>;
|
|
589
495
|
/**
|
|
590
|
-
* HTTP GET /
|
|
591
|
-
* Java method: org.openremote.model.
|
|
496
|
+
* HTTP GET /gateway/connection
|
|
497
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
592
498
|
*/
|
|
593
|
-
|
|
499
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
594
500
|
/**
|
|
595
|
-
* HTTP
|
|
596
|
-
* Java method: org.openremote.model.
|
|
501
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
502
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
597
503
|
*/
|
|
598
|
-
|
|
504
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
599
505
|
/**
|
|
600
|
-
* HTTP GET /
|
|
601
|
-
* Java method: org.openremote.model.
|
|
506
|
+
* HTTP GET /gateway/connection/{realm}
|
|
507
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
602
508
|
*/
|
|
603
|
-
|
|
509
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
604
510
|
/**
|
|
605
|
-
* HTTP
|
|
606
|
-
* Java method: org.openremote.model.
|
|
511
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
512
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
607
513
|
*/
|
|
608
|
-
|
|
514
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
609
515
|
/**
|
|
610
|
-
* HTTP GET /
|
|
611
|
-
* Java method: org.openremote.model.
|
|
516
|
+
* HTTP GET /gateway/status/{realm}
|
|
517
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
612
518
|
*/
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
519
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
520
|
+
}
|
|
521
|
+
export declare class DashboardResourceClient<O> {
|
|
522
|
+
protected httpClient: HttpClient<O>;
|
|
523
|
+
constructor(httpClient: HttpClient<O>);
|
|
617
524
|
/**
|
|
618
|
-
* HTTP
|
|
619
|
-
* Java method: org.openremote.model.
|
|
525
|
+
* HTTP POST /dashboard
|
|
526
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
620
527
|
*/
|
|
621
|
-
|
|
528
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
622
529
|
/**
|
|
623
|
-
* HTTP
|
|
624
|
-
* Java method: org.openremote.model.
|
|
530
|
+
* HTTP PUT /dashboard
|
|
531
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
625
532
|
*/
|
|
626
|
-
|
|
533
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
627
534
|
/**
|
|
628
|
-
* HTTP
|
|
629
|
-
* Java method: org.openremote.model.
|
|
535
|
+
* HTTP GET /dashboard/all/{realm}
|
|
536
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
630
537
|
*/
|
|
631
|
-
|
|
538
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
632
539
|
/**
|
|
633
|
-
* HTTP
|
|
634
|
-
* Java method: org.openremote.model.
|
|
540
|
+
* HTTP POST /dashboard/query
|
|
541
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
635
542
|
*/
|
|
636
|
-
|
|
543
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
637
544
|
/**
|
|
638
|
-
* HTTP
|
|
639
|
-
* Java method: org.openremote.model.
|
|
545
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
546
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
640
547
|
*/
|
|
641
|
-
|
|
548
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
642
549
|
/**
|
|
643
|
-
* HTTP
|
|
644
|
-
* Java method: org.openremote.model.
|
|
550
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
551
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
645
552
|
*/
|
|
646
|
-
|
|
553
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
647
554
|
}
|
|
648
555
|
export declare class AgentResourceClient<O> {
|
|
649
556
|
protected httpClient: HttpClient<O>;
|
|
@@ -671,154 +578,214 @@ export declare class AgentResourceClient<O> {
|
|
|
671
578
|
realm?: string;
|
|
672
579
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
673
580
|
}
|
|
674
|
-
export declare class
|
|
581
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
675
582
|
protected httpClient: HttpClient<O>;
|
|
676
583
|
constructor(httpClient: HttpClient<O>);
|
|
677
584
|
/**
|
|
678
|
-
* HTTP
|
|
679
|
-
* Java method: org.openremote.model.
|
|
585
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
586
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
680
587
|
*/
|
|
681
|
-
|
|
588
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
682
589
|
/**
|
|
683
|
-
* HTTP
|
|
684
|
-
* Java method: org.openremote.model.
|
|
590
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
591
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
685
592
|
*/
|
|
686
|
-
|
|
593
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
594
|
+
}
|
|
595
|
+
export declare class ProvisioningResourceClient<O> {
|
|
596
|
+
protected httpClient: HttpClient<O>;
|
|
597
|
+
constructor(httpClient: HttpClient<O>);
|
|
687
598
|
/**
|
|
688
|
-
* HTTP
|
|
689
|
-
* Java method: org.openremote.model.
|
|
599
|
+
* HTTP POST /provisioning
|
|
600
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
690
601
|
*/
|
|
691
|
-
|
|
602
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
603
|
+
/**
|
|
604
|
+
* HTTP GET /provisioning
|
|
605
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
606
|
+
*/
|
|
607
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
608
|
+
/**
|
|
609
|
+
* HTTP DELETE /provisioning/{id}
|
|
610
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
611
|
+
*/
|
|
612
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
613
|
+
/**
|
|
614
|
+
* HTTP PUT /provisioning/{id}
|
|
615
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
616
|
+
*/
|
|
617
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
692
618
|
}
|
|
693
|
-
export declare class
|
|
619
|
+
export declare class NotificationResourceClient<O> {
|
|
694
620
|
protected httpClient: HttpClient<O>;
|
|
695
621
|
constructor(httpClient: HttpClient<O>);
|
|
696
622
|
/**
|
|
697
|
-
* HTTP
|
|
698
|
-
* Java method: org.openremote.model.
|
|
623
|
+
* HTTP GET /notification
|
|
624
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
699
625
|
*/
|
|
700
|
-
|
|
701
|
-
|
|
626
|
+
getNotifications(queryParams?: {
|
|
627
|
+
id?: number;
|
|
628
|
+
type?: string;
|
|
629
|
+
from?: number;
|
|
630
|
+
to?: number;
|
|
631
|
+
realmId?: string;
|
|
632
|
+
userId?: string;
|
|
633
|
+
assetId?: string;
|
|
634
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
635
|
+
/**
|
|
636
|
+
* HTTP DELETE /notification
|
|
637
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
638
|
+
*/
|
|
639
|
+
removeNotifications(queryParams?: {
|
|
640
|
+
id?: number;
|
|
641
|
+
type?: string;
|
|
642
|
+
from?: number;
|
|
643
|
+
to?: number;
|
|
644
|
+
realmId?: string;
|
|
645
|
+
userId?: string;
|
|
646
|
+
assetId?: string;
|
|
702
647
|
}, options?: O): RestResponse<void>;
|
|
703
648
|
/**
|
|
704
|
-
* HTTP
|
|
705
|
-
* Java method: org.openremote.model.
|
|
649
|
+
* HTTP POST /notification/alert
|
|
650
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
706
651
|
*/
|
|
707
|
-
|
|
652
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
708
653
|
/**
|
|
709
|
-
* HTTP DELETE /
|
|
710
|
-
* Java method: org.openremote.model.
|
|
654
|
+
* HTTP DELETE /notification/{notificationId}
|
|
655
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
711
656
|
*/
|
|
712
|
-
|
|
657
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
713
658
|
/**
|
|
714
|
-
* HTTP
|
|
715
|
-
* Java method: org.openremote.model.
|
|
659
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
660
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
716
661
|
*/
|
|
717
|
-
|
|
662
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
663
|
+
targetId?: string;
|
|
664
|
+
}, options?: O): RestResponse<void>;
|
|
718
665
|
/**
|
|
719
|
-
* HTTP PUT /
|
|
720
|
-
* Java method: org.openremote.model.
|
|
666
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
667
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
721
668
|
*/
|
|
722
|
-
|
|
669
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
670
|
+
targetId?: string;
|
|
671
|
+
}, options?: O): RestResponse<void>;
|
|
672
|
+
}
|
|
673
|
+
export declare class ConsoleResourceClient<O> {
|
|
674
|
+
protected httpClient: HttpClient<O>;
|
|
675
|
+
constructor(httpClient: HttpClient<O>);
|
|
723
676
|
/**
|
|
724
|
-
* HTTP
|
|
725
|
-
* Java method: org.openremote.model.
|
|
677
|
+
* HTTP POST /console/register
|
|
678
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
726
679
|
*/
|
|
727
|
-
|
|
680
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
728
681
|
}
|
|
729
|
-
export declare class
|
|
682
|
+
export declare class RulesResourceClient<O> {
|
|
730
683
|
protected httpClient: HttpClient<O>;
|
|
731
684
|
constructor(httpClient: HttpClient<O>);
|
|
732
685
|
/**
|
|
733
|
-
* HTTP POST /
|
|
734
|
-
* Java method: org.openremote.model.
|
|
686
|
+
* HTTP POST /rules
|
|
687
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
735
688
|
*/
|
|
736
|
-
|
|
737
|
-
assetIds?: string[];
|
|
738
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
689
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
739
690
|
/**
|
|
740
|
-
* HTTP GET /
|
|
741
|
-
* Java method: org.openremote.model.
|
|
691
|
+
* HTTP GET /rules
|
|
692
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
742
693
|
*/
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
assigneeId?: string;
|
|
748
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
694
|
+
getGlobalRulesets(queryParams?: {
|
|
695
|
+
language?: Model.RulesetLang[];
|
|
696
|
+
fullyPopulate?: boolean;
|
|
697
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
749
698
|
/**
|
|
750
|
-
* HTTP
|
|
751
|
-
* Java method: org.openremote.model.
|
|
699
|
+
* HTTP POST /rules/asset
|
|
700
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
701
|
+
*/
|
|
702
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
703
|
+
/**
|
|
704
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
705
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
706
|
+
*/
|
|
707
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
708
|
+
language?: Model.RulesetLang[];
|
|
709
|
+
fullyPopulate?: boolean;
|
|
710
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
711
|
+
/**
|
|
712
|
+
* HTTP DELETE /rules/asset/{id}
|
|
713
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
714
|
+
*/
|
|
715
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
716
|
+
/**
|
|
717
|
+
* HTTP GET /rules/asset/{id}
|
|
718
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
719
|
+
*/
|
|
720
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
721
|
+
/**
|
|
722
|
+
* HTTP PUT /rules/asset/{id}
|
|
723
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
724
|
+
*/
|
|
725
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
726
|
+
/**
|
|
727
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
728
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
729
|
+
*/
|
|
730
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
731
|
+
/**
|
|
732
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
733
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
752
734
|
*/
|
|
753
|
-
|
|
735
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
754
736
|
/**
|
|
755
|
-
* HTTP
|
|
756
|
-
* Java method: org.openremote.model.
|
|
737
|
+
* HTTP GET /rules/info/global
|
|
738
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
757
739
|
*/
|
|
758
|
-
|
|
740
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
759
741
|
/**
|
|
760
|
-
* HTTP GET /
|
|
761
|
-
* Java method: org.openremote.model.
|
|
742
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
743
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
762
744
|
*/
|
|
763
|
-
|
|
745
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
764
746
|
/**
|
|
765
|
-
* HTTP
|
|
766
|
-
* Java method: org.openremote.model.
|
|
747
|
+
* HTTP POST /rules/realm
|
|
748
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
767
749
|
*/
|
|
768
|
-
|
|
750
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
769
751
|
/**
|
|
770
|
-
* HTTP
|
|
771
|
-
* Java method: org.openremote.model.
|
|
752
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
753
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
772
754
|
*/
|
|
773
|
-
|
|
755
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
756
|
+
language?: Model.RulesetLang[];
|
|
757
|
+
fullyPopulate?: boolean;
|
|
758
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
774
759
|
/**
|
|
775
|
-
* HTTP
|
|
776
|
-
* Java method: org.openremote.model.
|
|
760
|
+
* HTTP DELETE /rules/realm/{id}
|
|
761
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
777
762
|
*/
|
|
778
|
-
|
|
779
|
-
realm?: string;
|
|
780
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
781
|
-
}
|
|
782
|
-
export declare class SyslogResourceClient<O> {
|
|
783
|
-
protected httpClient: HttpClient<O>;
|
|
784
|
-
constructor(httpClient: HttpClient<O>);
|
|
763
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
785
764
|
/**
|
|
786
|
-
* HTTP GET /
|
|
787
|
-
* Java method: org.openremote.model.
|
|
765
|
+
* HTTP GET /rules/realm/{id}
|
|
766
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
788
767
|
*/
|
|
789
|
-
|
|
768
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
790
769
|
/**
|
|
791
|
-
* HTTP PUT /
|
|
792
|
-
* Java method: org.openremote.model.
|
|
770
|
+
* HTTP PUT /rules/realm/{id}
|
|
771
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
793
772
|
*/
|
|
794
|
-
|
|
773
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
795
774
|
/**
|
|
796
|
-
* HTTP DELETE /
|
|
797
|
-
* Java method: org.openremote.model.
|
|
775
|
+
* HTTP DELETE /rules/{id}
|
|
776
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
798
777
|
*/
|
|
799
|
-
|
|
778
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
800
779
|
/**
|
|
801
|
-
* HTTP GET /
|
|
802
|
-
* Java method: org.openremote.model.
|
|
780
|
+
* HTTP GET /rules/{id}
|
|
781
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
803
782
|
*/
|
|
804
|
-
|
|
805
|
-
level?: Model.SyslogLevel;
|
|
806
|
-
per_page?: number;
|
|
807
|
-
page?: number;
|
|
808
|
-
from?: number;
|
|
809
|
-
to?: number;
|
|
810
|
-
category?: Model.SyslogCategory[];
|
|
811
|
-
subCategory?: string[];
|
|
812
|
-
}, options?: O): RestResponse<any>;
|
|
813
|
-
}
|
|
814
|
-
export declare class ConsoleResourceClient<O> {
|
|
815
|
-
protected httpClient: HttpClient<O>;
|
|
816
|
-
constructor(httpClient: HttpClient<O>);
|
|
783
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
817
784
|
/**
|
|
818
|
-
* HTTP
|
|
819
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* HTTP PUT /rules/{id}
|
|
786
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
820
787
|
*/
|
|
821
|
-
|
|
788
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
822
789
|
}
|
|
823
790
|
export declare class StatusResourceClient<O> {
|
|
824
791
|
protected httpClient: HttpClient<O>;
|
|
@@ -838,89 +805,122 @@ export declare class StatusResourceClient<O> {
|
|
|
838
805
|
[index: string]: any;
|
|
839
806
|
}>;
|
|
840
807
|
}
|
|
841
|
-
export declare class
|
|
808
|
+
export declare class FlowResourceClient<O> {
|
|
842
809
|
protected httpClient: HttpClient<O>;
|
|
843
810
|
constructor(httpClient: HttpClient<O>);
|
|
844
811
|
/**
|
|
845
|
-
* HTTP
|
|
846
|
-
* Java method: org.openremote.model.
|
|
812
|
+
* HTTP GET /flow
|
|
813
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
847
814
|
*/
|
|
848
|
-
|
|
815
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
849
816
|
/**
|
|
850
|
-
* HTTP
|
|
851
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP GET /flow/{name}
|
|
818
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
852
819
|
*/
|
|
853
|
-
|
|
820
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
821
|
+
/**
|
|
822
|
+
* HTTP GET /flow/{type}
|
|
823
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
824
|
+
*/
|
|
825
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
854
826
|
}
|
|
855
|
-
export declare class
|
|
827
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
856
828
|
protected httpClient: HttpClient<O>;
|
|
857
829
|
constructor(httpClient: HttpClient<O>);
|
|
858
830
|
/**
|
|
859
|
-
* HTTP
|
|
860
|
-
* Java method: org.openremote.model.
|
|
831
|
+
* HTTP GET /asset/datapoint/export
|
|
832
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
861
833
|
*/
|
|
862
|
-
|
|
834
|
+
getDatapointExport(queryParams?: {
|
|
835
|
+
attributeRefs?: string;
|
|
836
|
+
fromTimestamp?: number;
|
|
837
|
+
toTimestamp?: number;
|
|
838
|
+
}, options?: O): RestResponse<any>;
|
|
863
839
|
/**
|
|
864
|
-
* HTTP GET /
|
|
865
|
-
* Java method: org.openremote.model.
|
|
840
|
+
* HTTP GET /asset/datapoint/periods
|
|
841
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
866
842
|
*/
|
|
867
|
-
|
|
843
|
+
getDatapointPeriod(queryParams?: {
|
|
844
|
+
assetId?: string;
|
|
845
|
+
attributeName?: string;
|
|
846
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
868
847
|
/**
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
848
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
849
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
871
850
|
*/
|
|
872
|
-
|
|
851
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
852
|
+
}
|
|
853
|
+
export declare class ConfigurationResourceClient<O> {
|
|
854
|
+
protected httpClient: HttpClient<O>;
|
|
855
|
+
constructor(httpClient: HttpClient<O>);
|
|
873
856
|
/**
|
|
874
|
-
* HTTP
|
|
875
|
-
* Java method: org.openremote.model.
|
|
857
|
+
* HTTP GET /configuration/manager
|
|
858
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
876
859
|
*/
|
|
877
|
-
|
|
860
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
861
|
+
/**
|
|
862
|
+
* HTTP PUT /configuration/manager
|
|
863
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
864
|
+
*/
|
|
865
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
866
|
+
/**
|
|
867
|
+
* HTTP POST /configuration/manager/file
|
|
868
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
869
|
+
*/
|
|
870
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
871
|
+
path?: string;
|
|
872
|
+
}, options?: O): RestResponse<string>;
|
|
873
|
+
/**
|
|
874
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
875
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
876
|
+
*/
|
|
877
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
878
878
|
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
882
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
883
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
884
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
885
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
886
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
887
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
888
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
889
881
|
protected _appResource: AxiosAppResourceClient;
|
|
890
|
-
protected
|
|
882
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
883
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
891
884
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
892
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
893
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
894
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
895
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
896
885
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
897
886
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
898
|
-
protected
|
|
899
|
-
protected
|
|
887
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
888
|
+
protected _userResource: AxiosUserResourceClient;
|
|
889
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
890
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
891
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
892
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
900
893
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
901
894
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
895
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
896
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
897
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
898
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
899
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
900
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
901
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
904
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
905
|
-
get MapResource(): AxiosMapResourceClient;
|
|
906
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
907
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
908
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
909
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
910
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
911
903
|
get AppResource(): AxiosAppResourceClient;
|
|
912
|
-
get
|
|
904
|
+
get MapResource(): AxiosMapResourceClient;
|
|
905
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
913
906
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
914
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
915
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
916
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
917
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
918
907
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
919
908
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
920
|
-
get
|
|
921
|
-
get
|
|
909
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
910
|
+
get UserResource(): AxiosUserResourceClient;
|
|
911
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
912
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
913
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
914
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
922
915
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
923
916
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
917
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
918
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
919
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
920
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
921
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
922
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
923
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
932
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
|
-
}
|
|
934
|
-
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
931
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
935
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
933
|
}
|
|
937
934
|
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
941
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
939
|
}
|
|
943
|
-
export declare class
|
|
940
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
|
-
export declare class
|
|
943
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
|
-
export declare class
|
|
946
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
949
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
|
-
export declare class
|
|
952
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
956
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
954
|
}
|
|
958
|
-
export declare class
|
|
955
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
959
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
957
|
}
|
|
961
|
-
export declare class
|
|
958
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
962
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
960
|
}
|
|
964
|
-
export declare class
|
|
961
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
965
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
963
|
}
|
|
967
964
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
|
-
export declare class
|
|
970
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
974
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
972
|
}
|
|
976
|
-
export declare class
|
|
973
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
977
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
975
|
}
|
|
979
|
-
export declare class
|
|
976
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
980
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
978
|
}
|
|
982
|
-
export declare class
|
|
979
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
983
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
981
|
}
|
|
985
982
|
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
986
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
984
|
}
|
|
988
|
-
export declare class
|
|
985
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
989
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
987
|
}
|
|
991
|
-
export declare class
|
|
988
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
989
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
+
}
|
|
991
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|