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