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