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