@openremote/rest 1.17.2 → 1.17.3
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 +476 -476
- package/lib/restclient.d.ts.map +1 -1
- 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,6 +9,246 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class AgentResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
17
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
18
|
+
*/
|
|
19
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
20
|
+
realm?: string;
|
|
21
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
22
|
+
/**
|
|
23
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
24
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
25
|
+
*/
|
|
26
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
27
|
+
realm?: string;
|
|
28
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
29
|
+
/**
|
|
30
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
31
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
32
|
+
*/
|
|
33
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
34
|
+
parentId?: string;
|
|
35
|
+
realm?: string;
|
|
36
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
37
|
+
}
|
|
38
|
+
export declare class StatusResourceClient<O> {
|
|
39
|
+
protected httpClient: HttpClient<O>;
|
|
40
|
+
constructor(httpClient: HttpClient<O>);
|
|
41
|
+
/**
|
|
42
|
+
* HTTP GET /health
|
|
43
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
44
|
+
*/
|
|
45
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
46
|
+
[index: string]: any;
|
|
47
|
+
}>;
|
|
48
|
+
/**
|
|
49
|
+
* HTTP GET /info
|
|
50
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
51
|
+
*/
|
|
52
|
+
getInfo(options?: O): RestResponse<{
|
|
53
|
+
[index: string]: any;
|
|
54
|
+
}>;
|
|
55
|
+
}
|
|
56
|
+
export declare class RealmResourceClient<O> {
|
|
57
|
+
protected httpClient: HttpClient<O>;
|
|
58
|
+
constructor(httpClient: HttpClient<O>);
|
|
59
|
+
/**
|
|
60
|
+
* HTTP POST /realm
|
|
61
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
62
|
+
*/
|
|
63
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
64
|
+
/**
|
|
65
|
+
* HTTP GET /realm
|
|
66
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
67
|
+
*/
|
|
68
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
69
|
+
/**
|
|
70
|
+
* HTTP GET /realm/accessible
|
|
71
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
72
|
+
*/
|
|
73
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
74
|
+
/**
|
|
75
|
+
* HTTP DELETE /realm/{name}
|
|
76
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
77
|
+
*/
|
|
78
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
79
|
+
/**
|
|
80
|
+
* HTTP GET /realm/{name}
|
|
81
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
82
|
+
*/
|
|
83
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
84
|
+
/**
|
|
85
|
+
* HTTP PUT /realm/{name}
|
|
86
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
87
|
+
*/
|
|
88
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
89
|
+
}
|
|
90
|
+
export declare class AppResourceClient<O> {
|
|
91
|
+
protected httpClient: HttpClient<O>;
|
|
92
|
+
constructor(httpClient: HttpClient<O>);
|
|
93
|
+
/**
|
|
94
|
+
* HTTP GET /apps
|
|
95
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
96
|
+
*/
|
|
97
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
98
|
+
/**
|
|
99
|
+
* HTTP GET /apps/consoleConfig
|
|
100
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
101
|
+
*/
|
|
102
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
103
|
+
/**
|
|
104
|
+
* HTTP GET /apps/info
|
|
105
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
106
|
+
*/
|
|
107
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
108
|
+
}
|
|
109
|
+
export declare class ConsoleResourceClient<O> {
|
|
110
|
+
protected httpClient: HttpClient<O>;
|
|
111
|
+
constructor(httpClient: HttpClient<O>);
|
|
112
|
+
/**
|
|
113
|
+
* HTTP POST /console/register
|
|
114
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
115
|
+
*/
|
|
116
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
117
|
+
}
|
|
118
|
+
export declare class NotificationResourceClient<O> {
|
|
119
|
+
protected httpClient: HttpClient<O>;
|
|
120
|
+
constructor(httpClient: HttpClient<O>);
|
|
121
|
+
/**
|
|
122
|
+
* HTTP GET /notification
|
|
123
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
124
|
+
*/
|
|
125
|
+
getNotifications(queryParams?: {
|
|
126
|
+
id?: number;
|
|
127
|
+
type?: string;
|
|
128
|
+
from?: number;
|
|
129
|
+
to?: number;
|
|
130
|
+
realmId?: string;
|
|
131
|
+
userId?: string;
|
|
132
|
+
assetId?: string;
|
|
133
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
134
|
+
/**
|
|
135
|
+
* HTTP DELETE /notification
|
|
136
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
137
|
+
*/
|
|
138
|
+
removeNotifications(queryParams?: {
|
|
139
|
+
id?: number;
|
|
140
|
+
type?: string;
|
|
141
|
+
from?: number;
|
|
142
|
+
to?: number;
|
|
143
|
+
realmId?: string;
|
|
144
|
+
userId?: string;
|
|
145
|
+
assetId?: string;
|
|
146
|
+
}, options?: O): RestResponse<void>;
|
|
147
|
+
/**
|
|
148
|
+
* HTTP POST /notification/alert
|
|
149
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
150
|
+
*/
|
|
151
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
152
|
+
/**
|
|
153
|
+
* HTTP DELETE /notification/{notificationId}
|
|
154
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
155
|
+
*/
|
|
156
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
157
|
+
/**
|
|
158
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
159
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
160
|
+
*/
|
|
161
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
162
|
+
targetId?: string;
|
|
163
|
+
}, options?: O): RestResponse<void>;
|
|
164
|
+
/**
|
|
165
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
166
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
167
|
+
*/
|
|
168
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
169
|
+
targetId?: string;
|
|
170
|
+
}, options?: O): RestResponse<void>;
|
|
171
|
+
}
|
|
172
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
173
|
+
protected httpClient: HttpClient<O>;
|
|
174
|
+
constructor(httpClient: HttpClient<O>);
|
|
175
|
+
/**
|
|
176
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
177
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
178
|
+
*/
|
|
179
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
180
|
+
/**
|
|
181
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
182
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
183
|
+
*/
|
|
184
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
185
|
+
}
|
|
186
|
+
export declare class DashboardResourceClient<O> {
|
|
187
|
+
protected httpClient: HttpClient<O>;
|
|
188
|
+
constructor(httpClient: HttpClient<O>);
|
|
189
|
+
/**
|
|
190
|
+
* HTTP POST /dashboard
|
|
191
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
192
|
+
*/
|
|
193
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
194
|
+
/**
|
|
195
|
+
* HTTP PUT /dashboard
|
|
196
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
197
|
+
*/
|
|
198
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
199
|
+
/**
|
|
200
|
+
* HTTP GET /dashboard/all/{realm}
|
|
201
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
202
|
+
*/
|
|
203
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
204
|
+
/**
|
|
205
|
+
* HTTP POST /dashboard/query
|
|
206
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
207
|
+
*/
|
|
208
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
209
|
+
/**
|
|
210
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
211
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
212
|
+
*/
|
|
213
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
214
|
+
/**
|
|
215
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
216
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
217
|
+
*/
|
|
218
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
219
|
+
}
|
|
220
|
+
export declare class SyslogResourceClient<O> {
|
|
221
|
+
protected httpClient: HttpClient<O>;
|
|
222
|
+
constructor(httpClient: HttpClient<O>);
|
|
223
|
+
/**
|
|
224
|
+
* HTTP GET /syslog/config
|
|
225
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
226
|
+
*/
|
|
227
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
228
|
+
/**
|
|
229
|
+
* HTTP PUT /syslog/config
|
|
230
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
231
|
+
*/
|
|
232
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
233
|
+
/**
|
|
234
|
+
* HTTP DELETE /syslog/event
|
|
235
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
236
|
+
*/
|
|
237
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
238
|
+
/**
|
|
239
|
+
* HTTP GET /syslog/event
|
|
240
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
241
|
+
*/
|
|
242
|
+
getEvents(queryParams?: {
|
|
243
|
+
level?: Model.SyslogLevel;
|
|
244
|
+
per_page?: number;
|
|
245
|
+
page?: number;
|
|
246
|
+
from?: number;
|
|
247
|
+
to?: number;
|
|
248
|
+
category?: Model.SyslogCategory[];
|
|
249
|
+
subCategory?: string[];
|
|
250
|
+
}, options?: O): RestResponse<any>;
|
|
251
|
+
}
|
|
12
252
|
export declare class UserResourceClient<O> {
|
|
13
253
|
protected httpClient: HttpClient<O>;
|
|
14
254
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -133,61 +373,6 @@ export declare class UserResourceClient<O> {
|
|
|
133
373
|
*/
|
|
134
374
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
135
375
|
}
|
|
136
|
-
export declare class ConsoleResourceClient<O> {
|
|
137
|
-
protected httpClient: HttpClient<O>;
|
|
138
|
-
constructor(httpClient: HttpClient<O>);
|
|
139
|
-
/**
|
|
140
|
-
* HTTP POST /console/register
|
|
141
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
142
|
-
*/
|
|
143
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
144
|
-
}
|
|
145
|
-
export declare class MapResourceClient<O> {
|
|
146
|
-
protected httpClient: HttpClient<O>;
|
|
147
|
-
constructor(httpClient: HttpClient<O>);
|
|
148
|
-
/**
|
|
149
|
-
* HTTP GET /map
|
|
150
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
151
|
-
*/
|
|
152
|
-
getSettings(options?: O): RestResponse<{
|
|
153
|
-
[id: string]: unknown;
|
|
154
|
-
}>;
|
|
155
|
-
/**
|
|
156
|
-
* HTTP PUT /map
|
|
157
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
158
|
-
*/
|
|
159
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
160
|
-
[id: string]: unknown;
|
|
161
|
-
}>;
|
|
162
|
-
/**
|
|
163
|
-
* HTTP DELETE /map/deleteMap
|
|
164
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
165
|
-
*/
|
|
166
|
-
deleteMap(options?: O): RestResponse<{
|
|
167
|
-
[id: string]: unknown;
|
|
168
|
-
}>;
|
|
169
|
-
/**
|
|
170
|
-
* HTTP GET /map/getCustomMapInfo
|
|
171
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
172
|
-
*/
|
|
173
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
174
|
-
[id: string]: unknown;
|
|
175
|
-
}>;
|
|
176
|
-
/**
|
|
177
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
178
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
179
|
-
*/
|
|
180
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
181
|
-
/**
|
|
182
|
-
* HTTP POST /map/upload
|
|
183
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
184
|
-
*/
|
|
185
|
-
uploadMap(queryParams?: {
|
|
186
|
-
filename?: string;
|
|
187
|
-
}, options?: O): RestResponse<{
|
|
188
|
-
[id: string]: unknown;
|
|
189
|
-
}>;
|
|
190
|
-
}
|
|
191
376
|
export declare class RulesResourceClient<O> {
|
|
192
377
|
protected httpClient: HttpClient<O>;
|
|
193
378
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -296,211 +481,77 @@ export declare class RulesResourceClient<O> {
|
|
|
296
481
|
*/
|
|
297
482
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
298
483
|
}
|
|
299
|
-
export declare class
|
|
300
|
-
protected httpClient: HttpClient<O>;
|
|
301
|
-
constructor(httpClient: HttpClient<O>);
|
|
302
|
-
/**
|
|
303
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
304
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
305
|
-
*/
|
|
306
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
307
|
-
/**
|
|
308
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
309
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
310
|
-
*/
|
|
311
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
312
|
-
}
|
|
313
|
-
export declare class DashboardResourceClient<O> {
|
|
314
|
-
protected httpClient: HttpClient<O>;
|
|
315
|
-
constructor(httpClient: HttpClient<O>);
|
|
316
|
-
/**
|
|
317
|
-
* HTTP POST /dashboard
|
|
318
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
319
|
-
*/
|
|
320
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
321
|
-
/**
|
|
322
|
-
* HTTP PUT /dashboard
|
|
323
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
324
|
-
*/
|
|
325
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
326
|
-
/**
|
|
327
|
-
* HTTP GET /dashboard/all/{realm}
|
|
328
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
329
|
-
*/
|
|
330
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
331
|
-
/**
|
|
332
|
-
* HTTP POST /dashboard/query
|
|
333
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
334
|
-
*/
|
|
335
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
338
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
339
|
-
*/
|
|
340
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
341
|
-
/**
|
|
342
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
343
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
344
|
-
*/
|
|
345
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
346
|
-
}
|
|
347
|
-
export declare class AgentResourceClient<O> {
|
|
348
|
-
protected httpClient: HttpClient<O>;
|
|
349
|
-
constructor(httpClient: HttpClient<O>);
|
|
350
|
-
/**
|
|
351
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
352
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
353
|
-
*/
|
|
354
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
355
|
-
realm?: string;
|
|
356
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
357
|
-
/**
|
|
358
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
359
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
360
|
-
*/
|
|
361
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
362
|
-
realm?: string;
|
|
363
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
364
|
-
/**
|
|
365
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
366
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
367
|
-
*/
|
|
368
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
369
|
-
parentId?: string;
|
|
370
|
-
realm?: string;
|
|
371
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
372
|
-
}
|
|
373
|
-
export declare class AppResourceClient<O> {
|
|
374
|
-
protected httpClient: HttpClient<O>;
|
|
375
|
-
constructor(httpClient: HttpClient<O>);
|
|
376
|
-
/**
|
|
377
|
-
* HTTP GET /apps
|
|
378
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
379
|
-
*/
|
|
380
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
381
|
-
/**
|
|
382
|
-
* HTTP GET /apps/consoleConfig
|
|
383
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
384
|
-
*/
|
|
385
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
386
|
-
/**
|
|
387
|
-
* HTTP GET /apps/info
|
|
388
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
389
|
-
*/
|
|
390
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
391
|
-
}
|
|
392
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
484
|
+
export declare class AlarmResourceClient<O> {
|
|
393
485
|
protected httpClient: HttpClient<O>;
|
|
394
486
|
constructor(httpClient: HttpClient<O>);
|
|
395
487
|
/**
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
399
|
-
*/
|
|
400
|
-
getServices(queryParams?: {
|
|
401
|
-
realm?: string;
|
|
402
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
403
|
-
/**
|
|
404
|
-
* Response code 200 - Service registered successfully
|
|
405
|
-
* Response code 400 - Invalid external service object
|
|
406
|
-
* Response code 409 - ExternalService instance already registered
|
|
407
|
-
* HTTP POST /service
|
|
408
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
409
|
-
*/
|
|
410
|
-
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
411
|
-
/**
|
|
412
|
-
* Response code 200 - List of registered external services
|
|
413
|
-
* HTTP GET /service/global
|
|
414
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
415
|
-
*/
|
|
416
|
-
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
417
|
-
/**
|
|
418
|
-
* Response code 200 - Service registered successfully
|
|
419
|
-
* Response code 400 - Invalid external service object
|
|
420
|
-
* Response code 409 - ExternalService instance already registered
|
|
421
|
-
* HTTP POST /service/global
|
|
422
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
423
|
-
*/
|
|
424
|
-
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
425
|
-
/**
|
|
426
|
-
* Response code 204 - Service deregistered successfully
|
|
427
|
-
* Response code 404 - Service instance not found
|
|
428
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
429
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
430
|
-
*/
|
|
431
|
-
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
432
|
-
/**
|
|
433
|
-
* Response code 200 - ExternalService retrieved successfully
|
|
434
|
-
* Response code 404 - ExternalService not found
|
|
435
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
436
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
488
|
+
* HTTP POST /alarm
|
|
489
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
437
490
|
*/
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
* HTTP
|
|
443
|
-
* Java method: org.openremote.model.
|
|
491
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
492
|
+
assetIds?: string[];
|
|
493
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
494
|
+
/**
|
|
495
|
+
* HTTP GET /alarm
|
|
496
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
444
497
|
*/
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
498
|
+
getAlarms(queryParams?: {
|
|
499
|
+
realm?: string;
|
|
500
|
+
status?: Model.AlarmStatus;
|
|
501
|
+
assetId?: string;
|
|
502
|
+
assigneeId?: string;
|
|
503
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
450
504
|
/**
|
|
451
|
-
* HTTP
|
|
452
|
-
* Java method: org.openremote.model.
|
|
505
|
+
* HTTP DELETE /alarm
|
|
506
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
453
507
|
*/
|
|
454
|
-
|
|
508
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
455
509
|
/**
|
|
456
|
-
* HTTP
|
|
457
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* HTTP PUT /alarm/assets
|
|
511
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
458
512
|
*/
|
|
459
|
-
|
|
513
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
460
514
|
/**
|
|
461
|
-
* HTTP GET /
|
|
462
|
-
* Java method: org.openremote.model.
|
|
515
|
+
* HTTP GET /alarm/{alarmId}
|
|
516
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
463
517
|
*/
|
|
464
|
-
|
|
518
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
465
519
|
/**
|
|
466
|
-
* HTTP DELETE /
|
|
467
|
-
* Java method: org.openremote.model.
|
|
520
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
521
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
468
522
|
*/
|
|
469
|
-
|
|
523
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
470
524
|
/**
|
|
471
|
-
* HTTP
|
|
472
|
-
* Java method: org.openremote.model.
|
|
525
|
+
* HTTP PUT /alarm/{alarmId}
|
|
526
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
473
527
|
*/
|
|
474
|
-
|
|
528
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
475
529
|
/**
|
|
476
|
-
* HTTP
|
|
477
|
-
* Java method: org.openremote.model.
|
|
530
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
531
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
478
532
|
*/
|
|
479
|
-
|
|
533
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
534
|
+
realm?: string;
|
|
535
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
480
536
|
}
|
|
481
|
-
export declare class
|
|
537
|
+
export declare class FlowResourceClient<O> {
|
|
482
538
|
protected httpClient: HttpClient<O>;
|
|
483
539
|
constructor(httpClient: HttpClient<O>);
|
|
484
540
|
/**
|
|
485
|
-
* HTTP
|
|
486
|
-
* Java method: org.openremote.model.
|
|
487
|
-
*/
|
|
488
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
489
|
-
/**
|
|
490
|
-
* HTTP GET /provisioning
|
|
491
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
541
|
+
* HTTP GET /flow
|
|
542
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
492
543
|
*/
|
|
493
|
-
|
|
544
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
494
545
|
/**
|
|
495
|
-
* HTTP
|
|
496
|
-
* Java method: org.openremote.model.
|
|
546
|
+
* HTTP GET /flow/{name}
|
|
547
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
497
548
|
*/
|
|
498
|
-
|
|
549
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
499
550
|
/**
|
|
500
|
-
* HTTP
|
|
501
|
-
* Java method: org.openremote.model.
|
|
551
|
+
* HTTP GET /flow/{type}
|
|
552
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
502
553
|
*/
|
|
503
|
-
|
|
554
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
504
555
|
}
|
|
505
556
|
export declare class AssetModelResourceClient<O> {
|
|
506
557
|
protected httpClient: HttpClient<O>;
|
|
@@ -581,111 +632,79 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
581
632
|
*/
|
|
582
633
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
583
634
|
}
|
|
584
|
-
export declare class
|
|
635
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
585
636
|
protected httpClient: HttpClient<O>;
|
|
586
637
|
constructor(httpClient: HttpClient<O>);
|
|
587
638
|
/**
|
|
588
|
-
* HTTP POST /
|
|
589
|
-
* Java method: org.openremote.model.
|
|
590
|
-
*/
|
|
591
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
592
|
-
assetIds?: string[];
|
|
593
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
594
|
-
/**
|
|
595
|
-
* HTTP GET /alarm
|
|
596
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
597
|
-
*/
|
|
598
|
-
getAlarms(queryParams?: {
|
|
599
|
-
realm?: string;
|
|
600
|
-
status?: Model.AlarmStatus;
|
|
601
|
-
assetId?: string;
|
|
602
|
-
assigneeId?: string;
|
|
603
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
604
|
-
/**
|
|
605
|
-
* HTTP DELETE /alarm
|
|
606
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
607
|
-
*/
|
|
608
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
609
|
-
/**
|
|
610
|
-
* HTTP PUT /alarm/assets
|
|
611
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
639
|
+
* HTTP POST /gateway/tunnel
|
|
640
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
612
641
|
*/
|
|
613
|
-
|
|
642
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
614
643
|
/**
|
|
615
|
-
* HTTP
|
|
616
|
-
* Java method: org.openremote.model.
|
|
644
|
+
* HTTP DELETE /gateway/tunnel
|
|
645
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
617
646
|
*/
|
|
618
|
-
|
|
647
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
619
648
|
/**
|
|
620
|
-
* HTTP
|
|
621
|
-
* Java method: org.openremote.model.
|
|
649
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
650
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
622
651
|
*/
|
|
623
|
-
|
|
652
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
624
653
|
/**
|
|
625
|
-
* HTTP
|
|
626
|
-
* Java method: org.openremote.model.
|
|
654
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
655
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
627
656
|
*/
|
|
628
|
-
|
|
657
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
629
658
|
/**
|
|
630
|
-
* HTTP GET /
|
|
631
|
-
* Java method: org.openremote.model.
|
|
659
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
660
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
632
661
|
*/
|
|
633
|
-
|
|
634
|
-
realm?: string;
|
|
635
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
662
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
636
663
|
}
|
|
637
|
-
export declare class
|
|
664
|
+
export declare class MapResourceClient<O> {
|
|
638
665
|
protected httpClient: HttpClient<O>;
|
|
639
666
|
constructor(httpClient: HttpClient<O>);
|
|
640
667
|
/**
|
|
641
|
-
* HTTP
|
|
642
|
-
* Java method: org.openremote.model.
|
|
643
|
-
*/
|
|
644
|
-
deleteConnections(queryParams?: {
|
|
645
|
-
realm?: string[];
|
|
646
|
-
}, options?: O): RestResponse<void>;
|
|
647
|
-
/**
|
|
648
|
-
* HTTP GET /gateway/connection
|
|
649
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
650
|
-
*/
|
|
651
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
652
|
-
/**
|
|
653
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
654
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
668
|
+
* HTTP GET /map
|
|
669
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
655
670
|
*/
|
|
656
|
-
|
|
671
|
+
getSettings(options?: O): RestResponse<{
|
|
672
|
+
[id: string]: unknown;
|
|
673
|
+
}>;
|
|
657
674
|
/**
|
|
658
|
-
* HTTP
|
|
659
|
-
* Java method: org.openremote.model.
|
|
675
|
+
* HTTP PUT /map
|
|
676
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
660
677
|
*/
|
|
661
|
-
|
|
678
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
679
|
+
[id: string]: unknown;
|
|
680
|
+
}>;
|
|
662
681
|
/**
|
|
663
|
-
* HTTP
|
|
664
|
-
* Java method: org.openremote.model.
|
|
682
|
+
* HTTP DELETE /map/deleteMap
|
|
683
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
665
684
|
*/
|
|
666
|
-
|
|
685
|
+
deleteMap(options?: O): RestResponse<{
|
|
686
|
+
[id: string]: unknown;
|
|
687
|
+
}>;
|
|
667
688
|
/**
|
|
668
|
-
* HTTP GET /
|
|
669
|
-
* Java method: org.openremote.model.
|
|
689
|
+
* HTTP GET /map/getCustomMapInfo
|
|
690
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
670
691
|
*/
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
protected httpClient: HttpClient<O>;
|
|
675
|
-
constructor(httpClient: HttpClient<O>);
|
|
692
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
693
|
+
[id: string]: unknown;
|
|
694
|
+
}>;
|
|
676
695
|
/**
|
|
677
|
-
* HTTP GET /
|
|
678
|
-
* Java method: org.openremote.model.
|
|
696
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
697
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
679
698
|
*/
|
|
680
|
-
|
|
681
|
-
[index: string]: any;
|
|
682
|
-
}>;
|
|
699
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
683
700
|
/**
|
|
684
|
-
* HTTP
|
|
685
|
-
* Java method: org.openremote.model.
|
|
701
|
+
* HTTP POST /map/upload
|
|
702
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
686
703
|
*/
|
|
687
|
-
|
|
688
|
-
|
|
704
|
+
uploadMap(queryParams?: {
|
|
705
|
+
filename?: string;
|
|
706
|
+
}, options?: O): RestResponse<{
|
|
707
|
+
[id: string]: unknown;
|
|
689
708
|
}>;
|
|
690
709
|
}
|
|
691
710
|
export declare class AssetDatapointResourceClient<O> {
|
|
@@ -709,71 +728,10 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
709
728
|
attributeName?: string;
|
|
710
729
|
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
711
730
|
/**
|
|
712
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
713
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
714
|
-
*/
|
|
715
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
716
|
-
}
|
|
717
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
718
|
-
protected httpClient: HttpClient<O>;
|
|
719
|
-
constructor(httpClient: HttpClient<O>);
|
|
720
|
-
/**
|
|
721
|
-
* HTTP POST /gateway/tunnel
|
|
722
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
723
|
-
*/
|
|
724
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
725
|
-
/**
|
|
726
|
-
* HTTP DELETE /gateway/tunnel
|
|
727
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
728
|
-
*/
|
|
729
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
730
|
-
/**
|
|
731
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
732
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
733
|
-
*/
|
|
734
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
735
|
-
/**
|
|
736
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
737
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
738
|
-
*/
|
|
739
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
740
|
-
/**
|
|
741
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
742
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
743
|
-
*/
|
|
744
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
745
|
-
}
|
|
746
|
-
export declare class SyslogResourceClient<O> {
|
|
747
|
-
protected httpClient: HttpClient<O>;
|
|
748
|
-
constructor(httpClient: HttpClient<O>);
|
|
749
|
-
/**
|
|
750
|
-
* HTTP GET /syslog/config
|
|
751
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
752
|
-
*/
|
|
753
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
754
|
-
/**
|
|
755
|
-
* HTTP PUT /syslog/config
|
|
756
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
757
|
-
*/
|
|
758
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
759
|
-
/**
|
|
760
|
-
* HTTP DELETE /syslog/event
|
|
761
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
762
|
-
*/
|
|
763
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
764
|
-
/**
|
|
765
|
-
* HTTP GET /syslog/event
|
|
766
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
731
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
732
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
767
733
|
*/
|
|
768
|
-
|
|
769
|
-
level?: Model.SyslogLevel;
|
|
770
|
-
per_page?: number;
|
|
771
|
-
page?: number;
|
|
772
|
-
from?: number;
|
|
773
|
-
to?: number;
|
|
774
|
-
category?: Model.SyslogCategory[];
|
|
775
|
-
subCategory?: string[];
|
|
776
|
-
}, options?: O): RestResponse<any>;
|
|
734
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
777
735
|
}
|
|
778
736
|
export declare class AssetResourceClient<O> {
|
|
779
737
|
protected httpClient: HttpClient<O>;
|
|
@@ -889,126 +847,168 @@ export declare class AssetResourceClient<O> {
|
|
|
889
847
|
assetIds?: string[];
|
|
890
848
|
}, options?: O): RestResponse<void>;
|
|
891
849
|
}
|
|
892
|
-
export declare class
|
|
850
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
893
851
|
protected httpClient: HttpClient<O>;
|
|
894
852
|
constructor(httpClient: HttpClient<O>);
|
|
895
853
|
/**
|
|
896
|
-
*
|
|
897
|
-
*
|
|
854
|
+
* Response code 200 - List of registered external services
|
|
855
|
+
* HTTP GET /service
|
|
856
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
898
857
|
*/
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
from?: number;
|
|
903
|
-
to?: number;
|
|
904
|
-
realmId?: string;
|
|
905
|
-
userId?: string;
|
|
906
|
-
assetId?: string;
|
|
907
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
858
|
+
getServices(queryParams?: {
|
|
859
|
+
realm?: string;
|
|
860
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
908
861
|
/**
|
|
909
|
-
*
|
|
910
|
-
*
|
|
862
|
+
* Response code 200 - Service registered successfully
|
|
863
|
+
* Response code 400 - Invalid external service object
|
|
864
|
+
* Response code 409 - ExternalService instance already registered
|
|
865
|
+
* HTTP POST /service
|
|
866
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
911
867
|
*/
|
|
912
|
-
|
|
913
|
-
id?: number;
|
|
914
|
-
type?: string;
|
|
915
|
-
from?: number;
|
|
916
|
-
to?: number;
|
|
917
|
-
realmId?: string;
|
|
918
|
-
userId?: string;
|
|
919
|
-
assetId?: string;
|
|
920
|
-
}, options?: O): RestResponse<void>;
|
|
868
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
921
869
|
/**
|
|
922
|
-
*
|
|
923
|
-
*
|
|
870
|
+
* Response code 200 - List of registered external services
|
|
871
|
+
* HTTP GET /service/global
|
|
872
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
924
873
|
*/
|
|
925
|
-
|
|
874
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
926
875
|
/**
|
|
927
|
-
*
|
|
928
|
-
*
|
|
876
|
+
* Response code 200 - Service registered successfully
|
|
877
|
+
* Response code 400 - Invalid external service object
|
|
878
|
+
* Response code 409 - ExternalService instance already registered
|
|
879
|
+
* HTTP POST /service/global
|
|
880
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
929
881
|
*/
|
|
930
|
-
|
|
882
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
931
883
|
/**
|
|
932
|
-
*
|
|
933
|
-
*
|
|
884
|
+
* Response code 204 - Service deregistered successfully
|
|
885
|
+
* Response code 404 - Service instance not found
|
|
886
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
887
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
934
888
|
*/
|
|
935
|
-
|
|
936
|
-
targetId?: string;
|
|
937
|
-
}, options?: O): RestResponse<void>;
|
|
889
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
938
890
|
/**
|
|
939
|
-
*
|
|
940
|
-
*
|
|
891
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
892
|
+
* Response code 404 - ExternalService not found
|
|
893
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
894
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
941
895
|
*/
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
896
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
897
|
+
/**
|
|
898
|
+
* Response code 204 - Heartbeat sent successfully
|
|
899
|
+
* Response code 404 - Service instance not found
|
|
900
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
901
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
902
|
+
*/
|
|
903
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
945
904
|
}
|
|
946
|
-
export declare class
|
|
905
|
+
export declare class ProvisioningResourceClient<O> {
|
|
947
906
|
protected httpClient: HttpClient<O>;
|
|
948
907
|
constructor(httpClient: HttpClient<O>);
|
|
949
908
|
/**
|
|
950
|
-
* HTTP
|
|
951
|
-
* Java method: org.openremote.model.
|
|
909
|
+
* HTTP POST /provisioning
|
|
910
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
952
911
|
*/
|
|
953
|
-
|
|
912
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
954
913
|
/**
|
|
955
|
-
* HTTP GET /
|
|
956
|
-
* Java method: org.openremote.model.
|
|
914
|
+
* HTTP GET /provisioning
|
|
915
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
957
916
|
*/
|
|
958
|
-
|
|
917
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
959
918
|
/**
|
|
960
|
-
* HTTP
|
|
961
|
-
* Java method: org.openremote.model.
|
|
919
|
+
* HTTP DELETE /provisioning/{id}
|
|
920
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
962
921
|
*/
|
|
963
|
-
|
|
922
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
923
|
+
/**
|
|
924
|
+
* HTTP PUT /provisioning/{id}
|
|
925
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
926
|
+
*/
|
|
927
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
928
|
+
}
|
|
929
|
+
export declare class GatewayClientResourceClient<O> {
|
|
930
|
+
protected httpClient: HttpClient<O>;
|
|
931
|
+
constructor(httpClient: HttpClient<O>);
|
|
932
|
+
/**
|
|
933
|
+
* HTTP DELETE /gateway/connection
|
|
934
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
935
|
+
*/
|
|
936
|
+
deleteConnections(queryParams?: {
|
|
937
|
+
realm?: string[];
|
|
938
|
+
}, options?: O): RestResponse<void>;
|
|
939
|
+
/**
|
|
940
|
+
* HTTP GET /gateway/connection
|
|
941
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
942
|
+
*/
|
|
943
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
944
|
+
/**
|
|
945
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
946
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
947
|
+
*/
|
|
948
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
949
|
+
/**
|
|
950
|
+
* HTTP GET /gateway/connection/{realm}
|
|
951
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
952
|
+
*/
|
|
953
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
954
|
+
/**
|
|
955
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
956
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
957
|
+
*/
|
|
958
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
959
|
+
/**
|
|
960
|
+
* HTTP GET /gateway/status/{realm}
|
|
961
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
962
|
+
*/
|
|
963
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
964
964
|
}
|
|
965
965
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
966
966
|
export declare class ApiClient {
|
|
967
|
-
protected
|
|
967
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
968
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
969
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
970
|
+
protected _appResource: AxiosAppResourceClient;
|
|
968
971
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
969
|
-
protected
|
|
970
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
972
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
971
973
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
972
974
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
973
|
-
protected
|
|
974
|
-
protected
|
|
975
|
-
protected
|
|
976
|
-
protected
|
|
977
|
-
protected
|
|
975
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
976
|
+
protected _userResource: AxiosUserResourceClient;
|
|
977
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
978
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
979
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
978
980
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
979
981
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
980
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
981
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
982
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
983
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
984
982
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
985
|
-
protected
|
|
983
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
984
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
986
985
|
protected _assetResource: AxiosAssetResourceClient;
|
|
987
|
-
protected
|
|
988
|
-
protected
|
|
986
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
987
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
988
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
-
get
|
|
990
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
991
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
992
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
993
|
+
get AppResource(): AxiosAppResourceClient;
|
|
991
994
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
992
|
-
get
|
|
993
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
995
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
994
996
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
995
997
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
996
|
-
get
|
|
997
|
-
get
|
|
998
|
-
get
|
|
999
|
-
get
|
|
1000
|
-
get
|
|
998
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
999
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1000
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1001
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1002
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1001
1003
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1002
1004
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1003
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1004
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1005
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1006
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1007
1005
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1008
|
-
get
|
|
1006
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1007
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1009
1008
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1010
|
-
get
|
|
1011
|
-
get
|
|
1009
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1010
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1011
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1012
1012
|
}
|
|
1013
1013
|
import * as Axios from "axios";
|
|
1014
1014
|
declare module "axios" {
|
|
@@ -1016,16 +1016,22 @@ declare module "axios" {
|
|
|
1016
1016
|
data: R;
|
|
1017
1017
|
}
|
|
1018
1018
|
}
|
|
1019
|
-
export declare class
|
|
1019
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1020
1020
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1021
1021
|
}
|
|
1022
|
-
export declare class
|
|
1022
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1023
1023
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1024
1024
|
}
|
|
1025
|
-
export declare class
|
|
1025
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1026
1026
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1027
1027
|
}
|
|
1028
|
-
export declare class
|
|
1028
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1029
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1030
|
+
}
|
|
1031
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1032
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1033
|
+
}
|
|
1034
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1029
1035
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1030
1036
|
}
|
|
1031
1037
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1034,19 +1040,19 @@ export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPre
|
|
|
1034
1040
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1035
1041
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1036
1042
|
}
|
|
1037
|
-
export declare class
|
|
1043
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1038
1044
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1039
1045
|
}
|
|
1040
|
-
export declare class
|
|
1046
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1041
1047
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1042
1048
|
}
|
|
1043
|
-
export declare class
|
|
1049
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1044
1050
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1045
1051
|
}
|
|
1046
|
-
export declare class
|
|
1052
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1047
1053
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1048
1054
|
}
|
|
1049
|
-
export declare class
|
|
1055
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1050
1056
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1051
1057
|
}
|
|
1052
1058
|
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -1055,31 +1061,25 @@ export declare class AxiosAssetModelResourceClient extends AssetModelResourceCli
|
|
|
1055
1061
|
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1056
1062
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1057
1063
|
}
|
|
1058
|
-
export declare class
|
|
1059
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1060
|
-
}
|
|
1061
|
-
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1064
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1062
1065
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1063
1066
|
}
|
|
1064
|
-
export declare class
|
|
1067
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1065
1068
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1066
1069
|
}
|
|
1067
1070
|
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1068
1071
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1069
1072
|
}
|
|
1070
|
-
export declare class
|
|
1071
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1072
|
-
}
|
|
1073
|
-
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1073
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1074
1074
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1075
1075
|
}
|
|
1076
|
-
export declare class
|
|
1076
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1077
1077
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1078
1078
|
}
|
|
1079
|
-
export declare class
|
|
1079
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1080
1080
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1081
1081
|
}
|
|
1082
|
-
export declare class
|
|
1082
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1083
1083
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1084
1084
|
}
|
|
1085
1085
|
//# sourceMappingURL=restclient.d.ts.map
|