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