@openremote/rest 1.4.0-snapshot.20250228134346 → 1.4.0-snapshot.20250303163733
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.js +1 -1
- package/lib/restclient.d.ts +447 -447
- 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,15 +9,6 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class ConsoleResourceClient<O> {
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* HTTP POST /console/register
|
|
17
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
18
|
-
*/
|
|
19
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
20
|
-
}
|
|
21
12
|
export declare class AssetResourceClient<O> {
|
|
22
13
|
protected httpClient: HttpClient<O>;
|
|
23
14
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -122,279 +113,204 @@ export declare class AssetResourceClient<O> {
|
|
|
122
113
|
assetIds?: string[];
|
|
123
114
|
}, options?: O): RestResponse<void>;
|
|
124
115
|
}
|
|
125
|
-
export declare class
|
|
116
|
+
export declare class RealmResourceClient<O> {
|
|
126
117
|
protected httpClient: HttpClient<O>;
|
|
127
118
|
constructor(httpClient: HttpClient<O>);
|
|
128
119
|
/**
|
|
129
|
-
* HTTP
|
|
130
|
-
* Java method: org.openremote.model.
|
|
120
|
+
* HTTP POST /realm
|
|
121
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
131
122
|
*/
|
|
132
|
-
|
|
123
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
133
124
|
/**
|
|
134
|
-
* HTTP GET /
|
|
135
|
-
* Java method: org.openremote.model.
|
|
125
|
+
* HTTP GET /realm
|
|
126
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
136
127
|
*/
|
|
137
|
-
|
|
128
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
138
129
|
/**
|
|
139
|
-
* HTTP GET /
|
|
140
|
-
* Java method: org.openremote.model.
|
|
130
|
+
* HTTP GET /realm/accessible
|
|
131
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
141
132
|
*/
|
|
142
|
-
|
|
133
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
134
|
+
/**
|
|
135
|
+
* HTTP DELETE /realm/{name}
|
|
136
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
137
|
+
*/
|
|
138
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
139
|
+
/**
|
|
140
|
+
* HTTP GET /realm/{name}
|
|
141
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
142
|
+
*/
|
|
143
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
144
|
+
/**
|
|
145
|
+
* HTTP PUT /realm/{name}
|
|
146
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
147
|
+
*/
|
|
148
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
143
149
|
}
|
|
144
|
-
export declare class
|
|
150
|
+
export declare class FlowResourceClient<O> {
|
|
145
151
|
protected httpClient: HttpClient<O>;
|
|
146
152
|
constructor(httpClient: HttpClient<O>);
|
|
147
153
|
/**
|
|
148
|
-
* HTTP GET /
|
|
149
|
-
* Java method: org.openremote.model.
|
|
154
|
+
* HTTP GET /flow
|
|
155
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
150
156
|
*/
|
|
151
|
-
|
|
152
|
-
parentId?: string;
|
|
153
|
-
parentType?: string;
|
|
154
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
157
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
155
158
|
/**
|
|
156
|
-
* HTTP GET /
|
|
157
|
-
* Java method: org.openremote.model.
|
|
159
|
+
* HTTP GET /flow/{name}
|
|
160
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
158
161
|
*/
|
|
159
|
-
|
|
160
|
-
parentId?: string;
|
|
161
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
162
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
162
163
|
/**
|
|
163
|
-
* HTTP GET /
|
|
164
|
-
* Java method: org.openremote.model.
|
|
164
|
+
* HTTP GET /flow/{type}
|
|
165
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
165
166
|
*/
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
167
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
168
|
+
}
|
|
169
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
170
|
+
protected httpClient: HttpClient<O>;
|
|
171
|
+
constructor(httpClient: HttpClient<O>);
|
|
170
172
|
/**
|
|
171
|
-
* HTTP
|
|
172
|
-
* Java method: org.openremote.model.
|
|
173
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
174
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
173
175
|
*/
|
|
174
|
-
|
|
175
|
-
parentId?: string;
|
|
176
|
-
}, options?: O): RestResponse<{
|
|
177
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
178
|
-
}>;
|
|
176
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
179
177
|
/**
|
|
180
|
-
* HTTP
|
|
181
|
-
* Java method: org.openremote.model.
|
|
178
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
179
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
182
180
|
*/
|
|
183
|
-
|
|
184
|
-
parentId?: string;
|
|
185
|
-
}, options?: O): RestResponse<{
|
|
186
|
-
[index: string]: Model.ValueDescriptor;
|
|
187
|
-
}>;
|
|
181
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
188
182
|
}
|
|
189
|
-
export declare class
|
|
183
|
+
export declare class RulesResourceClient<O> {
|
|
190
184
|
protected httpClient: HttpClient<O>;
|
|
191
185
|
constructor(httpClient: HttpClient<O>);
|
|
192
186
|
/**
|
|
193
|
-
* HTTP
|
|
194
|
-
* Java method: org.openremote.model.
|
|
187
|
+
* HTTP POST /rules
|
|
188
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
195
189
|
*/
|
|
196
|
-
|
|
197
|
-
id?: number;
|
|
198
|
-
type?: string;
|
|
199
|
-
from?: number;
|
|
200
|
-
to?: number;
|
|
201
|
-
realmId?: string;
|
|
202
|
-
userId?: string;
|
|
203
|
-
assetId?: string;
|
|
204
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
190
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
205
191
|
/**
|
|
206
|
-
* HTTP
|
|
207
|
-
* Java method: org.openremote.model.
|
|
192
|
+
* HTTP GET /rules
|
|
193
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
208
194
|
*/
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
to?: number;
|
|
214
|
-
realmId?: string;
|
|
215
|
-
userId?: string;
|
|
216
|
-
assetId?: string;
|
|
217
|
-
}, options?: O): RestResponse<void>;
|
|
195
|
+
getGlobalRulesets(queryParams?: {
|
|
196
|
+
language?: Model.RulesetLang[];
|
|
197
|
+
fullyPopulate?: boolean;
|
|
198
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
218
199
|
/**
|
|
219
|
-
* HTTP POST /
|
|
220
|
-
* Java method: org.openremote.model.
|
|
200
|
+
* HTTP POST /rules/asset
|
|
201
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
221
202
|
*/
|
|
222
|
-
|
|
203
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
223
204
|
/**
|
|
224
|
-
* HTTP
|
|
225
|
-
* Java method: org.openremote.model.
|
|
205
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
206
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
226
207
|
*/
|
|
227
|
-
|
|
208
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
209
|
+
language?: Model.RulesetLang[];
|
|
210
|
+
fullyPopulate?: boolean;
|
|
211
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
228
212
|
/**
|
|
229
|
-
* HTTP
|
|
230
|
-
* Java method: org.openremote.model.
|
|
213
|
+
* HTTP DELETE /rules/asset/{id}
|
|
214
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
231
215
|
*/
|
|
232
|
-
|
|
233
|
-
targetId?: string;
|
|
234
|
-
}, options?: O): RestResponse<void>;
|
|
216
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
235
217
|
/**
|
|
236
|
-
* HTTP
|
|
237
|
-
* Java method: org.openremote.model.
|
|
218
|
+
* HTTP GET /rules/asset/{id}
|
|
219
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
238
220
|
*/
|
|
239
|
-
|
|
240
|
-
targetId?: string;
|
|
241
|
-
}, options?: O): RestResponse<void>;
|
|
242
|
-
}
|
|
243
|
-
export declare class ConfigurationResourceClient<O> {
|
|
244
|
-
protected httpClient: HttpClient<O>;
|
|
245
|
-
constructor(httpClient: HttpClient<O>);
|
|
221
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
246
222
|
/**
|
|
247
|
-
* HTTP
|
|
248
|
-
* Java method: org.openremote.model.
|
|
223
|
+
* HTTP PUT /rules/asset/{id}
|
|
224
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
249
225
|
*/
|
|
250
|
-
|
|
226
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
251
227
|
/**
|
|
252
|
-
* HTTP
|
|
253
|
-
* Java method: org.openremote.model.
|
|
228
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
229
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
254
230
|
*/
|
|
255
|
-
|
|
231
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
256
232
|
/**
|
|
257
|
-
* HTTP
|
|
258
|
-
* Java method: org.openremote.model.
|
|
233
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
234
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
259
235
|
*/
|
|
260
|
-
|
|
261
|
-
path?: string;
|
|
262
|
-
}, options?: O): RestResponse<string>;
|
|
236
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
263
237
|
/**
|
|
264
|
-
* HTTP GET /
|
|
265
|
-
* Java method: org.openremote.model.
|
|
238
|
+
* HTTP GET /rules/info/global
|
|
239
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
266
240
|
*/
|
|
267
|
-
|
|
268
|
-
}
|
|
269
|
-
export declare class DashboardResourceClient<O> {
|
|
270
|
-
protected httpClient: HttpClient<O>;
|
|
271
|
-
constructor(httpClient: HttpClient<O>);
|
|
241
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
272
242
|
/**
|
|
273
|
-
* HTTP
|
|
274
|
-
* Java method: org.openremote.model.
|
|
243
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
244
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
275
245
|
*/
|
|
276
|
-
|
|
246
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
277
247
|
/**
|
|
278
|
-
* HTTP
|
|
279
|
-
* Java method: org.openremote.model.
|
|
248
|
+
* HTTP POST /rules/realm
|
|
249
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
280
250
|
*/
|
|
281
|
-
|
|
251
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
282
252
|
/**
|
|
283
|
-
* HTTP GET /
|
|
284
|
-
* Java method: org.openremote.model.
|
|
253
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
254
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
285
255
|
*/
|
|
286
|
-
|
|
256
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
257
|
+
language?: Model.RulesetLang[];
|
|
258
|
+
fullyPopulate?: boolean;
|
|
259
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
287
260
|
/**
|
|
288
|
-
* HTTP
|
|
289
|
-
* Java method: org.openremote.model.
|
|
261
|
+
* HTTP DELETE /rules/realm/{id}
|
|
262
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
290
263
|
*/
|
|
291
|
-
|
|
264
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
292
265
|
/**
|
|
293
|
-
* HTTP
|
|
294
|
-
* Java method: org.openremote.model.
|
|
266
|
+
* HTTP GET /rules/realm/{id}
|
|
267
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
295
268
|
*/
|
|
296
|
-
|
|
269
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
297
270
|
/**
|
|
298
|
-
* HTTP
|
|
299
|
-
* Java method: org.openremote.model.
|
|
271
|
+
* HTTP PUT /rules/realm/{id}
|
|
272
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
300
273
|
*/
|
|
301
|
-
|
|
302
|
-
}
|
|
303
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
304
|
-
protected httpClient: HttpClient<O>;
|
|
305
|
-
constructor(httpClient: HttpClient<O>);
|
|
274
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
306
275
|
/**
|
|
307
|
-
* HTTP
|
|
308
|
-
* Java method: org.openremote.model.
|
|
276
|
+
* HTTP DELETE /rules/{id}
|
|
277
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
309
278
|
*/
|
|
310
|
-
|
|
279
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
311
280
|
/**
|
|
312
|
-
* HTTP
|
|
313
|
-
* Java method: org.openremote.model.
|
|
281
|
+
* HTTP GET /rules/{id}
|
|
282
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
314
283
|
*/
|
|
315
|
-
|
|
284
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
285
|
+
/**
|
|
286
|
+
* HTTP PUT /rules/{id}
|
|
287
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
288
|
+
*/
|
|
289
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
316
290
|
}
|
|
317
|
-
export declare class
|
|
291
|
+
export declare class ProvisioningResourceClient<O> {
|
|
318
292
|
protected httpClient: HttpClient<O>;
|
|
319
293
|
constructor(httpClient: HttpClient<O>);
|
|
320
294
|
/**
|
|
321
|
-
* HTTP POST /
|
|
322
|
-
* Java method: org.openremote.model.
|
|
323
|
-
*/
|
|
324
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
325
|
-
assetIds?: string[];
|
|
326
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
327
|
-
/**
|
|
328
|
-
* HTTP GET /alarm
|
|
329
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
330
|
-
*/
|
|
331
|
-
getAlarms(queryParams?: {
|
|
332
|
-
realm?: string;
|
|
333
|
-
status?: Model.AlarmStatus;
|
|
334
|
-
assetId?: string;
|
|
335
|
-
assigneeId?: string;
|
|
336
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
337
|
-
/**
|
|
338
|
-
* HTTP DELETE /alarm
|
|
339
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
340
|
-
*/
|
|
341
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
342
|
-
/**
|
|
343
|
-
* HTTP PUT /alarm/assets
|
|
344
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
345
|
-
*/
|
|
346
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
347
|
-
/**
|
|
348
|
-
* HTTP GET /alarm/{alarmId}
|
|
349
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
350
|
-
*/
|
|
351
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
352
|
-
/**
|
|
353
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
354
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
355
|
-
*/
|
|
356
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
357
|
-
/**
|
|
358
|
-
* HTTP PUT /alarm/{alarmId}
|
|
359
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
360
|
-
*/
|
|
361
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
362
|
-
/**
|
|
363
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
364
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
365
|
-
*/
|
|
366
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
367
|
-
realm?: string;
|
|
368
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
369
|
-
}
|
|
370
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
371
|
-
protected httpClient: HttpClient<O>;
|
|
372
|
-
constructor(httpClient: HttpClient<O>);
|
|
373
|
-
/**
|
|
374
|
-
* HTTP POST /gateway/tunnel
|
|
375
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
376
|
-
*/
|
|
377
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
378
|
-
/**
|
|
379
|
-
* HTTP DELETE /gateway/tunnel
|
|
380
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
295
|
+
* HTTP POST /provisioning
|
|
296
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
381
297
|
*/
|
|
382
|
-
|
|
298
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
383
299
|
/**
|
|
384
|
-
* HTTP GET /
|
|
385
|
-
* Java method: org.openremote.model.
|
|
300
|
+
* HTTP GET /provisioning
|
|
301
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
386
302
|
*/
|
|
387
|
-
|
|
303
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
388
304
|
/**
|
|
389
|
-
* HTTP
|
|
390
|
-
* Java method: org.openremote.model.
|
|
305
|
+
* HTTP DELETE /provisioning/{id}
|
|
306
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
391
307
|
*/
|
|
392
|
-
|
|
308
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
393
309
|
/**
|
|
394
|
-
* HTTP
|
|
395
|
-
* Java method: org.openremote.model.
|
|
310
|
+
* HTTP PUT /provisioning/{id}
|
|
311
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
396
312
|
*/
|
|
397
|
-
|
|
313
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
398
314
|
}
|
|
399
315
|
export declare class UserResourceClient<O> {
|
|
400
316
|
protected httpClient: HttpClient<O>;
|
|
@@ -520,24 +436,52 @@ export declare class UserResourceClient<O> {
|
|
|
520
436
|
*/
|
|
521
437
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
522
438
|
}
|
|
523
|
-
export declare class
|
|
439
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
524
440
|
protected httpClient: HttpClient<O>;
|
|
525
441
|
constructor(httpClient: HttpClient<O>);
|
|
526
442
|
/**
|
|
527
|
-
* HTTP
|
|
528
|
-
* Java method: org.openremote.model.
|
|
443
|
+
* HTTP POST /gateway/tunnel
|
|
444
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
529
445
|
*/
|
|
530
|
-
|
|
446
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
531
447
|
/**
|
|
532
|
-
* HTTP
|
|
533
|
-
* Java method: org.openremote.model.
|
|
448
|
+
* HTTP DELETE /gateway/tunnel
|
|
449
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
534
450
|
*/
|
|
535
|
-
|
|
451
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
536
452
|
/**
|
|
537
|
-
* HTTP GET /
|
|
538
|
-
* Java method: org.openremote.model.
|
|
453
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
454
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
539
455
|
*/
|
|
540
|
-
|
|
456
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
457
|
+
/**
|
|
458
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
459
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
460
|
+
*/
|
|
461
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
462
|
+
/**
|
|
463
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
464
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
465
|
+
*/
|
|
466
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
467
|
+
}
|
|
468
|
+
export declare class StatusResourceClient<O> {
|
|
469
|
+
protected httpClient: HttpClient<O>;
|
|
470
|
+
constructor(httpClient: HttpClient<O>);
|
|
471
|
+
/**
|
|
472
|
+
* HTTP GET /health
|
|
473
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
474
|
+
*/
|
|
475
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
476
|
+
[index: string]: any;
|
|
477
|
+
}>;
|
|
478
|
+
/**
|
|
479
|
+
* HTTP GET /info
|
|
480
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
481
|
+
*/
|
|
482
|
+
getInfo(options?: O): RestResponse<{
|
|
483
|
+
[index: string]: any;
|
|
484
|
+
}>;
|
|
541
485
|
}
|
|
542
486
|
export declare class SyslogResourceClient<O> {
|
|
543
487
|
protected httpClient: HttpClient<O>;
|
|
@@ -571,219 +515,239 @@ export declare class SyslogResourceClient<O> {
|
|
|
571
515
|
subCategory?: string[];
|
|
572
516
|
}, options?: O): RestResponse<any>;
|
|
573
517
|
}
|
|
574
|
-
export declare class
|
|
518
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
575
519
|
protected httpClient: HttpClient<O>;
|
|
576
520
|
constructor(httpClient: HttpClient<O>);
|
|
577
521
|
/**
|
|
578
|
-
* HTTP
|
|
579
|
-
* Java method: org.openremote.model.
|
|
580
|
-
*/
|
|
581
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
582
|
-
/**
|
|
583
|
-
* HTTP GET /rules
|
|
584
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
522
|
+
* HTTP GET /asset/datapoint/export
|
|
523
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
585
524
|
*/
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
525
|
+
getDatapointExport(queryParams?: {
|
|
526
|
+
attributeRefs?: string;
|
|
527
|
+
fromTimestamp?: number;
|
|
528
|
+
toTimestamp?: number;
|
|
529
|
+
}, options?: O): RestResponse<any>;
|
|
590
530
|
/**
|
|
591
|
-
* HTTP
|
|
592
|
-
* Java method: org.openremote.model.
|
|
531
|
+
* HTTP GET /asset/datapoint/periods
|
|
532
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
593
533
|
*/
|
|
594
|
-
|
|
534
|
+
getDatapointPeriod(queryParams?: {
|
|
535
|
+
assetId?: string;
|
|
536
|
+
attributeName?: string;
|
|
537
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
595
538
|
/**
|
|
596
|
-
* HTTP
|
|
597
|
-
* Java method: org.openremote.model.
|
|
539
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
540
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
598
541
|
*/
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
542
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
543
|
+
}
|
|
544
|
+
export declare class DashboardResourceClient<O> {
|
|
545
|
+
protected httpClient: HttpClient<O>;
|
|
546
|
+
constructor(httpClient: HttpClient<O>);
|
|
603
547
|
/**
|
|
604
|
-
* HTTP
|
|
605
|
-
* Java method: org.openremote.model.
|
|
548
|
+
* HTTP POST /dashboard
|
|
549
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
606
550
|
*/
|
|
607
|
-
|
|
551
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
608
552
|
/**
|
|
609
|
-
* HTTP
|
|
610
|
-
* Java method: org.openremote.model.
|
|
553
|
+
* HTTP PUT /dashboard
|
|
554
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
611
555
|
*/
|
|
612
|
-
|
|
556
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
613
557
|
/**
|
|
614
|
-
* HTTP
|
|
615
|
-
* Java method: org.openremote.model.
|
|
558
|
+
* HTTP GET /dashboard/all/{realm}
|
|
559
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
616
560
|
*/
|
|
617
|
-
|
|
561
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
618
562
|
/**
|
|
619
|
-
* HTTP
|
|
620
|
-
* Java method: org.openremote.model.
|
|
563
|
+
* HTTP POST /dashboard/query
|
|
564
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
621
565
|
*/
|
|
622
|
-
|
|
566
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
623
567
|
/**
|
|
624
|
-
* HTTP
|
|
625
|
-
* Java method: org.openremote.model.
|
|
568
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
569
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
626
570
|
*/
|
|
627
|
-
|
|
571
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
628
572
|
/**
|
|
629
|
-
* HTTP GET /
|
|
630
|
-
* Java method: org.openremote.model.
|
|
573
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
574
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
631
575
|
*/
|
|
632
|
-
|
|
576
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
577
|
+
}
|
|
578
|
+
export declare class AssetModelResourceClient<O> {
|
|
579
|
+
protected httpClient: HttpClient<O>;
|
|
580
|
+
constructor(httpClient: HttpClient<O>);
|
|
633
581
|
/**
|
|
634
|
-
* HTTP GET /
|
|
635
|
-
* Java method: org.openremote.model.
|
|
582
|
+
* HTTP GET /model/assetDescriptors
|
|
583
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
636
584
|
*/
|
|
637
|
-
|
|
585
|
+
getAssetDescriptors(queryParams?: {
|
|
586
|
+
parentId?: string;
|
|
587
|
+
parentType?: string;
|
|
588
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
638
589
|
/**
|
|
639
|
-
* HTTP
|
|
640
|
-
* Java method: org.openremote.model.
|
|
590
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
591
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
641
592
|
*/
|
|
642
|
-
|
|
593
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
594
|
+
parentId?: string;
|
|
595
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
643
596
|
/**
|
|
644
|
-
* HTTP GET /
|
|
645
|
-
* Java method: org.openremote.model.
|
|
597
|
+
* HTTP GET /model/assetInfos
|
|
598
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
646
599
|
*/
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
}, options?: O): RestResponse<Model.
|
|
600
|
+
getAssetInfos(queryParams?: {
|
|
601
|
+
parentId?: string;
|
|
602
|
+
parentType?: string;
|
|
603
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
651
604
|
/**
|
|
652
|
-
* HTTP
|
|
653
|
-
* Java method: org.openremote.model.
|
|
605
|
+
* HTTP GET /model/metaItemDescriptors
|
|
606
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
654
607
|
*/
|
|
655
|
-
|
|
608
|
+
getMetaItemDescriptors(queryParams?: {
|
|
609
|
+
parentId?: string;
|
|
610
|
+
}, options?: O): RestResponse<{
|
|
611
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
612
|
+
}>;
|
|
656
613
|
/**
|
|
657
|
-
* HTTP GET /
|
|
658
|
-
* Java method: org.openremote.model.
|
|
614
|
+
* HTTP GET /model/valueDescriptors
|
|
615
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
659
616
|
*/
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
*/
|
|
670
|
-
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
617
|
+
getValueDescriptors(queryParams?: {
|
|
618
|
+
parentId?: string;
|
|
619
|
+
}, options?: O): RestResponse<{
|
|
620
|
+
[index: string]: Model.ValueDescriptor;
|
|
621
|
+
}>;
|
|
622
|
+
}
|
|
623
|
+
export declare class NotificationResourceClient<O> {
|
|
624
|
+
protected httpClient: HttpClient<O>;
|
|
625
|
+
constructor(httpClient: HttpClient<O>);
|
|
671
626
|
/**
|
|
672
|
-
* HTTP GET /
|
|
673
|
-
* Java method: org.openremote.model.
|
|
627
|
+
* HTTP GET /notification
|
|
628
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
674
629
|
*/
|
|
675
|
-
|
|
630
|
+
getNotifications(queryParams?: {
|
|
631
|
+
id?: number;
|
|
632
|
+
type?: string;
|
|
633
|
+
from?: number;
|
|
634
|
+
to?: number;
|
|
635
|
+
realmId?: string;
|
|
636
|
+
userId?: string;
|
|
637
|
+
assetId?: string;
|
|
638
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
676
639
|
/**
|
|
677
|
-
* HTTP
|
|
678
|
-
* Java method: org.openremote.model.
|
|
640
|
+
* HTTP DELETE /notification
|
|
641
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
679
642
|
*/
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
643
|
+
removeNotifications(queryParams?: {
|
|
644
|
+
id?: number;
|
|
645
|
+
type?: string;
|
|
646
|
+
from?: number;
|
|
647
|
+
to?: number;
|
|
648
|
+
realmId?: string;
|
|
649
|
+
userId?: string;
|
|
650
|
+
assetId?: string;
|
|
651
|
+
}, options?: O): RestResponse<void>;
|
|
685
652
|
/**
|
|
686
|
-
* HTTP
|
|
687
|
-
* Java method: org.openremote.model.
|
|
653
|
+
* HTTP POST /notification/alert
|
|
654
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
688
655
|
*/
|
|
689
|
-
|
|
690
|
-
[id: string]: unknown;
|
|
691
|
-
}>;
|
|
656
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
692
657
|
/**
|
|
693
|
-
* HTTP
|
|
694
|
-
* Java method: org.openremote.model.
|
|
658
|
+
* HTTP DELETE /notification/{notificationId}
|
|
659
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
695
660
|
*/
|
|
696
|
-
|
|
697
|
-
[index: string]: Model.MapRealmConfig;
|
|
698
|
-
}, options?: O): RestResponse<any>;
|
|
661
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
699
662
|
/**
|
|
700
|
-
* HTTP
|
|
701
|
-
* Java method: org.openremote.model.
|
|
663
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
664
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
702
665
|
*/
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
}>;
|
|
666
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
667
|
+
targetId?: string;
|
|
668
|
+
}, options?: O): RestResponse<void>;
|
|
706
669
|
/**
|
|
707
|
-
* HTTP
|
|
708
|
-
* Java method: org.openremote.model.
|
|
670
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
671
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
709
672
|
*/
|
|
710
|
-
|
|
673
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
674
|
+
targetId?: string;
|
|
675
|
+
}, options?: O): RestResponse<void>;
|
|
711
676
|
}
|
|
712
|
-
export declare class
|
|
677
|
+
export declare class AppResourceClient<O> {
|
|
713
678
|
protected httpClient: HttpClient<O>;
|
|
714
679
|
constructor(httpClient: HttpClient<O>);
|
|
715
680
|
/**
|
|
716
|
-
* HTTP
|
|
717
|
-
* Java method: org.openremote.model.
|
|
718
|
-
*/
|
|
719
|
-
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
720
|
-
/**
|
|
721
|
-
* HTTP GET /provisioning
|
|
722
|
-
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
681
|
+
* HTTP GET /apps
|
|
682
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
723
683
|
*/
|
|
724
|
-
|
|
684
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
725
685
|
/**
|
|
726
|
-
* HTTP
|
|
727
|
-
* Java method: org.openremote.model.
|
|
686
|
+
* HTTP GET /apps/consoleConfig
|
|
687
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
728
688
|
*/
|
|
729
|
-
|
|
689
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
730
690
|
/**
|
|
731
|
-
* HTTP
|
|
732
|
-
* Java method: org.openremote.model.
|
|
691
|
+
* HTTP GET /apps/info
|
|
692
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
733
693
|
*/
|
|
734
|
-
|
|
694
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
735
695
|
}
|
|
736
|
-
export declare class
|
|
696
|
+
export declare class AgentResourceClient<O> {
|
|
737
697
|
protected httpClient: HttpClient<O>;
|
|
738
698
|
constructor(httpClient: HttpClient<O>);
|
|
739
699
|
/**
|
|
740
|
-
* HTTP GET /
|
|
741
|
-
* Java method: org.openremote.model.
|
|
700
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
701
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
742
702
|
*/
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
}>;
|
|
703
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
704
|
+
realm?: string;
|
|
705
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
746
706
|
/**
|
|
747
|
-
* HTTP
|
|
748
|
-
* Java method: org.openremote.model.
|
|
707
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
708
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
749
709
|
*/
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
}>;
|
|
710
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
711
|
+
realm?: string;
|
|
712
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
713
|
+
/**
|
|
714
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
715
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
716
|
+
*/
|
|
717
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
718
|
+
parentId?: string;
|
|
719
|
+
realm?: string;
|
|
720
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
753
721
|
}
|
|
754
|
-
export declare class
|
|
722
|
+
export declare class MapResourceClient<O> {
|
|
755
723
|
protected httpClient: HttpClient<O>;
|
|
756
724
|
constructor(httpClient: HttpClient<O>);
|
|
757
725
|
/**
|
|
758
|
-
* HTTP
|
|
759
|
-
* Java method: org.openremote.model.
|
|
760
|
-
*/
|
|
761
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
762
|
-
/**
|
|
763
|
-
* HTTP GET /realm
|
|
764
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
765
|
-
*/
|
|
766
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
767
|
-
/**
|
|
768
|
-
* HTTP GET /realm/accessible
|
|
769
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
726
|
+
* HTTP GET /map
|
|
727
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
770
728
|
*/
|
|
771
|
-
|
|
729
|
+
getSettings(options?: O): RestResponse<{
|
|
730
|
+
[id: string]: unknown;
|
|
731
|
+
}>;
|
|
772
732
|
/**
|
|
773
|
-
* HTTP
|
|
774
|
-
* Java method: org.openremote.model.
|
|
733
|
+
* HTTP PUT /map
|
|
734
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
775
735
|
*/
|
|
776
|
-
|
|
736
|
+
saveSettings(mapConfig: {
|
|
737
|
+
[index: string]: Model.MapRealmConfig;
|
|
738
|
+
}, options?: O): RestResponse<any>;
|
|
777
739
|
/**
|
|
778
|
-
* HTTP GET /
|
|
779
|
-
* Java method: org.openremote.model.
|
|
740
|
+
* HTTP GET /map/js
|
|
741
|
+
* Java method: org.openremote.model.map.MapResource.getSettingsJs
|
|
780
742
|
*/
|
|
781
|
-
|
|
743
|
+
getSettingsJs(options?: O): RestResponse<{
|
|
744
|
+
[id: string]: unknown;
|
|
745
|
+
}>;
|
|
782
746
|
/**
|
|
783
|
-
* HTTP
|
|
784
|
-
* Java method: org.openremote.model.
|
|
747
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
748
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
785
749
|
*/
|
|
786
|
-
|
|
750
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
787
751
|
}
|
|
788
752
|
export declare class GatewayClientResourceClient<O> {
|
|
789
753
|
protected httpClient: HttpClient<O>;
|
|
@@ -821,103 +785,139 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
821
785
|
*/
|
|
822
786
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
823
787
|
}
|
|
824
|
-
export declare class
|
|
788
|
+
export declare class AlarmResourceClient<O> {
|
|
825
789
|
protected httpClient: HttpClient<O>;
|
|
826
790
|
constructor(httpClient: HttpClient<O>);
|
|
827
791
|
/**
|
|
828
|
-
* HTTP
|
|
829
|
-
* Java method: org.openremote.model.
|
|
792
|
+
* HTTP POST /alarm
|
|
793
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
830
794
|
*/
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
toTimestamp?: number;
|
|
835
|
-
}, options?: O): RestResponse<any>;
|
|
795
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
796
|
+
assetIds?: string[];
|
|
797
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
836
798
|
/**
|
|
837
|
-
* HTTP GET /
|
|
838
|
-
* Java method: org.openremote.model.
|
|
799
|
+
* HTTP GET /alarm
|
|
800
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
839
801
|
*/
|
|
840
|
-
|
|
802
|
+
getAlarms(queryParams?: {
|
|
803
|
+
realm?: string;
|
|
804
|
+
status?: Model.AlarmStatus;
|
|
841
805
|
assetId?: string;
|
|
842
|
-
|
|
843
|
-
}, options?: O): RestResponse<Model.
|
|
806
|
+
assigneeId?: string;
|
|
807
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
844
808
|
/**
|
|
845
|
-
* HTTP
|
|
846
|
-
* Java method: org.openremote.model.
|
|
809
|
+
* HTTP DELETE /alarm
|
|
810
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
847
811
|
*/
|
|
848
|
-
|
|
812
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
813
|
+
/**
|
|
814
|
+
* HTTP PUT /alarm/assets
|
|
815
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
816
|
+
*/
|
|
817
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
818
|
+
/**
|
|
819
|
+
* HTTP GET /alarm/{alarmId}
|
|
820
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
821
|
+
*/
|
|
822
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
823
|
+
/**
|
|
824
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
825
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
826
|
+
*/
|
|
827
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
828
|
+
/**
|
|
829
|
+
* HTTP PUT /alarm/{alarmId}
|
|
830
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
831
|
+
*/
|
|
832
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
833
|
+
/**
|
|
834
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
835
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
836
|
+
*/
|
|
837
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
838
|
+
realm?: string;
|
|
839
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
849
840
|
}
|
|
850
|
-
export declare class
|
|
841
|
+
export declare class ConsoleResourceClient<O> {
|
|
851
842
|
protected httpClient: HttpClient<O>;
|
|
852
843
|
constructor(httpClient: HttpClient<O>);
|
|
853
844
|
/**
|
|
854
|
-
* HTTP
|
|
855
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* HTTP POST /console/register
|
|
846
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
856
847
|
*/
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
848
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
849
|
+
}
|
|
850
|
+
export declare class ConfigurationResourceClient<O> {
|
|
851
|
+
protected httpClient: HttpClient<O>;
|
|
852
|
+
constructor(httpClient: HttpClient<O>);
|
|
860
853
|
/**
|
|
861
|
-
* HTTP
|
|
862
|
-
* Java method: org.openremote.model.
|
|
854
|
+
* HTTP GET /configuration/manager
|
|
855
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
863
856
|
*/
|
|
864
|
-
|
|
865
|
-
realm?: string;
|
|
866
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
857
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
867
858
|
/**
|
|
868
|
-
* HTTP
|
|
869
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* HTTP PUT /configuration/manager
|
|
860
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
870
861
|
*/
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
862
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
863
|
+
/**
|
|
864
|
+
* HTTP POST /configuration/manager/file
|
|
865
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
866
|
+
*/
|
|
867
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
868
|
+
path?: string;
|
|
869
|
+
}, options?: O): RestResponse<string>;
|
|
870
|
+
/**
|
|
871
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
872
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
873
|
+
*/
|
|
874
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
875
875
|
}
|
|
876
876
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
877
877
|
export declare class ApiClient {
|
|
878
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
879
878
|
protected _assetResource: AxiosAssetResourceClient;
|
|
880
|
-
protected
|
|
881
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
882
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
883
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
884
|
-
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
885
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
886
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
887
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
888
|
-
protected _userResource: AxiosUserResourceClient;
|
|
879
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
889
880
|
protected _flowResource: AxiosFlowResourceClient;
|
|
890
|
-
protected
|
|
881
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
891
882
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
892
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
893
883
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
884
|
+
protected _userResource: AxiosUserResourceClient;
|
|
885
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
894
886
|
protected _statusResource: AxiosStatusResourceClient;
|
|
895
|
-
protected
|
|
896
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
887
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
897
888
|
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
889
|
+
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
890
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
891
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
892
|
+
protected _appResource: AxiosAppResourceClient;
|
|
898
893
|
protected _agentResource: AxiosAgentResourceClient;
|
|
894
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
895
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
896
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
897
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
898
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
899
899
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
900
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
901
900
|
get AssetResource(): AxiosAssetResourceClient;
|
|
902
|
-
get
|
|
903
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
904
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
905
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
906
|
-
get DashboardResource(): AxiosDashboardResourceClient;
|
|
907
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
908
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
909
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
910
|
-
get UserResource(): AxiosUserResourceClient;
|
|
901
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
911
902
|
get FlowResource(): AxiosFlowResourceClient;
|
|
912
|
-
get
|
|
903
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
913
904
|
get RulesResource(): AxiosRulesResourceClient;
|
|
914
|
-
get MapResource(): AxiosMapResourceClient;
|
|
915
905
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
906
|
+
get UserResource(): AxiosUserResourceClient;
|
|
907
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
916
908
|
get StatusResource(): AxiosStatusResourceClient;
|
|
917
|
-
get
|
|
918
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
909
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
919
910
|
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
911
|
+
get DashboardResource(): AxiosDashboardResourceClient;
|
|
912
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
913
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
914
|
+
get AppResource(): AxiosAppResourceClient;
|
|
920
915
|
get AgentResource(): AxiosAgentResourceClient;
|
|
916
|
+
get MapResource(): AxiosMapResourceClient;
|
|
917
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
918
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
919
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
920
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
921
921
|
}
|
|
922
922
|
import * as Axios from "axios";
|
|
923
923
|
declare module "axios" {
|
|
@@ -925,66 +925,66 @@ declare module "axios" {
|
|
|
925
925
|
data: R;
|
|
926
926
|
}
|
|
927
927
|
}
|
|
928
|
-
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
929
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
930
|
-
}
|
|
931
928
|
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
932
929
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
933
930
|
}
|
|
934
|
-
export declare class
|
|
931
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
935
932
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
936
933
|
}
|
|
937
|
-
export declare class
|
|
934
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
938
935
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
939
936
|
}
|
|
940
|
-
export declare class
|
|
937
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
941
938
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
942
939
|
}
|
|
943
|
-
export declare class
|
|
940
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
944
941
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
945
942
|
}
|
|
946
|
-
export declare class
|
|
943
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
947
944
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
948
945
|
}
|
|
949
|
-
export declare class
|
|
946
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
950
947
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
951
948
|
}
|
|
952
|
-
export declare class
|
|
949
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
953
950
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
954
951
|
}
|
|
955
|
-
export declare class
|
|
952
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
956
953
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
957
954
|
}
|
|
958
|
-
export declare class
|
|
955
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
959
956
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
960
957
|
}
|
|
961
|
-
export declare class
|
|
958
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
962
959
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
963
960
|
}
|
|
964
|
-
export declare class
|
|
961
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
965
962
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
966
963
|
}
|
|
967
|
-
export declare class
|
|
964
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
968
965
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
969
966
|
}
|
|
970
|
-
export declare class
|
|
967
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
971
968
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
972
969
|
}
|
|
973
|
-
export declare class
|
|
970
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
974
971
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
975
972
|
}
|
|
976
|
-
export declare class
|
|
973
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
977
974
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
978
975
|
}
|
|
979
|
-
export declare class
|
|
976
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
980
977
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
981
978
|
}
|
|
982
979
|
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
983
980
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
984
981
|
}
|
|
985
|
-
export declare class
|
|
982
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
986
983
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
984
|
}
|
|
988
|
-
export declare class
|
|
985
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
986
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
987
|
+
}
|
|
988
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
989
989
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
990
990
|
}
|