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