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