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