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