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