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