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