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