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