@openremote/rest 1.4.0-snapshot.20250331211521 → 1.4.0-snapshot.20250401092307
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.js +1 -1
- package/lib/restclient.d.ts +446 -446
- 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,132 +9,139 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class GatewayClientResourceClient<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 DELETE /gateway/connection
|
|
17
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
18
18
|
*/
|
|
19
|
-
|
|
19
|
+
deleteConnections(queryParams?: {
|
|
20
|
+
realm?: string[];
|
|
21
|
+
}, options?: O): RestResponse<void>;
|
|
20
22
|
/**
|
|
21
|
-
* HTTP GET /
|
|
22
|
-
* Java method: org.openremote.model.
|
|
23
|
+
* HTTP GET /gateway/connection
|
|
24
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
23
25
|
*/
|
|
24
|
-
|
|
26
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
25
27
|
/**
|
|
26
|
-
* HTTP DELETE /
|
|
27
|
-
* Java method: org.openremote.model.
|
|
28
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
28
30
|
*/
|
|
29
|
-
|
|
31
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
30
32
|
/**
|
|
31
|
-
* HTTP
|
|
32
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP GET /gateway/connection/{realm}
|
|
34
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
33
35
|
*/
|
|
34
|
-
|
|
35
|
-
}
|
|
36
|
-
export declare class ConsoleResourceClient<O> {
|
|
37
|
-
protected httpClient: HttpClient<O>;
|
|
38
|
-
constructor(httpClient: HttpClient<O>);
|
|
36
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
39
37
|
/**
|
|
40
|
-
* HTTP
|
|
41
|
-
* Java method: org.openremote.model.
|
|
38
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
39
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
42
40
|
*/
|
|
43
|
-
|
|
41
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
42
|
+
/**
|
|
43
|
+
* HTTP GET /gateway/status/{realm}
|
|
44
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
45
|
+
*/
|
|
46
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
44
47
|
}
|
|
45
|
-
export declare class
|
|
48
|
+
export declare class ConfigurationResourceClient<O> {
|
|
46
49
|
protected httpClient: HttpClient<O>;
|
|
47
50
|
constructor(httpClient: HttpClient<O>);
|
|
48
51
|
/**
|
|
49
|
-
* HTTP GET /
|
|
50
|
-
* Java method: org.openremote.model.
|
|
52
|
+
* HTTP GET /configuration/manager
|
|
53
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
51
54
|
*/
|
|
52
|
-
|
|
53
|
-
attributeRefs?: string;
|
|
54
|
-
fromTimestamp?: number;
|
|
55
|
-
toTimestamp?: number;
|
|
56
|
-
}, options?: O): RestResponse<any>;
|
|
55
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
57
56
|
/**
|
|
58
|
-
* HTTP
|
|
59
|
-
* Java method: org.openremote.model.
|
|
57
|
+
* HTTP PUT /configuration/manager
|
|
58
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
60
59
|
*/
|
|
61
|
-
|
|
62
|
-
assetId?: string;
|
|
63
|
-
attributeName?: string;
|
|
64
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
60
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
65
61
|
/**
|
|
66
|
-
* HTTP POST /
|
|
67
|
-
* Java method: org.openremote.model.
|
|
62
|
+
* HTTP POST /configuration/manager/file
|
|
63
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
68
64
|
*/
|
|
69
|
-
|
|
65
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
66
|
+
path?: string;
|
|
67
|
+
}, options?: O): RestResponse<string>;
|
|
68
|
+
/**
|
|
69
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
70
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
71
|
+
*/
|
|
72
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
70
73
|
}
|
|
71
|
-
export declare class
|
|
74
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
72
75
|
protected httpClient: HttpClient<O>;
|
|
73
76
|
constructor(httpClient: HttpClient<O>);
|
|
74
77
|
/**
|
|
75
|
-
* HTTP
|
|
76
|
-
* Java method: org.openremote.model.
|
|
78
|
+
* HTTP POST /gateway/tunnel
|
|
79
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
77
80
|
*/
|
|
78
|
-
|
|
79
|
-
id?: number;
|
|
80
|
-
type?: string;
|
|
81
|
-
from?: number;
|
|
82
|
-
to?: number;
|
|
83
|
-
realmId?: string;
|
|
84
|
-
userId?: string;
|
|
85
|
-
assetId?: string;
|
|
86
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
81
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
87
82
|
/**
|
|
88
|
-
* HTTP DELETE /
|
|
89
|
-
* Java method: org.openremote.model.
|
|
83
|
+
* HTTP DELETE /gateway/tunnel
|
|
84
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
90
85
|
*/
|
|
91
|
-
|
|
92
|
-
id?: number;
|
|
93
|
-
type?: string;
|
|
94
|
-
from?: number;
|
|
95
|
-
to?: number;
|
|
96
|
-
realmId?: string;
|
|
97
|
-
userId?: string;
|
|
98
|
-
assetId?: string;
|
|
99
|
-
}, options?: O): RestResponse<void>;
|
|
86
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
100
87
|
/**
|
|
101
|
-
* HTTP
|
|
102
|
-
* Java method: org.openremote.model.
|
|
88
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
89
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
103
90
|
*/
|
|
104
|
-
|
|
91
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
105
92
|
/**
|
|
106
|
-
* HTTP
|
|
107
|
-
* Java method: org.openremote.model.
|
|
93
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
94
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
108
95
|
*/
|
|
109
|
-
|
|
96
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
110
97
|
/**
|
|
111
|
-
* HTTP
|
|
112
|
-
* Java method: org.openremote.model.
|
|
98
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
99
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
113
100
|
*/
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
101
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
102
|
+
}
|
|
103
|
+
export declare class ConsoleResourceClient<O> {
|
|
104
|
+
protected httpClient: HttpClient<O>;
|
|
105
|
+
constructor(httpClient: HttpClient<O>);
|
|
117
106
|
/**
|
|
118
|
-
* HTTP
|
|
119
|
-
* Java method: org.openremote.model.
|
|
107
|
+
* HTTP POST /console/register
|
|
108
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
120
109
|
*/
|
|
121
|
-
|
|
122
|
-
targetId?: string;
|
|
123
|
-
}, options?: O): RestResponse<void>;
|
|
110
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
124
111
|
}
|
|
125
|
-
export declare class
|
|
112
|
+
export declare class RealmResourceClient<O> {
|
|
126
113
|
protected httpClient: HttpClient<O>;
|
|
127
114
|
constructor(httpClient: HttpClient<O>);
|
|
128
115
|
/**
|
|
129
|
-
* HTTP POST /
|
|
130
|
-
* Java method: org.openremote.model.
|
|
116
|
+
* HTTP POST /realm
|
|
117
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
131
118
|
*/
|
|
132
|
-
|
|
119
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
133
120
|
/**
|
|
134
|
-
* HTTP
|
|
135
|
-
* Java method: org.openremote.model.
|
|
121
|
+
* HTTP GET /realm
|
|
122
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
136
123
|
*/
|
|
137
|
-
|
|
124
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
125
|
+
/**
|
|
126
|
+
* HTTP GET /realm/accessible
|
|
127
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
128
|
+
*/
|
|
129
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
130
|
+
/**
|
|
131
|
+
* HTTP DELETE /realm/{name}
|
|
132
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
133
|
+
*/
|
|
134
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
135
|
+
/**
|
|
136
|
+
* HTTP GET /realm/{name}
|
|
137
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
138
|
+
*/
|
|
139
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
140
|
+
/**
|
|
141
|
+
* HTTP PUT /realm/{name}
|
|
142
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
143
|
+
*/
|
|
144
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
138
145
|
}
|
|
139
146
|
export declare class AgentResourceClient<O> {
|
|
140
147
|
protected httpClient: HttpClient<O>;
|
|
@@ -162,102 +169,136 @@ export declare class AgentResourceClient<O> {
|
|
|
162
169
|
realm?: string;
|
|
163
170
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
164
171
|
}
|
|
165
|
-
export declare class
|
|
172
|
+
export declare class DashboardResourceClient<O> {
|
|
166
173
|
protected httpClient: HttpClient<O>;
|
|
167
174
|
constructor(httpClient: HttpClient<O>);
|
|
168
175
|
/**
|
|
169
|
-
* HTTP POST /
|
|
170
|
-
* Java method: org.openremote.model.
|
|
176
|
+
* HTTP POST /dashboard
|
|
177
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
171
178
|
*/
|
|
172
|
-
create(
|
|
179
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
173
180
|
/**
|
|
174
|
-
* HTTP
|
|
175
|
-
* Java method: org.openremote.model.
|
|
181
|
+
* HTTP PUT /dashboard
|
|
182
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
176
183
|
*/
|
|
177
|
-
|
|
184
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
178
185
|
/**
|
|
179
|
-
* HTTP GET /realm
|
|
180
|
-
* Java method: org.openremote.model.
|
|
186
|
+
* HTTP GET /dashboard/all/{realm}
|
|
187
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
181
188
|
*/
|
|
182
|
-
|
|
189
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
183
190
|
/**
|
|
184
|
-
* HTTP
|
|
185
|
-
* Java method: org.openremote.model.
|
|
191
|
+
* HTTP POST /dashboard/query
|
|
192
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
186
193
|
*/
|
|
187
|
-
|
|
194
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
188
195
|
/**
|
|
189
|
-
* HTTP
|
|
190
|
-
* Java method: org.openremote.model.
|
|
196
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
197
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
191
198
|
*/
|
|
192
|
-
|
|
199
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
193
200
|
/**
|
|
194
|
-
* HTTP
|
|
195
|
-
* Java method: org.openremote.model.
|
|
201
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
202
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
196
203
|
*/
|
|
197
|
-
|
|
204
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
198
205
|
}
|
|
199
|
-
export declare class
|
|
206
|
+
export declare class ProvisioningResourceClient<O> {
|
|
200
207
|
protected httpClient: HttpClient<O>;
|
|
201
208
|
constructor(httpClient: HttpClient<O>);
|
|
202
209
|
/**
|
|
203
|
-
* HTTP
|
|
204
|
-
* Java method: org.openremote.model.
|
|
210
|
+
* HTTP POST /provisioning
|
|
211
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
205
212
|
*/
|
|
206
|
-
|
|
207
|
-
parentId?: string;
|
|
208
|
-
parentType?: string;
|
|
209
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
213
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
210
214
|
/**
|
|
211
|
-
* HTTP GET /
|
|
212
|
-
* Java method: org.openremote.model.
|
|
215
|
+
* HTTP GET /provisioning
|
|
216
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
213
217
|
*/
|
|
214
|
-
|
|
215
|
-
parentId?: string;
|
|
216
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
218
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
217
219
|
/**
|
|
218
|
-
* HTTP
|
|
219
|
-
* Java method: org.openremote.model.
|
|
220
|
+
* HTTP DELETE /provisioning/{id}
|
|
221
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
220
222
|
*/
|
|
221
|
-
|
|
222
|
-
parentId?: string;
|
|
223
|
-
parentType?: string;
|
|
224
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
223
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
225
224
|
/**
|
|
226
|
-
* HTTP
|
|
227
|
-
* Java method: org.openremote.model.
|
|
225
|
+
* HTTP PUT /provisioning/{id}
|
|
226
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
228
227
|
*/
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
228
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
229
|
+
}
|
|
230
|
+
export declare class NotificationResourceClient<O> {
|
|
231
|
+
protected httpClient: HttpClient<O>;
|
|
232
|
+
constructor(httpClient: HttpClient<O>);
|
|
234
233
|
/**
|
|
235
|
-
* HTTP GET /
|
|
236
|
-
* Java method: org.openremote.model.
|
|
234
|
+
* HTTP GET /notification
|
|
235
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
237
236
|
*/
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
237
|
+
getNotifications(queryParams?: {
|
|
238
|
+
id?: number;
|
|
239
|
+
type?: string;
|
|
240
|
+
from?: number;
|
|
241
|
+
to?: number;
|
|
242
|
+
realmId?: string;
|
|
243
|
+
userId?: string;
|
|
244
|
+
assetId?: string;
|
|
245
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
246
|
+
/**
|
|
247
|
+
* HTTP DELETE /notification
|
|
248
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
249
|
+
*/
|
|
250
|
+
removeNotifications(queryParams?: {
|
|
251
|
+
id?: number;
|
|
252
|
+
type?: string;
|
|
253
|
+
from?: number;
|
|
254
|
+
to?: number;
|
|
255
|
+
realmId?: string;
|
|
256
|
+
userId?: string;
|
|
257
|
+
assetId?: string;
|
|
258
|
+
}, options?: O): RestResponse<void>;
|
|
259
|
+
/**
|
|
260
|
+
* HTTP POST /notification/alert
|
|
261
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
262
|
+
*/
|
|
263
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
264
|
+
/**
|
|
265
|
+
* HTTP DELETE /notification/{notificationId}
|
|
266
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
267
|
+
*/
|
|
268
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
269
|
+
/**
|
|
270
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
271
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
272
|
+
*/
|
|
273
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
274
|
+
targetId?: string;
|
|
275
|
+
}, options?: O): RestResponse<void>;
|
|
276
|
+
/**
|
|
277
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
278
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
279
|
+
*/
|
|
280
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
281
|
+
targetId?: string;
|
|
282
|
+
}, options?: O): RestResponse<void>;
|
|
243
283
|
}
|
|
244
|
-
export declare class
|
|
284
|
+
export declare class FlowResourceClient<O> {
|
|
245
285
|
protected httpClient: HttpClient<O>;
|
|
246
286
|
constructor(httpClient: HttpClient<O>);
|
|
247
287
|
/**
|
|
248
|
-
* HTTP GET /
|
|
249
|
-
* Java method: org.openremote.model.
|
|
288
|
+
* HTTP GET /flow
|
|
289
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
250
290
|
*/
|
|
251
|
-
|
|
252
|
-
[index: string]: any;
|
|
253
|
-
}>;
|
|
291
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
254
292
|
/**
|
|
255
|
-
* HTTP GET /
|
|
256
|
-
* Java method: org.openremote.model.
|
|
293
|
+
* HTTP GET /flow/{name}
|
|
294
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
257
295
|
*/
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
296
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
297
|
+
/**
|
|
298
|
+
* HTTP GET /flow/{type}
|
|
299
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
300
|
+
*/
|
|
301
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
261
302
|
}
|
|
262
303
|
export declare class UserResourceClient<O> {
|
|
263
304
|
protected httpClient: HttpClient<O>;
|
|
@@ -413,70 +454,51 @@ export declare class MapResourceClient<O> {
|
|
|
413
454
|
*/
|
|
414
455
|
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
415
456
|
}
|
|
416
|
-
export declare class
|
|
417
|
-
protected httpClient: HttpClient<O>;
|
|
418
|
-
constructor(httpClient: HttpClient<O>);
|
|
419
|
-
/**
|
|
420
|
-
* HTTP POST /gateway/tunnel
|
|
421
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
422
|
-
*/
|
|
423
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
424
|
-
/**
|
|
425
|
-
* HTTP DELETE /gateway/tunnel
|
|
426
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
427
|
-
*/
|
|
428
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
429
|
-
/**
|
|
430
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
431
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
432
|
-
*/
|
|
433
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
434
|
-
/**
|
|
435
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
436
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
437
|
-
*/
|
|
438
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
439
|
-
/**
|
|
440
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
441
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
442
|
-
*/
|
|
443
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
444
|
-
}
|
|
445
|
-
export declare class GatewayClientResourceClient<O> {
|
|
457
|
+
export declare class SyslogResourceClient<O> {
|
|
446
458
|
protected httpClient: HttpClient<O>;
|
|
447
459
|
constructor(httpClient: HttpClient<O>);
|
|
448
460
|
/**
|
|
449
|
-
* HTTP
|
|
450
|
-
* Java method: org.openremote.model.
|
|
461
|
+
* HTTP GET /syslog/config
|
|
462
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
451
463
|
*/
|
|
452
|
-
|
|
453
|
-
realm?: string[];
|
|
454
|
-
}, options?: O): RestResponse<void>;
|
|
464
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
455
465
|
/**
|
|
456
|
-
* HTTP
|
|
457
|
-
* Java method: org.openremote.model.
|
|
466
|
+
* HTTP PUT /syslog/config
|
|
467
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
458
468
|
*/
|
|
459
|
-
|
|
469
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
460
470
|
/**
|
|
461
|
-
* HTTP DELETE /
|
|
462
|
-
* Java method: org.openremote.model.
|
|
471
|
+
* HTTP DELETE /syslog/event
|
|
472
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
463
473
|
*/
|
|
464
|
-
|
|
474
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
465
475
|
/**
|
|
466
|
-
* HTTP GET /
|
|
467
|
-
* Java method: org.openremote.model.
|
|
476
|
+
* HTTP GET /syslog/event
|
|
477
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
468
478
|
*/
|
|
469
|
-
|
|
479
|
+
getEvents(queryParams?: {
|
|
480
|
+
level?: Model.SyslogLevel;
|
|
481
|
+
per_page?: number;
|
|
482
|
+
page?: number;
|
|
483
|
+
from?: number;
|
|
484
|
+
to?: number;
|
|
485
|
+
category?: Model.SyslogCategory[];
|
|
486
|
+
subCategory?: string[];
|
|
487
|
+
}, options?: O): RestResponse<any>;
|
|
488
|
+
}
|
|
489
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
490
|
+
protected httpClient: HttpClient<O>;
|
|
491
|
+
constructor(httpClient: HttpClient<O>);
|
|
470
492
|
/**
|
|
471
|
-
* HTTP
|
|
472
|
-
* Java method: org.openremote.model.
|
|
493
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
494
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
473
495
|
*/
|
|
474
|
-
|
|
496
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
475
497
|
/**
|
|
476
|
-
* HTTP
|
|
477
|
-
* Java method: org.openremote.model.
|
|
498
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
499
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
478
500
|
*/
|
|
479
|
-
|
|
501
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
480
502
|
}
|
|
481
503
|
export declare class AssetResourceClient<O> {
|
|
482
504
|
protected httpClient: HttpClient<O>;
|
|
@@ -582,132 +604,58 @@ export declare class AssetResourceClient<O> {
|
|
|
582
604
|
assetIds?: string[];
|
|
583
605
|
}, options?: O): RestResponse<void>;
|
|
584
606
|
}
|
|
585
|
-
export declare class
|
|
607
|
+
export declare class AlarmResourceClient<O> {
|
|
586
608
|
protected httpClient: HttpClient<O>;
|
|
587
609
|
constructor(httpClient: HttpClient<O>);
|
|
588
610
|
/**
|
|
589
|
-
* HTTP POST /
|
|
590
|
-
* Java method: org.openremote.model.
|
|
591
|
-
*/
|
|
592
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
593
|
-
/**
|
|
594
|
-
* HTTP GET /rules
|
|
595
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
596
|
-
*/
|
|
597
|
-
getGlobalRulesets(queryParams?: {
|
|
598
|
-
language?: Model.RulesetLang[];
|
|
599
|
-
fullyPopulate?: boolean;
|
|
600
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
601
|
-
/**
|
|
602
|
-
* HTTP POST /rules/asset
|
|
603
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
604
|
-
*/
|
|
605
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
606
|
-
/**
|
|
607
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
608
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
609
|
-
*/
|
|
610
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
611
|
-
language?: Model.RulesetLang[];
|
|
612
|
-
fullyPopulate?: boolean;
|
|
613
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
614
|
-
/**
|
|
615
|
-
* HTTP DELETE /rules/asset/{id}
|
|
616
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
617
|
-
*/
|
|
618
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
619
|
-
/**
|
|
620
|
-
* HTTP GET /rules/asset/{id}
|
|
621
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
622
|
-
*/
|
|
623
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
624
|
-
/**
|
|
625
|
-
* HTTP PUT /rules/asset/{id}
|
|
626
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
627
|
-
*/
|
|
628
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
629
|
-
/**
|
|
630
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
631
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
632
|
-
*/
|
|
633
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
634
|
-
/**
|
|
635
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
636
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
637
|
-
*/
|
|
638
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
639
|
-
/**
|
|
640
|
-
* HTTP GET /rules/info/global
|
|
641
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
642
|
-
*/
|
|
643
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
644
|
-
/**
|
|
645
|
-
* HTTP GET /rules/info/realm/{realm}
|
|
646
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
647
|
-
*/
|
|
648
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
649
|
-
/**
|
|
650
|
-
* HTTP POST /rules/realm
|
|
651
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
652
|
-
*/
|
|
653
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
654
|
-
/**
|
|
655
|
-
* HTTP GET /rules/realm/for/{realm}
|
|
656
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
657
|
-
*/
|
|
658
|
-
getRealmRulesets(realm: string, queryParams?: {
|
|
659
|
-
language?: Model.RulesetLang[];
|
|
660
|
-
fullyPopulate?: boolean;
|
|
661
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
662
|
-
/**
|
|
663
|
-
* HTTP DELETE /rules/realm/{id}
|
|
664
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
665
|
-
*/
|
|
666
|
-
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
667
|
-
/**
|
|
668
|
-
* HTTP GET /rules/realm/{id}
|
|
669
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
611
|
+
* HTTP POST /alarm
|
|
612
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
670
613
|
*/
|
|
671
|
-
|
|
614
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
615
|
+
assetIds?: string[];
|
|
616
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
672
617
|
/**
|
|
673
|
-
* HTTP
|
|
674
|
-
* Java method: org.openremote.model.
|
|
618
|
+
* HTTP GET /alarm
|
|
619
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
675
620
|
*/
|
|
676
|
-
|
|
621
|
+
getAlarms(queryParams?: {
|
|
622
|
+
realm?: string;
|
|
623
|
+
status?: Model.AlarmStatus;
|
|
624
|
+
assetId?: string;
|
|
625
|
+
assigneeId?: string;
|
|
626
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
677
627
|
/**
|
|
678
|
-
* HTTP DELETE /
|
|
679
|
-
* Java method: org.openremote.model.
|
|
628
|
+
* HTTP DELETE /alarm
|
|
629
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
680
630
|
*/
|
|
681
|
-
|
|
631
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
682
632
|
/**
|
|
683
|
-
* HTTP
|
|
684
|
-
* Java method: org.openremote.model.
|
|
633
|
+
* HTTP PUT /alarm/assets
|
|
634
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
685
635
|
*/
|
|
686
|
-
|
|
636
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
687
637
|
/**
|
|
688
|
-
* HTTP
|
|
689
|
-
* Java method: org.openremote.model.
|
|
638
|
+
* HTTP GET /alarm/{alarmId}
|
|
639
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
690
640
|
*/
|
|
691
|
-
|
|
692
|
-
}
|
|
693
|
-
export declare class FlowResourceClient<O> {
|
|
694
|
-
protected httpClient: HttpClient<O>;
|
|
695
|
-
constructor(httpClient: HttpClient<O>);
|
|
641
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
696
642
|
/**
|
|
697
|
-
* HTTP
|
|
698
|
-
* Java method: org.openremote.model.
|
|
643
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
644
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
699
645
|
*/
|
|
700
|
-
|
|
646
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
701
647
|
/**
|
|
702
|
-
* HTTP
|
|
703
|
-
* Java method: org.openremote.model.
|
|
648
|
+
* HTTP PUT /alarm/{alarmId}
|
|
649
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
704
650
|
*/
|
|
705
|
-
|
|
651
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
706
652
|
/**
|
|
707
|
-
* HTTP GET /
|
|
708
|
-
* Java method: org.openremote.model.
|
|
653
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
654
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
709
655
|
*/
|
|
710
|
-
|
|
656
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
657
|
+
realm?: string;
|
|
658
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
711
659
|
}
|
|
712
660
|
export declare class AppResourceClient<O> {
|
|
713
661
|
protected httpClient: HttpClient<O>;
|
|
@@ -728,196 +676,248 @@ export declare class AppResourceClient<O> {
|
|
|
728
676
|
*/
|
|
729
677
|
getAppInfos(options?: O): RestResponse<any>;
|
|
730
678
|
}
|
|
731
|
-
export declare class
|
|
679
|
+
export declare class AssetModelResourceClient<O> {
|
|
732
680
|
protected httpClient: HttpClient<O>;
|
|
733
681
|
constructor(httpClient: HttpClient<O>);
|
|
734
682
|
/**
|
|
735
|
-
* HTTP
|
|
736
|
-
* Java method: org.openremote.model.
|
|
683
|
+
* HTTP GET /model/assetDescriptors
|
|
684
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
737
685
|
*/
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
686
|
+
getAssetDescriptors(queryParams?: {
|
|
687
|
+
parentId?: string;
|
|
688
|
+
parentType?: string;
|
|
689
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
741
690
|
/**
|
|
742
|
-
* HTTP GET /
|
|
743
|
-
* Java method: org.openremote.model.
|
|
691
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
692
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
744
693
|
*/
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
assetId?: string;
|
|
749
|
-
assigneeId?: string;
|
|
750
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
694
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
695
|
+
parentId?: string;
|
|
696
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
751
697
|
/**
|
|
752
|
-
* HTTP
|
|
753
|
-
* Java method: org.openremote.model.
|
|
698
|
+
* HTTP GET /model/assetInfos
|
|
699
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
754
700
|
*/
|
|
755
|
-
|
|
701
|
+
getAssetInfos(queryParams?: {
|
|
702
|
+
parentId?: string;
|
|
703
|
+
parentType?: string;
|
|
704
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
705
|
+
/**
|
|
706
|
+
* HTTP GET /model/metaItemDescriptors
|
|
707
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
708
|
+
*/
|
|
709
|
+
getMetaItemDescriptors(queryParams?: {
|
|
710
|
+
parentId?: string;
|
|
711
|
+
}, options?: O): RestResponse<{
|
|
712
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
713
|
+
}>;
|
|
714
|
+
/**
|
|
715
|
+
* HTTP GET /model/valueDescriptors
|
|
716
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
717
|
+
*/
|
|
718
|
+
getValueDescriptors(queryParams?: {
|
|
719
|
+
parentId?: string;
|
|
720
|
+
}, options?: O): RestResponse<{
|
|
721
|
+
[index: string]: Model.ValueDescriptor;
|
|
722
|
+
}>;
|
|
723
|
+
}
|
|
724
|
+
export declare class RulesResourceClient<O> {
|
|
725
|
+
protected httpClient: HttpClient<O>;
|
|
726
|
+
constructor(httpClient: HttpClient<O>);
|
|
727
|
+
/**
|
|
728
|
+
* HTTP POST /rules
|
|
729
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
730
|
+
*/
|
|
731
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
732
|
+
/**
|
|
733
|
+
* HTTP GET /rules
|
|
734
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
735
|
+
*/
|
|
736
|
+
getGlobalRulesets(queryParams?: {
|
|
737
|
+
language?: Model.RulesetLang[];
|
|
738
|
+
fullyPopulate?: boolean;
|
|
739
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
740
|
+
/**
|
|
741
|
+
* HTTP POST /rules/asset
|
|
742
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
743
|
+
*/
|
|
744
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
745
|
+
/**
|
|
746
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
747
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
748
|
+
*/
|
|
749
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
750
|
+
language?: Model.RulesetLang[];
|
|
751
|
+
fullyPopulate?: boolean;
|
|
752
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
756
753
|
/**
|
|
757
|
-
* HTTP
|
|
758
|
-
* Java method: org.openremote.model.
|
|
754
|
+
* HTTP DELETE /rules/asset/{id}
|
|
755
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
759
756
|
*/
|
|
760
|
-
|
|
757
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
761
758
|
/**
|
|
762
|
-
* HTTP GET /
|
|
763
|
-
* Java method: org.openremote.model.
|
|
759
|
+
* HTTP GET /rules/asset/{id}
|
|
760
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
764
761
|
*/
|
|
765
|
-
|
|
762
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
766
763
|
/**
|
|
767
|
-
* HTTP
|
|
768
|
-
* Java method: org.openremote.model.
|
|
764
|
+
* HTTP PUT /rules/asset/{id}
|
|
765
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
769
766
|
*/
|
|
770
|
-
|
|
767
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
771
768
|
/**
|
|
772
|
-
* HTTP
|
|
773
|
-
* Java method: org.openremote.model.
|
|
769
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
770
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
774
771
|
*/
|
|
775
|
-
|
|
772
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
776
773
|
/**
|
|
777
|
-
* HTTP GET /
|
|
778
|
-
* Java method: org.openremote.model.
|
|
774
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
775
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
779
776
|
*/
|
|
780
|
-
|
|
781
|
-
realm?: string;
|
|
782
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
783
|
-
}
|
|
784
|
-
export declare class ConfigurationResourceClient<O> {
|
|
785
|
-
protected httpClient: HttpClient<O>;
|
|
786
|
-
constructor(httpClient: HttpClient<O>);
|
|
777
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
787
778
|
/**
|
|
788
|
-
* HTTP GET /
|
|
789
|
-
* Java method: org.openremote.model.
|
|
779
|
+
* HTTP GET /rules/info/global
|
|
780
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
790
781
|
*/
|
|
791
|
-
|
|
782
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
792
783
|
/**
|
|
793
|
-
* HTTP
|
|
794
|
-
* Java method: org.openremote.model.
|
|
784
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
785
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
795
786
|
*/
|
|
796
|
-
|
|
787
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
797
788
|
/**
|
|
798
|
-
* HTTP POST /
|
|
799
|
-
* Java method: org.openremote.model.
|
|
789
|
+
* HTTP POST /rules/realm
|
|
790
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
800
791
|
*/
|
|
801
|
-
|
|
802
|
-
path?: string;
|
|
803
|
-
}, options?: O): RestResponse<string>;
|
|
792
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
804
793
|
/**
|
|
805
|
-
* HTTP GET /
|
|
806
|
-
* Java method: org.openremote.model.
|
|
794
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
795
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
807
796
|
*/
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
constructor(httpClient: HttpClient<O>);
|
|
797
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
798
|
+
language?: Model.RulesetLang[];
|
|
799
|
+
fullyPopulate?: boolean;
|
|
800
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
813
801
|
/**
|
|
814
|
-
* HTTP
|
|
815
|
-
* Java method: org.openremote.model.
|
|
802
|
+
* HTTP DELETE /rules/realm/{id}
|
|
803
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
816
804
|
*/
|
|
817
|
-
|
|
805
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
818
806
|
/**
|
|
819
|
-
* HTTP
|
|
820
|
-
* Java method: org.openremote.model.
|
|
807
|
+
* HTTP GET /rules/realm/{id}
|
|
808
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
821
809
|
*/
|
|
822
|
-
|
|
810
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
823
811
|
/**
|
|
824
|
-
* HTTP
|
|
825
|
-
* Java method: org.openremote.model.
|
|
812
|
+
* HTTP PUT /rules/realm/{id}
|
|
813
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
826
814
|
*/
|
|
827
|
-
|
|
815
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
828
816
|
/**
|
|
829
|
-
* HTTP
|
|
830
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* HTTP DELETE /rules/{id}
|
|
818
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
831
819
|
*/
|
|
832
|
-
|
|
820
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
833
821
|
/**
|
|
834
|
-
* HTTP
|
|
835
|
-
* Java method: org.openremote.model.
|
|
822
|
+
* HTTP GET /rules/{id}
|
|
823
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
836
824
|
*/
|
|
837
|
-
|
|
825
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
838
826
|
/**
|
|
839
|
-
* HTTP
|
|
840
|
-
* Java method: org.openremote.model.
|
|
827
|
+
* HTTP PUT /rules/{id}
|
|
828
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
841
829
|
*/
|
|
842
|
-
|
|
830
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
843
831
|
}
|
|
844
|
-
export declare class
|
|
832
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
845
833
|
protected httpClient: HttpClient<O>;
|
|
846
834
|
constructor(httpClient: HttpClient<O>);
|
|
847
835
|
/**
|
|
848
|
-
* HTTP GET /
|
|
849
|
-
* Java method: org.openremote.model.
|
|
836
|
+
* HTTP GET /asset/datapoint/export
|
|
837
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
850
838
|
*/
|
|
851
|
-
|
|
839
|
+
getDatapointExport(queryParams?: {
|
|
840
|
+
attributeRefs?: string;
|
|
841
|
+
fromTimestamp?: number;
|
|
842
|
+
toTimestamp?: number;
|
|
843
|
+
}, options?: O): RestResponse<any>;
|
|
852
844
|
/**
|
|
853
|
-
* HTTP
|
|
854
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* HTTP GET /asset/datapoint/periods
|
|
846
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
855
847
|
*/
|
|
856
|
-
|
|
848
|
+
getDatapointPeriod(queryParams?: {
|
|
849
|
+
assetId?: string;
|
|
850
|
+
attributeName?: string;
|
|
851
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
857
852
|
/**
|
|
858
|
-
* HTTP
|
|
859
|
-
* Java method: org.openremote.model.
|
|
853
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
854
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
860
855
|
*/
|
|
861
|
-
|
|
856
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
857
|
+
}
|
|
858
|
+
export declare class StatusResourceClient<O> {
|
|
859
|
+
protected httpClient: HttpClient<O>;
|
|
860
|
+
constructor(httpClient: HttpClient<O>);
|
|
862
861
|
/**
|
|
863
|
-
* HTTP GET /
|
|
864
|
-
* Java method: org.openremote.model.
|
|
862
|
+
* HTTP GET /health
|
|
863
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
865
864
|
*/
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
865
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
866
|
+
[index: string]: any;
|
|
867
|
+
}>;
|
|
868
|
+
/**
|
|
869
|
+
* HTTP GET /info
|
|
870
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
871
|
+
*/
|
|
872
|
+
getInfo(options?: O): RestResponse<{
|
|
873
|
+
[index: string]: any;
|
|
874
|
+
}>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
878
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
879
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
880
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
879
881
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
880
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
881
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
882
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
883
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
884
882
|
protected _realmResource: AxiosRealmResourceClient;
|
|
885
|
-
protected
|
|
886
|
-
protected
|
|
883
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
884
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
885
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
886
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
887
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
887
888
|
protected _userResource: AxiosUserResourceClient;
|
|
888
889
|
protected _mapResource: AxiosMapResourceClient;
|
|
889
|
-
protected
|
|
890
|
-
protected
|
|
890
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
891
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
891
892
|
protected _assetResource: AxiosAssetResourceClient;
|
|
892
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
893
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
894
|
-
protected _appResource: AxiosAppResourceClient;
|
|
895
893
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
896
|
-
protected
|
|
897
|
-
protected
|
|
898
|
-
protected
|
|
894
|
+
protected _appResource: AxiosAppResourceClient;
|
|
895
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
896
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
897
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
898
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
900
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
901
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
902
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
901
903
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
902
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
903
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
904
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
905
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
906
904
|
get RealmResource(): AxiosRealmResourceClient;
|
|
907
|
-
get
|
|
908
|
-
get
|
|
905
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
906
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
907
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
908
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
909
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
909
910
|
get UserResource(): AxiosUserResourceClient;
|
|
910
911
|
get MapResource(): AxiosMapResourceClient;
|
|
911
|
-
get
|
|
912
|
-
get
|
|
912
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
913
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
913
914
|
get AssetResource(): AxiosAssetResourceClient;
|
|
914
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
915
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
916
|
-
get AppResource(): AxiosAppResourceClient;
|
|
917
915
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
918
|
-
get
|
|
919
|
-
get
|
|
920
|
-
get
|
|
916
|
+
get AppResource(): AxiosAppResourceClient;
|
|
917
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
918
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
919
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
920
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,31 +925,34 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
929
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
943
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
953
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
|
+
}
|
|
955
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
953
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
957
|
}
|
|
955
958
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
@@ -958,33 +961,30 @@ export declare class AxiosUserResourceClient extends UserResourceClient<Axios.Ax
|
|
|
958
961
|
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
959
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
963
|
}
|
|
961
|
-
export declare class
|
|
964
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
962
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
966
|
}
|
|
964
|
-
export declare class
|
|
967
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
965
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
969
|
}
|
|
967
970
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
968
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
972
|
}
|
|
970
|
-
export declare class
|
|
971
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
|
-
}
|
|
973
|
-
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
973
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
976
|
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|