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