@openremote/rest 1.7.0-snapshot.20250626150423 → 1.7.0-snapshot.20250627125543
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +431 -431
- 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,41 +9,31 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
18
|
-
*/
|
|
19
|
-
deleteConnections(queryParams?: {
|
|
20
|
-
realm?: string[];
|
|
21
|
-
}, options?: O): RestResponse<void>;
|
|
22
|
-
/**
|
|
23
|
-
* HTTP GET /gateway/connection
|
|
24
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
25
|
-
*/
|
|
26
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
27
|
-
/**
|
|
28
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
29
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
30
|
-
*/
|
|
31
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
32
|
-
/**
|
|
33
|
-
* HTTP GET /gateway/connection/{realm}
|
|
34
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
16
|
+
* HTTP GET /asset/datapoint/export
|
|
17
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
35
18
|
*/
|
|
36
|
-
|
|
19
|
+
getDatapointExport(queryParams?: {
|
|
20
|
+
attributeRefs?: string;
|
|
21
|
+
fromTimestamp?: number;
|
|
22
|
+
toTimestamp?: number;
|
|
23
|
+
}, options?: O): RestResponse<any>;
|
|
37
24
|
/**
|
|
38
|
-
* HTTP
|
|
39
|
-
* Java method: org.openremote.model.
|
|
25
|
+
* HTTP GET /asset/datapoint/periods
|
|
26
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
40
27
|
*/
|
|
41
|
-
|
|
28
|
+
getDatapointPeriod(queryParams?: {
|
|
29
|
+
assetId?: string;
|
|
30
|
+
attributeName?: string;
|
|
31
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
42
32
|
/**
|
|
43
|
-
* HTTP
|
|
44
|
-
* Java method: org.openremote.model.
|
|
33
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
34
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
45
35
|
*/
|
|
46
|
-
|
|
36
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
47
37
|
}
|
|
48
38
|
export declare class RealmResourceClient<O> {
|
|
49
39
|
protected httpClient: HttpClient<O>;
|
|
@@ -79,121 +69,133 @@ export declare class RealmResourceClient<O> {
|
|
|
79
69
|
*/
|
|
80
70
|
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
81
71
|
}
|
|
82
|
-
export declare class
|
|
72
|
+
export declare class AppResourceClient<O> {
|
|
83
73
|
protected httpClient: HttpClient<O>;
|
|
84
74
|
constructor(httpClient: HttpClient<O>);
|
|
85
75
|
/**
|
|
86
|
-
* HTTP GET /
|
|
87
|
-
* Java method: org.openremote.model.
|
|
88
|
-
*/
|
|
89
|
-
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
90
|
-
/**
|
|
91
|
-
* HTTP PUT /configuration/manager
|
|
92
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
76
|
+
* HTTP GET /apps
|
|
77
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
93
78
|
*/
|
|
94
|
-
|
|
79
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
95
80
|
/**
|
|
96
|
-
* HTTP
|
|
97
|
-
* Java method: org.openremote.model.
|
|
81
|
+
* HTTP GET /apps/consoleConfig
|
|
82
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
98
83
|
*/
|
|
99
|
-
|
|
100
|
-
path?: string;
|
|
101
|
-
}, options?: O): RestResponse<string>;
|
|
84
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
102
85
|
/**
|
|
103
|
-
* HTTP GET /
|
|
104
|
-
* Java method: org.openremote.model.
|
|
86
|
+
* HTTP GET /apps/info
|
|
87
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
105
88
|
*/
|
|
106
|
-
|
|
89
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
107
90
|
}
|
|
108
|
-
export declare class
|
|
91
|
+
export declare class NotificationResourceClient<O> {
|
|
109
92
|
protected httpClient: HttpClient<O>;
|
|
110
93
|
constructor(httpClient: HttpClient<O>);
|
|
111
94
|
/**
|
|
112
|
-
* HTTP
|
|
113
|
-
* Java method: org.openremote.model.
|
|
95
|
+
* HTTP GET /notification
|
|
96
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
114
97
|
*/
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
98
|
+
getNotifications(queryParams?: {
|
|
99
|
+
id?: number;
|
|
100
|
+
type?: string;
|
|
101
|
+
from?: number;
|
|
102
|
+
to?: number;
|
|
103
|
+
realmId?: string;
|
|
104
|
+
userId?: string;
|
|
105
|
+
assetId?: string;
|
|
106
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
118
107
|
/**
|
|
119
|
-
* HTTP
|
|
120
|
-
* Java method: org.openremote.model.
|
|
108
|
+
* HTTP DELETE /notification
|
|
109
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
121
110
|
*/
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
111
|
+
removeNotifications(queryParams?: {
|
|
112
|
+
id?: number;
|
|
113
|
+
type?: string;
|
|
114
|
+
from?: number;
|
|
115
|
+
to?: number;
|
|
116
|
+
realmId?: string;
|
|
117
|
+
userId?: string;
|
|
125
118
|
assetId?: string;
|
|
126
|
-
|
|
127
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
119
|
+
}, options?: O): RestResponse<void>;
|
|
128
120
|
/**
|
|
129
|
-
* HTTP
|
|
130
|
-
* Java method: org.openremote.model.
|
|
121
|
+
* HTTP POST /notification/alert
|
|
122
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
131
123
|
*/
|
|
132
|
-
|
|
124
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
133
125
|
/**
|
|
134
|
-
* HTTP
|
|
135
|
-
* Java method: org.openremote.model.
|
|
126
|
+
* HTTP DELETE /notification/{notificationId}
|
|
127
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
136
128
|
*/
|
|
137
|
-
|
|
129
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
138
130
|
/**
|
|
139
|
-
* HTTP
|
|
140
|
-
* Java method: org.openremote.model.
|
|
131
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
132
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
141
133
|
*/
|
|
142
|
-
|
|
134
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
135
|
+
targetId?: string;
|
|
136
|
+
}, options?: O): RestResponse<void>;
|
|
143
137
|
/**
|
|
144
|
-
* HTTP
|
|
145
|
-
* Java method: org.openremote.model.
|
|
138
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
139
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
146
140
|
*/
|
|
147
|
-
|
|
141
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
142
|
+
targetId?: string;
|
|
143
|
+
}, options?: O): RestResponse<void>;
|
|
144
|
+
}
|
|
145
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
146
|
+
protected httpClient: HttpClient<O>;
|
|
147
|
+
constructor(httpClient: HttpClient<O>);
|
|
148
148
|
/**
|
|
149
|
-
* HTTP
|
|
150
|
-
* Java method: org.openremote.model.
|
|
149
|
+
* HTTP POST /gateway/tunnel
|
|
150
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
151
151
|
*/
|
|
152
|
-
|
|
152
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
153
153
|
/**
|
|
154
|
-
* HTTP
|
|
155
|
-
* Java method: org.openremote.model.
|
|
154
|
+
* HTTP DELETE /gateway/tunnel
|
|
155
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
156
156
|
*/
|
|
157
|
-
|
|
158
|
-
realm?: string;
|
|
159
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
160
|
-
}
|
|
161
|
-
export declare class StatusResourceClient<O> {
|
|
162
|
-
protected httpClient: HttpClient<O>;
|
|
163
|
-
constructor(httpClient: HttpClient<O>);
|
|
157
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
164
158
|
/**
|
|
165
|
-
* HTTP GET /
|
|
166
|
-
* Java method: org.openremote.model.
|
|
159
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
160
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
167
161
|
*/
|
|
168
|
-
|
|
169
|
-
[index: string]: any;
|
|
170
|
-
}>;
|
|
162
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
171
163
|
/**
|
|
172
|
-
* HTTP GET /
|
|
173
|
-
* Java method: org.openremote.model.
|
|
164
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
165
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
174
166
|
*/
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
167
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
168
|
+
/**
|
|
169
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
170
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
171
|
+
*/
|
|
172
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
178
173
|
}
|
|
179
|
-
export declare class
|
|
174
|
+
export declare class ConfigurationResourceClient<O> {
|
|
180
175
|
protected httpClient: HttpClient<O>;
|
|
181
176
|
constructor(httpClient: HttpClient<O>);
|
|
182
177
|
/**
|
|
183
|
-
* HTTP GET /
|
|
184
|
-
* Java method: org.openremote.model.
|
|
178
|
+
* HTTP GET /configuration/manager
|
|
179
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
185
180
|
*/
|
|
186
|
-
|
|
181
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
187
182
|
/**
|
|
188
|
-
* HTTP
|
|
189
|
-
* Java method: org.openremote.model.
|
|
183
|
+
* HTTP PUT /configuration/manager
|
|
184
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
190
185
|
*/
|
|
191
|
-
|
|
186
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
192
187
|
/**
|
|
193
|
-
* HTTP
|
|
194
|
-
* Java method: org.openremote.model.
|
|
188
|
+
* HTTP POST /configuration/manager/file
|
|
189
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
195
190
|
*/
|
|
196
|
-
|
|
191
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
192
|
+
path?: string;
|
|
193
|
+
}, options?: O): RestResponse<string>;
|
|
194
|
+
/**
|
|
195
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
196
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
197
|
+
*/
|
|
198
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
197
199
|
}
|
|
198
200
|
export declare class DashboardResourceClient<O> {
|
|
199
201
|
protected httpClient: HttpClient<O>;
|
|
@@ -229,59 +231,6 @@ export declare class DashboardResourceClient<O> {
|
|
|
229
231
|
*/
|
|
230
232
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
231
233
|
}
|
|
232
|
-
export declare class MapResourceClient<O> {
|
|
233
|
-
protected httpClient: HttpClient<O>;
|
|
234
|
-
constructor(httpClient: HttpClient<O>);
|
|
235
|
-
/**
|
|
236
|
-
* HTTP GET /map
|
|
237
|
-
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
238
|
-
*/
|
|
239
|
-
getSettings(options?: O): RestResponse<{
|
|
240
|
-
[id: string]: unknown;
|
|
241
|
-
}>;
|
|
242
|
-
/**
|
|
243
|
-
* HTTP PUT /map
|
|
244
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
245
|
-
*/
|
|
246
|
-
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
247
|
-
[id: string]: unknown;
|
|
248
|
-
}>;
|
|
249
|
-
/**
|
|
250
|
-
* HTTP DELETE /map/deleteMap
|
|
251
|
-
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
252
|
-
*/
|
|
253
|
-
deleteMap(options?: O): RestResponse<{
|
|
254
|
-
[id: string]: unknown;
|
|
255
|
-
}>;
|
|
256
|
-
/**
|
|
257
|
-
* HTTP GET /map/getCustomMapInfo
|
|
258
|
-
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
259
|
-
*/
|
|
260
|
-
getCustomMapInfo(options?: O): RestResponse<{
|
|
261
|
-
[id: string]: unknown;
|
|
262
|
-
}>;
|
|
263
|
-
/**
|
|
264
|
-
* HTTP GET /map/js
|
|
265
|
-
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
266
|
-
*/
|
|
267
|
-
getSettingsJs(options?: O): RestResponse<{
|
|
268
|
-
[id: string]: unknown;
|
|
269
|
-
}>;
|
|
270
|
-
/**
|
|
271
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
272
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
273
|
-
*/
|
|
274
|
-
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
275
|
-
/**
|
|
276
|
-
* HTTP POST /map/upload
|
|
277
|
-
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
278
|
-
*/
|
|
279
|
-
uploadMap(queryParams?: {
|
|
280
|
-
filename?: string;
|
|
281
|
-
}, options?: O): RestResponse<{
|
|
282
|
-
[id: string]: unknown;
|
|
283
|
-
}>;
|
|
284
|
-
}
|
|
285
234
|
export declare class AgentResourceClient<O> {
|
|
286
235
|
protected httpClient: HttpClient<O>;
|
|
287
236
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -308,113 +257,103 @@ export declare class AgentResourceClient<O> {
|
|
|
308
257
|
realm?: string;
|
|
309
258
|
}, options?: O): RestResponse<Model.Agent[]>;
|
|
310
259
|
}
|
|
311
|
-
export declare class
|
|
260
|
+
export declare class AssetModelResourceClient<O> {
|
|
312
261
|
protected httpClient: HttpClient<O>;
|
|
313
262
|
constructor(httpClient: HttpClient<O>);
|
|
314
263
|
/**
|
|
315
|
-
* HTTP
|
|
316
|
-
* Java method: org.openremote.model.
|
|
317
|
-
*/
|
|
318
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
319
|
-
/**
|
|
320
|
-
* HTTP GET /rules
|
|
321
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
322
|
-
*/
|
|
323
|
-
getGlobalRulesets(queryParams?: {
|
|
324
|
-
language?: Model.RulesetLang[];
|
|
325
|
-
fullyPopulate?: boolean;
|
|
326
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
327
|
-
/**
|
|
328
|
-
* HTTP POST /rules/asset
|
|
329
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
330
|
-
*/
|
|
331
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
332
|
-
/**
|
|
333
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
334
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
335
|
-
*/
|
|
336
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
337
|
-
language?: Model.RulesetLang[];
|
|
338
|
-
fullyPopulate?: boolean;
|
|
339
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
340
|
-
/**
|
|
341
|
-
* HTTP DELETE /rules/asset/{id}
|
|
342
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
343
|
-
*/
|
|
344
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
345
|
-
/**
|
|
346
|
-
* HTTP GET /rules/asset/{id}
|
|
347
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
348
|
-
*/
|
|
349
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
350
|
-
/**
|
|
351
|
-
* HTTP PUT /rules/asset/{id}
|
|
352
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
353
|
-
*/
|
|
354
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
355
|
-
/**
|
|
356
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
357
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
264
|
+
* HTTP GET /model/assetDescriptors
|
|
265
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
358
266
|
*/
|
|
359
|
-
|
|
267
|
+
getAssetDescriptors(queryParams?: {
|
|
268
|
+
parentId?: string;
|
|
269
|
+
parentType?: string;
|
|
270
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
360
271
|
/**
|
|
361
|
-
* HTTP GET /
|
|
362
|
-
* Java method: org.openremote.model.
|
|
272
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
273
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
363
274
|
*/
|
|
364
|
-
|
|
275
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
276
|
+
parentId?: string;
|
|
277
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
365
278
|
/**
|
|
366
|
-
* HTTP GET /
|
|
367
|
-
* Java method: org.openremote.model.
|
|
279
|
+
* HTTP GET /model/assetInfos
|
|
280
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
368
281
|
*/
|
|
369
|
-
|
|
282
|
+
getAssetInfos(queryParams?: {
|
|
283
|
+
parentId?: string;
|
|
284
|
+
parentType?: string;
|
|
285
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
370
286
|
/**
|
|
371
|
-
* HTTP GET /
|
|
372
|
-
* Java method: org.openremote.model.
|
|
287
|
+
* HTTP GET /model/metaItemDescriptors
|
|
288
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
373
289
|
*/
|
|
374
|
-
|
|
290
|
+
getMetaItemDescriptors(queryParams?: {
|
|
291
|
+
parentId?: string;
|
|
292
|
+
}, options?: O): RestResponse<{
|
|
293
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
294
|
+
}>;
|
|
375
295
|
/**
|
|
376
|
-
* HTTP
|
|
377
|
-
* Java method: org.openremote.model.
|
|
296
|
+
* HTTP GET /model/valueDescriptors
|
|
297
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
378
298
|
*/
|
|
379
|
-
|
|
299
|
+
getValueDescriptors(queryParams?: {
|
|
300
|
+
parentId?: string;
|
|
301
|
+
}, options?: O): RestResponse<{
|
|
302
|
+
[index: string]: Model.ValueDescriptor;
|
|
303
|
+
}>;
|
|
304
|
+
}
|
|
305
|
+
export declare class MapResourceClient<O> {
|
|
306
|
+
protected httpClient: HttpClient<O>;
|
|
307
|
+
constructor(httpClient: HttpClient<O>);
|
|
380
308
|
/**
|
|
381
|
-
* HTTP GET /
|
|
382
|
-
* Java method: org.openremote.model.
|
|
309
|
+
* HTTP GET /map
|
|
310
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
383
311
|
*/
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
312
|
+
getSettings(options?: O): RestResponse<{
|
|
313
|
+
[id: string]: unknown;
|
|
314
|
+
}>;
|
|
388
315
|
/**
|
|
389
|
-
* HTTP
|
|
390
|
-
* Java method: org.openremote.model.
|
|
316
|
+
* HTTP PUT /map
|
|
317
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
391
318
|
*/
|
|
392
|
-
|
|
319
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
320
|
+
[id: string]: unknown;
|
|
321
|
+
}>;
|
|
393
322
|
/**
|
|
394
|
-
* HTTP
|
|
395
|
-
* Java method: org.openremote.model.
|
|
323
|
+
* HTTP DELETE /map/deleteMap
|
|
324
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
396
325
|
*/
|
|
397
|
-
|
|
326
|
+
deleteMap(options?: O): RestResponse<{
|
|
327
|
+
[id: string]: unknown;
|
|
328
|
+
}>;
|
|
398
329
|
/**
|
|
399
|
-
* HTTP
|
|
400
|
-
* Java method: org.openremote.model.
|
|
330
|
+
* HTTP GET /map/getCustomMapInfo
|
|
331
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
401
332
|
*/
|
|
402
|
-
|
|
333
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
334
|
+
[id: string]: unknown;
|
|
335
|
+
}>;
|
|
403
336
|
/**
|
|
404
|
-
* HTTP
|
|
405
|
-
* Java method: org.openremote.model.
|
|
337
|
+
* HTTP GET /map/js
|
|
338
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
406
339
|
*/
|
|
407
|
-
|
|
340
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
341
|
+
[id: string]: unknown;
|
|
342
|
+
}>;
|
|
408
343
|
/**
|
|
409
|
-
* HTTP GET /
|
|
410
|
-
* Java method: org.openremote.model.
|
|
344
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
345
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
411
346
|
*/
|
|
412
|
-
|
|
347
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
413
348
|
/**
|
|
414
|
-
* HTTP
|
|
415
|
-
* Java method: org.openremote.model.
|
|
349
|
+
* HTTP POST /map/upload
|
|
350
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
416
351
|
*/
|
|
417
|
-
|
|
352
|
+
uploadMap(queryParams?: {
|
|
353
|
+
filename?: string;
|
|
354
|
+
}, options?: O): RestResponse<{
|
|
355
|
+
[id: string]: unknown;
|
|
356
|
+
}>;
|
|
418
357
|
}
|
|
419
358
|
export declare class UserResourceClient<O> {
|
|
420
359
|
protected httpClient: HttpClient<O>;
|
|
@@ -520,38 +459,91 @@ export declare class UserResourceClient<O> {
|
|
|
520
459
|
*/
|
|
521
460
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
522
461
|
}
|
|
523
|
-
export declare class
|
|
462
|
+
export declare class AlarmResourceClient<O> {
|
|
524
463
|
protected httpClient: HttpClient<O>;
|
|
525
464
|
constructor(httpClient: HttpClient<O>);
|
|
526
465
|
/**
|
|
527
|
-
* HTTP POST /
|
|
528
|
-
* Java method: org.openremote.model.
|
|
466
|
+
* HTTP POST /alarm
|
|
467
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
529
468
|
*/
|
|
530
|
-
|
|
469
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
470
|
+
assetIds?: string[];
|
|
471
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
531
472
|
/**
|
|
532
|
-
* HTTP
|
|
533
|
-
* Java method: org.openremote.model.
|
|
473
|
+
* HTTP GET /alarm
|
|
474
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
534
475
|
*/
|
|
535
|
-
|
|
476
|
+
getAlarms(queryParams?: {
|
|
477
|
+
realm?: string;
|
|
478
|
+
status?: Model.AlarmStatus;
|
|
479
|
+
assetId?: string;
|
|
480
|
+
assigneeId?: string;
|
|
481
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
482
|
+
/**
|
|
483
|
+
* HTTP DELETE /alarm
|
|
484
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
485
|
+
*/
|
|
486
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
487
|
+
/**
|
|
488
|
+
* HTTP PUT /alarm/assets
|
|
489
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
490
|
+
*/
|
|
491
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
492
|
+
/**
|
|
493
|
+
* HTTP GET /alarm/{alarmId}
|
|
494
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
495
|
+
*/
|
|
496
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
497
|
+
/**
|
|
498
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
499
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
500
|
+
*/
|
|
501
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
502
|
+
/**
|
|
503
|
+
* HTTP PUT /alarm/{alarmId}
|
|
504
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
505
|
+
*/
|
|
506
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
507
|
+
/**
|
|
508
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
509
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
510
|
+
*/
|
|
511
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
512
|
+
realm?: string;
|
|
513
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
536
514
|
}
|
|
537
|
-
export declare class
|
|
515
|
+
export declare class FlowResourceClient<O> {
|
|
538
516
|
protected httpClient: HttpClient<O>;
|
|
539
517
|
constructor(httpClient: HttpClient<O>);
|
|
540
518
|
/**
|
|
541
|
-
* HTTP GET /
|
|
542
|
-
* Java method: org.openremote.model.
|
|
519
|
+
* HTTP GET /flow
|
|
520
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
543
521
|
*/
|
|
544
|
-
|
|
522
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
545
523
|
/**
|
|
546
|
-
* HTTP GET /
|
|
547
|
-
* Java method: org.openremote.model.
|
|
524
|
+
* HTTP GET /flow/{name}
|
|
525
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
548
526
|
*/
|
|
549
|
-
|
|
527
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
550
528
|
/**
|
|
551
|
-
* HTTP GET /
|
|
552
|
-
* Java method: org.openremote.model.
|
|
529
|
+
* HTTP GET /flow/{type}
|
|
530
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
553
531
|
*/
|
|
554
|
-
|
|
532
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
533
|
+
}
|
|
534
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
535
|
+
protected httpClient: HttpClient<O>;
|
|
536
|
+
constructor(httpClient: HttpClient<O>);
|
|
537
|
+
/**
|
|
538
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
539
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
540
|
+
*/
|
|
541
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
542
|
+
/**
|
|
543
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
544
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
545
|
+
*/
|
|
546
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
555
547
|
}
|
|
556
548
|
export declare class AssetResourceClient<O> {
|
|
557
549
|
protected httpClient: HttpClient<O>;
|
|
@@ -657,88 +649,146 @@ export declare class AssetResourceClient<O> {
|
|
|
657
649
|
assetIds?: string[];
|
|
658
650
|
}, options?: O): RestResponse<void>;
|
|
659
651
|
}
|
|
660
|
-
export declare class
|
|
652
|
+
export declare class RulesResourceClient<O> {
|
|
661
653
|
protected httpClient: HttpClient<O>;
|
|
662
654
|
constructor(httpClient: HttpClient<O>);
|
|
663
655
|
/**
|
|
664
|
-
* HTTP
|
|
665
|
-
* Java method: org.openremote.model.
|
|
656
|
+
* HTTP POST /rules
|
|
657
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
666
658
|
*/
|
|
667
|
-
|
|
668
|
-
id?: number;
|
|
669
|
-
type?: string;
|
|
670
|
-
from?: number;
|
|
671
|
-
to?: number;
|
|
672
|
-
realmId?: string;
|
|
673
|
-
userId?: string;
|
|
674
|
-
assetId?: string;
|
|
675
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
659
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
676
660
|
/**
|
|
677
|
-
* HTTP
|
|
678
|
-
* Java method: org.openremote.model.
|
|
661
|
+
* HTTP GET /rules
|
|
662
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
679
663
|
*/
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
to?: number;
|
|
685
|
-
realmId?: string;
|
|
686
|
-
userId?: string;
|
|
687
|
-
assetId?: string;
|
|
688
|
-
}, options?: O): RestResponse<void>;
|
|
664
|
+
getGlobalRulesets(queryParams?: {
|
|
665
|
+
language?: Model.RulesetLang[];
|
|
666
|
+
fullyPopulate?: boolean;
|
|
667
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
689
668
|
/**
|
|
690
|
-
* HTTP POST /
|
|
691
|
-
* Java method: org.openremote.model.
|
|
669
|
+
* HTTP POST /rules/asset
|
|
670
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
692
671
|
*/
|
|
693
|
-
|
|
672
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
673
|
+
/**
|
|
674
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
675
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
676
|
+
*/
|
|
677
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
678
|
+
language?: Model.RulesetLang[];
|
|
679
|
+
fullyPopulate?: boolean;
|
|
680
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
681
|
+
/**
|
|
682
|
+
* HTTP DELETE /rules/asset/{id}
|
|
683
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
684
|
+
*/
|
|
685
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
686
|
+
/**
|
|
687
|
+
* HTTP GET /rules/asset/{id}
|
|
688
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
689
|
+
*/
|
|
690
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
691
|
+
/**
|
|
692
|
+
* HTTP PUT /rules/asset/{id}
|
|
693
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
694
|
+
*/
|
|
695
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
696
|
+
/**
|
|
697
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
698
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
699
|
+
*/
|
|
700
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
701
|
+
/**
|
|
702
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
703
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
704
|
+
*/
|
|
705
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
706
|
+
/**
|
|
707
|
+
* HTTP GET /rules/info/global
|
|
708
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
709
|
+
*/
|
|
710
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
711
|
+
/**
|
|
712
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
713
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
714
|
+
*/
|
|
715
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
716
|
+
/**
|
|
717
|
+
* HTTP POST /rules/realm
|
|
718
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
719
|
+
*/
|
|
720
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
721
|
+
/**
|
|
722
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
723
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
724
|
+
*/
|
|
725
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
726
|
+
language?: Model.RulesetLang[];
|
|
727
|
+
fullyPopulate?: boolean;
|
|
728
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
729
|
+
/**
|
|
730
|
+
* HTTP DELETE /rules/realm/{id}
|
|
731
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
732
|
+
*/
|
|
733
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
734
|
+
/**
|
|
735
|
+
* HTTP GET /rules/realm/{id}
|
|
736
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
737
|
+
*/
|
|
738
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
739
|
+
/**
|
|
740
|
+
* HTTP PUT /rules/realm/{id}
|
|
741
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
742
|
+
*/
|
|
743
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
694
744
|
/**
|
|
695
|
-
* HTTP DELETE /
|
|
696
|
-
* Java method: org.openremote.model.
|
|
745
|
+
* HTTP DELETE /rules/{id}
|
|
746
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
697
747
|
*/
|
|
698
|
-
|
|
748
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
699
749
|
/**
|
|
700
|
-
* HTTP
|
|
701
|
-
* Java method: org.openremote.model.
|
|
750
|
+
* HTTP GET /rules/{id}
|
|
751
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
702
752
|
*/
|
|
703
|
-
|
|
704
|
-
targetId?: string;
|
|
705
|
-
}, options?: O): RestResponse<void>;
|
|
753
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
706
754
|
/**
|
|
707
|
-
* HTTP PUT /
|
|
708
|
-
* Java method: org.openremote.model.
|
|
755
|
+
* HTTP PUT /rules/{id}
|
|
756
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
709
757
|
*/
|
|
710
|
-
|
|
711
|
-
targetId?: string;
|
|
712
|
-
}, options?: O): RestResponse<void>;
|
|
758
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
713
759
|
}
|
|
714
|
-
export declare class
|
|
760
|
+
export declare class ProvisioningResourceClient<O> {
|
|
715
761
|
protected httpClient: HttpClient<O>;
|
|
716
762
|
constructor(httpClient: HttpClient<O>);
|
|
717
763
|
/**
|
|
718
|
-
* HTTP POST /
|
|
719
|
-
* Java method: org.openremote.model.
|
|
764
|
+
* HTTP POST /provisioning
|
|
765
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
720
766
|
*/
|
|
721
|
-
|
|
767
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
722
768
|
/**
|
|
723
|
-
* HTTP
|
|
724
|
-
* Java method: org.openremote.model.
|
|
769
|
+
* HTTP GET /provisioning
|
|
770
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
725
771
|
*/
|
|
726
|
-
|
|
772
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
727
773
|
/**
|
|
728
|
-
* HTTP
|
|
729
|
-
* Java method: org.openremote.model.
|
|
774
|
+
* HTTP DELETE /provisioning/{id}
|
|
775
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
730
776
|
*/
|
|
731
|
-
|
|
777
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
732
778
|
/**
|
|
733
|
-
* HTTP
|
|
734
|
-
* Java method: org.openremote.model.
|
|
779
|
+
* HTTP PUT /provisioning/{id}
|
|
780
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
735
781
|
*/
|
|
736
|
-
|
|
782
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
783
|
+
}
|
|
784
|
+
export declare class ConsoleResourceClient<O> {
|
|
785
|
+
protected httpClient: HttpClient<O>;
|
|
786
|
+
constructor(httpClient: HttpClient<O>);
|
|
737
787
|
/**
|
|
738
|
-
* HTTP
|
|
739
|
-
* Java method: org.openremote.model.
|
|
788
|
+
* HTTP POST /console/register
|
|
789
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
740
790
|
*/
|
|
741
|
-
|
|
791
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
742
792
|
}
|
|
743
793
|
export declare class SyslogResourceClient<O> {
|
|
744
794
|
protected httpClient: HttpClient<O>;
|
|
@@ -772,155 +822,105 @@ export declare class SyslogResourceClient<O> {
|
|
|
772
822
|
subCategory?: string[];
|
|
773
823
|
}, options?: O): RestResponse<any>;
|
|
774
824
|
}
|
|
775
|
-
export declare class
|
|
825
|
+
export declare class GatewayClientResourceClient<O> {
|
|
776
826
|
protected httpClient: HttpClient<O>;
|
|
777
827
|
constructor(httpClient: HttpClient<O>);
|
|
778
828
|
/**
|
|
779
|
-
* HTTP
|
|
780
|
-
* Java method: org.openremote.model.
|
|
781
|
-
*/
|
|
782
|
-
getDatapointExport(queryParams?: {
|
|
783
|
-
attributeRefs?: string;
|
|
784
|
-
fromTimestamp?: number;
|
|
785
|
-
toTimestamp?: number;
|
|
786
|
-
}, options?: O): RestResponse<any>;
|
|
787
|
-
/**
|
|
788
|
-
* HTTP GET /asset/datapoint/periods
|
|
789
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
790
|
-
*/
|
|
791
|
-
getDatapointPeriod(queryParams?: {
|
|
792
|
-
assetId?: string;
|
|
793
|
-
attributeName?: string;
|
|
794
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
795
|
-
/**
|
|
796
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
797
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
829
|
+
* HTTP DELETE /gateway/connection
|
|
830
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
798
831
|
*/
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
protected httpClient: HttpClient<O>;
|
|
803
|
-
constructor(httpClient: HttpClient<O>);
|
|
832
|
+
deleteConnections(queryParams?: {
|
|
833
|
+
realm?: string[];
|
|
834
|
+
}, options?: O): RestResponse<void>;
|
|
804
835
|
/**
|
|
805
|
-
* HTTP GET /
|
|
806
|
-
* Java method: org.openremote.model.
|
|
836
|
+
* HTTP GET /gateway/connection
|
|
837
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
807
838
|
*/
|
|
808
|
-
|
|
809
|
-
parentId?: string;
|
|
810
|
-
parentType?: string;
|
|
811
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
839
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
812
840
|
/**
|
|
813
|
-
* HTTP
|
|
814
|
-
* Java method: org.openremote.model.
|
|
841
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
842
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
815
843
|
*/
|
|
816
|
-
|
|
817
|
-
parentId?: string;
|
|
818
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
844
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
819
845
|
/**
|
|
820
|
-
* HTTP GET /
|
|
821
|
-
* Java method: org.openremote.model.
|
|
846
|
+
* HTTP GET /gateway/connection/{realm}
|
|
847
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
822
848
|
*/
|
|
823
|
-
|
|
824
|
-
parentId?: string;
|
|
825
|
-
parentType?: string;
|
|
826
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
849
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
827
850
|
/**
|
|
828
|
-
* HTTP
|
|
829
|
-
* Java method: org.openremote.model.
|
|
851
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
852
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
830
853
|
*/
|
|
831
|
-
|
|
832
|
-
parentId?: string;
|
|
833
|
-
}, options?: O): RestResponse<{
|
|
834
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
835
|
-
}>;
|
|
854
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
836
855
|
/**
|
|
837
|
-
* HTTP GET /
|
|
838
|
-
* Java method: org.openremote.model.
|
|
856
|
+
* HTTP GET /gateway/status/{realm}
|
|
857
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
839
858
|
*/
|
|
840
|
-
|
|
841
|
-
parentId?: string;
|
|
842
|
-
}, options?: O): RestResponse<{
|
|
843
|
-
[index: string]: Model.ValueDescriptor;
|
|
844
|
-
}>;
|
|
859
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
845
860
|
}
|
|
846
|
-
export declare class
|
|
861
|
+
export declare class StatusResourceClient<O> {
|
|
847
862
|
protected httpClient: HttpClient<O>;
|
|
848
863
|
constructor(httpClient: HttpClient<O>);
|
|
849
864
|
/**
|
|
850
|
-
* HTTP
|
|
851
|
-
* Java method: org.openremote.model.
|
|
852
|
-
*/
|
|
853
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
854
|
-
/**
|
|
855
|
-
* HTTP GET /provisioning
|
|
856
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
857
|
-
*/
|
|
858
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
859
|
-
/**
|
|
860
|
-
* HTTP DELETE /provisioning/{id}
|
|
861
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
862
|
-
*/
|
|
863
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
864
|
-
/**
|
|
865
|
-
* HTTP PUT /provisioning/{id}
|
|
866
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
865
|
+
* HTTP GET /health
|
|
866
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
867
867
|
*/
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
protected httpClient: HttpClient<O>;
|
|
872
|
-
constructor(httpClient: HttpClient<O>);
|
|
868
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
869
|
+
[index: string]: any;
|
|
870
|
+
}>;
|
|
873
871
|
/**
|
|
874
|
-
* HTTP
|
|
875
|
-
* Java method: org.openremote.model.
|
|
872
|
+
* HTTP GET /info
|
|
873
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
876
874
|
*/
|
|
877
|
-
|
|
875
|
+
getInfo(options?: O): RestResponse<{
|
|
876
|
+
[index: string]: any;
|
|
877
|
+
}>;
|
|
878
878
|
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
|
-
protected
|
|
881
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
882
882
|
protected _realmResource: AxiosRealmResourceClient;
|
|
883
|
+
protected _appResource: AxiosAppResourceClient;
|
|
884
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
885
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
883
886
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
884
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
885
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
886
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
887
887
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
888
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
889
888
|
protected _agentResource: AxiosAgentResourceClient;
|
|
890
|
-
protected
|
|
889
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
890
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
891
891
|
protected _userResource: AxiosUserResourceClient;
|
|
892
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
893
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
892
894
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
893
|
-
protected _appResource: AxiosAppResourceClient;
|
|
894
895
|
protected _assetResource: AxiosAssetResourceClient;
|
|
895
|
-
protected
|
|
896
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
897
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
898
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
899
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
896
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
900
897
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
901
898
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
899
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
900
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
901
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
|
-
get
|
|
903
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
904
904
|
get RealmResource(): AxiosRealmResourceClient;
|
|
905
|
+
get AppResource(): AxiosAppResourceClient;
|
|
906
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
907
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
905
908
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
906
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
907
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
908
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
909
909
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
910
|
-
get MapResource(): AxiosMapResourceClient;
|
|
911
910
|
get AgentResource(): AxiosAgentResourceClient;
|
|
912
|
-
get
|
|
911
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
912
|
+
get MapResource(): AxiosMapResourceClient;
|
|
913
913
|
get UserResource(): AxiosUserResourceClient;
|
|
914
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
915
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
914
916
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
915
|
-
get AppResource(): AxiosAppResourceClient;
|
|
916
917
|
get AssetResource(): AxiosAssetResourceClient;
|
|
917
|
-
get
|
|
918
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
919
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
920
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
921
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
918
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
922
919
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
923
920
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
921
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
922
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
923
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -928,66 +928,66 @@ declare module "axios" {
|
|
|
928
928
|
data: R;
|
|
929
929
|
}
|
|
930
930
|
}
|
|
931
|
-
export declare class
|
|
931
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
934
|
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
949
|
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
|
-
export declare class
|
|
955
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
961
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
|
-
export declare class
|
|
988
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|
|
991
|
-
export declare class
|
|
991
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|