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