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