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