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