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