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