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