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