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