@openremote/rest 1.7.0-snapshot.20250624092918 → 1.7.0-snapshot.20250625071311
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +442 -442
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -28,106 +28,42 @@ export declare class AppResourceClient<O> {
|
|
|
28
28
|
*/
|
|
29
29
|
getAppInfos(options?: O): RestResponse<any>;
|
|
30
30
|
}
|
|
31
|
-
export declare class
|
|
32
|
-
protected httpClient: HttpClient<O>;
|
|
33
|
-
constructor(httpClient: HttpClient<O>);
|
|
34
|
-
/**
|
|
35
|
-
* HTTP POST /gateway/tunnel
|
|
36
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
37
|
-
*/
|
|
38
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
39
|
-
/**
|
|
40
|
-
* HTTP DELETE /gateway/tunnel
|
|
41
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
42
|
-
*/
|
|
43
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
44
|
-
/**
|
|
45
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
46
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
47
|
-
*/
|
|
48
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
49
|
-
/**
|
|
50
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
51
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
52
|
-
*/
|
|
53
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
54
|
-
/**
|
|
55
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
56
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
57
|
-
*/
|
|
58
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
59
|
-
}
|
|
60
|
-
export declare class DashboardResourceClient<O> {
|
|
61
|
-
protected httpClient: HttpClient<O>;
|
|
62
|
-
constructor(httpClient: HttpClient<O>);
|
|
63
|
-
/**
|
|
64
|
-
* HTTP POST /dashboard
|
|
65
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
66
|
-
*/
|
|
67
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
68
|
-
/**
|
|
69
|
-
* HTTP PUT /dashboard
|
|
70
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
71
|
-
*/
|
|
72
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
73
|
-
/**
|
|
74
|
-
* HTTP GET /dashboard/all/{realm}
|
|
75
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
76
|
-
*/
|
|
77
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
78
|
-
/**
|
|
79
|
-
* HTTP POST /dashboard/query
|
|
80
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
81
|
-
*/
|
|
82
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
83
|
-
/**
|
|
84
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
85
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
86
|
-
*/
|
|
87
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
88
|
-
/**
|
|
89
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
90
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
91
|
-
*/
|
|
92
|
-
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
93
|
-
}
|
|
94
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
31
|
+
export declare class StatusResourceClient<O> {
|
|
95
32
|
protected httpClient: HttpClient<O>;
|
|
96
33
|
constructor(httpClient: HttpClient<O>);
|
|
97
34
|
/**
|
|
98
|
-
* HTTP
|
|
99
|
-
* Java method: org.openremote.model.
|
|
35
|
+
* HTTP GET /health
|
|
36
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
100
37
|
*/
|
|
101
|
-
|
|
38
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
39
|
+
[index: string]: any;
|
|
40
|
+
}>;
|
|
102
41
|
/**
|
|
103
|
-
* HTTP
|
|
104
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP GET /info
|
|
43
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
105
44
|
*/
|
|
106
|
-
|
|
45
|
+
getInfo(options?: O): RestResponse<{
|
|
46
|
+
[index: string]: any;
|
|
47
|
+
}>;
|
|
107
48
|
}
|
|
108
|
-
export declare class
|
|
49
|
+
export declare class FlowResourceClient<O> {
|
|
109
50
|
protected httpClient: HttpClient<O>;
|
|
110
51
|
constructor(httpClient: HttpClient<O>);
|
|
111
52
|
/**
|
|
112
|
-
* HTTP
|
|
113
|
-
* Java method: org.openremote.model.
|
|
114
|
-
*/
|
|
115
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
116
|
-
/**
|
|
117
|
-
* HTTP GET /provisioning
|
|
118
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
53
|
+
* HTTP GET /flow
|
|
54
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
119
55
|
*/
|
|
120
|
-
|
|
56
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
121
57
|
/**
|
|
122
|
-
* HTTP
|
|
123
|
-
* Java method: org.openremote.model.
|
|
58
|
+
* HTTP GET /flow/{name}
|
|
59
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
124
60
|
*/
|
|
125
|
-
|
|
61
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
126
62
|
/**
|
|
127
|
-
* HTTP
|
|
128
|
-
* Java method: org.openremote.model.
|
|
63
|
+
* HTTP GET /flow/{type}
|
|
64
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
129
65
|
*/
|
|
130
|
-
|
|
66
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
131
67
|
}
|
|
132
68
|
export declare class SyslogResourceClient<O> {
|
|
133
69
|
protected httpClient: HttpClient<O>;
|
|
@@ -161,215 +97,330 @@ export declare class SyslogResourceClient<O> {
|
|
|
161
97
|
subCategory?: string[];
|
|
162
98
|
}, options?: O): RestResponse<any>;
|
|
163
99
|
}
|
|
164
|
-
export declare class
|
|
100
|
+
export declare class RealmResourceClient<O> {
|
|
165
101
|
protected httpClient: HttpClient<O>;
|
|
166
102
|
constructor(httpClient: HttpClient<O>);
|
|
167
103
|
/**
|
|
168
|
-
* HTTP
|
|
169
|
-
* Java method: org.openremote.model.
|
|
104
|
+
* HTTP POST /realm
|
|
105
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
170
106
|
*/
|
|
171
|
-
|
|
107
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
172
108
|
/**
|
|
173
|
-
* HTTP
|
|
174
|
-
* Java method: org.openremote.model.
|
|
109
|
+
* HTTP GET /realm
|
|
110
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
175
111
|
*/
|
|
176
|
-
|
|
112
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
177
113
|
/**
|
|
178
|
-
* HTTP
|
|
179
|
-
* Java method: org.openremote.model.
|
|
114
|
+
* HTTP GET /realm/accessible
|
|
115
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
180
116
|
*/
|
|
181
|
-
|
|
182
|
-
path?: string;
|
|
183
|
-
}, options?: O): RestResponse<string>;
|
|
117
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
184
118
|
/**
|
|
185
|
-
* HTTP
|
|
186
|
-
* Java method: org.openremote.model.
|
|
119
|
+
* HTTP DELETE /realm/{name}
|
|
120
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
187
121
|
*/
|
|
188
|
-
|
|
122
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
123
|
+
/**
|
|
124
|
+
* HTTP GET /realm/{name}
|
|
125
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
126
|
+
*/
|
|
127
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
128
|
+
/**
|
|
129
|
+
* HTTP PUT /realm/{name}
|
|
130
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
131
|
+
*/
|
|
132
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
189
133
|
}
|
|
190
|
-
export declare class
|
|
134
|
+
export declare class AgentResourceClient<O> {
|
|
191
135
|
protected httpClient: HttpClient<O>;
|
|
192
136
|
constructor(httpClient: HttpClient<O>);
|
|
193
137
|
/**
|
|
194
|
-
* HTTP
|
|
195
|
-
* Java method: org.openremote.model.asset.
|
|
138
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
139
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
196
140
|
*/
|
|
197
|
-
|
|
141
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
142
|
+
realm?: string;
|
|
143
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
198
144
|
/**
|
|
199
|
-
* HTTP
|
|
200
|
-
* Java method: org.openremote.model.asset.
|
|
145
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
146
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
201
147
|
*/
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
}, options?: O): RestResponse<
|
|
148
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
149
|
+
realm?: string;
|
|
150
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
205
151
|
/**
|
|
206
|
-
* HTTP
|
|
207
|
-
* Java method: org.openremote.model.asset.
|
|
152
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
153
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
208
154
|
*/
|
|
209
|
-
|
|
155
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
156
|
+
parentId?: string;
|
|
157
|
+
realm?: string;
|
|
158
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
159
|
+
}
|
|
160
|
+
export declare class DashboardResourceClient<O> {
|
|
161
|
+
protected httpClient: HttpClient<O>;
|
|
162
|
+
constructor(httpClient: HttpClient<O>);
|
|
210
163
|
/**
|
|
211
|
-
* HTTP
|
|
212
|
-
* Java method: org.openremote.model.
|
|
164
|
+
* HTTP POST /dashboard
|
|
165
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
213
166
|
*/
|
|
214
|
-
|
|
167
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
215
168
|
/**
|
|
216
|
-
* HTTP
|
|
217
|
-
* Java method: org.openremote.model.
|
|
169
|
+
* HTTP PUT /dashboard
|
|
170
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
218
171
|
*/
|
|
219
|
-
|
|
220
|
-
assetIds?: string[];
|
|
221
|
-
}, options?: O): RestResponse<void>;
|
|
172
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
222
173
|
/**
|
|
223
|
-
* HTTP GET /
|
|
224
|
-
* Java method: org.openremote.model.
|
|
174
|
+
* HTTP GET /dashboard/all/{realm}
|
|
175
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
225
176
|
*/
|
|
226
|
-
|
|
177
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
227
178
|
/**
|
|
228
|
-
* HTTP POST /
|
|
229
|
-
* Java method: org.openremote.model.
|
|
179
|
+
* HTTP POST /dashboard/query
|
|
180
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
230
181
|
*/
|
|
231
|
-
|
|
182
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
232
183
|
/**
|
|
233
|
-
* HTTP
|
|
234
|
-
* Java method: org.openremote.model.
|
|
184
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
185
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
235
186
|
*/
|
|
236
|
-
|
|
187
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
237
188
|
/**
|
|
238
|
-
* HTTP
|
|
239
|
-
* Java method: org.openremote.model.
|
|
189
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
190
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
240
191
|
*/
|
|
241
|
-
|
|
192
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
193
|
+
}
|
|
194
|
+
export declare class AssetModelResourceClient<O> {
|
|
195
|
+
protected httpClient: HttpClient<O>;
|
|
196
|
+
constructor(httpClient: HttpClient<O>);
|
|
242
197
|
/**
|
|
243
|
-
* HTTP GET /
|
|
244
|
-
* Java method: org.openremote.model.asset.
|
|
198
|
+
* HTTP GET /model/assetDescriptors
|
|
199
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
245
200
|
*/
|
|
246
|
-
|
|
201
|
+
getAssetDescriptors(queryParams?: {
|
|
202
|
+
parentId?: string;
|
|
203
|
+
parentType?: string;
|
|
204
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
205
|
+
/**
|
|
206
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
207
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
208
|
+
*/
|
|
209
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
210
|
+
parentId?: string;
|
|
211
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
212
|
+
/**
|
|
213
|
+
* HTTP GET /model/assetInfos
|
|
214
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
215
|
+
*/
|
|
216
|
+
getAssetInfos(queryParams?: {
|
|
217
|
+
parentId?: string;
|
|
218
|
+
parentType?: string;
|
|
219
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
220
|
+
/**
|
|
221
|
+
* HTTP GET /model/metaItemDescriptors
|
|
222
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
223
|
+
*/
|
|
224
|
+
getMetaItemDescriptors(queryParams?: {
|
|
225
|
+
parentId?: string;
|
|
226
|
+
}, options?: O): RestResponse<{
|
|
227
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
228
|
+
}>;
|
|
229
|
+
/**
|
|
230
|
+
* HTTP GET /model/valueDescriptors
|
|
231
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
232
|
+
*/
|
|
233
|
+
getValueDescriptors(queryParams?: {
|
|
234
|
+
parentId?: string;
|
|
235
|
+
}, options?: O): RestResponse<{
|
|
236
|
+
[index: string]: Model.ValueDescriptor;
|
|
237
|
+
}>;
|
|
238
|
+
}
|
|
239
|
+
export declare class AlarmResourceClient<O> {
|
|
240
|
+
protected httpClient: HttpClient<O>;
|
|
241
|
+
constructor(httpClient: HttpClient<O>);
|
|
242
|
+
/**
|
|
243
|
+
* HTTP POST /alarm
|
|
244
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
245
|
+
*/
|
|
246
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
247
|
+
assetIds?: string[];
|
|
248
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
249
|
+
/**
|
|
250
|
+
* HTTP GET /alarm
|
|
251
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
252
|
+
*/
|
|
253
|
+
getAlarms(queryParams?: {
|
|
247
254
|
realm?: string;
|
|
248
|
-
|
|
255
|
+
status?: Model.AlarmStatus;
|
|
249
256
|
assetId?: string;
|
|
250
|
-
|
|
257
|
+
assigneeId?: string;
|
|
258
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
251
259
|
/**
|
|
252
|
-
* HTTP
|
|
253
|
-
* Java method: org.openremote.model.
|
|
260
|
+
* HTTP DELETE /alarm
|
|
261
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
254
262
|
*/
|
|
255
|
-
|
|
263
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
256
264
|
/**
|
|
257
|
-
* HTTP
|
|
258
|
-
* Java method: org.openremote.model.
|
|
265
|
+
* HTTP PUT /alarm/assets
|
|
266
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
259
267
|
*/
|
|
260
|
-
|
|
268
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
261
269
|
/**
|
|
262
|
-
* HTTP
|
|
263
|
-
* Java method: org.openremote.model.
|
|
270
|
+
* HTTP GET /alarm/{alarmId}
|
|
271
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
264
272
|
*/
|
|
265
|
-
|
|
273
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
266
274
|
/**
|
|
267
|
-
* HTTP
|
|
268
|
-
* Java method: org.openremote.model.
|
|
275
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
276
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
269
277
|
*/
|
|
270
|
-
|
|
278
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
271
279
|
/**
|
|
272
|
-
* HTTP PUT /
|
|
273
|
-
* Java method: org.openremote.model.
|
|
280
|
+
* HTTP PUT /alarm/{alarmId}
|
|
281
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
274
282
|
*/
|
|
275
|
-
|
|
283
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
276
284
|
/**
|
|
277
|
-
* HTTP
|
|
278
|
-
* Java method: org.openremote.model.
|
|
285
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
286
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
279
287
|
*/
|
|
280
|
-
|
|
288
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
289
|
+
realm?: string;
|
|
290
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
291
|
+
}
|
|
292
|
+
export declare class MapResourceClient<O> {
|
|
293
|
+
protected httpClient: HttpClient<O>;
|
|
294
|
+
constructor(httpClient: HttpClient<O>);
|
|
281
295
|
/**
|
|
282
|
-
* HTTP
|
|
283
|
-
* Java method: org.openremote.model.
|
|
296
|
+
* HTTP GET /map
|
|
297
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
284
298
|
*/
|
|
285
|
-
|
|
299
|
+
getSettings(options?: O): RestResponse<{
|
|
300
|
+
[id: string]: unknown;
|
|
301
|
+
}>;
|
|
286
302
|
/**
|
|
287
|
-
* HTTP PUT /
|
|
288
|
-
* Java method: org.openremote.model.
|
|
303
|
+
* HTTP PUT /map
|
|
304
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
289
305
|
*/
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
}
|
|
306
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
307
|
+
[id: string]: unknown;
|
|
308
|
+
}>;
|
|
309
|
+
/**
|
|
310
|
+
* HTTP DELETE /map/deleteMap
|
|
311
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
312
|
+
*/
|
|
313
|
+
deleteMap(options?: O): RestResponse<{
|
|
314
|
+
[id: string]: unknown;
|
|
315
|
+
}>;
|
|
316
|
+
/**
|
|
317
|
+
* HTTP GET /map/getCustomMapInfo
|
|
318
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
319
|
+
*/
|
|
320
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
321
|
+
[id: string]: unknown;
|
|
322
|
+
}>;
|
|
323
|
+
/**
|
|
324
|
+
* HTTP GET /map/js
|
|
325
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
326
|
+
*/
|
|
327
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
328
|
+
[id: string]: unknown;
|
|
329
|
+
}>;
|
|
330
|
+
/**
|
|
331
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
332
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
333
|
+
*/
|
|
334
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
335
|
+
/**
|
|
336
|
+
* HTTP POST /map/upload
|
|
337
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
338
|
+
*/
|
|
339
|
+
uploadMap(queryParams?: {
|
|
340
|
+
filename?: string;
|
|
341
|
+
}, options?: O): RestResponse<{
|
|
342
|
+
[id: string]: unknown;
|
|
343
|
+
}>;
|
|
293
344
|
}
|
|
294
|
-
export declare class
|
|
345
|
+
export declare class NotificationResourceClient<O> {
|
|
295
346
|
protected httpClient: HttpClient<O>;
|
|
296
347
|
constructor(httpClient: HttpClient<O>);
|
|
297
348
|
/**
|
|
298
|
-
* HTTP
|
|
299
|
-
* Java method: org.openremote.model.
|
|
300
|
-
*/
|
|
301
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
302
|
-
assetIds?: string[];
|
|
303
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
304
|
-
/**
|
|
305
|
-
* HTTP GET /alarm
|
|
306
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
349
|
+
* HTTP GET /notification
|
|
350
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
307
351
|
*/
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
352
|
+
getNotifications(queryParams?: {
|
|
353
|
+
id?: number;
|
|
354
|
+
type?: string;
|
|
355
|
+
from?: number;
|
|
356
|
+
to?: number;
|
|
357
|
+
realmId?: string;
|
|
358
|
+
userId?: string;
|
|
311
359
|
assetId?: string;
|
|
312
|
-
|
|
313
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
314
|
-
/**
|
|
315
|
-
* HTTP DELETE /alarm
|
|
316
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
317
|
-
*/
|
|
318
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
360
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
319
361
|
/**
|
|
320
|
-
* HTTP
|
|
321
|
-
* Java method: org.openremote.model.
|
|
362
|
+
* HTTP DELETE /notification
|
|
363
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
322
364
|
*/
|
|
323
|
-
|
|
365
|
+
removeNotifications(queryParams?: {
|
|
366
|
+
id?: number;
|
|
367
|
+
type?: string;
|
|
368
|
+
from?: number;
|
|
369
|
+
to?: number;
|
|
370
|
+
realmId?: string;
|
|
371
|
+
userId?: string;
|
|
372
|
+
assetId?: string;
|
|
373
|
+
}, options?: O): RestResponse<void>;
|
|
324
374
|
/**
|
|
325
|
-
* HTTP
|
|
326
|
-
* Java method: org.openremote.model.
|
|
375
|
+
* HTTP POST /notification/alert
|
|
376
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
327
377
|
*/
|
|
328
|
-
|
|
378
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
329
379
|
/**
|
|
330
|
-
* HTTP DELETE /
|
|
331
|
-
* Java method: org.openremote.model.
|
|
380
|
+
* HTTP DELETE /notification/{notificationId}
|
|
381
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
332
382
|
*/
|
|
333
|
-
|
|
383
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
334
384
|
/**
|
|
335
|
-
* HTTP PUT /
|
|
336
|
-
* Java method: org.openremote.model.
|
|
385
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
386
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
337
387
|
*/
|
|
338
|
-
|
|
388
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
389
|
+
targetId?: string;
|
|
390
|
+
}, options?: O): RestResponse<void>;
|
|
339
391
|
/**
|
|
340
|
-
* HTTP
|
|
341
|
-
* Java method: org.openremote.model.
|
|
392
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
393
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
342
394
|
*/
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
}, options?: O): RestResponse<
|
|
395
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
396
|
+
targetId?: string;
|
|
397
|
+
}, options?: O): RestResponse<void>;
|
|
346
398
|
}
|
|
347
|
-
export declare class
|
|
399
|
+
export declare class ConfigurationResourceClient<O> {
|
|
348
400
|
protected httpClient: HttpClient<O>;
|
|
349
401
|
constructor(httpClient: HttpClient<O>);
|
|
350
402
|
/**
|
|
351
|
-
* HTTP
|
|
352
|
-
* Java method: org.openremote.model.
|
|
403
|
+
* HTTP GET /configuration/manager
|
|
404
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
353
405
|
*/
|
|
354
|
-
|
|
355
|
-
}
|
|
356
|
-
export declare class StatusResourceClient<O> {
|
|
357
|
-
protected httpClient: HttpClient<O>;
|
|
358
|
-
constructor(httpClient: HttpClient<O>);
|
|
406
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
359
407
|
/**
|
|
360
|
-
* HTTP
|
|
361
|
-
* Java method: org.openremote.model.
|
|
408
|
+
* HTTP PUT /configuration/manager
|
|
409
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
362
410
|
*/
|
|
363
|
-
|
|
364
|
-
[index: string]: any;
|
|
365
|
-
}>;
|
|
411
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
366
412
|
/**
|
|
367
|
-
* HTTP
|
|
368
|
-
* Java method: org.openremote.model.
|
|
413
|
+
* HTTP POST /configuration/manager/file
|
|
414
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
369
415
|
*/
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
}>;
|
|
416
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
417
|
+
path?: string;
|
|
418
|
+
}, options?: O): RestResponse<string>;
|
|
419
|
+
/**
|
|
420
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
421
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
422
|
+
*/
|
|
423
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
373
424
|
}
|
|
374
425
|
export declare class GatewayClientResourceClient<O> {
|
|
375
426
|
protected httpClient: HttpClient<O>;
|
|
@@ -433,191 +484,118 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
433
484
|
*/
|
|
434
485
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
435
486
|
}
|
|
436
|
-
export declare class
|
|
487
|
+
export declare class AssetResourceClient<O> {
|
|
437
488
|
protected httpClient: HttpClient<O>;
|
|
438
489
|
constructor(httpClient: HttpClient<O>);
|
|
439
490
|
/**
|
|
440
|
-
* HTTP
|
|
441
|
-
* Java method: org.openremote.model.asset.
|
|
442
|
-
*/
|
|
443
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
444
|
-
realm?: string;
|
|
445
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
446
|
-
/**
|
|
447
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
448
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
491
|
+
* HTTP POST /asset
|
|
492
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
449
493
|
*/
|
|
450
|
-
|
|
451
|
-
realm?: string;
|
|
452
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
494
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
453
495
|
/**
|
|
454
|
-
* HTTP
|
|
455
|
-
* Java method: org.openremote.model.asset.
|
|
496
|
+
* HTTP DELETE /asset
|
|
497
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
456
498
|
*/
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
461
|
-
}
|
|
462
|
-
export declare class RealmResourceClient<O> {
|
|
463
|
-
protected httpClient: HttpClient<O>;
|
|
464
|
-
constructor(httpClient: HttpClient<O>);
|
|
499
|
+
delete(queryParams?: {
|
|
500
|
+
assetId?: string[];
|
|
501
|
+
}, options?: O): RestResponse<void>;
|
|
465
502
|
/**
|
|
466
|
-
* HTTP
|
|
467
|
-
* Java method: org.openremote.model.
|
|
503
|
+
* HTTP PUT /asset/attributes
|
|
504
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
468
505
|
*/
|
|
469
|
-
|
|
506
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
470
507
|
/**
|
|
471
|
-
* HTTP
|
|
472
|
-
* Java method: org.openremote.model.
|
|
508
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
509
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
473
510
|
*/
|
|
474
|
-
|
|
511
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
475
512
|
/**
|
|
476
|
-
* HTTP
|
|
477
|
-
* Java method: org.openremote.model.
|
|
513
|
+
* HTTP DELETE /asset/parent
|
|
514
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
478
515
|
*/
|
|
479
|
-
|
|
516
|
+
updateNoneParent(queryParams?: {
|
|
517
|
+
assetIds?: string[];
|
|
518
|
+
}, options?: O): RestResponse<void>;
|
|
480
519
|
/**
|
|
481
|
-
* HTTP
|
|
482
|
-
* Java method: org.openremote.model.
|
|
520
|
+
* HTTP GET /asset/partial/{assetId}
|
|
521
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
483
522
|
*/
|
|
484
|
-
|
|
523
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
485
524
|
/**
|
|
486
|
-
* HTTP
|
|
487
|
-
* Java method: org.openremote.model.
|
|
525
|
+
* HTTP POST /asset/query
|
|
526
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
488
527
|
*/
|
|
489
|
-
|
|
528
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
490
529
|
/**
|
|
491
|
-
* HTTP
|
|
492
|
-
* Java method: org.openremote.model.
|
|
530
|
+
* HTTP GET /asset/user/current
|
|
531
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
493
532
|
*/
|
|
494
|
-
|
|
495
|
-
}
|
|
496
|
-
export declare class NotificationResourceClient<O> {
|
|
497
|
-
protected httpClient: HttpClient<O>;
|
|
498
|
-
constructor(httpClient: HttpClient<O>);
|
|
533
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
499
534
|
/**
|
|
500
|
-
* HTTP
|
|
501
|
-
* Java method: org.openremote.model.
|
|
535
|
+
* HTTP POST /asset/user/link
|
|
536
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
502
537
|
*/
|
|
503
|
-
|
|
504
|
-
id?: number;
|
|
505
|
-
type?: string;
|
|
506
|
-
from?: number;
|
|
507
|
-
to?: number;
|
|
508
|
-
realmId?: string;
|
|
509
|
-
userId?: string;
|
|
510
|
-
assetId?: string;
|
|
511
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
538
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
512
539
|
/**
|
|
513
|
-
* HTTP
|
|
514
|
-
* Java method: org.openremote.model.
|
|
540
|
+
* HTTP GET /asset/user/link
|
|
541
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
515
542
|
*/
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
type?: string;
|
|
519
|
-
from?: number;
|
|
520
|
-
to?: number;
|
|
521
|
-
realmId?: string;
|
|
543
|
+
getUserAssetLinks(queryParams?: {
|
|
544
|
+
realm?: string;
|
|
522
545
|
userId?: string;
|
|
523
546
|
assetId?: string;
|
|
524
|
-
}, options?: O): RestResponse<
|
|
525
|
-
/**
|
|
526
|
-
* HTTP POST /notification/alert
|
|
527
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
528
|
-
*/
|
|
529
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
530
|
-
/**
|
|
531
|
-
* HTTP DELETE /notification/{notificationId}
|
|
532
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
533
|
-
*/
|
|
534
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
535
|
-
/**
|
|
536
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
537
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
538
|
-
*/
|
|
539
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
540
|
-
targetId?: string;
|
|
541
|
-
}, options?: O): RestResponse<void>;
|
|
547
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
542
548
|
/**
|
|
543
|
-
* HTTP
|
|
544
|
-
* Java method: org.openremote.model.
|
|
549
|
+
* HTTP POST /asset/user/link/delete
|
|
550
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
545
551
|
*/
|
|
546
|
-
|
|
547
|
-
targetId?: string;
|
|
548
|
-
}, options?: O): RestResponse<void>;
|
|
549
|
-
}
|
|
550
|
-
export declare class MapResourceClient<O> {
|
|
551
|
-
protected httpClient: HttpClient<O>;
|
|
552
|
-
constructor(httpClient: HttpClient<O>);
|
|
552
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
553
553
|
/**
|
|
554
|
-
* HTTP
|
|
555
|
-
* Java method: org.openremote.model.
|
|
554
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
555
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
556
556
|
*/
|
|
557
|
-
|
|
558
|
-
[id: string]: unknown;
|
|
559
|
-
}>;
|
|
557
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
560
558
|
/**
|
|
561
|
-
* HTTP
|
|
562
|
-
* Java method: org.openremote.model.
|
|
559
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
560
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
563
561
|
*/
|
|
564
|
-
|
|
565
|
-
[id: string]: unknown;
|
|
566
|
-
}>;
|
|
562
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
567
563
|
/**
|
|
568
|
-
* HTTP
|
|
569
|
-
* Java method: org.openremote.model.
|
|
564
|
+
* HTTP GET /asset/{assetId}
|
|
565
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
570
566
|
*/
|
|
571
|
-
|
|
572
|
-
[id: string]: unknown;
|
|
573
|
-
}>;
|
|
567
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
574
568
|
/**
|
|
575
|
-
* HTTP
|
|
576
|
-
* Java method: org.openremote.model.
|
|
569
|
+
* HTTP PUT /asset/{assetId}
|
|
570
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
577
571
|
*/
|
|
578
|
-
|
|
579
|
-
[id: string]: unknown;
|
|
580
|
-
}>;
|
|
572
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
581
573
|
/**
|
|
582
|
-
* HTTP
|
|
583
|
-
* Java method: org.openremote.model.
|
|
574
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
575
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
584
576
|
*/
|
|
585
|
-
|
|
586
|
-
[id: string]: unknown;
|
|
587
|
-
}>;
|
|
577
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
588
578
|
/**
|
|
589
|
-
* HTTP
|
|
590
|
-
* Java method: org.openremote.model.
|
|
579
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
580
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
591
581
|
*/
|
|
592
|
-
|
|
582
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
593
583
|
/**
|
|
594
|
-
* HTTP
|
|
595
|
-
* Java method: org.openremote.model.
|
|
584
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
585
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
596
586
|
*/
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
}, options?: O): RestResponse<
|
|
600
|
-
[id: string]: unknown;
|
|
601
|
-
}>;
|
|
587
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
588
|
+
assetIds?: string[];
|
|
589
|
+
}, options?: O): RestResponse<void>;
|
|
602
590
|
}
|
|
603
|
-
export declare class
|
|
591
|
+
export declare class ConsoleResourceClient<O> {
|
|
604
592
|
protected httpClient: HttpClient<O>;
|
|
605
593
|
constructor(httpClient: HttpClient<O>);
|
|
606
594
|
/**
|
|
607
|
-
* HTTP
|
|
608
|
-
* Java method: org.openremote.model.
|
|
609
|
-
*/
|
|
610
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
611
|
-
/**
|
|
612
|
-
* HTTP GET /flow/{name}
|
|
613
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
614
|
-
*/
|
|
615
|
-
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
616
|
-
/**
|
|
617
|
-
* HTTP GET /flow/{type}
|
|
618
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
595
|
+
* HTTP POST /console/register
|
|
596
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
619
597
|
*/
|
|
620
|
-
|
|
598
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
621
599
|
}
|
|
622
600
|
export declare class RulesResourceClient<O> {
|
|
623
601
|
protected httpClient: HttpClient<O>;
|
|
@@ -727,6 +705,59 @@ export declare class RulesResourceClient<O> {
|
|
|
727
705
|
*/
|
|
728
706
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
729
707
|
}
|
|
708
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
709
|
+
protected httpClient: HttpClient<O>;
|
|
710
|
+
constructor(httpClient: HttpClient<O>);
|
|
711
|
+
/**
|
|
712
|
+
* HTTP POST /gateway/tunnel
|
|
713
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
714
|
+
*/
|
|
715
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
716
|
+
/**
|
|
717
|
+
* HTTP DELETE /gateway/tunnel
|
|
718
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
719
|
+
*/
|
|
720
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
721
|
+
/**
|
|
722
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
723
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
724
|
+
*/
|
|
725
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
726
|
+
/**
|
|
727
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
728
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
729
|
+
*/
|
|
730
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
731
|
+
/**
|
|
732
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
733
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
734
|
+
*/
|
|
735
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
736
|
+
}
|
|
737
|
+
export declare class ProvisioningResourceClient<O> {
|
|
738
|
+
protected httpClient: HttpClient<O>;
|
|
739
|
+
constructor(httpClient: HttpClient<O>);
|
|
740
|
+
/**
|
|
741
|
+
* HTTP POST /provisioning
|
|
742
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
743
|
+
*/
|
|
744
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
745
|
+
/**
|
|
746
|
+
* HTTP GET /provisioning
|
|
747
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
748
|
+
*/
|
|
749
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
750
|
+
/**
|
|
751
|
+
* HTTP DELETE /provisioning/{id}
|
|
752
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
753
|
+
*/
|
|
754
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
755
|
+
/**
|
|
756
|
+
* HTTP PUT /provisioning/{id}
|
|
757
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
758
|
+
*/
|
|
759
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
760
|
+
}
|
|
730
761
|
export declare class UserResourceClient<O> {
|
|
731
762
|
protected httpClient: HttpClient<O>;
|
|
732
763
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -831,96 +862,65 @@ export declare class UserResourceClient<O> {
|
|
|
831
862
|
*/
|
|
832
863
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
833
864
|
}
|
|
834
|
-
export declare class
|
|
865
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
835
866
|
protected httpClient: HttpClient<O>;
|
|
836
867
|
constructor(httpClient: HttpClient<O>);
|
|
837
868
|
/**
|
|
838
|
-
* HTTP
|
|
839
|
-
* Java method: org.openremote.model.
|
|
840
|
-
*/
|
|
841
|
-
getAssetDescriptors(queryParams?: {
|
|
842
|
-
parentId?: string;
|
|
843
|
-
parentType?: string;
|
|
844
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
845
|
-
/**
|
|
846
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
847
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
848
|
-
*/
|
|
849
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
850
|
-
parentId?: string;
|
|
851
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
852
|
-
/**
|
|
853
|
-
* HTTP GET /model/assetInfos
|
|
854
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
855
|
-
*/
|
|
856
|
-
getAssetInfos(queryParams?: {
|
|
857
|
-
parentId?: string;
|
|
858
|
-
parentType?: string;
|
|
859
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
860
|
-
/**
|
|
861
|
-
* HTTP GET /model/metaItemDescriptors
|
|
862
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
869
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
870
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
863
871
|
*/
|
|
864
|
-
|
|
865
|
-
parentId?: string;
|
|
866
|
-
}, options?: O): RestResponse<{
|
|
867
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
868
|
-
}>;
|
|
872
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
869
873
|
/**
|
|
870
|
-
* HTTP
|
|
871
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
875
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
872
876
|
*/
|
|
873
|
-
|
|
874
|
-
parentId?: string;
|
|
875
|
-
}, options?: O): RestResponse<{
|
|
876
|
-
[index: string]: Model.ValueDescriptor;
|
|
877
|
-
}>;
|
|
877
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
878
878
|
}
|
|
879
879
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
880
880
|
export declare class ApiClient {
|
|
881
881
|
protected _appResource: AxiosAppResourceClient;
|
|
882
|
-
protected
|
|
883
|
-
protected
|
|
884
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
885
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
882
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
883
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
886
884
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
887
|
-
protected
|
|
888
|
-
protected
|
|
885
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
886
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
887
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
888
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
889
889
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
890
|
-
protected
|
|
891
|
-
protected
|
|
890
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
891
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
892
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
892
893
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
893
894
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
894
|
-
protected
|
|
895
|
-
protected
|
|
896
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
897
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
898
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
895
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
896
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
899
897
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
898
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
899
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
900
900
|
protected _userResource: AxiosUserResourceClient;
|
|
901
|
-
protected
|
|
901
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
902
902
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
903
903
|
get AppResource(): AxiosAppResourceClient;
|
|
904
|
-
get
|
|
905
|
-
get
|
|
906
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
907
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
904
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
905
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
908
906
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
909
|
-
get
|
|
910
|
-
get
|
|
907
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
908
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
909
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
910
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
911
911
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
912
|
-
get
|
|
913
|
-
get
|
|
912
|
+
get MapResource(): AxiosMapResourceClient;
|
|
913
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
914
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
914
915
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
915
916
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
916
|
-
get
|
|
917
|
-
get
|
|
918
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
919
|
-
get MapResource(): AxiosMapResourceClient;
|
|
920
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
917
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
918
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
921
919
|
get RulesResource(): AxiosRulesResourceClient;
|
|
920
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
921
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
922
922
|
get UserResource(): AxiosUserResourceClient;
|
|
923
|
-
get
|
|
923
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
924
924
|
}
|
|
925
925
|
import * as Axios from "axios";
|
|
926
926
|
declare module "axios" {
|
|
@@ -931,63 +931,63 @@ declare module "axios" {
|
|
|
931
931
|
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
932
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
933
|
}
|
|
934
|
-
export declare class
|
|
934
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
935
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
936
|
}
|
|
937
|
-
export declare class
|
|
937
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
938
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
939
|
}
|
|
940
|
-
export declare class
|
|
940
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
941
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
942
|
}
|
|
943
|
-
export declare class
|
|
943
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
944
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
945
|
}
|
|
946
|
-
export declare class
|
|
946
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
947
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
948
|
}
|
|
949
|
-
export declare class
|
|
949
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
950
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
951
|
}
|
|
952
|
-
export declare class
|
|
952
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
953
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
954
|
}
|
|
955
955
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
956
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
957
|
}
|
|
958
|
-
export declare class
|
|
958
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
959
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
960
|
}
|
|
961
|
-
export declare class
|
|
961
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
962
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
963
|
}
|
|
964
|
-
export declare class
|
|
964
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
965
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
966
|
}
|
|
967
|
-
export declare class
|
|
967
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
968
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
969
|
}
|
|
970
|
-
export declare class
|
|
970
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
971
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
972
|
}
|
|
973
|
-
export declare class
|
|
973
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
974
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
975
|
}
|
|
976
|
-
export declare class
|
|
976
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
977
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
978
|
}
|
|
979
|
-
export declare class
|
|
979
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
980
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
981
|
}
|
|
982
|
-
export declare class
|
|
982
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
983
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
984
|
}
|
|
985
|
-
export declare class
|
|
985
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
986
986
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
987
|
}
|
|
988
988
|
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|
|
991
|
-
export declare class
|
|
991
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
992
992
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
993
993
|
}
|