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