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