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