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