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