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