@openremote/rest 1.8.0-snapshot.20250723094757 → 1.8.0-snapshot.20250723203453
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +441 -441
- 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,91 +9,139 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class RulesResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
* HTTP
|
|
17
|
-
* Java method: org.openremote.model.
|
|
16
|
+
* HTTP POST /rules
|
|
17
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
18
18
|
*/
|
|
19
|
-
|
|
20
|
-
[id: string]: unknown;
|
|
21
|
-
}>;
|
|
19
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
22
20
|
/**
|
|
23
|
-
* HTTP
|
|
24
|
-
* Java method: org.openremote.model.
|
|
21
|
+
* HTTP GET /rules
|
|
22
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
25
23
|
*/
|
|
26
|
-
|
|
27
|
-
[
|
|
28
|
-
|
|
24
|
+
getGlobalRulesets(queryParams?: {
|
|
25
|
+
language?: Model.RulesetLang[];
|
|
26
|
+
fullyPopulate?: boolean;
|
|
27
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
29
28
|
/**
|
|
30
|
-
* HTTP
|
|
31
|
-
* Java method: org.openremote.model.
|
|
29
|
+
* HTTP POST /rules/asset
|
|
30
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
32
31
|
*/
|
|
33
|
-
|
|
34
|
-
[id: string]: unknown;
|
|
35
|
-
}>;
|
|
32
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
36
33
|
/**
|
|
37
|
-
* HTTP GET /
|
|
38
|
-
* Java method: org.openremote.model.
|
|
34
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
35
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
39
36
|
*/
|
|
40
|
-
|
|
41
|
-
[
|
|
42
|
-
|
|
37
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
38
|
+
language?: Model.RulesetLang[];
|
|
39
|
+
fullyPopulate?: boolean;
|
|
40
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
43
41
|
/**
|
|
44
|
-
* HTTP
|
|
45
|
-
* Java method: org.openremote.model.
|
|
42
|
+
* HTTP DELETE /rules/asset/{id}
|
|
43
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
46
44
|
*/
|
|
47
|
-
|
|
48
|
-
[id: string]: unknown;
|
|
49
|
-
}>;
|
|
45
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
50
46
|
/**
|
|
51
|
-
* HTTP GET /
|
|
52
|
-
* Java method: org.openremote.model.
|
|
47
|
+
* HTTP GET /rules/asset/{id}
|
|
48
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
53
49
|
*/
|
|
54
|
-
|
|
50
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
55
51
|
/**
|
|
56
|
-
* HTTP
|
|
57
|
-
* Java method: org.openremote.model.
|
|
52
|
+
* HTTP PUT /rules/asset/{id}
|
|
53
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
58
54
|
*/
|
|
59
|
-
|
|
60
|
-
filename?: string;
|
|
61
|
-
}, options?: O): RestResponse<{
|
|
62
|
-
[id: string]: unknown;
|
|
63
|
-
}>;
|
|
64
|
-
}
|
|
65
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
66
|
-
protected httpClient: HttpClient<O>;
|
|
67
|
-
constructor(httpClient: HttpClient<O>);
|
|
55
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
68
56
|
/**
|
|
69
|
-
* HTTP
|
|
70
|
-
* Java method: org.openremote.model.
|
|
57
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
58
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
71
59
|
*/
|
|
72
|
-
|
|
60
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
73
61
|
/**
|
|
74
|
-
* HTTP
|
|
75
|
-
* Java method: org.openremote.model.
|
|
62
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
63
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
76
64
|
*/
|
|
77
|
-
|
|
65
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
66
|
+
/**
|
|
67
|
+
* HTTP GET /rules/info/global
|
|
68
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
69
|
+
*/
|
|
70
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
71
|
+
/**
|
|
72
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
73
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
74
|
+
*/
|
|
75
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
76
|
+
/**
|
|
77
|
+
* HTTP POST /rules/realm
|
|
78
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
79
|
+
*/
|
|
80
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
81
|
+
/**
|
|
82
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
83
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
84
|
+
*/
|
|
85
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
86
|
+
language?: Model.RulesetLang[];
|
|
87
|
+
fullyPopulate?: boolean;
|
|
88
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
89
|
+
/**
|
|
90
|
+
* HTTP DELETE /rules/realm/{id}
|
|
91
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
92
|
+
*/
|
|
93
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
94
|
+
/**
|
|
95
|
+
* HTTP GET /rules/realm/{id}
|
|
96
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
97
|
+
*/
|
|
98
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
99
|
+
/**
|
|
100
|
+
* HTTP PUT /rules/realm/{id}
|
|
101
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
102
|
+
*/
|
|
103
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
104
|
+
/**
|
|
105
|
+
* HTTP DELETE /rules/{id}
|
|
106
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
107
|
+
*/
|
|
108
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
109
|
+
/**
|
|
110
|
+
* HTTP GET /rules/{id}
|
|
111
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
112
|
+
*/
|
|
113
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
114
|
+
/**
|
|
115
|
+
* HTTP PUT /rules/{id}
|
|
116
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
117
|
+
*/
|
|
118
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
78
119
|
}
|
|
79
|
-
export declare class
|
|
120
|
+
export declare class ConfigurationResourceClient<O> {
|
|
80
121
|
protected httpClient: HttpClient<O>;
|
|
81
122
|
constructor(httpClient: HttpClient<O>);
|
|
82
123
|
/**
|
|
83
|
-
* HTTP GET /
|
|
84
|
-
* Java method: org.openremote.model.
|
|
124
|
+
* HTTP GET /configuration/manager
|
|
125
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
85
126
|
*/
|
|
86
|
-
|
|
127
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
87
128
|
/**
|
|
88
|
-
* HTTP
|
|
89
|
-
* Java method: org.openremote.model.
|
|
129
|
+
* HTTP PUT /configuration/manager
|
|
130
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
90
131
|
*/
|
|
91
|
-
|
|
132
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
92
133
|
/**
|
|
93
|
-
* HTTP
|
|
94
|
-
* Java method: org.openremote.model.
|
|
134
|
+
* HTTP POST /configuration/manager/file
|
|
135
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
95
136
|
*/
|
|
96
|
-
|
|
137
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
138
|
+
path?: string;
|
|
139
|
+
}, options?: O): RestResponse<string>;
|
|
140
|
+
/**
|
|
141
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
142
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
143
|
+
*/
|
|
144
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
97
145
|
}
|
|
98
146
|
export declare class AssetDatapointResourceClient<O> {
|
|
99
147
|
protected httpClient: HttpClient<O>;
|
|
@@ -121,233 +169,138 @@ export declare class AssetDatapointResourceClient<O> {
|
|
|
121
169
|
*/
|
|
122
170
|
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
123
171
|
}
|
|
124
|
-
export declare class
|
|
172
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
125
173
|
protected httpClient: HttpClient<O>;
|
|
126
174
|
constructor(httpClient: HttpClient<O>);
|
|
127
175
|
/**
|
|
128
|
-
* HTTP
|
|
129
|
-
* Java method: org.openremote.model.
|
|
176
|
+
* HTTP POST /gateway/tunnel
|
|
177
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
130
178
|
*/
|
|
131
|
-
|
|
132
|
-
[index: string]: any;
|
|
133
|
-
}>;
|
|
179
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
134
180
|
/**
|
|
135
|
-
* HTTP
|
|
136
|
-
* Java method: org.openremote.model.
|
|
181
|
+
* HTTP DELETE /gateway/tunnel
|
|
182
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
137
183
|
*/
|
|
138
|
-
|
|
139
|
-
[index: string]: any;
|
|
140
|
-
}>;
|
|
141
|
-
}
|
|
142
|
-
export declare class RealmResourceClient<O> {
|
|
143
|
-
protected httpClient: HttpClient<O>;
|
|
144
|
-
constructor(httpClient: HttpClient<O>);
|
|
184
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
145
185
|
/**
|
|
146
|
-
* HTTP
|
|
147
|
-
* Java method: org.openremote.model.
|
|
186
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
187
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
148
188
|
*/
|
|
149
|
-
|
|
189
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
150
190
|
/**
|
|
151
|
-
* HTTP GET /realm
|
|
152
|
-
* Java method: org.openremote.model.
|
|
191
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
192
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
153
193
|
*/
|
|
154
|
-
|
|
194
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
155
195
|
/**
|
|
156
|
-
* HTTP GET /realm/
|
|
157
|
-
* Java method: org.openremote.model.
|
|
196
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
197
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
158
198
|
*/
|
|
159
|
-
|
|
199
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
200
|
+
}
|
|
201
|
+
export declare class FlowResourceClient<O> {
|
|
202
|
+
protected httpClient: HttpClient<O>;
|
|
203
|
+
constructor(httpClient: HttpClient<O>);
|
|
160
204
|
/**
|
|
161
|
-
* HTTP
|
|
162
|
-
* Java method: org.openremote.model.
|
|
205
|
+
* HTTP GET /flow
|
|
206
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
163
207
|
*/
|
|
164
|
-
|
|
208
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
165
209
|
/**
|
|
166
|
-
* HTTP GET /
|
|
167
|
-
* Java method: org.openremote.model.
|
|
210
|
+
* HTTP GET /flow/{name}
|
|
211
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
168
212
|
*/
|
|
169
|
-
|
|
213
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
170
214
|
/**
|
|
171
|
-
* HTTP
|
|
172
|
-
* Java method: org.openremote.model.
|
|
215
|
+
* HTTP GET /flow/{type}
|
|
216
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
173
217
|
*/
|
|
174
|
-
|
|
218
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
175
219
|
}
|
|
176
|
-
export declare class
|
|
220
|
+
export declare class DashboardResourceClient<O> {
|
|
177
221
|
protected httpClient: HttpClient<O>;
|
|
178
222
|
constructor(httpClient: HttpClient<O>);
|
|
179
223
|
/**
|
|
180
|
-
* HTTP
|
|
181
|
-
* Java method: org.openremote.model.
|
|
224
|
+
* HTTP POST /dashboard
|
|
225
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
182
226
|
*/
|
|
183
|
-
|
|
184
|
-
realm?: string[];
|
|
185
|
-
}, options?: O): RestResponse<void>;
|
|
227
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
186
228
|
/**
|
|
187
|
-
* HTTP
|
|
188
|
-
* Java method: org.openremote.model.
|
|
229
|
+
* HTTP PUT /dashboard
|
|
230
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
189
231
|
*/
|
|
190
|
-
|
|
232
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
191
233
|
/**
|
|
192
|
-
* HTTP
|
|
193
|
-
* Java method: org.openremote.model.
|
|
234
|
+
* HTTP GET /dashboard/all/{realm}
|
|
235
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
194
236
|
*/
|
|
195
|
-
|
|
237
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
196
238
|
/**
|
|
197
|
-
* HTTP
|
|
198
|
-
* Java method: org.openremote.model.
|
|
239
|
+
* HTTP POST /dashboard/query
|
|
240
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
199
241
|
*/
|
|
200
|
-
|
|
242
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
201
243
|
/**
|
|
202
|
-
* HTTP
|
|
203
|
-
* Java method: org.openremote.model.
|
|
244
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
245
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
204
246
|
*/
|
|
205
|
-
|
|
247
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
206
248
|
/**
|
|
207
|
-
* HTTP GET /
|
|
208
|
-
* Java method: org.openremote.model.
|
|
249
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
250
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
209
251
|
*/
|
|
210
|
-
|
|
252
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
211
253
|
}
|
|
212
|
-
export declare class
|
|
254
|
+
export declare class ConsoleResourceClient<O> {
|
|
213
255
|
protected httpClient: HttpClient<O>;
|
|
214
256
|
constructor(httpClient: HttpClient<O>);
|
|
215
257
|
/**
|
|
216
|
-
* HTTP
|
|
217
|
-
* Java method: org.openremote.model.
|
|
218
|
-
*/
|
|
219
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
220
|
-
/**
|
|
221
|
-
* HTTP PUT /syslog/config
|
|
222
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
223
|
-
*/
|
|
224
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
225
|
-
/**
|
|
226
|
-
* HTTP DELETE /syslog/event
|
|
227
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
228
|
-
*/
|
|
229
|
-
clearEvents(options?: O): RestResponse<void>;
|
|
230
|
-
/**
|
|
231
|
-
* HTTP GET /syslog/event
|
|
232
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
258
|
+
* HTTP POST /console/register
|
|
259
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
233
260
|
*/
|
|
234
|
-
|
|
235
|
-
level?: Model.SyslogLevel;
|
|
236
|
-
per_page?: number;
|
|
237
|
-
page?: number;
|
|
238
|
-
from?: number;
|
|
239
|
-
to?: number;
|
|
240
|
-
category?: Model.SyslogCategory[];
|
|
241
|
-
subCategory?: string[];
|
|
242
|
-
}, options?: O): RestResponse<any>;
|
|
261
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
243
262
|
}
|
|
244
|
-
export declare class
|
|
263
|
+
export declare class StatusResourceClient<O> {
|
|
245
264
|
protected httpClient: HttpClient<O>;
|
|
246
|
-
constructor(httpClient: HttpClient<O>);
|
|
247
|
-
/**
|
|
248
|
-
* HTTP POST /rules
|
|
249
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
250
|
-
*/
|
|
251
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
252
|
-
/**
|
|
253
|
-
* HTTP GET /rules
|
|
254
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
255
|
-
*/
|
|
256
|
-
getGlobalRulesets(queryParams?: {
|
|
257
|
-
language?: Model.RulesetLang[];
|
|
258
|
-
fullyPopulate?: boolean;
|
|
259
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
260
|
-
/**
|
|
261
|
-
* HTTP POST /rules/asset
|
|
262
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
263
|
-
*/
|
|
264
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
265
|
-
/**
|
|
266
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
267
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
268
|
-
*/
|
|
269
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
270
|
-
language?: Model.RulesetLang[];
|
|
271
|
-
fullyPopulate?: boolean;
|
|
272
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
273
|
-
/**
|
|
274
|
-
* HTTP DELETE /rules/asset/{id}
|
|
275
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
276
|
-
*/
|
|
277
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
278
|
-
/**
|
|
279
|
-
* HTTP GET /rules/asset/{id}
|
|
280
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
281
|
-
*/
|
|
282
|
-
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
283
|
-
/**
|
|
284
|
-
* HTTP PUT /rules/asset/{id}
|
|
285
|
-
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
286
|
-
*/
|
|
287
|
-
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
288
|
-
/**
|
|
289
|
-
* HTTP GET /rules/geofences/{assetId}
|
|
290
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
291
|
-
*/
|
|
292
|
-
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
293
|
-
/**
|
|
294
|
-
* HTTP GET /rules/info/asset/{assetId}
|
|
295
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
296
|
-
*/
|
|
297
|
-
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
298
|
-
/**
|
|
299
|
-
* HTTP GET /rules/info/global
|
|
300
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
301
|
-
*/
|
|
302
|
-
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
303
|
-
/**
|
|
304
|
-
* HTTP GET /rules/info/realm/{realm}
|
|
305
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
306
|
-
*/
|
|
307
|
-
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
308
|
-
/**
|
|
309
|
-
* HTTP POST /rules/realm
|
|
310
|
-
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
311
|
-
*/
|
|
312
|
-
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
313
|
-
/**
|
|
314
|
-
* HTTP GET /rules/realm/for/{realm}
|
|
315
|
-
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
316
|
-
*/
|
|
317
|
-
getRealmRulesets(realm: string, queryParams?: {
|
|
318
|
-
language?: Model.RulesetLang[];
|
|
319
|
-
fullyPopulate?: boolean;
|
|
320
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
265
|
+
constructor(httpClient: HttpClient<O>);
|
|
321
266
|
/**
|
|
322
|
-
* HTTP
|
|
323
|
-
* Java method: org.openremote.model.
|
|
267
|
+
* HTTP GET /health
|
|
268
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
324
269
|
*/
|
|
325
|
-
|
|
270
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
271
|
+
[index: string]: any;
|
|
272
|
+
}>;
|
|
326
273
|
/**
|
|
327
|
-
* HTTP GET /
|
|
328
|
-
* Java method: org.openremote.model.
|
|
274
|
+
* HTTP GET /info
|
|
275
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
329
276
|
*/
|
|
330
|
-
|
|
277
|
+
getInfo(options?: O): RestResponse<{
|
|
278
|
+
[index: string]: any;
|
|
279
|
+
}>;
|
|
280
|
+
}
|
|
281
|
+
export declare class ProvisioningResourceClient<O> {
|
|
282
|
+
protected httpClient: HttpClient<O>;
|
|
283
|
+
constructor(httpClient: HttpClient<O>);
|
|
331
284
|
/**
|
|
332
|
-
* HTTP
|
|
333
|
-
* Java method: org.openremote.model.
|
|
285
|
+
* HTTP POST /provisioning
|
|
286
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
334
287
|
*/
|
|
335
|
-
|
|
288
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
336
289
|
/**
|
|
337
|
-
* HTTP
|
|
338
|
-
* Java method: org.openremote.model.
|
|
290
|
+
* HTTP GET /provisioning
|
|
291
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
339
292
|
*/
|
|
340
|
-
|
|
293
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
341
294
|
/**
|
|
342
|
-
* HTTP
|
|
343
|
-
* Java method: org.openremote.model.
|
|
295
|
+
* HTTP DELETE /provisioning/{id}
|
|
296
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
344
297
|
*/
|
|
345
|
-
|
|
298
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
346
299
|
/**
|
|
347
|
-
* HTTP PUT /
|
|
348
|
-
* Java method: org.openremote.model.
|
|
300
|
+
* HTTP PUT /provisioning/{id}
|
|
301
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
349
302
|
*/
|
|
350
|
-
|
|
303
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
351
304
|
}
|
|
352
305
|
export declare class AssetModelResourceClient<O> {
|
|
353
306
|
protected httpClient: HttpClient<O>;
|
|
@@ -394,97 +347,171 @@ export declare class AssetModelResourceClient<O> {
|
|
|
394
347
|
[index: string]: Model.ValueDescriptor;
|
|
395
348
|
}>;
|
|
396
349
|
}
|
|
397
|
-
export declare class
|
|
350
|
+
export declare class SyslogResourceClient<O> {
|
|
398
351
|
protected httpClient: HttpClient<O>;
|
|
399
352
|
constructor(httpClient: HttpClient<O>);
|
|
400
353
|
/**
|
|
401
|
-
* HTTP GET /
|
|
402
|
-
* Java method: org.openremote.model.
|
|
354
|
+
* HTTP GET /syslog/config
|
|
355
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
403
356
|
*/
|
|
404
|
-
|
|
405
|
-
id?: number;
|
|
406
|
-
type?: string;
|
|
407
|
-
from?: number;
|
|
408
|
-
to?: number;
|
|
409
|
-
realmId?: string;
|
|
410
|
-
userId?: string;
|
|
411
|
-
assetId?: string;
|
|
412
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
357
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
413
358
|
/**
|
|
414
|
-
* HTTP
|
|
415
|
-
* Java method: org.openremote.model.
|
|
359
|
+
* HTTP PUT /syslog/config
|
|
360
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
416
361
|
*/
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
362
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
363
|
+
/**
|
|
364
|
+
* HTTP DELETE /syslog/event
|
|
365
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
366
|
+
*/
|
|
367
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
368
|
+
/**
|
|
369
|
+
* HTTP GET /syslog/event
|
|
370
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
371
|
+
*/
|
|
372
|
+
getEvents(queryParams?: {
|
|
373
|
+
level?: Model.SyslogLevel;
|
|
374
|
+
per_page?: number;
|
|
375
|
+
page?: number;
|
|
420
376
|
from?: number;
|
|
421
377
|
to?: number;
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
378
|
+
category?: Model.SyslogCategory[];
|
|
379
|
+
subCategory?: string[];
|
|
380
|
+
}, options?: O): RestResponse<any>;
|
|
381
|
+
}
|
|
382
|
+
export declare class GatewayClientResourceClient<O> {
|
|
383
|
+
protected httpClient: HttpClient<O>;
|
|
384
|
+
constructor(httpClient: HttpClient<O>);
|
|
385
|
+
/**
|
|
386
|
+
* HTTP DELETE /gateway/connection
|
|
387
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
388
|
+
*/
|
|
389
|
+
deleteConnections(queryParams?: {
|
|
390
|
+
realm?: string[];
|
|
425
391
|
}, options?: O): RestResponse<void>;
|
|
426
392
|
/**
|
|
427
|
-
* HTTP
|
|
428
|
-
* Java method: org.openremote.model.
|
|
393
|
+
* HTTP GET /gateway/connection
|
|
394
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
429
395
|
*/
|
|
430
|
-
|
|
396
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
431
397
|
/**
|
|
432
|
-
* HTTP DELETE /
|
|
433
|
-
* Java method: org.openremote.model.
|
|
398
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
399
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
434
400
|
*/
|
|
435
|
-
|
|
401
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
436
402
|
/**
|
|
437
|
-
* HTTP
|
|
438
|
-
* Java method: org.openremote.model.
|
|
403
|
+
* HTTP GET /gateway/connection/{realm}
|
|
404
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
439
405
|
*/
|
|
440
|
-
|
|
441
|
-
targetId?: string;
|
|
442
|
-
}, options?: O): RestResponse<void>;
|
|
406
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
443
407
|
/**
|
|
444
|
-
* HTTP PUT /
|
|
445
|
-
* Java method: org.openremote.model.
|
|
408
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
409
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
446
410
|
*/
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
411
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
412
|
+
/**
|
|
413
|
+
* HTTP GET /gateway/status/{realm}
|
|
414
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
415
|
+
*/
|
|
416
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
450
417
|
}
|
|
451
|
-
export declare class
|
|
418
|
+
export declare class MapResourceClient<O> {
|
|
452
419
|
protected httpClient: HttpClient<O>;
|
|
453
420
|
constructor(httpClient: HttpClient<O>);
|
|
454
421
|
/**
|
|
455
|
-
* HTTP
|
|
456
|
-
* Java method: org.openremote.model.
|
|
422
|
+
* HTTP GET /map
|
|
423
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
457
424
|
*/
|
|
458
|
-
|
|
425
|
+
getSettings(options?: O): RestResponse<{
|
|
426
|
+
[id: string]: unknown;
|
|
427
|
+
}>;
|
|
428
|
+
/**
|
|
429
|
+
* HTTP PUT /map
|
|
430
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
431
|
+
*/
|
|
432
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
433
|
+
[id: string]: unknown;
|
|
434
|
+
}>;
|
|
435
|
+
/**
|
|
436
|
+
* HTTP DELETE /map/deleteMap
|
|
437
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
438
|
+
*/
|
|
439
|
+
deleteMap(options?: O): RestResponse<{
|
|
440
|
+
[id: string]: unknown;
|
|
441
|
+
}>;
|
|
442
|
+
/**
|
|
443
|
+
* HTTP GET /map/getCustomMapInfo
|
|
444
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
445
|
+
*/
|
|
446
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
447
|
+
[id: string]: unknown;
|
|
448
|
+
}>;
|
|
449
|
+
/**
|
|
450
|
+
* HTTP GET /map/js
|
|
451
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
452
|
+
*/
|
|
453
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
454
|
+
[id: string]: unknown;
|
|
455
|
+
}>;
|
|
456
|
+
/**
|
|
457
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
458
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
459
|
+
*/
|
|
460
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
461
|
+
/**
|
|
462
|
+
* HTTP POST /map/upload
|
|
463
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
464
|
+
*/
|
|
465
|
+
uploadMap(queryParams?: {
|
|
466
|
+
filename?: string;
|
|
467
|
+
}, options?: O): RestResponse<{
|
|
468
|
+
[id: string]: unknown;
|
|
469
|
+
}>;
|
|
459
470
|
}
|
|
460
|
-
export declare class
|
|
471
|
+
export declare class AgentResourceClient<O> {
|
|
461
472
|
protected httpClient: HttpClient<O>;
|
|
462
473
|
constructor(httpClient: HttpClient<O>);
|
|
463
474
|
/**
|
|
464
|
-
* HTTP
|
|
465
|
-
* Java method: org.openremote.model.
|
|
475
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
476
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
466
477
|
*/
|
|
467
|
-
|
|
478
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
479
|
+
realm?: string;
|
|
480
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
468
481
|
/**
|
|
469
|
-
* HTTP
|
|
470
|
-
* Java method: org.openremote.model.
|
|
482
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
483
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
471
484
|
*/
|
|
472
|
-
|
|
485
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
486
|
+
realm?: string;
|
|
487
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
473
488
|
/**
|
|
474
|
-
* HTTP GET /
|
|
475
|
-
* Java method: org.openremote.model.
|
|
489
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
490
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
476
491
|
*/
|
|
477
|
-
|
|
492
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
493
|
+
parentId?: string;
|
|
494
|
+
realm?: string;
|
|
495
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
496
|
+
}
|
|
497
|
+
export declare class AppResourceClient<O> {
|
|
498
|
+
protected httpClient: HttpClient<O>;
|
|
499
|
+
constructor(httpClient: HttpClient<O>);
|
|
478
500
|
/**
|
|
479
|
-
* HTTP GET /
|
|
480
|
-
* Java method: org.openremote.model.
|
|
501
|
+
* HTTP GET /apps
|
|
502
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
481
503
|
*/
|
|
482
|
-
|
|
504
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
483
505
|
/**
|
|
484
|
-
* HTTP GET /
|
|
485
|
-
* Java method: org.openremote.model.
|
|
506
|
+
* HTTP GET /apps/consoleConfig
|
|
507
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
486
508
|
*/
|
|
487
|
-
|
|
509
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
510
|
+
/**
|
|
511
|
+
* HTTP GET /apps/info
|
|
512
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
513
|
+
*/
|
|
514
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
488
515
|
}
|
|
489
516
|
export declare class AssetResourceClient<O> {
|
|
490
517
|
protected httpClient: HttpClient<O>;
|
|
@@ -588,91 +615,109 @@ export declare class AssetResourceClient<O> {
|
|
|
588
615
|
*/
|
|
589
616
|
updateParent(parentAssetId: string, queryParams?: {
|
|
590
617
|
assetIds?: string[];
|
|
591
|
-
}, options?: O): RestResponse<void>;
|
|
592
|
-
}
|
|
593
|
-
export declare class ProvisioningResourceClient<O> {
|
|
594
|
-
protected httpClient: HttpClient<O>;
|
|
595
|
-
constructor(httpClient: HttpClient<O>);
|
|
596
|
-
/**
|
|
597
|
-
* HTTP POST /provisioning
|
|
598
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
599
|
-
*/
|
|
600
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
601
|
-
/**
|
|
602
|
-
* HTTP GET /provisioning
|
|
603
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
604
|
-
*/
|
|
605
|
-
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
606
|
-
/**
|
|
607
|
-
* HTTP DELETE /provisioning/{id}
|
|
608
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
609
|
-
*/
|
|
610
|
-
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
611
|
-
/**
|
|
612
|
-
* HTTP PUT /provisioning/{id}
|
|
613
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
614
|
-
*/
|
|
615
|
-
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
618
|
+
}, options?: O): RestResponse<void>;
|
|
616
619
|
}
|
|
617
|
-
export declare class
|
|
620
|
+
export declare class RealmResourceClient<O> {
|
|
618
621
|
protected httpClient: HttpClient<O>;
|
|
619
622
|
constructor(httpClient: HttpClient<O>);
|
|
620
623
|
/**
|
|
621
|
-
* HTTP
|
|
622
|
-
* Java method: org.openremote.model.
|
|
624
|
+
* HTTP POST /realm
|
|
625
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
623
626
|
*/
|
|
624
|
-
|
|
627
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
625
628
|
/**
|
|
626
|
-
* HTTP
|
|
627
|
-
* Java method: org.openremote.model.
|
|
629
|
+
* HTTP GET /realm
|
|
630
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
628
631
|
*/
|
|
629
|
-
|
|
632
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
630
633
|
/**
|
|
631
|
-
* HTTP
|
|
632
|
-
* Java method: org.openremote.model.
|
|
634
|
+
* HTTP GET /realm/accessible
|
|
635
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
633
636
|
*/
|
|
634
|
-
|
|
635
|
-
path?: string;
|
|
636
|
-
}, options?: O): RestResponse<string>;
|
|
637
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
637
638
|
/**
|
|
638
|
-
* HTTP
|
|
639
|
-
* Java method: org.openremote.model.
|
|
639
|
+
* HTTP DELETE /realm/{name}
|
|
640
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
640
641
|
*/
|
|
641
|
-
|
|
642
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
643
|
+
/**
|
|
644
|
+
* HTTP GET /realm/{name}
|
|
645
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
646
|
+
*/
|
|
647
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
648
|
+
/**
|
|
649
|
+
* HTTP PUT /realm/{name}
|
|
650
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
651
|
+
*/
|
|
652
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
642
653
|
}
|
|
643
|
-
export declare class
|
|
654
|
+
export declare class NotificationResourceClient<O> {
|
|
644
655
|
protected httpClient: HttpClient<O>;
|
|
645
656
|
constructor(httpClient: HttpClient<O>);
|
|
646
657
|
/**
|
|
647
|
-
* HTTP
|
|
648
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP GET /notification
|
|
659
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
649
660
|
*/
|
|
650
|
-
|
|
661
|
+
getNotifications(queryParams?: {
|
|
662
|
+
id?: number;
|
|
663
|
+
type?: string;
|
|
664
|
+
from?: number;
|
|
665
|
+
to?: number;
|
|
666
|
+
realmId?: string;
|
|
667
|
+
userId?: string;
|
|
668
|
+
assetId?: string;
|
|
669
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
651
670
|
/**
|
|
652
|
-
* HTTP
|
|
653
|
-
* Java method: org.openremote.model.
|
|
671
|
+
* HTTP DELETE /notification
|
|
672
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
654
673
|
*/
|
|
655
|
-
|
|
674
|
+
removeNotifications(queryParams?: {
|
|
675
|
+
id?: number;
|
|
676
|
+
type?: string;
|
|
677
|
+
from?: number;
|
|
678
|
+
to?: number;
|
|
679
|
+
realmId?: string;
|
|
680
|
+
userId?: string;
|
|
681
|
+
assetId?: string;
|
|
682
|
+
}, options?: O): RestResponse<void>;
|
|
656
683
|
/**
|
|
657
|
-
* HTTP
|
|
658
|
-
* Java method: org.openremote.model.
|
|
684
|
+
* HTTP POST /notification/alert
|
|
685
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
659
686
|
*/
|
|
660
|
-
|
|
687
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
661
688
|
/**
|
|
662
|
-
* HTTP
|
|
663
|
-
* Java method: org.openremote.model.
|
|
689
|
+
* HTTP DELETE /notification/{notificationId}
|
|
690
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
664
691
|
*/
|
|
665
|
-
|
|
692
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
666
693
|
/**
|
|
667
|
-
* HTTP
|
|
668
|
-
* Java method: org.openremote.model.
|
|
694
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
695
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
669
696
|
*/
|
|
670
|
-
|
|
697
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
698
|
+
targetId?: string;
|
|
699
|
+
}, options?: O): RestResponse<void>;
|
|
671
700
|
/**
|
|
672
|
-
* HTTP
|
|
673
|
-
* Java method: org.openremote.model.
|
|
701
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
702
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
674
703
|
*/
|
|
675
|
-
|
|
704
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
705
|
+
targetId?: string;
|
|
706
|
+
}, options?: O): RestResponse<void>;
|
|
707
|
+
}
|
|
708
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
709
|
+
protected httpClient: HttpClient<O>;
|
|
710
|
+
constructor(httpClient: HttpClient<O>);
|
|
711
|
+
/**
|
|
712
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
713
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
714
|
+
*/
|
|
715
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
716
|
+
/**
|
|
717
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
718
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
719
|
+
*/
|
|
720
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
676
721
|
}
|
|
677
722
|
export declare class AlarmResourceClient<O> {
|
|
678
723
|
protected httpClient: HttpClient<O>;
|
|
@@ -851,96 +896,51 @@ export declare class UserResourceClient<O> {
|
|
|
851
896
|
*/
|
|
852
897
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
853
898
|
}
|
|
854
|
-
export declare class AgentResourceClient<O> {
|
|
855
|
-
protected httpClient: HttpClient<O>;
|
|
856
|
-
constructor(httpClient: HttpClient<O>);
|
|
857
|
-
/**
|
|
858
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
859
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
860
|
-
*/
|
|
861
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
862
|
-
realm?: string;
|
|
863
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
864
|
-
/**
|
|
865
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
866
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
867
|
-
*/
|
|
868
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
869
|
-
realm?: string;
|
|
870
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
871
|
-
/**
|
|
872
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
873
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
874
|
-
*/
|
|
875
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
876
|
-
parentId?: string;
|
|
877
|
-
realm?: string;
|
|
878
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
879
|
-
}
|
|
880
|
-
export declare class AppResourceClient<O> {
|
|
881
|
-
protected httpClient: HttpClient<O>;
|
|
882
|
-
constructor(httpClient: HttpClient<O>);
|
|
883
|
-
/**
|
|
884
|
-
* HTTP GET /apps
|
|
885
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
886
|
-
*/
|
|
887
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
888
|
-
/**
|
|
889
|
-
* HTTP GET /apps/consoleConfig
|
|
890
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
891
|
-
*/
|
|
892
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
893
|
-
/**
|
|
894
|
-
* HTTP GET /apps/info
|
|
895
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
896
|
-
*/
|
|
897
|
-
getAppInfos(options?: O): RestResponse<any>;
|
|
898
|
-
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
902
|
-
protected
|
|
903
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
901
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
902
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
904
903
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
904
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
905
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
906
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
907
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
905
908
|
protected _statusResource: AxiosStatusResourceClient;
|
|
906
|
-
protected
|
|
907
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
908
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
909
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
909
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
910
910
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
911
|
-
protected
|
|
912
|
-
protected
|
|
913
|
-
protected
|
|
911
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
912
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
913
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
914
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
915
|
+
protected _appResource: AxiosAppResourceClient;
|
|
914
916
|
protected _assetResource: AxiosAssetResourceClient;
|
|
915
|
-
protected
|
|
916
|
-
protected
|
|
917
|
-
protected
|
|
917
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
918
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
919
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
918
920
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
919
921
|
protected _userResource: AxiosUserResourceClient;
|
|
920
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
921
|
-
protected _appResource: AxiosAppResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
924
|
-
get
|
|
925
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
923
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
924
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
926
925
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
926
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
927
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
928
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
929
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
927
930
|
get StatusResource(): AxiosStatusResourceClient;
|
|
928
|
-
get
|
|
929
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
930
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
931
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
931
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
932
932
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
933
|
-
get
|
|
934
|
-
get
|
|
935
|
-
get
|
|
933
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
934
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
935
|
+
get MapResource(): AxiosMapResourceClient;
|
|
936
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
937
|
+
get AppResource(): AxiosAppResourceClient;
|
|
936
938
|
get AssetResource(): AxiosAssetResourceClient;
|
|
937
|
-
get
|
|
938
|
-
get
|
|
939
|
-
get
|
|
939
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
940
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
941
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
940
942
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
941
943
|
get UserResource(): AxiosUserResourceClient;
|
|
942
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
943
|
-
get AppResource(): AxiosAppResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
|
-
export declare class
|
|
957
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
978
|
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|