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