@openremote/rest 1.9.0-snapshot.20250904114348 → 1.9.0-snapshot.20250905090529
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 +456 -456
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,94 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class NotificationResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP GET /notification
|
|
17
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
18
|
-
*/
|
|
19
|
-
getNotifications(queryParams?: {
|
|
20
|
-
id?: number;
|
|
21
|
-
type?: string;
|
|
22
|
-
from?: number;
|
|
23
|
-
to?: number;
|
|
24
|
-
realmId?: string;
|
|
25
|
-
userId?: string;
|
|
26
|
-
assetId?: string;
|
|
27
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
28
|
-
/**
|
|
29
|
-
* HTTP DELETE /notification
|
|
30
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
31
|
-
*/
|
|
32
|
-
removeNotifications(queryParams?: {
|
|
33
|
-
id?: number;
|
|
34
|
-
type?: string;
|
|
35
|
-
from?: number;
|
|
36
|
-
to?: number;
|
|
37
|
-
realmId?: string;
|
|
38
|
-
userId?: string;
|
|
39
|
-
assetId?: string;
|
|
40
|
-
}, options?: O): RestResponse<void>;
|
|
41
|
-
/**
|
|
42
|
-
* HTTP POST /notification/alert
|
|
43
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
44
|
-
*/
|
|
45
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
46
|
-
/**
|
|
47
|
-
* HTTP DELETE /notification/{notificationId}
|
|
48
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
49
|
-
*/
|
|
50
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
51
|
-
/**
|
|
52
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
53
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
54
|
-
*/
|
|
55
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
56
|
-
targetId?: string;
|
|
57
|
-
}, options?: O): RestResponse<void>;
|
|
58
|
-
/**
|
|
59
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
60
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
61
|
-
*/
|
|
62
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
63
|
-
targetId?: string;
|
|
64
|
-
}, options?: O): RestResponse<void>;
|
|
65
|
-
}
|
|
66
|
-
export declare class DashboardResourceClient<O> {
|
|
67
|
-
protected httpClient: HttpClient<O>;
|
|
68
|
-
constructor(httpClient: HttpClient<O>);
|
|
69
|
-
/**
|
|
70
|
-
* HTTP POST /dashboard
|
|
71
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
72
|
-
*/
|
|
73
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
74
|
-
/**
|
|
75
|
-
* HTTP PUT /dashboard
|
|
76
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
77
|
-
*/
|
|
78
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
79
|
-
/**
|
|
80
|
-
* HTTP GET /dashboard/all/{realm}
|
|
81
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
82
|
-
*/
|
|
83
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
84
|
-
/**
|
|
85
|
-
* HTTP POST /dashboard/query
|
|
86
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
87
|
-
*/
|
|
88
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
89
|
-
/**
|
|
90
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
91
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
92
|
-
*/
|
|
93
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
94
|
-
/**
|
|
95
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
96
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
97
|
-
*/
|
|
98
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
99
|
-
}
|
|
100
12
|
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
101
13
|
protected httpClient: HttpClient<O>;
|
|
102
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -111,42 +23,6 @@ export declare class AssetPredictedDatapointResourceClient<O> {
|
|
|
111
23
|
*/
|
|
112
24
|
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
113
25
|
}
|
|
114
|
-
export declare class GatewayClientResourceClient<O> {
|
|
115
|
-
protected httpClient: HttpClient<O>;
|
|
116
|
-
constructor(httpClient: HttpClient<O>);
|
|
117
|
-
/**
|
|
118
|
-
* HTTP DELETE /gateway/connection
|
|
119
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
120
|
-
*/
|
|
121
|
-
deleteConnections(queryParams?: {
|
|
122
|
-
realm?: string[];
|
|
123
|
-
}, options?: O): RestResponse<void>;
|
|
124
|
-
/**
|
|
125
|
-
* HTTP GET /gateway/connection
|
|
126
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
127
|
-
*/
|
|
128
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
129
|
-
/**
|
|
130
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
131
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
132
|
-
*/
|
|
133
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
134
|
-
/**
|
|
135
|
-
* HTTP GET /gateway/connection/{realm}
|
|
136
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
137
|
-
*/
|
|
138
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
139
|
-
/**
|
|
140
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
141
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
142
|
-
*/
|
|
143
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
144
|
-
/**
|
|
145
|
-
* HTTP GET /gateway/status/{realm}
|
|
146
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
147
|
-
*/
|
|
148
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
149
|
-
}
|
|
150
26
|
export declare class AssetResourceClient<O> {
|
|
151
27
|
protected httpClient: HttpClient<O>;
|
|
152
28
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -251,6 +127,51 @@ export declare class AssetResourceClient<O> {
|
|
|
251
127
|
assetIds?: string[];
|
|
252
128
|
}, options?: O): RestResponse<void>;
|
|
253
129
|
}
|
|
130
|
+
export declare class FlowResourceClient<O> {
|
|
131
|
+
protected httpClient: HttpClient<O>;
|
|
132
|
+
constructor(httpClient: HttpClient<O>);
|
|
133
|
+
/**
|
|
134
|
+
* HTTP GET /flow
|
|
135
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
136
|
+
*/
|
|
137
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
138
|
+
/**
|
|
139
|
+
* HTTP GET /flow/{name}
|
|
140
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
141
|
+
*/
|
|
142
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
143
|
+
/**
|
|
144
|
+
* HTTP GET /flow/{type}
|
|
145
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
146
|
+
*/
|
|
147
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
148
|
+
}
|
|
149
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
150
|
+
protected httpClient: HttpClient<O>;
|
|
151
|
+
constructor(httpClient: HttpClient<O>);
|
|
152
|
+
/**
|
|
153
|
+
* HTTP GET /asset/datapoint/export
|
|
154
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
155
|
+
*/
|
|
156
|
+
getDatapointExport(queryParams?: {
|
|
157
|
+
attributeRefs?: string;
|
|
158
|
+
fromTimestamp?: number;
|
|
159
|
+
toTimestamp?: number;
|
|
160
|
+
}, options?: O): RestResponse<any>;
|
|
161
|
+
/**
|
|
162
|
+
* HTTP GET /asset/datapoint/periods
|
|
163
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
164
|
+
*/
|
|
165
|
+
getDatapointPeriod(queryParams?: {
|
|
166
|
+
assetId?: string;
|
|
167
|
+
attributeName?: string;
|
|
168
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
169
|
+
/**
|
|
170
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
171
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
172
|
+
*/
|
|
173
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
174
|
+
}
|
|
254
175
|
export declare class ProvisioningResourceClient<O> {
|
|
255
176
|
protected httpClient: HttpClient<O>;
|
|
256
177
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -275,90 +196,195 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
275
196
|
*/
|
|
276
197
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
277
198
|
}
|
|
278
|
-
export declare class
|
|
199
|
+
export declare class ConsoleResourceClient<O> {
|
|
279
200
|
protected httpClient: HttpClient<O>;
|
|
280
201
|
constructor(httpClient: HttpClient<O>);
|
|
281
202
|
/**
|
|
282
|
-
* HTTP
|
|
283
|
-
* Java method: org.openremote.model.
|
|
284
|
-
*/
|
|
285
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
286
|
-
/**
|
|
287
|
-
* HTTP PUT /syslog/config
|
|
288
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
289
|
-
*/
|
|
290
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
291
|
-
/**
|
|
292
|
-
* HTTP DELETE /syslog/event
|
|
293
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
294
|
-
*/
|
|
295
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
296
|
-
/**
|
|
297
|
-
* HTTP GET /syslog/event
|
|
298
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
203
|
+
* HTTP POST /console/register
|
|
204
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
299
205
|
*/
|
|
300
|
-
|
|
301
|
-
level?: Model.SyslogLevel;
|
|
302
|
-
per_page?: number;
|
|
303
|
-
page?: number;
|
|
304
|
-
from?: number;
|
|
305
|
-
to?: number;
|
|
306
|
-
category?: Model.SyslogCategory[];
|
|
307
|
-
subCategory?: string[];
|
|
308
|
-
}, options?: O): RestResponse<any>;
|
|
206
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
309
207
|
}
|
|
310
|
-
export declare class
|
|
208
|
+
export declare class RulesResourceClient<O> {
|
|
311
209
|
protected httpClient: HttpClient<O>;
|
|
312
210
|
constructor(httpClient: HttpClient<O>);
|
|
313
211
|
/**
|
|
314
|
-
* HTTP POST /
|
|
315
|
-
* Java method: org.openremote.model.
|
|
212
|
+
* HTTP POST /rules
|
|
213
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
316
214
|
*/
|
|
317
|
-
|
|
215
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
318
216
|
/**
|
|
319
|
-
* HTTP GET /
|
|
320
|
-
* Java method: org.openremote.model.
|
|
217
|
+
* HTTP GET /rules
|
|
218
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
321
219
|
*/
|
|
322
|
-
|
|
220
|
+
getGlobalRulesets(queryParams?: {
|
|
221
|
+
language?: Model.RulesetLang[];
|
|
222
|
+
fullyPopulate?: boolean;
|
|
223
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
323
224
|
/**
|
|
324
|
-
* HTTP
|
|
325
|
-
* Java method: org.openremote.model.
|
|
225
|
+
* HTTP POST /rules/asset
|
|
226
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
326
227
|
*/
|
|
327
|
-
|
|
228
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
328
229
|
/**
|
|
329
|
-
* HTTP
|
|
330
|
-
* Java method: org.openremote.model.
|
|
230
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
231
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
331
232
|
*/
|
|
332
|
-
|
|
233
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
234
|
+
language?: Model.RulesetLang[];
|
|
235
|
+
fullyPopulate?: boolean;
|
|
236
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
333
237
|
/**
|
|
334
|
-
* HTTP
|
|
335
|
-
* Java method: org.openremote.model.
|
|
238
|
+
* HTTP DELETE /rules/asset/{id}
|
|
239
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
336
240
|
*/
|
|
337
|
-
|
|
241
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
338
242
|
/**
|
|
339
|
-
* HTTP
|
|
340
|
-
* Java method: org.openremote.model.
|
|
243
|
+
* HTTP GET /rules/asset/{id}
|
|
244
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
341
245
|
*/
|
|
342
|
-
|
|
343
|
-
}
|
|
344
|
-
export declare class FlowResourceClient<O> {
|
|
345
|
-
protected httpClient: HttpClient<O>;
|
|
346
|
-
constructor(httpClient: HttpClient<O>);
|
|
246
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
347
247
|
/**
|
|
348
|
-
* HTTP
|
|
349
|
-
* Java method: org.openremote.model.rules.
|
|
248
|
+
* HTTP PUT /rules/asset/{id}
|
|
249
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
350
250
|
*/
|
|
351
|
-
|
|
251
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
352
252
|
/**
|
|
353
|
-
* HTTP GET /
|
|
354
|
-
* Java method: org.openremote.model.rules.
|
|
253
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
254
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
355
255
|
*/
|
|
356
|
-
|
|
256
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
357
257
|
/**
|
|
358
|
-
* HTTP GET /
|
|
359
|
-
* Java method: org.openremote.model.rules.
|
|
258
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
259
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
360
260
|
*/
|
|
361
|
-
|
|
261
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
262
|
+
/**
|
|
263
|
+
* HTTP GET /rules/info/global
|
|
264
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
265
|
+
*/
|
|
266
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
267
|
+
/**
|
|
268
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
269
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
270
|
+
*/
|
|
271
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
272
|
+
/**
|
|
273
|
+
* HTTP POST /rules/realm
|
|
274
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
275
|
+
*/
|
|
276
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
277
|
+
/**
|
|
278
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
279
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
280
|
+
*/
|
|
281
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
282
|
+
language?: Model.RulesetLang[];
|
|
283
|
+
fullyPopulate?: boolean;
|
|
284
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
285
|
+
/**
|
|
286
|
+
* HTTP DELETE /rules/realm/{id}
|
|
287
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
288
|
+
*/
|
|
289
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
290
|
+
/**
|
|
291
|
+
* HTTP GET /rules/realm/{id}
|
|
292
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
293
|
+
*/
|
|
294
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
295
|
+
/**
|
|
296
|
+
* HTTP PUT /rules/realm/{id}
|
|
297
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
298
|
+
*/
|
|
299
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
300
|
+
/**
|
|
301
|
+
* HTTP DELETE /rules/{id}
|
|
302
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
303
|
+
*/
|
|
304
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
305
|
+
/**
|
|
306
|
+
* HTTP GET /rules/{id}
|
|
307
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
308
|
+
*/
|
|
309
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
310
|
+
/**
|
|
311
|
+
* HTTP PUT /rules/{id}
|
|
312
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
313
|
+
*/
|
|
314
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
315
|
+
}
|
|
316
|
+
export declare class NotificationResourceClient<O> {
|
|
317
|
+
protected httpClient: HttpClient<O>;
|
|
318
|
+
constructor(httpClient: HttpClient<O>);
|
|
319
|
+
/**
|
|
320
|
+
* HTTP GET /notification
|
|
321
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
322
|
+
*/
|
|
323
|
+
getNotifications(queryParams?: {
|
|
324
|
+
id?: number;
|
|
325
|
+
type?: string;
|
|
326
|
+
from?: number;
|
|
327
|
+
to?: number;
|
|
328
|
+
realmId?: string;
|
|
329
|
+
userId?: string;
|
|
330
|
+
assetId?: string;
|
|
331
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
332
|
+
/**
|
|
333
|
+
* HTTP DELETE /notification
|
|
334
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
335
|
+
*/
|
|
336
|
+
removeNotifications(queryParams?: {
|
|
337
|
+
id?: number;
|
|
338
|
+
type?: string;
|
|
339
|
+
from?: number;
|
|
340
|
+
to?: number;
|
|
341
|
+
realmId?: string;
|
|
342
|
+
userId?: string;
|
|
343
|
+
assetId?: string;
|
|
344
|
+
}, options?: O): RestResponse<void>;
|
|
345
|
+
/**
|
|
346
|
+
* HTTP POST /notification/alert
|
|
347
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
348
|
+
*/
|
|
349
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
350
|
+
/**
|
|
351
|
+
* HTTP DELETE /notification/{notificationId}
|
|
352
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
353
|
+
*/
|
|
354
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
355
|
+
/**
|
|
356
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
357
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
358
|
+
*/
|
|
359
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
360
|
+
targetId?: string;
|
|
361
|
+
}, options?: O): RestResponse<void>;
|
|
362
|
+
/**
|
|
363
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
364
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
365
|
+
*/
|
|
366
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
367
|
+
targetId?: string;
|
|
368
|
+
}, options?: O): RestResponse<void>;
|
|
369
|
+
}
|
|
370
|
+
export declare class AppResourceClient<O> {
|
|
371
|
+
protected httpClient: HttpClient<O>;
|
|
372
|
+
constructor(httpClient: HttpClient<O>);
|
|
373
|
+
/**
|
|
374
|
+
* HTTP GET /apps
|
|
375
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
376
|
+
*/
|
|
377
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
378
|
+
/**
|
|
379
|
+
* HTTP GET /apps/consoleConfig
|
|
380
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
381
|
+
*/
|
|
382
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
383
|
+
/**
|
|
384
|
+
* HTTP GET /apps/info
|
|
385
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
386
|
+
*/
|
|
387
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
362
388
|
}
|
|
363
389
|
export declare class AgentResourceClient<O> {
|
|
364
390
|
protected httpClient: HttpClient<O>;
|
|
@@ -386,50 +412,108 @@ export declare class AgentResourceClient<O> {
|
|
|
386
412
|
realm?: string;
|
|
387
413
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
388
414
|
}
|
|
389
|
-
export declare class
|
|
415
|
+
export declare class StatusResourceClient<O> {
|
|
390
416
|
protected httpClient: HttpClient<O>;
|
|
391
417
|
constructor(httpClient: HttpClient<O>);
|
|
392
418
|
/**
|
|
393
|
-
* HTTP GET /
|
|
394
|
-
* Java method: org.openremote.model.
|
|
419
|
+
* HTTP GET /health
|
|
420
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
395
421
|
*/
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
422
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
423
|
+
[index: string]: any;
|
|
424
|
+
}>;
|
|
400
425
|
/**
|
|
401
|
-
* HTTP GET /
|
|
402
|
-
* Java method: org.openremote.model.
|
|
426
|
+
* HTTP GET /info
|
|
427
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
403
428
|
*/
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
}
|
|
429
|
+
getInfo(options?: O): RestResponse<{
|
|
430
|
+
[index: string]: any;
|
|
431
|
+
}>;
|
|
432
|
+
}
|
|
433
|
+
export declare class AlarmResourceClient<O> {
|
|
434
|
+
protected httpClient: HttpClient<O>;
|
|
435
|
+
constructor(httpClient: HttpClient<O>);
|
|
407
436
|
/**
|
|
408
|
-
* HTTP
|
|
409
|
-
* Java method: org.openremote.model.
|
|
437
|
+
* HTTP POST /alarm
|
|
438
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
410
439
|
*/
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
440
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
441
|
+
assetIds?: string[];
|
|
442
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
415
443
|
/**
|
|
416
|
-
* HTTP GET /
|
|
417
|
-
* Java method: org.openremote.model.
|
|
444
|
+
* HTTP GET /alarm
|
|
445
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
418
446
|
*/
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
447
|
+
getAlarms(queryParams?: {
|
|
448
|
+
realm?: string;
|
|
449
|
+
status?: Model.AlarmStatus;
|
|
450
|
+
assetId?: string;
|
|
451
|
+
assigneeId?: string;
|
|
452
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
424
453
|
/**
|
|
425
|
-
* HTTP
|
|
426
|
-
* Java method: org.openremote.model.
|
|
454
|
+
* HTTP DELETE /alarm
|
|
455
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
427
456
|
*/
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
457
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
458
|
+
/**
|
|
459
|
+
* HTTP PUT /alarm/assets
|
|
460
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
461
|
+
*/
|
|
462
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
463
|
+
/**
|
|
464
|
+
* HTTP GET /alarm/{alarmId}
|
|
465
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
466
|
+
*/
|
|
467
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
468
|
+
/**
|
|
469
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
470
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
471
|
+
*/
|
|
472
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
473
|
+
/**
|
|
474
|
+
* HTTP PUT /alarm/{alarmId}
|
|
475
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
476
|
+
*/
|
|
477
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
478
|
+
/**
|
|
479
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
480
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
481
|
+
*/
|
|
482
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
483
|
+
realm?: string;
|
|
484
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
485
|
+
}
|
|
486
|
+
export declare class SyslogResourceClient<O> {
|
|
487
|
+
protected httpClient: HttpClient<O>;
|
|
488
|
+
constructor(httpClient: HttpClient<O>);
|
|
489
|
+
/**
|
|
490
|
+
* HTTP GET /syslog/config
|
|
491
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
492
|
+
*/
|
|
493
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
494
|
+
/**
|
|
495
|
+
* HTTP PUT /syslog/config
|
|
496
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
497
|
+
*/
|
|
498
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
499
|
+
/**
|
|
500
|
+
* HTTP DELETE /syslog/event
|
|
501
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
502
|
+
*/
|
|
503
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
504
|
+
/**
|
|
505
|
+
* HTTP GET /syslog/event
|
|
506
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
507
|
+
*/
|
|
508
|
+
getEvents(queryParams?: {
|
|
509
|
+
level?: Model.SyslogLevel;
|
|
510
|
+
per_page?: number;
|
|
511
|
+
page?: number;
|
|
512
|
+
from?: number;
|
|
513
|
+
to?: number;
|
|
514
|
+
category?: Model.SyslogCategory[];
|
|
515
|
+
subCategory?: string[];
|
|
516
|
+
}, options?: O): RestResponse<any>;
|
|
433
517
|
}
|
|
434
518
|
export declare class MapResourceClient<O> {
|
|
435
519
|
protected httpClient: HttpClient<O>;
|
|
@@ -484,161 +568,102 @@ export declare class MapResourceClient<O> {
|
|
|
484
568
|
[id: string]: unknown;
|
|
485
569
|
}>;
|
|
486
570
|
}
|
|
487
|
-
export declare class
|
|
571
|
+
export declare class RealmResourceClient<O> {
|
|
488
572
|
protected httpClient: HttpClient<O>;
|
|
489
573
|
constructor(httpClient: HttpClient<O>);
|
|
490
574
|
/**
|
|
491
|
-
* HTTP POST /
|
|
492
|
-
* Java method: org.openremote.model.
|
|
493
|
-
*/
|
|
494
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
495
|
-
/**
|
|
496
|
-
* HTTP GET /rules
|
|
497
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
498
|
-
*/
|
|
499
|
-
getGlobalRulesets(queryParams?: {
|
|
500
|
-
language?: Model.RulesetLang[];
|
|
501
|
-
fullyPopulate?: boolean;
|
|
502
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
503
|
-
/**
|
|
504
|
-
* HTTP POST /rules/asset
|
|
505
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
506
|
-
*/
|
|
507
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
508
|
-
/**
|
|
509
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
510
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
511
|
-
*/
|
|
512
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
513
|
-
language?: Model.RulesetLang[];
|
|
514
|
-
fullyPopulate?: boolean;
|
|
515
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
516
|
-
/**
|
|
517
|
-
* HTTP DELETE /rules/asset/{id}
|
|
518
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
519
|
-
*/
|
|
520
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
521
|
-
/**
|
|
522
|
-
* HTTP GET /rules/asset/{id}
|
|
523
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
524
|
-
*/
|
|
525
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
526
|
-
/**
|
|
527
|
-
* HTTP PUT /rules/asset/{id}
|
|
528
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
529
|
-
*/
|
|
530
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
531
|
-
/**
|
|
532
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
533
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
534
|
-
*/
|
|
535
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
536
|
-
/**
|
|
537
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
538
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
575
|
+
* HTTP POST /realm
|
|
576
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
539
577
|
*/
|
|
540
|
-
|
|
578
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
541
579
|
/**
|
|
542
|
-
* HTTP GET /
|
|
543
|
-
* Java method: org.openremote.model.
|
|
580
|
+
* HTTP GET /realm
|
|
581
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
544
582
|
*/
|
|
545
|
-
|
|
583
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
546
584
|
/**
|
|
547
|
-
* HTTP GET /
|
|
548
|
-
* Java method: org.openremote.model.
|
|
585
|
+
* HTTP GET /realm/accessible
|
|
586
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
549
587
|
*/
|
|
550
|
-
|
|
588
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
551
589
|
/**
|
|
552
|
-
* HTTP
|
|
553
|
-
* Java method: org.openremote.model.
|
|
590
|
+
* HTTP DELETE /realm/{name}
|
|
591
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
554
592
|
*/
|
|
555
|
-
|
|
593
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
556
594
|
/**
|
|
557
|
-
* HTTP GET /
|
|
558
|
-
* Java method: org.openremote.model.
|
|
595
|
+
* HTTP GET /realm/{name}
|
|
596
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
559
597
|
*/
|
|
560
|
-
|
|
561
|
-
language?: Model.RulesetLang[];
|
|
562
|
-
fullyPopulate?: boolean;
|
|
563
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
598
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
564
599
|
/**
|
|
565
|
-
* HTTP
|
|
566
|
-
* Java method: org.openremote.model.
|
|
600
|
+
* HTTP PUT /realm/{name}
|
|
601
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
567
602
|
*/
|
|
568
|
-
|
|
603
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
604
|
+
}
|
|
605
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
606
|
+
protected httpClient: HttpClient<O>;
|
|
607
|
+
constructor(httpClient: HttpClient<O>);
|
|
569
608
|
/**
|
|
570
|
-
* HTTP
|
|
571
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* HTTP POST /gateway/tunnel
|
|
610
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
572
611
|
*/
|
|
573
|
-
|
|
612
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
574
613
|
/**
|
|
575
|
-
* HTTP
|
|
576
|
-
* Java method: org.openremote.model.
|
|
614
|
+
* HTTP DELETE /gateway/tunnel
|
|
615
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
577
616
|
*/
|
|
578
|
-
|
|
617
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
579
618
|
/**
|
|
580
|
-
* HTTP
|
|
581
|
-
* Java method: org.openremote.model.
|
|
619
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
620
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
582
621
|
*/
|
|
583
|
-
|
|
622
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
584
623
|
/**
|
|
585
|
-
* HTTP GET /
|
|
586
|
-
* Java method: org.openremote.model.
|
|
624
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
625
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
587
626
|
*/
|
|
588
|
-
|
|
627
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
589
628
|
/**
|
|
590
|
-
* HTTP
|
|
591
|
-
* Java method: org.openremote.model.
|
|
629
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
630
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
592
631
|
*/
|
|
593
|
-
|
|
632
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
594
633
|
}
|
|
595
|
-
export declare class
|
|
634
|
+
export declare class DashboardResourceClient<O> {
|
|
596
635
|
protected httpClient: HttpClient<O>;
|
|
597
636
|
constructor(httpClient: HttpClient<O>);
|
|
598
637
|
/**
|
|
599
|
-
* HTTP
|
|
600
|
-
* Java method: org.openremote.model.
|
|
601
|
-
*/
|
|
602
|
-
|
|
603
|
-
/**
|
|
604
|
-
* HTTP GET /apps/consoleConfig
|
|
605
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
606
|
-
*/
|
|
607
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
608
|
-
/**
|
|
609
|
-
* HTTP GET /apps/info
|
|
610
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
611
|
-
*/
|
|
612
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
613
|
-
}
|
|
614
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
615
|
-
protected httpClient: HttpClient<O>;
|
|
616
|
-
constructor(httpClient: HttpClient<O>);
|
|
638
|
+
* HTTP POST /dashboard
|
|
639
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
640
|
+
*/
|
|
641
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
617
642
|
/**
|
|
618
|
-
* HTTP
|
|
619
|
-
* Java method: org.openremote.model.
|
|
643
|
+
* HTTP PUT /dashboard
|
|
644
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
620
645
|
*/
|
|
621
|
-
|
|
646
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
622
647
|
/**
|
|
623
|
-
* HTTP
|
|
624
|
-
* Java method: org.openremote.model.
|
|
648
|
+
* HTTP GET /dashboard/all/{realm}
|
|
649
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
625
650
|
*/
|
|
626
|
-
|
|
651
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
627
652
|
/**
|
|
628
|
-
* HTTP
|
|
629
|
-
* Java method: org.openremote.model.
|
|
653
|
+
* HTTP POST /dashboard/query
|
|
654
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
630
655
|
*/
|
|
631
|
-
|
|
656
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
632
657
|
/**
|
|
633
|
-
* HTTP
|
|
634
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
659
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
635
660
|
*/
|
|
636
|
-
|
|
661
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
637
662
|
/**
|
|
638
|
-
* HTTP GET /
|
|
639
|
-
* Java method: org.openremote.model.
|
|
663
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
664
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
640
665
|
*/
|
|
641
|
-
|
|
666
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
642
667
|
}
|
|
643
668
|
export declare class ConfigurationResourceClient<O> {
|
|
644
669
|
protected httpClient: HttpClient<O>;
|
|
@@ -666,67 +691,41 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
666
691
|
*/
|
|
667
692
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
668
693
|
}
|
|
669
|
-
export declare class
|
|
670
|
-
protected httpClient: HttpClient<O>;
|
|
671
|
-
constructor(httpClient: HttpClient<O>);
|
|
672
|
-
/**
|
|
673
|
-
* HTTP POST /console/register
|
|
674
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
675
|
-
*/
|
|
676
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
677
|
-
}
|
|
678
|
-
export declare class AlarmResourceClient<O> {
|
|
694
|
+
export declare class GatewayClientResourceClient<O> {
|
|
679
695
|
protected httpClient: HttpClient<O>;
|
|
680
696
|
constructor(httpClient: HttpClient<O>);
|
|
681
697
|
/**
|
|
682
|
-
* HTTP
|
|
683
|
-
* Java method: org.openremote.model.
|
|
684
|
-
*/
|
|
685
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
686
|
-
assetIds?: string[];
|
|
687
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
688
|
-
/**
|
|
689
|
-
* HTTP GET /alarm
|
|
690
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
691
|
-
*/
|
|
692
|
-
getAlarms(queryParams?: {
|
|
693
|
-
realm?: string;
|
|
694
|
-
status?: Model.AlarmStatus;
|
|
695
|
-
assetId?: string;
|
|
696
|
-
assigneeId?: string;
|
|
697
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
698
|
-
/**
|
|
699
|
-
* HTTP DELETE /alarm
|
|
700
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
698
|
+
* HTTP DELETE /gateway/connection
|
|
699
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
701
700
|
*/
|
|
702
|
-
|
|
701
|
+
deleteConnections(queryParams?: {
|
|
702
|
+
realm?: string[];
|
|
703
|
+
}, options?: O): RestResponse<void>;
|
|
703
704
|
/**
|
|
704
|
-
* HTTP
|
|
705
|
-
* Java method: org.openremote.model.
|
|
705
|
+
* HTTP GET /gateway/connection
|
|
706
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
706
707
|
*/
|
|
707
|
-
|
|
708
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
708
709
|
/**
|
|
709
|
-
* HTTP
|
|
710
|
-
* Java method: org.openremote.model.
|
|
710
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
711
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
711
712
|
*/
|
|
712
|
-
|
|
713
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
713
714
|
/**
|
|
714
|
-
* HTTP
|
|
715
|
-
* Java method: org.openremote.model.
|
|
715
|
+
* HTTP GET /gateway/connection/{realm}
|
|
716
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
716
717
|
*/
|
|
717
|
-
|
|
718
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
718
719
|
/**
|
|
719
|
-
* HTTP PUT /
|
|
720
|
-
* Java method: org.openremote.model.
|
|
720
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
721
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
721
722
|
*/
|
|
722
|
-
|
|
723
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
723
724
|
/**
|
|
724
|
-
* HTTP GET /
|
|
725
|
-
* Java method: org.openremote.model.
|
|
725
|
+
* HTTP GET /gateway/status/{realm}
|
|
726
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
726
727
|
*/
|
|
727
|
-
|
|
728
|
-
realm?: string;
|
|
729
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
728
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
730
729
|
}
|
|
731
730
|
export declare class UserResourceClient<O> {
|
|
732
731
|
protected httpClient: HttpClient<O>;
|
|
@@ -852,95 +851,96 @@ export declare class UserResourceClient<O> {
|
|
|
852
851
|
*/
|
|
853
852
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
854
853
|
}
|
|
855
|
-
export declare class
|
|
854
|
+
export declare class AssetModelResourceClient<O> {
|
|
856
855
|
protected httpClient: HttpClient<O>;
|
|
857
856
|
constructor(httpClient: HttpClient<O>);
|
|
858
857
|
/**
|
|
859
|
-
* HTTP GET /
|
|
860
|
-
* Java method: org.openremote.model.
|
|
858
|
+
* HTTP GET /model/assetDescriptors
|
|
859
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
861
860
|
*/
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
861
|
+
getAssetDescriptors(queryParams?: {
|
|
862
|
+
parentId?: string;
|
|
863
|
+
parentType?: string;
|
|
864
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
865
865
|
/**
|
|
866
|
-
* HTTP GET /
|
|
867
|
-
* Java method: org.openremote.model.
|
|
866
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
867
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
868
868
|
*/
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
}>;
|
|
872
|
-
}
|
|
873
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
874
|
-
protected httpClient: HttpClient<O>;
|
|
875
|
-
constructor(httpClient: HttpClient<O>);
|
|
869
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
870
|
+
parentId?: string;
|
|
871
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
876
872
|
/**
|
|
877
|
-
* HTTP GET /
|
|
878
|
-
* Java method: org.openremote.model.
|
|
873
|
+
* HTTP GET /model/assetInfos
|
|
874
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
879
875
|
*/
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
}, options?: O): RestResponse<any>;
|
|
876
|
+
getAssetInfos(queryParams?: {
|
|
877
|
+
parentId?: string;
|
|
878
|
+
parentType?: string;
|
|
879
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
885
880
|
/**
|
|
886
|
-
* HTTP GET /
|
|
887
|
-
* Java method: org.openremote.model.
|
|
881
|
+
* HTTP GET /model/metaItemDescriptors
|
|
882
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
888
883
|
*/
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
884
|
+
getMetaItemDescriptors(queryParams?: {
|
|
885
|
+
parentId?: string;
|
|
886
|
+
}, options?: O): RestResponse<{
|
|
887
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
888
|
+
}>;
|
|
893
889
|
/**
|
|
894
|
-
* HTTP
|
|
895
|
-
* Java method: org.openremote.model.
|
|
890
|
+
* HTTP GET /model/valueDescriptors
|
|
891
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
896
892
|
*/
|
|
897
|
-
|
|
893
|
+
getValueDescriptors(queryParams?: {
|
|
894
|
+
parentId?: string;
|
|
895
|
+
}, options?: O): RestResponse<{
|
|
896
|
+
[index: string]: Model.ValueDescriptor;
|
|
897
|
+
}>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
902
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
903
901
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
904
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
905
902
|
protected _assetResource: AxiosAssetResourceClient;
|
|
906
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
907
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
908
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
909
903
|
protected _flowResource: AxiosFlowResourceClient;
|
|
910
|
-
protected
|
|
911
|
-
protected
|
|
912
|
-
protected
|
|
904
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
905
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
906
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
913
907
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
908
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
914
909
|
protected _appResource: AxiosAppResourceClient;
|
|
910
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
911
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
912
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
913
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
914
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
915
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
915
916
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
917
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
916
918
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
917
|
-
protected
|
|
918
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
919
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
919
920
|
protected _userResource: AxiosUserResourceClient;
|
|
920
|
-
protected
|
|
921
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
921
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
924
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
925
923
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
926
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
927
924
|
get AssetResource(): AxiosAssetResourceClient;
|
|
928
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
929
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
930
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
931
925
|
get FlowResource(): AxiosFlowResourceClient;
|
|
932
|
-
get
|
|
933
|
-
get
|
|
934
|
-
get
|
|
926
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
927
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
928
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
935
929
|
get RulesResource(): AxiosRulesResourceClient;
|
|
930
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
936
931
|
get AppResource(): AxiosAppResourceClient;
|
|
932
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
933
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
934
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
935
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
936
|
+
get MapResource(): AxiosMapResourceClient;
|
|
937
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
937
938
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
939
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
938
940
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
939
|
-
get
|
|
940
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
941
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
941
942
|
get UserResource(): AxiosUserResourceClient;
|
|
942
|
-
get
|
|
943
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
943
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
978
|
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|