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