@openremote/rest 1.9.0-snapshot.20250915151349 → 1.9.0-snapshot.20250919113633
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 +463 -463
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +3 -3
package/lib/restclient.d.ts
CHANGED
|
@@ -9,6 +9,217 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
17
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
18
|
+
*/
|
|
19
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
20
|
+
/**
|
|
21
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
22
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
23
|
+
*/
|
|
24
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
25
|
+
}
|
|
26
|
+
export declare class AppResourceClient<O> {
|
|
27
|
+
protected httpClient: HttpClient<O>;
|
|
28
|
+
constructor(httpClient: HttpClient<O>);
|
|
29
|
+
/**
|
|
30
|
+
* HTTP GET /apps
|
|
31
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
32
|
+
*/
|
|
33
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
34
|
+
/**
|
|
35
|
+
* HTTP GET /apps/consoleConfig
|
|
36
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
37
|
+
*/
|
|
38
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
39
|
+
/**
|
|
40
|
+
* HTTP GET /apps/info
|
|
41
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
42
|
+
*/
|
|
43
|
+
getAppInfos(options?: O): RestResponse<any>;
|
|
44
|
+
}
|
|
45
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
46
|
+
protected httpClient: HttpClient<O>;
|
|
47
|
+
constructor(httpClient: HttpClient<O>);
|
|
48
|
+
/**
|
|
49
|
+
* HTTP POST /gateway/tunnel
|
|
50
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
51
|
+
*/
|
|
52
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
53
|
+
/**
|
|
54
|
+
* HTTP DELETE /gateway/tunnel
|
|
55
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
56
|
+
*/
|
|
57
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
58
|
+
/**
|
|
59
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
60
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
61
|
+
*/
|
|
62
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
63
|
+
/**
|
|
64
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
65
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
66
|
+
*/
|
|
67
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
68
|
+
/**
|
|
69
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
70
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
71
|
+
*/
|
|
72
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
73
|
+
}
|
|
74
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
75
|
+
protected httpClient: HttpClient<O>;
|
|
76
|
+
constructor(httpClient: HttpClient<O>);
|
|
77
|
+
/**
|
|
78
|
+
* HTTP GET /asset/datapoint/export
|
|
79
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
80
|
+
*/
|
|
81
|
+
getDatapointExport(queryParams?: {
|
|
82
|
+
attributeRefs?: string;
|
|
83
|
+
fromTimestamp?: number;
|
|
84
|
+
toTimestamp?: number;
|
|
85
|
+
}, options?: O): RestResponse<any>;
|
|
86
|
+
/**
|
|
87
|
+
* HTTP GET /asset/datapoint/periods
|
|
88
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
89
|
+
*/
|
|
90
|
+
getDatapointPeriod(queryParams?: {
|
|
91
|
+
assetId?: string;
|
|
92
|
+
attributeName?: string;
|
|
93
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
94
|
+
/**
|
|
95
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
96
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
97
|
+
*/
|
|
98
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
99
|
+
}
|
|
100
|
+
export declare class AssetModelResourceClient<O> {
|
|
101
|
+
protected httpClient: HttpClient<O>;
|
|
102
|
+
constructor(httpClient: HttpClient<O>);
|
|
103
|
+
/**
|
|
104
|
+
* HTTP GET /model/assetDescriptors
|
|
105
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
106
|
+
*/
|
|
107
|
+
getAssetDescriptors(queryParams?: {
|
|
108
|
+
parentId?: string;
|
|
109
|
+
parentType?: string;
|
|
110
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
111
|
+
/**
|
|
112
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
113
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
114
|
+
*/
|
|
115
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
116
|
+
parentId?: string;
|
|
117
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
118
|
+
/**
|
|
119
|
+
* HTTP GET /model/assetInfos
|
|
120
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
121
|
+
*/
|
|
122
|
+
getAssetInfos(queryParams?: {
|
|
123
|
+
parentId?: string;
|
|
124
|
+
parentType?: string;
|
|
125
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
126
|
+
/**
|
|
127
|
+
* HTTP GET /model/metaItemDescriptors
|
|
128
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
129
|
+
*/
|
|
130
|
+
getMetaItemDescriptors(queryParams?: {
|
|
131
|
+
parentId?: string;
|
|
132
|
+
}, options?: O): RestResponse<{
|
|
133
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
134
|
+
}>;
|
|
135
|
+
/**
|
|
136
|
+
* HTTP GET /model/valueDescriptors
|
|
137
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
138
|
+
*/
|
|
139
|
+
getValueDescriptors(queryParams?: {
|
|
140
|
+
parentId?: string;
|
|
141
|
+
}, options?: O): RestResponse<{
|
|
142
|
+
[index: string]: Model.ValueDescriptor;
|
|
143
|
+
}>;
|
|
144
|
+
}
|
|
145
|
+
export declare class ConfigurationResourceClient<O> {
|
|
146
|
+
protected httpClient: HttpClient<O>;
|
|
147
|
+
constructor(httpClient: HttpClient<O>);
|
|
148
|
+
/**
|
|
149
|
+
* HTTP GET /configuration/manager
|
|
150
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
151
|
+
*/
|
|
152
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
153
|
+
/**
|
|
154
|
+
* HTTP PUT /configuration/manager
|
|
155
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
156
|
+
*/
|
|
157
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
158
|
+
/**
|
|
159
|
+
* HTTP POST /configuration/manager/file
|
|
160
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
161
|
+
*/
|
|
162
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
163
|
+
path?: string;
|
|
164
|
+
}, options?: O): RestResponse<string>;
|
|
165
|
+
/**
|
|
166
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
167
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
168
|
+
*/
|
|
169
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
170
|
+
}
|
|
171
|
+
export declare class RealmResourceClient<O> {
|
|
172
|
+
protected httpClient: HttpClient<O>;
|
|
173
|
+
constructor(httpClient: HttpClient<O>);
|
|
174
|
+
/**
|
|
175
|
+
* HTTP POST /realm
|
|
176
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
177
|
+
*/
|
|
178
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
179
|
+
/**
|
|
180
|
+
* HTTP GET /realm
|
|
181
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
182
|
+
*/
|
|
183
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
184
|
+
/**
|
|
185
|
+
* HTTP GET /realm/accessible
|
|
186
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
187
|
+
*/
|
|
188
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
189
|
+
/**
|
|
190
|
+
* HTTP DELETE /realm/{name}
|
|
191
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
192
|
+
*/
|
|
193
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
194
|
+
/**
|
|
195
|
+
* HTTP GET /realm/{name}
|
|
196
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
197
|
+
*/
|
|
198
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
199
|
+
/**
|
|
200
|
+
* HTTP PUT /realm/{name}
|
|
201
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
202
|
+
*/
|
|
203
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
204
|
+
}
|
|
205
|
+
export declare class StatusResourceClient<O> {
|
|
206
|
+
protected httpClient: HttpClient<O>;
|
|
207
|
+
constructor(httpClient: HttpClient<O>);
|
|
208
|
+
/**
|
|
209
|
+
* HTTP GET /health
|
|
210
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
211
|
+
*/
|
|
212
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
213
|
+
[index: string]: any;
|
|
214
|
+
}>;
|
|
215
|
+
/**
|
|
216
|
+
* HTTP GET /info
|
|
217
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
218
|
+
*/
|
|
219
|
+
getInfo(options?: O): RestResponse<{
|
|
220
|
+
[index: string]: any;
|
|
221
|
+
}>;
|
|
222
|
+
}
|
|
12
223
|
export declare class UserResourceClient<O> {
|
|
13
224
|
protected httpClient: HttpClient<O>;
|
|
14
225
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -133,122 +344,40 @@ export declare class UserResourceClient<O> {
|
|
|
133
344
|
*/
|
|
134
345
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
135
346
|
}
|
|
136
|
-
export declare class
|
|
347
|
+
export declare class RulesResourceClient<O> {
|
|
137
348
|
protected httpClient: HttpClient<O>;
|
|
138
349
|
constructor(httpClient: HttpClient<O>);
|
|
139
350
|
/**
|
|
140
|
-
* HTTP
|
|
141
|
-
* Java method: org.openremote.model.rules.
|
|
351
|
+
* HTTP POST /rules
|
|
352
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
142
353
|
*/
|
|
143
|
-
|
|
354
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
144
355
|
/**
|
|
145
|
-
* HTTP GET /
|
|
146
|
-
* Java method: org.openremote.model.rules.
|
|
356
|
+
* HTTP GET /rules
|
|
357
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
147
358
|
*/
|
|
148
|
-
|
|
359
|
+
getGlobalRulesets(queryParams?: {
|
|
360
|
+
language?: Model.RulesetLang[];
|
|
361
|
+
fullyPopulate?: boolean;
|
|
362
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
149
363
|
/**
|
|
150
|
-
* HTTP
|
|
151
|
-
* Java method: org.openremote.model.rules.
|
|
364
|
+
* HTTP POST /rules/asset
|
|
365
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
152
366
|
*/
|
|
153
|
-
|
|
154
|
-
}
|
|
155
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
156
|
-
protected httpClient: HttpClient<O>;
|
|
157
|
-
constructor(httpClient: HttpClient<O>);
|
|
367
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
158
368
|
/**
|
|
159
|
-
* HTTP
|
|
160
|
-
* Java method: org.openremote.model.
|
|
369
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
370
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
161
371
|
*/
|
|
162
|
-
|
|
372
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
373
|
+
language?: Model.RulesetLang[];
|
|
374
|
+
fullyPopulate?: boolean;
|
|
375
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
163
376
|
/**
|
|
164
|
-
* HTTP DELETE /
|
|
165
|
-
* Java method: org.openremote.model.
|
|
377
|
+
* HTTP DELETE /rules/asset/{id}
|
|
378
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
166
379
|
*/
|
|
167
|
-
|
|
168
|
-
/**
|
|
169
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
170
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
171
|
-
*/
|
|
172
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
173
|
-
/**
|
|
174
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
175
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
176
|
-
*/
|
|
177
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
178
|
-
/**
|
|
179
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
180
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
181
|
-
*/
|
|
182
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
183
|
-
}
|
|
184
|
-
export declare class RealmResourceClient<O> {
|
|
185
|
-
protected httpClient: HttpClient<O>;
|
|
186
|
-
constructor(httpClient: HttpClient<O>);
|
|
187
|
-
/**
|
|
188
|
-
* HTTP POST /realm
|
|
189
|
-
* Java method: org.openremote.model.security.RealmResource.create
|
|
190
|
-
*/
|
|
191
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
192
|
-
/**
|
|
193
|
-
* HTTP GET /realm
|
|
194
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
195
|
-
*/
|
|
196
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
197
|
-
/**
|
|
198
|
-
* HTTP GET /realm/accessible
|
|
199
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
200
|
-
*/
|
|
201
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
202
|
-
/**
|
|
203
|
-
* HTTP DELETE /realm/{name}
|
|
204
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
205
|
-
*/
|
|
206
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
207
|
-
/**
|
|
208
|
-
* HTTP GET /realm/{name}
|
|
209
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
210
|
-
*/
|
|
211
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
212
|
-
/**
|
|
213
|
-
* HTTP PUT /realm/{name}
|
|
214
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
215
|
-
*/
|
|
216
|
-
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
217
|
-
}
|
|
218
|
-
export declare class RulesResourceClient<O> {
|
|
219
|
-
protected httpClient: HttpClient<O>;
|
|
220
|
-
constructor(httpClient: HttpClient<O>);
|
|
221
|
-
/**
|
|
222
|
-
* HTTP POST /rules
|
|
223
|
-
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
224
|
-
*/
|
|
225
|
-
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
226
|
-
/**
|
|
227
|
-
* HTTP GET /rules
|
|
228
|
-
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
229
|
-
*/
|
|
230
|
-
getGlobalRulesets(queryParams?: {
|
|
231
|
-
language?: Model.RulesetLang[];
|
|
232
|
-
fullyPopulate?: boolean;
|
|
233
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
234
|
-
/**
|
|
235
|
-
* HTTP POST /rules/asset
|
|
236
|
-
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
237
|
-
*/
|
|
238
|
-
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
239
|
-
/**
|
|
240
|
-
* HTTP GET /rules/asset/for/{assetId}
|
|
241
|
-
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
242
|
-
*/
|
|
243
|
-
getAssetRulesets(assetId: string, queryParams?: {
|
|
244
|
-
language?: Model.RulesetLang[];
|
|
245
|
-
fullyPopulate?: boolean;
|
|
246
|
-
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
247
|
-
/**
|
|
248
|
-
* HTTP DELETE /rules/asset/{id}
|
|
249
|
-
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
250
|
-
*/
|
|
251
|
-
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
380
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
252
381
|
/**
|
|
253
382
|
* HTTP GET /rules/asset/{id}
|
|
254
383
|
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
@@ -323,139 +452,6 @@ export declare class RulesResourceClient<O> {
|
|
|
323
452
|
*/
|
|
324
453
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
325
454
|
}
|
|
326
|
-
export declare class AgentResourceClient<O> {
|
|
327
|
-
protected httpClient: HttpClient<O>;
|
|
328
|
-
constructor(httpClient: HttpClient<O>);
|
|
329
|
-
/**
|
|
330
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
331
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
332
|
-
*/
|
|
333
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
334
|
-
realm?: string;
|
|
335
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
336
|
-
/**
|
|
337
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
338
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
339
|
-
*/
|
|
340
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
341
|
-
realm?: string;
|
|
342
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
343
|
-
/**
|
|
344
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
345
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
346
|
-
*/
|
|
347
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
348
|
-
parentId?: string;
|
|
349
|
-
realm?: string;
|
|
350
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
351
|
-
}
|
|
352
|
-
export declare class AlarmResourceClient<O> {
|
|
353
|
-
protected httpClient: HttpClient<O>;
|
|
354
|
-
constructor(httpClient: HttpClient<O>);
|
|
355
|
-
/**
|
|
356
|
-
* HTTP POST /alarm
|
|
357
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
358
|
-
*/
|
|
359
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
360
|
-
assetIds?: string[];
|
|
361
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
362
|
-
/**
|
|
363
|
-
* HTTP GET /alarm
|
|
364
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
365
|
-
*/
|
|
366
|
-
getAlarms(queryParams?: {
|
|
367
|
-
realm?: string;
|
|
368
|
-
status?: Model.AlarmStatus;
|
|
369
|
-
assetId?: string;
|
|
370
|
-
assigneeId?: string;
|
|
371
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
372
|
-
/**
|
|
373
|
-
* HTTP DELETE /alarm
|
|
374
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
375
|
-
*/
|
|
376
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
377
|
-
/**
|
|
378
|
-
* HTTP PUT /alarm/assets
|
|
379
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
380
|
-
*/
|
|
381
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
382
|
-
/**
|
|
383
|
-
* HTTP GET /alarm/{alarmId}
|
|
384
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
385
|
-
*/
|
|
386
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
387
|
-
/**
|
|
388
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
389
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
390
|
-
*/
|
|
391
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
392
|
-
/**
|
|
393
|
-
* HTTP PUT /alarm/{alarmId}
|
|
394
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
395
|
-
*/
|
|
396
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
397
|
-
/**
|
|
398
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
399
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
400
|
-
*/
|
|
401
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
402
|
-
realm?: string;
|
|
403
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
404
|
-
}
|
|
405
|
-
export declare class NotificationResourceClient<O> {
|
|
406
|
-
protected httpClient: HttpClient<O>;
|
|
407
|
-
constructor(httpClient: HttpClient<O>);
|
|
408
|
-
/**
|
|
409
|
-
* HTTP GET /notification
|
|
410
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
411
|
-
*/
|
|
412
|
-
getNotifications(queryParams?: {
|
|
413
|
-
id?: number;
|
|
414
|
-
type?: string;
|
|
415
|
-
from?: number;
|
|
416
|
-
to?: number;
|
|
417
|
-
realmId?: string;
|
|
418
|
-
userId?: string;
|
|
419
|
-
assetId?: string;
|
|
420
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
421
|
-
/**
|
|
422
|
-
* HTTP DELETE /notification
|
|
423
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
424
|
-
*/
|
|
425
|
-
removeNotifications(queryParams?: {
|
|
426
|
-
id?: number;
|
|
427
|
-
type?: string;
|
|
428
|
-
from?: number;
|
|
429
|
-
to?: number;
|
|
430
|
-
realmId?: string;
|
|
431
|
-
userId?: string;
|
|
432
|
-
assetId?: string;
|
|
433
|
-
}, options?: O): RestResponse<void>;
|
|
434
|
-
/**
|
|
435
|
-
* HTTP POST /notification/alert
|
|
436
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
437
|
-
*/
|
|
438
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
439
|
-
/**
|
|
440
|
-
* HTTP DELETE /notification/{notificationId}
|
|
441
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
442
|
-
*/
|
|
443
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
444
|
-
/**
|
|
445
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
446
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
447
|
-
*/
|
|
448
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
449
|
-
targetId?: string;
|
|
450
|
-
}, options?: O): RestResponse<void>;
|
|
451
|
-
/**
|
|
452
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
453
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
454
|
-
*/
|
|
455
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
456
|
-
targetId?: string;
|
|
457
|
-
}, options?: O): RestResponse<void>;
|
|
458
|
-
}
|
|
459
455
|
export declare class AssetResourceClient<O> {
|
|
460
456
|
protected httpClient: HttpClient<O>;
|
|
461
457
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -560,131 +556,114 @@ export declare class AssetResourceClient<O> {
|
|
|
560
556
|
assetIds?: string[];
|
|
561
557
|
}, options?: O): RestResponse<void>;
|
|
562
558
|
}
|
|
563
|
-
export declare class
|
|
559
|
+
export declare class ProvisioningResourceClient<O> {
|
|
564
560
|
protected httpClient: HttpClient<O>;
|
|
565
561
|
constructor(httpClient: HttpClient<O>);
|
|
566
562
|
/**
|
|
567
|
-
* HTTP
|
|
568
|
-
* Java method: org.openremote.model.
|
|
569
|
-
*/
|
|
570
|
-
deleteConnections(queryParams?: {
|
|
571
|
-
realm?: string[];
|
|
572
|
-
}, options?: O): RestResponse<void>;
|
|
573
|
-
/**
|
|
574
|
-
* HTTP GET /gateway/connection
|
|
575
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
576
|
-
*/
|
|
577
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
578
|
-
/**
|
|
579
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
580
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
563
|
+
* HTTP POST /provisioning
|
|
564
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
581
565
|
*/
|
|
582
|
-
|
|
566
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
583
567
|
/**
|
|
584
|
-
* HTTP GET /
|
|
585
|
-
* Java method: org.openremote.model.
|
|
568
|
+
* HTTP GET /provisioning
|
|
569
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
586
570
|
*/
|
|
587
|
-
|
|
571
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
588
572
|
/**
|
|
589
|
-
* HTTP
|
|
590
|
-
* Java method: org.openremote.model.
|
|
573
|
+
* HTTP DELETE /provisioning/{id}
|
|
574
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
591
575
|
*/
|
|
592
|
-
|
|
576
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
593
577
|
/**
|
|
594
|
-
* HTTP
|
|
595
|
-
* Java method: org.openremote.model.
|
|
578
|
+
* HTTP PUT /provisioning/{id}
|
|
579
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
596
580
|
*/
|
|
597
|
-
|
|
581
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
598
582
|
}
|
|
599
|
-
export declare class
|
|
583
|
+
export declare class SyslogResourceClient<O> {
|
|
600
584
|
protected httpClient: HttpClient<O>;
|
|
601
585
|
constructor(httpClient: HttpClient<O>);
|
|
602
586
|
/**
|
|
603
|
-
* HTTP GET /
|
|
604
|
-
* Java method: org.openremote.model.
|
|
605
|
-
*/
|
|
606
|
-
getAssetDescriptors(queryParams?: {
|
|
607
|
-
parentId?: string;
|
|
608
|
-
parentType?: string;
|
|
609
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
610
|
-
/**
|
|
611
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
612
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
587
|
+
* HTTP GET /syslog/config
|
|
588
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
613
589
|
*/
|
|
614
|
-
|
|
615
|
-
parentId?: string;
|
|
616
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
590
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
617
591
|
/**
|
|
618
|
-
* HTTP
|
|
619
|
-
* Java method: org.openremote.model.
|
|
592
|
+
* HTTP PUT /syslog/config
|
|
593
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
620
594
|
*/
|
|
621
|
-
|
|
622
|
-
parentId?: string;
|
|
623
|
-
parentType?: string;
|
|
624
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
595
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
625
596
|
/**
|
|
626
|
-
* HTTP
|
|
627
|
-
* Java method: org.openremote.model.
|
|
597
|
+
* HTTP DELETE /syslog/event
|
|
598
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
628
599
|
*/
|
|
629
|
-
|
|
630
|
-
parentId?: string;
|
|
631
|
-
}, options?: O): RestResponse<{
|
|
632
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
633
|
-
}>;
|
|
600
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
634
601
|
/**
|
|
635
|
-
* HTTP GET /
|
|
636
|
-
* Java method: org.openremote.model.
|
|
602
|
+
* HTTP GET /syslog/event
|
|
603
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
637
604
|
*/
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
605
|
+
getEvents(queryParams?: {
|
|
606
|
+
level?: Model.SyslogLevel;
|
|
607
|
+
per_page?: number;
|
|
608
|
+
page?: number;
|
|
609
|
+
from?: number;
|
|
610
|
+
to?: number;
|
|
611
|
+
category?: Model.SyslogCategory[];
|
|
612
|
+
subCategory?: string[];
|
|
613
|
+
}, options?: O): RestResponse<any>;
|
|
643
614
|
}
|
|
644
|
-
export declare class
|
|
615
|
+
export declare class AlarmResourceClient<O> {
|
|
645
616
|
protected httpClient: HttpClient<O>;
|
|
646
617
|
constructor(httpClient: HttpClient<O>);
|
|
647
618
|
/**
|
|
648
|
-
* HTTP
|
|
649
|
-
* Java method: org.openremote.model.
|
|
619
|
+
* HTTP POST /alarm
|
|
620
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
650
621
|
*/
|
|
651
|
-
|
|
622
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
623
|
+
assetIds?: string[];
|
|
624
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
652
625
|
/**
|
|
653
|
-
* HTTP GET /
|
|
654
|
-
* Java method: org.openremote.model.
|
|
626
|
+
* HTTP GET /alarm
|
|
627
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
655
628
|
*/
|
|
656
|
-
|
|
629
|
+
getAlarms(queryParams?: {
|
|
630
|
+
realm?: string;
|
|
631
|
+
status?: Model.AlarmStatus;
|
|
632
|
+
assetId?: string;
|
|
633
|
+
assigneeId?: string;
|
|
634
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
657
635
|
/**
|
|
658
|
-
* HTTP
|
|
659
|
-
* Java method: org.openremote.model.
|
|
636
|
+
* HTTP DELETE /alarm
|
|
637
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
660
638
|
*/
|
|
661
|
-
|
|
662
|
-
}
|
|
663
|
-
export declare class ConfigurationResourceClient<O> {
|
|
664
|
-
protected httpClient: HttpClient<O>;
|
|
665
|
-
constructor(httpClient: HttpClient<O>);
|
|
639
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
666
640
|
/**
|
|
667
|
-
* HTTP
|
|
668
|
-
* Java method: org.openremote.model.
|
|
641
|
+
* HTTP PUT /alarm/assets
|
|
642
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
669
643
|
*/
|
|
670
|
-
|
|
644
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
671
645
|
/**
|
|
672
|
-
* HTTP
|
|
673
|
-
* Java method: org.openremote.model.
|
|
646
|
+
* HTTP GET /alarm/{alarmId}
|
|
647
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
674
648
|
*/
|
|
675
|
-
|
|
649
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
676
650
|
/**
|
|
677
|
-
* HTTP
|
|
678
|
-
* Java method: org.openremote.model.
|
|
651
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
652
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
679
653
|
*/
|
|
680
|
-
|
|
681
|
-
path?: string;
|
|
682
|
-
}, options?: O): RestResponse<string>;
|
|
654
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
683
655
|
/**
|
|
684
|
-
* HTTP
|
|
685
|
-
* Java method: org.openremote.model.
|
|
656
|
+
* HTTP PUT /alarm/{alarmId}
|
|
657
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
686
658
|
*/
|
|
687
|
-
|
|
659
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
660
|
+
/**
|
|
661
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
662
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
663
|
+
*/
|
|
664
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
665
|
+
realm?: string;
|
|
666
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
688
667
|
}
|
|
689
668
|
export declare class MapResourceClient<O> {
|
|
690
669
|
protected httpClient: HttpClient<O>;
|
|
@@ -748,199 +727,220 @@ export declare class ConsoleResourceClient<O> {
|
|
|
748
727
|
*/
|
|
749
728
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
750
729
|
}
|
|
751
|
-
export declare class
|
|
730
|
+
export declare class DashboardResourceClient<O> {
|
|
752
731
|
protected httpClient: HttpClient<O>;
|
|
753
732
|
constructor(httpClient: HttpClient<O>);
|
|
754
733
|
/**
|
|
755
|
-
* HTTP POST /
|
|
756
|
-
* Java method: org.openremote.model.
|
|
734
|
+
* HTTP POST /dashboard
|
|
735
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
757
736
|
*/
|
|
758
|
-
|
|
737
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
759
738
|
/**
|
|
760
|
-
* HTTP
|
|
761
|
-
* Java method: org.openremote.model.
|
|
739
|
+
* HTTP PUT /dashboard
|
|
740
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
762
741
|
*/
|
|
763
|
-
|
|
742
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
764
743
|
/**
|
|
765
|
-
* HTTP
|
|
766
|
-
* Java method: org.openremote.model.
|
|
744
|
+
* HTTP GET /dashboard/all/{realm}
|
|
745
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
767
746
|
*/
|
|
768
|
-
|
|
747
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
769
748
|
/**
|
|
770
|
-
* HTTP
|
|
771
|
-
* Java method: org.openremote.model.
|
|
749
|
+
* HTTP POST /dashboard/query
|
|
750
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
772
751
|
*/
|
|
773
|
-
|
|
752
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
753
|
+
/**
|
|
754
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
755
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
756
|
+
*/
|
|
757
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
758
|
+
/**
|
|
759
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
760
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
761
|
+
*/
|
|
762
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
774
763
|
}
|
|
775
|
-
export declare class
|
|
764
|
+
export declare class FlowResourceClient<O> {
|
|
776
765
|
protected httpClient: HttpClient<O>;
|
|
777
766
|
constructor(httpClient: HttpClient<O>);
|
|
778
767
|
/**
|
|
779
|
-
* HTTP
|
|
780
|
-
* Java method: org.openremote.model.
|
|
768
|
+
* HTTP GET /flow
|
|
769
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
781
770
|
*/
|
|
782
|
-
|
|
771
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
783
772
|
/**
|
|
784
|
-
* HTTP
|
|
785
|
-
* Java method: org.openremote.model.
|
|
773
|
+
* HTTP GET /flow/{name}
|
|
774
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
786
775
|
*/
|
|
787
|
-
|
|
776
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
777
|
+
/**
|
|
778
|
+
* HTTP GET /flow/{type}
|
|
779
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
780
|
+
*/
|
|
781
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
788
782
|
}
|
|
789
|
-
export declare class
|
|
783
|
+
export declare class AgentResourceClient<O> {
|
|
790
784
|
protected httpClient: HttpClient<O>;
|
|
791
785
|
constructor(httpClient: HttpClient<O>);
|
|
792
786
|
/**
|
|
793
|
-
* HTTP GET /
|
|
794
|
-
* Java method: org.openremote.model.
|
|
787
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
788
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
795
789
|
*/
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
toTimestamp?: number;
|
|
800
|
-
}, options?: O): RestResponse<any>;
|
|
790
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
791
|
+
realm?: string;
|
|
792
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
801
793
|
/**
|
|
802
|
-
* HTTP
|
|
803
|
-
* Java method: org.openremote.model.
|
|
794
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
795
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
804
796
|
*/
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
797
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
798
|
+
realm?: string;
|
|
799
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
809
800
|
/**
|
|
810
|
-
* HTTP
|
|
811
|
-
* Java method: org.openremote.model.
|
|
801
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
802
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
812
803
|
*/
|
|
813
|
-
|
|
804
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
805
|
+
parentId?: string;
|
|
806
|
+
realm?: string;
|
|
807
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
814
808
|
}
|
|
815
|
-
export declare class
|
|
809
|
+
export declare class NotificationResourceClient<O> {
|
|
816
810
|
protected httpClient: HttpClient<O>;
|
|
817
811
|
constructor(httpClient: HttpClient<O>);
|
|
818
812
|
/**
|
|
819
|
-
* HTTP GET /
|
|
820
|
-
* Java method: org.openremote.model.
|
|
813
|
+
* HTTP GET /notification
|
|
814
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
821
815
|
*/
|
|
822
|
-
|
|
816
|
+
getNotifications(queryParams?: {
|
|
817
|
+
id?: number;
|
|
818
|
+
type?: string;
|
|
819
|
+
from?: number;
|
|
820
|
+
to?: number;
|
|
821
|
+
realmId?: string;
|
|
822
|
+
userId?: string;
|
|
823
|
+
assetId?: string;
|
|
824
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
823
825
|
/**
|
|
824
|
-
* HTTP
|
|
825
|
-
* Java method: org.openremote.model.
|
|
826
|
+
* HTTP DELETE /notification
|
|
827
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
826
828
|
*/
|
|
827
|
-
|
|
829
|
+
removeNotifications(queryParams?: {
|
|
830
|
+
id?: number;
|
|
831
|
+
type?: string;
|
|
832
|
+
from?: number;
|
|
833
|
+
to?: number;
|
|
834
|
+
realmId?: string;
|
|
835
|
+
userId?: string;
|
|
836
|
+
assetId?: string;
|
|
837
|
+
}, options?: O): RestResponse<void>;
|
|
828
838
|
/**
|
|
829
|
-
* HTTP
|
|
830
|
-
* Java method: org.openremote.model.
|
|
839
|
+
* HTTP POST /notification/alert
|
|
840
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
831
841
|
*/
|
|
832
|
-
|
|
842
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
833
843
|
/**
|
|
834
|
-
* HTTP
|
|
835
|
-
* Java method: org.openremote.model.
|
|
844
|
+
* HTTP DELETE /notification/{notificationId}
|
|
845
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
836
846
|
*/
|
|
837
|
-
|
|
838
|
-
level?: Model.SyslogLevel;
|
|
839
|
-
per_page?: number;
|
|
840
|
-
page?: number;
|
|
841
|
-
from?: number;
|
|
842
|
-
to?: number;
|
|
843
|
-
category?: Model.SyslogCategory[];
|
|
844
|
-
subCategory?: string[];
|
|
845
|
-
}, options?: O): RestResponse<any>;
|
|
846
|
-
}
|
|
847
|
-
export declare class StatusResourceClient<O> {
|
|
848
|
-
protected httpClient: HttpClient<O>;
|
|
849
|
-
constructor(httpClient: HttpClient<O>);
|
|
847
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
850
848
|
/**
|
|
851
|
-
* HTTP
|
|
852
|
-
* Java method: org.openremote.model.
|
|
849
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
850
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
853
851
|
*/
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
}>;
|
|
852
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
853
|
+
targetId?: string;
|
|
854
|
+
}, options?: O): RestResponse<void>;
|
|
857
855
|
/**
|
|
858
|
-
* HTTP
|
|
859
|
-
* Java method: org.openremote.model.
|
|
856
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
857
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
860
858
|
*/
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
}>;
|
|
859
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
860
|
+
targetId?: string;
|
|
861
|
+
}, options?: O): RestResponse<void>;
|
|
864
862
|
}
|
|
865
|
-
export declare class
|
|
863
|
+
export declare class GatewayClientResourceClient<O> {
|
|
866
864
|
protected httpClient: HttpClient<O>;
|
|
867
865
|
constructor(httpClient: HttpClient<O>);
|
|
868
866
|
/**
|
|
869
|
-
* HTTP
|
|
870
|
-
* Java method: org.openremote.model.
|
|
867
|
+
* HTTP DELETE /gateway/connection
|
|
868
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
871
869
|
*/
|
|
872
|
-
|
|
870
|
+
deleteConnections(queryParams?: {
|
|
871
|
+
realm?: string[];
|
|
872
|
+
}, options?: O): RestResponse<void>;
|
|
873
873
|
/**
|
|
874
|
-
* HTTP
|
|
875
|
-
* Java method: org.openremote.model.
|
|
874
|
+
* HTTP GET /gateway/connection
|
|
875
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
876
876
|
*/
|
|
877
|
-
|
|
877
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
878
878
|
/**
|
|
879
|
-
* HTTP
|
|
880
|
-
* Java method: org.openremote.model.
|
|
879
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
880
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
881
881
|
*/
|
|
882
|
-
|
|
882
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
883
883
|
/**
|
|
884
|
-
* HTTP
|
|
885
|
-
* Java method: org.openremote.model.
|
|
884
|
+
* HTTP GET /gateway/connection/{realm}
|
|
885
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
886
886
|
*/
|
|
887
|
-
|
|
887
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
888
888
|
/**
|
|
889
|
-
* HTTP
|
|
890
|
-
* Java method: org.openremote.model.
|
|
889
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
890
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
891
891
|
*/
|
|
892
|
-
|
|
892
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
893
893
|
/**
|
|
894
|
-
* HTTP GET /
|
|
895
|
-
* Java method: org.openremote.model.
|
|
894
|
+
* HTTP GET /gateway/status/{realm}
|
|
895
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
896
896
|
*/
|
|
897
|
-
|
|
897
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
898
898
|
}
|
|
899
899
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
900
900
|
export declare class ApiClient {
|
|
901
|
-
protected
|
|
902
|
-
protected
|
|
901
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
902
|
+
protected _appResource: AxiosAppResourceClient;
|
|
903
903
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
904
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
905
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
906
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
904
907
|
protected _realmResource: AxiosRealmResourceClient;
|
|
908
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
909
|
+
protected _userResource: AxiosUserResourceClient;
|
|
905
910
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
906
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
907
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
908
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
909
911
|
protected _assetResource: AxiosAssetResourceClient;
|
|
910
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
911
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
912
|
-
protected _appResource: AxiosAppResourceClient;
|
|
913
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
914
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
915
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
916
912
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
917
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
918
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
919
913
|
protected _syslogResource: AxiosSyslogResourceClient;
|
|
920
|
-
protected
|
|
914
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
915
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
916
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
921
917
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
918
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
919
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
920
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
921
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
922
922
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
923
|
-
get
|
|
924
|
-
get
|
|
923
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
924
|
+
get AppResource(): AxiosAppResourceClient;
|
|
925
925
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
926
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
927
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
928
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
926
929
|
get RealmResource(): AxiosRealmResourceClient;
|
|
930
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
931
|
+
get UserResource(): AxiosUserResourceClient;
|
|
927
932
|
get RulesResource(): AxiosRulesResourceClient;
|
|
928
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
929
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
930
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
931
933
|
get AssetResource(): AxiosAssetResourceClient;
|
|
932
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
933
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
934
|
-
get AppResource(): AxiosAppResourceClient;
|
|
935
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
936
|
-
get MapResource(): AxiosMapResourceClient;
|
|
937
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
938
934
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
939
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
940
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
941
935
|
get SyslogResource(): AxiosSyslogResourceClient;
|
|
942
|
-
get
|
|
936
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
937
|
+
get MapResource(): AxiosMapResourceClient;
|
|
938
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
943
939
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
940
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
941
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
942
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
943
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
944
944
|
}
|
|
945
945
|
import * as Axios from "axios";
|
|
946
946
|
declare module "axios" {
|
|
@@ -948,66 +948,66 @@ declare module "axios" {
|
|
|
948
948
|
data: R;
|
|
949
949
|
}
|
|
950
950
|
}
|
|
951
|
-
export declare class
|
|
951
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
952
952
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
953
953
|
}
|
|
954
|
-
export declare class
|
|
954
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
955
955
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
956
956
|
}
|
|
957
957
|
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
958
958
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
959
959
|
}
|
|
960
|
-
export declare class
|
|
960
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
961
961
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
962
962
|
}
|
|
963
|
-
export declare class
|
|
963
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
964
964
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
965
965
|
}
|
|
966
|
-
export declare class
|
|
966
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
967
967
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
968
968
|
}
|
|
969
|
-
export declare class
|
|
969
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
970
970
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
971
971
|
}
|
|
972
|
-
export declare class
|
|
972
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
973
973
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
974
974
|
}
|
|
975
|
-
export declare class
|
|
975
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
976
976
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
977
977
|
}
|
|
978
|
-
export declare class
|
|
978
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
979
979
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
980
980
|
}
|
|
981
|
-
export declare class
|
|
981
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
982
982
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
983
983
|
}
|
|
984
|
-
export declare class
|
|
984
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
985
985
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
986
986
|
}
|
|
987
|
-
export declare class
|
|
987
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
988
988
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
989
989
|
}
|
|
990
|
-
export declare class
|
|
990
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
991
991
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
992
992
|
}
|
|
993
|
-
export declare class
|
|
993
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
994
994
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
995
995
|
}
|
|
996
|
-
export declare class
|
|
996
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
997
997
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
998
998
|
}
|
|
999
|
-
export declare class
|
|
999
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1000
1000
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1001
1001
|
}
|
|
1002
|
-
export declare class
|
|
1002
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1003
1003
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1004
1004
|
}
|
|
1005
|
-
export declare class
|
|
1005
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1006
1006
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1007
1007
|
}
|
|
1008
|
-
export declare class
|
|
1008
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1009
1009
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1010
1010
|
}
|
|
1011
|
-
export declare class
|
|
1011
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1012
1012
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1013
1013
|
}
|