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