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