@openremote/rest 1.2.3-1 → 1.2.4
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 +471 -471
- 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,59 +9,63 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class SyslogResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP GET /
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP GET /syslog/config
|
|
17
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
id?: any;
|
|
21
|
-
type?: any;
|
|
22
|
-
from?: any;
|
|
23
|
-
to?: any;
|
|
24
|
-
realmId?: any;
|
|
25
|
-
userId?: any;
|
|
26
|
-
assetId?: any;
|
|
27
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
19
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
28
20
|
/**
|
|
29
|
-
* HTTP
|
|
30
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP PUT /syslog/config
|
|
22
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
31
23
|
*/
|
|
32
|
-
|
|
33
|
-
id?: any;
|
|
34
|
-
type?: any;
|
|
35
|
-
from?: any;
|
|
36
|
-
to?: any;
|
|
37
|
-
realmId?: any;
|
|
38
|
-
userId?: any;
|
|
39
|
-
assetId?: any;
|
|
40
|
-
}, options?: O): RestResponse<void>;
|
|
24
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
41
25
|
/**
|
|
42
|
-
* HTTP
|
|
43
|
-
* Java method: org.openremote.model.
|
|
26
|
+
* HTTP DELETE /syslog/event
|
|
27
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
44
28
|
*/
|
|
45
|
-
|
|
29
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
46
30
|
/**
|
|
47
|
-
* HTTP
|
|
48
|
-
* Java method: org.openremote.model.
|
|
31
|
+
* HTTP GET /syslog/event
|
|
32
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
49
33
|
*/
|
|
50
|
-
|
|
34
|
+
getEvents(queryParams?: {
|
|
35
|
+
level?: Model.SyslogLevel;
|
|
36
|
+
per_page?: any;
|
|
37
|
+
page?: any;
|
|
38
|
+
from?: any;
|
|
39
|
+
to?: any;
|
|
40
|
+
category?: Model.SyslogCategory[];
|
|
41
|
+
subCategory?: any[];
|
|
42
|
+
}, options?: O): RestResponse<any>;
|
|
43
|
+
}
|
|
44
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
45
|
+
protected httpClient: HttpClient<O>;
|
|
46
|
+
constructor(httpClient: HttpClient<O>);
|
|
51
47
|
/**
|
|
52
|
-
* HTTP
|
|
53
|
-
* Java method: org.openremote.model.
|
|
48
|
+
* HTTP GET /asset/datapoint/export
|
|
49
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
54
50
|
*/
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
51
|
+
getDatapointExport(queryParams?: {
|
|
52
|
+
attributeRefs?: any;
|
|
53
|
+
fromTimestamp?: number;
|
|
54
|
+
toTimestamp?: number;
|
|
55
|
+
}, options?: O): RestResponse<any>;
|
|
58
56
|
/**
|
|
59
|
-
* HTTP
|
|
60
|
-
* Java method: org.openremote.model.
|
|
57
|
+
* HTTP GET /asset/datapoint/periods
|
|
58
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
61
59
|
*/
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
60
|
+
getDatapointPeriod(queryParams?: {
|
|
61
|
+
assetId?: any;
|
|
62
|
+
attributeName?: any;
|
|
63
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
64
|
+
/**
|
|
65
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
66
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
67
|
+
*/
|
|
68
|
+
getDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
65
69
|
}
|
|
66
70
|
export declare class GatewayClientResourceClient<O> {
|
|
67
71
|
protected httpClient: HttpClient<O>;
|
|
@@ -99,31 +103,96 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
99
103
|
*/
|
|
100
104
|
getConnectionStatus(realm: any, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
101
105
|
}
|
|
102
|
-
export declare class
|
|
106
|
+
export declare class RealmResourceClient<O> {
|
|
103
107
|
protected httpClient: HttpClient<O>;
|
|
104
108
|
constructor(httpClient: HttpClient<O>);
|
|
105
109
|
/**
|
|
106
|
-
* HTTP
|
|
107
|
-
* Java method: org.openremote.model.
|
|
110
|
+
* HTTP POST /realm
|
|
111
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
108
112
|
*/
|
|
109
|
-
|
|
110
|
-
realm?: any;
|
|
111
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
113
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
112
114
|
/**
|
|
113
|
-
* HTTP
|
|
114
|
-
* Java method: org.openremote.model.
|
|
115
|
+
* HTTP GET /realm
|
|
116
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
115
117
|
*/
|
|
116
|
-
|
|
117
|
-
realm?: any;
|
|
118
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
118
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
119
119
|
/**
|
|
120
|
-
* HTTP GET /
|
|
121
|
-
* Java method: org.openremote.model.
|
|
120
|
+
* HTTP GET /realm/accessible
|
|
121
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
122
122
|
*/
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
123
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
124
|
+
/**
|
|
125
|
+
* HTTP DELETE /realm/{name}
|
|
126
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
127
|
+
*/
|
|
128
|
+
delete(name: any, options?: O): RestResponse<void>;
|
|
129
|
+
/**
|
|
130
|
+
* HTTP GET /realm/{name}
|
|
131
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
132
|
+
*/
|
|
133
|
+
get(name: any, options?: O): RestResponse<Model.Realm>;
|
|
134
|
+
/**
|
|
135
|
+
* HTTP PUT /realm/{name}
|
|
136
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
137
|
+
*/
|
|
138
|
+
update(name: any, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
139
|
+
}
|
|
140
|
+
export declare class AppResourceClient<O> {
|
|
141
|
+
protected httpClient: HttpClient<O>;
|
|
142
|
+
constructor(httpClient: HttpClient<O>);
|
|
143
|
+
/**
|
|
144
|
+
* HTTP GET /apps
|
|
145
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
146
|
+
*/
|
|
147
|
+
getApps(options?: O): RestResponse<any[]>;
|
|
148
|
+
/**
|
|
149
|
+
* HTTP GET /apps/consoleConfig
|
|
150
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
151
|
+
*/
|
|
152
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
153
|
+
/**
|
|
154
|
+
* HTTP GET /apps/info
|
|
155
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
156
|
+
*/
|
|
157
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
158
|
+
}
|
|
159
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
160
|
+
protected httpClient: HttpClient<O>;
|
|
161
|
+
constructor(httpClient: HttpClient<O>);
|
|
162
|
+
/**
|
|
163
|
+
* HTTP POST /gateway/tunnel
|
|
164
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
165
|
+
*/
|
|
166
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
167
|
+
/**
|
|
168
|
+
* HTTP DELETE /gateway/tunnel
|
|
169
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
170
|
+
*/
|
|
171
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
172
|
+
/**
|
|
173
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
174
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
175
|
+
*/
|
|
176
|
+
getAllActiveTunnelInfos(realm: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
177
|
+
/**
|
|
178
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
179
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
180
|
+
*/
|
|
181
|
+
getGatewayActiveTunnelInfos(realm: any, id: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
182
|
+
/**
|
|
183
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
184
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
185
|
+
*/
|
|
186
|
+
getActiveTunnelInfo(realm: any, id: any, target: any, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
187
|
+
}
|
|
188
|
+
export declare class ConsoleResourceClient<O> {
|
|
189
|
+
protected httpClient: HttpClient<O>;
|
|
190
|
+
constructor(httpClient: HttpClient<O>);
|
|
191
|
+
/**
|
|
192
|
+
* HTTP POST /console/register
|
|
193
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
194
|
+
*/
|
|
195
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
127
196
|
}
|
|
128
197
|
export declare class DashboardResourceClient<O> {
|
|
129
198
|
protected httpClient: HttpClient<O>;
|
|
@@ -159,49 +228,106 @@ export declare class DashboardResourceClient<O> {
|
|
|
159
228
|
*/
|
|
160
229
|
get(realm: any, dashboardId: any, options?: O): RestResponse<Model.Dashboard>;
|
|
161
230
|
}
|
|
162
|
-
export declare class
|
|
231
|
+
export declare class MapResourceClient<O> {
|
|
163
232
|
protected httpClient: HttpClient<O>;
|
|
164
233
|
constructor(httpClient: HttpClient<O>);
|
|
165
234
|
/**
|
|
166
|
-
* HTTP GET /
|
|
167
|
-
* Java method: org.openremote.model.
|
|
235
|
+
* HTTP GET /map
|
|
236
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
168
237
|
*/
|
|
169
|
-
|
|
170
|
-
[
|
|
238
|
+
getSettings(options?: O): RestResponse<{
|
|
239
|
+
[id: string]: any;
|
|
171
240
|
}>;
|
|
172
241
|
/**
|
|
173
|
-
* HTTP
|
|
174
|
-
* Java method: org.openremote.model.
|
|
242
|
+
* HTTP PUT /map
|
|
243
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
175
244
|
*/
|
|
176
|
-
|
|
177
|
-
[index: string]:
|
|
245
|
+
saveSettings(mapConfig: {
|
|
246
|
+
[index: string]: Model.MapRealmConfig;
|
|
247
|
+
}, options?: O): RestResponse<any>;
|
|
248
|
+
/**
|
|
249
|
+
* HTTP GET /map/js
|
|
250
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
251
|
+
*/
|
|
252
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
253
|
+
[id: string]: any;
|
|
178
254
|
}>;
|
|
255
|
+
/**
|
|
256
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
257
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
258
|
+
*/
|
|
259
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
179
260
|
}
|
|
180
|
-
export declare class
|
|
261
|
+
export declare class AssetModelResourceClient<O> {
|
|
181
262
|
protected httpClient: HttpClient<O>;
|
|
182
263
|
constructor(httpClient: HttpClient<O>);
|
|
183
264
|
/**
|
|
184
|
-
* HTTP GET /
|
|
185
|
-
* Java method: org.openremote.model.
|
|
265
|
+
* HTTP GET /model/assetDescriptors
|
|
266
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
186
267
|
*/
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
}, options?: O): RestResponse<any>;
|
|
268
|
+
getAssetDescriptors(queryParams?: {
|
|
269
|
+
parentId?: any;
|
|
270
|
+
parentType?: any;
|
|
271
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
192
272
|
/**
|
|
193
|
-
* HTTP GET /
|
|
194
|
-
* Java method: org.openremote.model.
|
|
273
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
274
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
195
275
|
*/
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
276
|
+
getAssetInfo(assetType: any, queryParams?: {
|
|
277
|
+
parentId?: any;
|
|
278
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
200
279
|
/**
|
|
201
|
-
* HTTP
|
|
202
|
-
* Java method: org.openremote.model.
|
|
280
|
+
* HTTP GET /model/assetInfos
|
|
281
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
203
282
|
*/
|
|
204
|
-
|
|
283
|
+
getAssetInfos(queryParams?: {
|
|
284
|
+
parentId?: any;
|
|
285
|
+
parentType?: any;
|
|
286
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
287
|
+
/**
|
|
288
|
+
* HTTP GET /model/metaItemDescriptors
|
|
289
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
290
|
+
*/
|
|
291
|
+
getMetaItemDescriptors(queryParams?: {
|
|
292
|
+
parentId?: any;
|
|
293
|
+
}, options?: O): RestResponse<{
|
|
294
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
295
|
+
}>;
|
|
296
|
+
/**
|
|
297
|
+
* HTTP GET /model/valueDescriptors
|
|
298
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
299
|
+
*/
|
|
300
|
+
getValueDescriptors(queryParams?: {
|
|
301
|
+
parentId?: any;
|
|
302
|
+
}, options?: O): RestResponse<{
|
|
303
|
+
[index: string]: Model.ValueDescriptor;
|
|
304
|
+
}>;
|
|
305
|
+
}
|
|
306
|
+
export declare class AgentResourceClient<O> {
|
|
307
|
+
protected httpClient: HttpClient<O>;
|
|
308
|
+
constructor(httpClient: HttpClient<O>);
|
|
309
|
+
/**
|
|
310
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
311
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
312
|
+
*/
|
|
313
|
+
doProtocolAssetDiscovery(agentId: any, queryParams?: {
|
|
314
|
+
realm?: any;
|
|
315
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
316
|
+
/**
|
|
317
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
318
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
319
|
+
*/
|
|
320
|
+
doProtocolAssetImport(agentId: any, fileInfo: Model.FileInfo, queryParams?: {
|
|
321
|
+
realm?: any;
|
|
322
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
323
|
+
/**
|
|
324
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
325
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
326
|
+
*/
|
|
327
|
+
doProtocolInstanceDiscovery(agentType: any, queryParams?: {
|
|
328
|
+
parentId?: any;
|
|
329
|
+
realm?: any;
|
|
330
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
205
331
|
}
|
|
206
332
|
export declare class AssetResourceClient<O> {
|
|
207
333
|
protected httpClient: HttpClient<O>;
|
|
@@ -260,224 +386,70 @@ export declare class AssetResourceClient<O> {
|
|
|
260
386
|
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
261
387
|
*/
|
|
262
388
|
getUserAssetLinks(queryParams?: {
|
|
263
|
-
realm?: any;
|
|
264
|
-
userId?: any;
|
|
265
|
-
assetId?: any;
|
|
266
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
267
|
-
/**
|
|
268
|
-
* HTTP POST /asset/user/link/delete
|
|
269
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
270
|
-
*/
|
|
271
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
272
|
-
/**
|
|
273
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
274
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
275
|
-
*/
|
|
276
|
-
deleteAllUserAssetLinks(realm: any, userId: any, options?: O): RestResponse<void>;
|
|
277
|
-
/**
|
|
278
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
279
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
280
|
-
*/
|
|
281
|
-
deleteUserAssetLink(realm: any, userId: any, assetId: any, options?: O): RestResponse<void>;
|
|
282
|
-
/**
|
|
283
|
-
* HTTP GET /asset/{assetId}
|
|
284
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
285
|
-
*/
|
|
286
|
-
get(assetId: any, options?: O): RestResponse<Model.Asset>;
|
|
287
|
-
/**
|
|
288
|
-
* HTTP PUT /asset/{assetId}
|
|
289
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
290
|
-
*/
|
|
291
|
-
update(assetId: any, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
292
|
-
/**
|
|
293
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
294
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
295
|
-
*/
|
|
296
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: any, attributeName: any, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
297
|
-
/**
|
|
298
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
299
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
300
|
-
*/
|
|
301
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: any, attributeName: any, timestamp: any, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
302
|
-
/**
|
|
303
|
-
* HTTP PUT /asset/{parentAssetId}/child
|
|
304
|
-
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
305
|
-
*/
|
|
306
|
-
updateParent(parentAssetId: any, queryParams?: {
|
|
307
|
-
assetIds?: any[];
|
|
308
|
-
}, options?: O): RestResponse<void>;
|
|
309
|
-
}
|
|
310
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
311
|
-
protected httpClient: HttpClient<O>;
|
|
312
|
-
constructor(httpClient: HttpClient<O>);
|
|
313
|
-
/**
|
|
314
|
-
* HTTP POST /gateway/tunnel
|
|
315
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
316
|
-
*/
|
|
317
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
318
|
-
/**
|
|
319
|
-
* HTTP DELETE /gateway/tunnel
|
|
320
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
321
|
-
*/
|
|
322
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
323
|
-
/**
|
|
324
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
325
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
326
|
-
*/
|
|
327
|
-
getAllActiveTunnelInfos(realm: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
328
|
-
/**
|
|
329
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
330
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
331
|
-
*/
|
|
332
|
-
getGatewayActiveTunnelInfos(realm: any, id: any, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
333
|
-
/**
|
|
334
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
335
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
336
|
-
*/
|
|
337
|
-
getActiveTunnelInfo(realm: any, id: any, target: any, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
338
|
-
}
|
|
339
|
-
export declare class RealmResourceClient<O> {
|
|
340
|
-
protected httpClient: HttpClient<O>;
|
|
341
|
-
constructor(httpClient: HttpClient<O>);
|
|
342
|
-
/**
|
|
343
|
-
* HTTP POST /realm
|
|
344
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
345
|
-
*/
|
|
346
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
347
|
-
/**
|
|
348
|
-
* HTTP GET /realm
|
|
349
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
350
|
-
*/
|
|
351
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
352
|
-
/**
|
|
353
|
-
* HTTP GET /realm/accessible
|
|
354
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
355
|
-
*/
|
|
356
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
357
|
-
/**
|
|
358
|
-
* HTTP DELETE /realm/{name}
|
|
359
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
360
|
-
*/
|
|
361
|
-
delete(name: any, options?: O): RestResponse<void>;
|
|
362
|
-
/**
|
|
363
|
-
* HTTP GET /realm/{name}
|
|
364
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
365
|
-
*/
|
|
366
|
-
get(name: any, options?: O): RestResponse<Model.Realm>;
|
|
367
|
-
/**
|
|
368
|
-
* HTTP PUT /realm/{name}
|
|
369
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
370
|
-
*/
|
|
371
|
-
update(name: any, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
372
|
-
}
|
|
373
|
-
export declare class AlarmResourceClient<O> {
|
|
374
|
-
protected httpClient: HttpClient<O>;
|
|
375
|
-
constructor(httpClient: HttpClient<O>);
|
|
376
|
-
/**
|
|
377
|
-
* HTTP POST /alarm
|
|
378
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
379
|
-
*/
|
|
380
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
381
|
-
assetIds?: any[];
|
|
382
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
383
|
-
/**
|
|
384
|
-
* HTTP GET /alarm
|
|
385
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
386
|
-
*/
|
|
387
|
-
getAlarms(queryParams?: {
|
|
388
|
-
realm?: any;
|
|
389
|
-
status?: Model.AlarmStatus;
|
|
390
|
-
assetId?: any;
|
|
391
|
-
assigneeId?: any;
|
|
392
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
393
|
-
/**
|
|
394
|
-
* HTTP DELETE /alarm
|
|
395
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
396
|
-
*/
|
|
397
|
-
removeAlarms(ids: any[], options?: O): RestResponse<void>;
|
|
398
|
-
/**
|
|
399
|
-
* HTTP PUT /alarm/assets
|
|
400
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
401
|
-
*/
|
|
402
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
389
|
+
realm?: any;
|
|
390
|
+
userId?: any;
|
|
391
|
+
assetId?: any;
|
|
392
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
403
393
|
/**
|
|
404
|
-
* HTTP
|
|
405
|
-
* Java method: org.openremote.model.
|
|
394
|
+
* HTTP POST /asset/user/link/delete
|
|
395
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
406
396
|
*/
|
|
407
|
-
|
|
397
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
408
398
|
/**
|
|
409
|
-
* HTTP DELETE /
|
|
410
|
-
* Java method: org.openremote.model.
|
|
399
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
400
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
411
401
|
*/
|
|
412
|
-
|
|
402
|
+
deleteAllUserAssetLinks(realm: any, userId: any, options?: O): RestResponse<void>;
|
|
413
403
|
/**
|
|
414
|
-
* HTTP
|
|
415
|
-
* Java method: org.openremote.model.
|
|
404
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
405
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
416
406
|
*/
|
|
417
|
-
|
|
407
|
+
deleteUserAssetLink(realm: any, userId: any, assetId: any, options?: O): RestResponse<void>;
|
|
418
408
|
/**
|
|
419
|
-
* HTTP GET /
|
|
420
|
-
* Java method: org.openremote.model.
|
|
409
|
+
* HTTP GET /asset/{assetId}
|
|
410
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
421
411
|
*/
|
|
422
|
-
|
|
423
|
-
realm?: any;
|
|
424
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
425
|
-
}
|
|
426
|
-
export declare class SyslogResourceClient<O> {
|
|
427
|
-
protected httpClient: HttpClient<O>;
|
|
428
|
-
constructor(httpClient: HttpClient<O>);
|
|
412
|
+
get(assetId: any, options?: O): RestResponse<Model.Asset>;
|
|
429
413
|
/**
|
|
430
|
-
* HTTP
|
|
431
|
-
* Java method: org.openremote.model.
|
|
414
|
+
* HTTP PUT /asset/{assetId}
|
|
415
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
432
416
|
*/
|
|
433
|
-
|
|
417
|
+
update(assetId: any, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
434
418
|
/**
|
|
435
|
-
* HTTP PUT /
|
|
436
|
-
* Java method: org.openremote.model.
|
|
419
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
420
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
437
421
|
*/
|
|
438
|
-
|
|
422
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: any, attributeName: any, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
439
423
|
/**
|
|
440
|
-
* HTTP
|
|
441
|
-
* Java method: org.openremote.model.
|
|
424
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
425
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
442
426
|
*/
|
|
443
|
-
|
|
427
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: any, attributeName: any, timestamp: any, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
444
428
|
/**
|
|
445
|
-
* HTTP
|
|
446
|
-
* Java method: org.openremote.model.
|
|
429
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
430
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
447
431
|
*/
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
page?: any;
|
|
452
|
-
from?: any;
|
|
453
|
-
to?: any;
|
|
454
|
-
category?: Model.SyslogCategory[];
|
|
455
|
-
subCategory?: any[];
|
|
456
|
-
}, options?: O): RestResponse<any>;
|
|
432
|
+
updateParent(parentAssetId: any, queryParams?: {
|
|
433
|
+
assetIds?: any[];
|
|
434
|
+
}, options?: O): RestResponse<void>;
|
|
457
435
|
}
|
|
458
|
-
export declare class
|
|
436
|
+
export declare class StatusResourceClient<O> {
|
|
459
437
|
protected httpClient: HttpClient<O>;
|
|
460
438
|
constructor(httpClient: HttpClient<O>);
|
|
461
439
|
/**
|
|
462
|
-
* HTTP
|
|
463
|
-
* Java method: org.openremote.model.
|
|
464
|
-
*/
|
|
465
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
466
|
-
/**
|
|
467
|
-
* HTTP GET /provisioning
|
|
468
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
469
|
-
*/
|
|
470
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
471
|
-
/**
|
|
472
|
-
* HTTP DELETE /provisioning/{id}
|
|
473
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
440
|
+
* HTTP GET /health
|
|
441
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
474
442
|
*/
|
|
475
|
-
|
|
443
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
444
|
+
[index: string]: any;
|
|
445
|
+
}>;
|
|
476
446
|
/**
|
|
477
|
-
* HTTP
|
|
478
|
-
* Java method: org.openremote.model.
|
|
447
|
+
* HTTP GET /info
|
|
448
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
479
449
|
*/
|
|
480
|
-
|
|
450
|
+
getInfo(options?: O): RestResponse<{
|
|
451
|
+
[index: string]: any;
|
|
452
|
+
}>;
|
|
481
453
|
}
|
|
482
454
|
export declare class FlowResourceClient<O> {
|
|
483
455
|
protected httpClient: HttpClient<O>;
|
|
@@ -498,76 +470,83 @@ export declare class FlowResourceClient<O> {
|
|
|
498
470
|
*/
|
|
499
471
|
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
500
472
|
}
|
|
501
|
-
export declare class
|
|
473
|
+
export declare class ProvisioningResourceClient<O> {
|
|
502
474
|
protected httpClient: HttpClient<O>;
|
|
503
475
|
constructor(httpClient: HttpClient<O>);
|
|
504
476
|
/**
|
|
505
|
-
* HTTP
|
|
506
|
-
* Java method: org.openremote.model.
|
|
477
|
+
* HTTP POST /provisioning
|
|
478
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
507
479
|
*/
|
|
508
|
-
|
|
480
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
509
481
|
/**
|
|
510
|
-
* HTTP
|
|
511
|
-
* Java method: org.openremote.model.
|
|
482
|
+
* HTTP GET /provisioning
|
|
483
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
512
484
|
*/
|
|
513
|
-
|
|
485
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
514
486
|
/**
|
|
515
|
-
* HTTP
|
|
516
|
-
* Java method: org.openremote.model.
|
|
487
|
+
* HTTP DELETE /provisioning/{id}
|
|
488
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
517
489
|
*/
|
|
518
|
-
|
|
519
|
-
path?: any;
|
|
520
|
-
}, options?: O): RestResponse<any>;
|
|
490
|
+
deleteProvisioningConfig(id: any, options?: O): RestResponse<void>;
|
|
521
491
|
/**
|
|
522
|
-
* HTTP
|
|
523
|
-
* Java method: org.openremote.model.
|
|
492
|
+
* HTTP PUT /provisioning/{id}
|
|
493
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
524
494
|
*/
|
|
525
|
-
|
|
495
|
+
updateProvisioningConfig(id: any, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
526
496
|
}
|
|
527
|
-
export declare class
|
|
497
|
+
export declare class NotificationResourceClient<O> {
|
|
528
498
|
protected httpClient: HttpClient<O>;
|
|
529
499
|
constructor(httpClient: HttpClient<O>);
|
|
530
500
|
/**
|
|
531
|
-
* HTTP GET /
|
|
532
|
-
* Java method: org.openremote.model.
|
|
501
|
+
* HTTP GET /notification
|
|
502
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
533
503
|
*/
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
504
|
+
getNotifications(queryParams?: {
|
|
505
|
+
id?: any;
|
|
506
|
+
type?: any;
|
|
507
|
+
from?: any;
|
|
508
|
+
to?: any;
|
|
509
|
+
realmId?: any;
|
|
510
|
+
userId?: any;
|
|
511
|
+
assetId?: any;
|
|
512
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
538
513
|
/**
|
|
539
|
-
* HTTP
|
|
540
|
-
* Java method: org.openremote.model.
|
|
514
|
+
* HTTP DELETE /notification
|
|
515
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
541
516
|
*/
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
517
|
+
removeNotifications(queryParams?: {
|
|
518
|
+
id?: any;
|
|
519
|
+
type?: any;
|
|
520
|
+
from?: any;
|
|
521
|
+
to?: any;
|
|
522
|
+
realmId?: any;
|
|
523
|
+
userId?: any;
|
|
524
|
+
assetId?: any;
|
|
525
|
+
}, options?: O): RestResponse<void>;
|
|
545
526
|
/**
|
|
546
|
-
* HTTP
|
|
547
|
-
* Java method: org.openremote.model.
|
|
527
|
+
* HTTP POST /notification/alert
|
|
528
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
548
529
|
*/
|
|
549
|
-
|
|
550
|
-
parentId?: any;
|
|
551
|
-
parentType?: any;
|
|
552
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
530
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
553
531
|
/**
|
|
554
|
-
* HTTP
|
|
555
|
-
* Java method: org.openremote.model.
|
|
532
|
+
* HTTP DELETE /notification/{notificationId}
|
|
533
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
556
534
|
*/
|
|
557
|
-
|
|
558
|
-
parentId?: any;
|
|
559
|
-
}, options?: O): RestResponse<{
|
|
560
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
561
|
-
}>;
|
|
535
|
+
removeNotification(notificationId: any, options?: O): RestResponse<void>;
|
|
562
536
|
/**
|
|
563
|
-
* HTTP
|
|
564
|
-
* Java method: org.openremote.model.
|
|
537
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
538
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
565
539
|
*/
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
}, options?: O): RestResponse<
|
|
569
|
-
|
|
570
|
-
|
|
540
|
+
notificationAcknowledged(notificationId: any, acknowledgement: any, queryParams?: {
|
|
541
|
+
targetId?: any;
|
|
542
|
+
}, options?: O): RestResponse<void>;
|
|
543
|
+
/**
|
|
544
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
545
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
546
|
+
*/
|
|
547
|
+
notificationDelivered(notificationId: any, queryParams?: {
|
|
548
|
+
targetId?: any;
|
|
549
|
+
}, options?: O): RestResponse<void>;
|
|
571
550
|
}
|
|
572
551
|
export declare class UserResourceClient<O> {
|
|
573
552
|
protected httpClient: HttpClient<O>;
|
|
@@ -649,121 +628,49 @@ export declare class UserResourceClient<O> {
|
|
|
649
628
|
updateUserRoles(realm: any, userId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
650
629
|
/**
|
|
651
630
|
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
652
|
-
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
653
|
-
*/
|
|
654
|
-
getUserClientRoles(realm: any, userId: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
655
|
-
/**
|
|
656
|
-
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
657
|
-
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
658
|
-
*/
|
|
659
|
-
updateUserClientRoles(realm: any, userId: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
660
|
-
/**
|
|
661
|
-
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
662
|
-
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
663
|
-
*/
|
|
664
|
-
getUserSessions(realm: any, userId: any, options?: O): RestResponse<Model.UserSession[]>;
|
|
665
|
-
/**
|
|
666
|
-
* HTTP POST /user/{realm}/users
|
|
667
|
-
* Java method: org.openremote.model.security.UserResource.create
|
|
668
|
-
*/
|
|
669
|
-
create(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
670
|
-
/**
|
|
671
|
-
* HTTP PUT /user/{realm}/users
|
|
672
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
673
|
-
*/
|
|
674
|
-
update(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
675
|
-
/**
|
|
676
|
-
* HTTP DELETE /user/{realm}/users/{userId}
|
|
677
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
678
|
-
*/
|
|
679
|
-
delete(realm: any, userId: any, options?: O): RestResponse<void>;
|
|
680
|
-
/**
|
|
681
|
-
* HTTP GET /user/{realm}/{clientId}/roles
|
|
682
|
-
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
683
|
-
*/
|
|
684
|
-
getClientRoles(realm: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
685
|
-
/**
|
|
686
|
-
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
687
|
-
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
688
|
-
*/
|
|
689
|
-
updateClientRoles(realm: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
690
|
-
/**
|
|
691
|
-
* HTTP GET /user/{realm}/{userId}
|
|
692
|
-
* Java method: org.openremote.model.security.UserResource.get
|
|
693
|
-
*/
|
|
694
|
-
get(realm: any, userId: any, options?: O): RestResponse<Model.User>;
|
|
695
|
-
}
|
|
696
|
-
export declare class ConsoleResourceClient<O> {
|
|
697
|
-
protected httpClient: HttpClient<O>;
|
|
698
|
-
constructor(httpClient: HttpClient<O>);
|
|
699
|
-
/**
|
|
700
|
-
* HTTP POST /console/register
|
|
701
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
702
|
-
*/
|
|
703
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
704
|
-
}
|
|
705
|
-
export declare class AppResourceClient<O> {
|
|
706
|
-
protected httpClient: HttpClient<O>;
|
|
707
|
-
constructor(httpClient: HttpClient<O>);
|
|
708
|
-
/**
|
|
709
|
-
* HTTP GET /apps
|
|
710
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
631
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
711
632
|
*/
|
|
712
|
-
|
|
633
|
+
getUserClientRoles(realm: any, userId: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
713
634
|
/**
|
|
714
|
-
* HTTP
|
|
715
|
-
* Java method: org.openremote.model.
|
|
635
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
636
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
716
637
|
*/
|
|
717
|
-
|
|
638
|
+
updateUserClientRoles(realm: any, userId: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
718
639
|
/**
|
|
719
|
-
* HTTP GET /
|
|
720
|
-
* Java method: org.openremote.model.
|
|
640
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
641
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
721
642
|
*/
|
|
722
|
-
|
|
723
|
-
}
|
|
724
|
-
export declare class MapResourceClient<O> {
|
|
725
|
-
protected httpClient: HttpClient<O>;
|
|
726
|
-
constructor(httpClient: HttpClient<O>);
|
|
643
|
+
getUserSessions(realm: any, userId: any, options?: O): RestResponse<Model.UserSession[]>;
|
|
727
644
|
/**
|
|
728
|
-
* HTTP
|
|
729
|
-
* Java method: org.openremote.model.
|
|
645
|
+
* HTTP POST /user/{realm}/users
|
|
646
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
730
647
|
*/
|
|
731
|
-
|
|
732
|
-
[id: string]: any;
|
|
733
|
-
}>;
|
|
648
|
+
create(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
734
649
|
/**
|
|
735
|
-
* HTTP PUT /
|
|
736
|
-
* Java method: org.openremote.model.
|
|
650
|
+
* HTTP PUT /user/{realm}/users
|
|
651
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
737
652
|
*/
|
|
738
|
-
|
|
739
|
-
[index: string]: Model.MapRealmConfig;
|
|
740
|
-
}, options?: O): RestResponse<any>;
|
|
653
|
+
update(realm: any, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
741
654
|
/**
|
|
742
|
-
* HTTP
|
|
743
|
-
* Java method: org.openremote.model.
|
|
655
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
656
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
744
657
|
*/
|
|
745
|
-
|
|
746
|
-
[id: string]: any;
|
|
747
|
-
}>;
|
|
658
|
+
delete(realm: any, userId: any, options?: O): RestResponse<void>;
|
|
748
659
|
/**
|
|
749
|
-
* HTTP GET /
|
|
750
|
-
* Java method: org.openremote.model.
|
|
660
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
661
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
751
662
|
*/
|
|
752
|
-
|
|
753
|
-
}
|
|
754
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
755
|
-
protected httpClient: HttpClient<O>;
|
|
756
|
-
constructor(httpClient: HttpClient<O>);
|
|
663
|
+
getClientRoles(realm: any, clientId: any, options?: O): RestResponse<Model.Role[]>;
|
|
757
664
|
/**
|
|
758
|
-
* HTTP
|
|
759
|
-
* Java method: org.openremote.model.
|
|
665
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
666
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
760
667
|
*/
|
|
761
|
-
|
|
668
|
+
updateClientRoles(realm: any, clientId: any, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
762
669
|
/**
|
|
763
|
-
* HTTP
|
|
764
|
-
* Java method: org.openremote.model.
|
|
670
|
+
* HTTP GET /user/{realm}/{userId}
|
|
671
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
765
672
|
*/
|
|
766
|
-
|
|
673
|
+
get(realm: any, userId: any, options?: O): RestResponse<Model.User>;
|
|
767
674
|
}
|
|
768
675
|
export declare class RulesResourceClient<O> {
|
|
769
676
|
protected httpClient: HttpClient<O>;
|
|
@@ -873,51 +780,144 @@ export declare class RulesResourceClient<O> {
|
|
|
873
780
|
*/
|
|
874
781
|
updateGlobalRuleset(id: any, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
875
782
|
}
|
|
783
|
+
export declare class AlarmResourceClient<O> {
|
|
784
|
+
protected httpClient: HttpClient<O>;
|
|
785
|
+
constructor(httpClient: HttpClient<O>);
|
|
786
|
+
/**
|
|
787
|
+
* HTTP POST /alarm
|
|
788
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
789
|
+
*/
|
|
790
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
791
|
+
assetIds?: any[];
|
|
792
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
793
|
+
/**
|
|
794
|
+
* HTTP GET /alarm
|
|
795
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
796
|
+
*/
|
|
797
|
+
getAlarms(queryParams?: {
|
|
798
|
+
realm?: any;
|
|
799
|
+
status?: Model.AlarmStatus;
|
|
800
|
+
assetId?: any;
|
|
801
|
+
assigneeId?: any;
|
|
802
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
803
|
+
/**
|
|
804
|
+
* HTTP DELETE /alarm
|
|
805
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
806
|
+
*/
|
|
807
|
+
removeAlarms(ids: any[], options?: O): RestResponse<void>;
|
|
808
|
+
/**
|
|
809
|
+
* HTTP PUT /alarm/assets
|
|
810
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
811
|
+
*/
|
|
812
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP GET /alarm/{alarmId}
|
|
815
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
816
|
+
*/
|
|
817
|
+
getAlarm(alarmId: any, options?: O): RestResponse<Model.SentAlarm>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
820
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
821
|
+
*/
|
|
822
|
+
removeAlarm(alarmId: any, options?: O): RestResponse<void>;
|
|
823
|
+
/**
|
|
824
|
+
* HTTP PUT /alarm/{alarmId}
|
|
825
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
826
|
+
*/
|
|
827
|
+
updateAlarm(alarmId: any, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
828
|
+
/**
|
|
829
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
830
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
831
|
+
*/
|
|
832
|
+
getAssetLinks(alarmId: any, queryParams?: {
|
|
833
|
+
realm?: any;
|
|
834
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
835
|
+
}
|
|
836
|
+
export declare class ConfigurationResourceClient<O> {
|
|
837
|
+
protected httpClient: HttpClient<O>;
|
|
838
|
+
constructor(httpClient: HttpClient<O>);
|
|
839
|
+
/**
|
|
840
|
+
* HTTP GET /configuration/manager
|
|
841
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
842
|
+
*/
|
|
843
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
844
|
+
/**
|
|
845
|
+
* HTTP PUT /configuration/manager
|
|
846
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
847
|
+
*/
|
|
848
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
849
|
+
/**
|
|
850
|
+
* HTTP POST /configuration/manager/file
|
|
851
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
852
|
+
*/
|
|
853
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
854
|
+
path?: any;
|
|
855
|
+
}, options?: O): RestResponse<any>;
|
|
856
|
+
/**
|
|
857
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
858
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
859
|
+
*/
|
|
860
|
+
getManagerConfigImage(filename: any, options?: O): RestResponse<any>;
|
|
861
|
+
}
|
|
862
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
863
|
+
protected httpClient: HttpClient<O>;
|
|
864
|
+
constructor(httpClient: HttpClient<O>);
|
|
865
|
+
/**
|
|
866
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
867
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
868
|
+
*/
|
|
869
|
+
getPredictedDatapoints(assetId: any, attributeName: any, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
870
|
+
/**
|
|
871
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
872
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
873
|
+
*/
|
|
874
|
+
writePredictedDatapoints(assetId: any, attributeName: any, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
875
|
+
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected
|
|
878
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
879
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
879
880
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
880
|
-
protected
|
|
881
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
882
|
+
protected _appResource: AxiosAppResourceClient;
|
|
883
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
884
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
881
885
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
882
|
-
protected
|
|
883
|
-
protected
|
|
886
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
887
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
888
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
884
889
|
protected _assetResource: AxiosAssetResourceClient;
|
|
885
|
-
protected
|
|
886
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
887
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
888
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
889
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
890
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
890
891
|
protected _flowResource: AxiosFlowResourceClient;
|
|
891
|
-
protected
|
|
892
|
-
protected
|
|
892
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
893
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
893
894
|
protected _userResource: AxiosUserResourceClient;
|
|
894
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
895
|
-
protected _appResource: AxiosAppResourceClient;
|
|
896
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
897
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
898
895
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
896
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
897
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
898
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get
|
|
900
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
901
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
901
902
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
902
|
-
get
|
|
903
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
904
|
+
get AppResource(): AxiosAppResourceClient;
|
|
905
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
906
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
903
907
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
904
|
-
get
|
|
905
|
-
get
|
|
908
|
+
get MapResource(): AxiosMapResourceClient;
|
|
909
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
910
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
906
911
|
get AssetResource(): AxiosAssetResourceClient;
|
|
907
|
-
get
|
|
908
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
909
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
910
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
911
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
912
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
912
913
|
get FlowResource(): AxiosFlowResourceClient;
|
|
913
|
-
get
|
|
914
|
-
get
|
|
914
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
915
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
915
916
|
get UserResource(): AxiosUserResourceClient;
|
|
916
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
917
|
-
get AppResource(): AxiosAppResourceClient;
|
|
918
|
-
get MapResource(): AxiosMapResourceClient;
|
|
919
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
920
917
|
get RulesResource(): AxiosRulesResourceClient;
|
|
918
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
919
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
920
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class
|
|
928
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
929
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
|
+
}
|
|
931
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
929
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
933
|
}
|
|
931
934
|
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
932
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
936
|
}
|
|
934
|
-
export declare class
|
|
937
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
935
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
939
|
}
|
|
937
|
-
export declare class
|
|
940
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
938
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
942
|
}
|
|
940
|
-
export declare class
|
|
943
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
941
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
945
|
}
|
|
943
|
-
export declare class
|
|
946
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
944
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
948
|
}
|
|
946
|
-
export declare class
|
|
949
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
947
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
951
|
}
|
|
949
|
-
export declare class
|
|
952
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
950
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
954
|
}
|
|
952
|
-
export declare class
|
|
955
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
953
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
957
|
}
|
|
955
|
-
export declare class
|
|
958
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
956
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
960
|
}
|
|
958
|
-
export declare class
|
|
961
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
959
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
963
|
}
|
|
961
|
-
export declare class
|
|
964
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
962
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
966
|
}
|
|
964
967
|
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
965
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
969
|
}
|
|
967
|
-
export declare class
|
|
970
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
968
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
972
|
}
|
|
970
|
-
export declare class
|
|
973
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
971
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
975
|
}
|
|
973
976
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
974
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
978
|
}
|
|
976
|
-
export declare class
|
|
979
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
977
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
981
|
}
|
|
979
|
-
export declare class
|
|
982
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
980
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
984
|
}
|
|
982
|
-
export declare class
|
|
985
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
983
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
987
|
}
|
|
985
988
|
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
986
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
990
|
}
|
|
988
|
-
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
989
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
|
-
}
|