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